diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index ea9665ada3d0..0adfe04eadc7 100644 --- a/.generator/schemas/v1/openapi.yaml +++ b/.generator/schemas/v1/openapi.yaml @@ -29,9 +29,9 @@ components: responses: TooManyRequestsResponse: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests schemas: APIErrorResponse: @@ -40,99 +40,74 @@ components: errors: description: Array of errors returned by the API. example: - - Bad Request + - "Bad Request" items: description: Error description. - example: Bad Request + example: "Bad Request" type: string type: array required: - - errors + - errors type: object AWSAccount: description: Returns the AWS account associated with this integration. properties: access_key_id: - description: Your AWS access key ID. Only required if your AWS account is - a GovCloud or China account. + description: Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. type: string account_id: description: Your AWS Account ID without dashes. - example: '123456789012' + example: "123456789012" type: string account_specific_namespace_rules: additionalProperties: description: A list of additional properties. type: boolean - description: 'An object (in the form `{"namespace1":true/false, "namespace2":true/false}`) - containing user-supplied overrides - - for AWS namespace metric collection. **Important**: This field only contains - namespaces explicitly configured through API calls, - - not the comprehensive enabled or disabled status of all namespaces. If - a namespace is absent from this field, it uses Datadog''s - - internal defaults (all namespaces enabled by default, except `AWS/SQS`, - `AWS/ElasticMapReduce`, and `AWS/Usage`). - - For a complete view of all namespace statuses, use the V2 AWS Integration - API instead.' - example: - auto_scaling: false - opswork: false + description: |- + An object (in the form `{"namespace1":true/false, "namespace2":true/false}`) containing user-supplied overrides + for AWS namespace metric collection. **Important**: This field only contains namespaces explicitly configured through API calls, + not the comprehensive enabled or disabled status of all namespaces. If a namespace is absent from this field, it uses Datadog's + internal defaults (all namespaces enabled by default, except `AWS/SQS`, `AWS/ElasticMapReduce`, and `AWS/Usage`). + For a complete view of all namespace statuses, use the V2 AWS Integration API instead. + example: {"auto_scaling": false, "opswork": false} type: object cspm_resource_collection_enabled: default: false - description: Whether Datadog collects cloud security posture management - resources from your AWS account. This includes additional resources not - covered under the general `resource_collection`. + description: Whether Datadog collects cloud security posture management resources from your AWS account. This includes additional resources not covered under the general `resource_collection`. example: true type: boolean excluded_regions: - description: 'An array of [AWS regions](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints) - - to exclude from metrics collection.' - example: - - us-east-1 - - us-west-2 + description: |- + An array of [AWS regions](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints) + to exclude from metrics collection. + example: ["us-east-1", "us-west-2"] items: description: Regions to exclude. type: string type: array extended_resource_collection_enabled: default: false - description: Whether Datadog collects additional attributes and configuration - information about the resources in your AWS account. Required for `cspm_resource_collection`. + description: Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`. example: true type: boolean filter_tags: - description: 'The array of EC2 tags (in the form `key:value`) defines a - filter that Datadog uses when collecting metrics from EC2. - - Wildcards, such as `?` (for single characters) and `*` (for multiple characters) - can also be used. - + description: |- + The array of EC2 tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from EC2. + Wildcards, such as `?` (for single characters) and `*` (for multiple characters) can also be used. Only hosts that match one of the defined tags - will be imported into Datadog. The rest will be ignored. - - Host matching a given tag can also be excluded by adding `!` before the - tag. - - For example, `env:production,instance-type:c1.*,!region:us-east-1`' - example: - - $KEY:$VALUE + Host matching a given tag can also be excluded by adding `!` before the tag. + For example, `env:production,instance-type:c1.*,!region:us-east-1` + example: ["$KEY:$VALUE"] items: description: The list of the filter_tags. type: string type: array host_tags: - description: 'Array of tags (in the form `key:value`) to add to all hosts - - and metrics reporting through this integration.' - example: - - $KEY:$VALUE + description: |- + Array of tags (in the form `key:value`) to add to all hosts + and metrics reporting through this integration. + example: ["$KEY:$VALUE"] items: description: The list of the host_tags. type: string @@ -145,34 +120,33 @@ components: resource_collection_enabled: default: false deprecated: true - description: Deprecated in favor of 'extended_resource_collection_enabled'. - Whether Datadog collects a standard set of resources from your AWS account. + description: Deprecated in favor of 'extended_resource_collection_enabled'. Whether Datadog collects a standard set of resources from your AWS account. example: true type: boolean role_name: description: Your Datadog role delegation name. - example: DatadogAWSIntegrationRole + example: "DatadogAWSIntegrationRole" type: string secret_access_key: - description: Your AWS secret access key. Only required if your AWS account - is a GovCloud or China account. + description: Your AWS secret access key. Only required if your AWS account is a GovCloud or China account. type: string type: object AWSAccountAndLambdaRequest: description: AWS account ID and Lambda ARN. properties: account_id: - description: Your AWS Account ID without dashes. - example: '1234567' + description: >- + Your AWS Account ID without dashes. + example: "1234567" type: string lambda_arn: - description: ARN of the Datadog Lambda created during the Datadog-Amazon - Web services Log collection setup. - example: arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest + description: >- + ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup. + example: "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest" type: string required: - - account_id - - lambda_arn + - account_id + - lambda_arn type: object AWSAccountCreateResponse: description: The Response returned by the AWS Create Account call. @@ -185,16 +159,15 @@ components: description: List of AWS accounts to delete. properties: access_key_id: - description: Your AWS access key ID. Only required if your AWS account is - a GovCloud or China account. + description: Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. type: string account_id: description: Your AWS Account ID without dashes. - example: '123456789012' + example: "123456789012" type: string role_name: description: Your Datadog role delegation name. - example: DatadogAWSIntegrationRole + example: "DatadogAWSIntegrationRole" type: string type: object AWSAccountListResponse: @@ -203,7 +176,7 @@ components: accounts: description: List of enabled AWS accounts. items: - $ref: '#/components/schemas/AWSAccount' + $ref: "#/components/schemas/AWSAccount" type: array type: object AWSEventBridgeAccountConfiguration: @@ -211,20 +184,18 @@ components: properties: accountId: description: Your AWS Account ID without dashes. - example: '123456789012' + example: "123456789012" type: string eventHubs: description: Array of AWS event sources associated with this account. items: - $ref: '#/components/schemas/AWSEventBridgeSource' + $ref: "#/components/schemas/AWSEventBridgeSource" type: array tags: - description: 'Array of tags (in the form `key:value`) which are added to - all hosts - - and metrics reporting through the main AWS integration.' - example: - - $KEY:$VALUE + description: |- + Array of tags (in the form `key:value`) which are added to all hosts + and metrics reporting through the main AWS integration. + example: ["$KEY:$VALUE"] items: description: The list of the host_tags. type: string @@ -235,20 +206,18 @@ components: properties: account_id: description: Your AWS Account ID without dashes. - example: '123456789012' + example: "123456789012" type: string create_event_bus: - description: 'True if Datadog should create the event bus in addition to - the event - - source. Requires the `events:CreateEventBus` permission.' + description: |- + True if Datadog should create the event bus in addition to the event + source. Requires the `events:CreateEventBus` permission. example: true type: boolean event_generator_name: - description: 'The given part of the event source name, which is then combined - with an - - assigned suffix to form the full name.' + description: |- + The given part of the event source name, which is then combined with an + assigned suffix to form the full name. example: app-alerts type: string region: @@ -272,22 +241,20 @@ components: example: us-east-1 type: string status: - $ref: '#/components/schemas/AWSEventBridgeCreateStatus' + $ref: "#/components/schemas/AWSEventBridgeCreateStatus" type: object AWSEventBridgeCreateStatus: description: The event source status "created". - enum: - - created + enum: ["created"] example: created type: string - x-enum-varnames: - - CREATED + x-enum-varnames: ["CREATED"] AWSEventBridgeDeleteRequest: description: An object used to delete an EventBridge source. properties: account_id: description: Your AWS Account ID without dashes. - example: '123456789012' + example: "123456789012" type: string event_generator_name: description: The event source name. @@ -302,28 +269,24 @@ components: description: An indicator of the successful deletion of an EventBridge source. properties: status: - $ref: '#/components/schemas/AWSEventBridgeDeleteStatus' + $ref: "#/components/schemas/AWSEventBridgeDeleteStatus" type: object AWSEventBridgeDeleteStatus: description: The event source status "empty". - enum: - - empty + enum: ["empty"] example: empty type: string - x-enum-varnames: - - EMPTY + x-enum-varnames: ["EMPTY"] AWSEventBridgeListResponse: - description: An object describing the EventBridge configuration for multiple - accounts. + description: An object describing the EventBridge configuration for multiple accounts. properties: accounts: description: List of accounts with their event sources. items: - $ref: '#/components/schemas/AWSEventBridgeAccountConfiguration' + $ref: "#/components/schemas/AWSEventBridgeAccountConfiguration" type: array isInstalled: - description: True if the EventBridge sub-integration is enabled for your - organization. + description: True if the EventBridge sub-integration is enabled for your organization. type: boolean type: object AWSEventBridgeSource: @@ -341,25 +304,24 @@ components: properties: code: description: Code properties - example: no_such_config + example: "no_such_config" type: string message: description: Message content. - example: AWS account 12345 has no Lambda config to update + example: "AWS account 12345 has no Lambda config to update" type: string type: object AWSLogsAsyncResponse: - description: A list of all Datadog-AWS logs integrations available in your Datadog - organization. + description: A list of all Datadog-AWS logs integrations available in your Datadog organization. properties: errors: description: List of errors. items: - $ref: '#/components/schemas/AWSLogsAsyncError' + $ref: "#/components/schemas/AWSLogsAsyncError" type: array status: description: Status of the properties. - example: created + example: "created" type: string type: object AWSLogsLambda: @@ -370,103 +332,76 @@ components: type: string type: object AWSLogsListResponse: - description: A list of all Datadog-AWS logs integrations available in your Datadog - organization. + description: A list of all Datadog-AWS logs integrations available in your Datadog organization. properties: account_id: - description: Your AWS Account ID without dashes. - example: '1234567' + description: >- + Your AWS Account ID without dashes. + example: "1234567" type: string lambdas: - description: List of ARNs configured in your Datadog account. - example: - - arn: arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest + description: >- + List of ARNs configured in your Datadog account. + example: ["arn": "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest"] items: - $ref: '#/components/schemas/AWSLogsLambda' + $ref: "#/components/schemas/AWSLogsLambda" type: array services: - description: Array of services IDs. - example: - - s3 - - elb - - elbv2 - - cloudfront - - redshift - - lambda + description: >- + Array of services IDs. + example: ["s3", "elb", "elbv2", "cloudfront", "redshift", "lambda"] items: description: Description of the services. type: string type: array type: object AWSLogsListServicesResponse: - description: The list of current AWS services for which Datadog offers automatic - log collection. + description: The list of current AWS services for which Datadog offers automatic log collection. properties: id: - description: Key value in returned object. - example: s3 + description: >- + Key value in returned object. + example: "s3" type: string label: - description: Name of service available for configuration with Datadog logs. - example: S3 Access Logs + description: >- + Name of service available for configuration with Datadog logs. + example: "S3 Access Logs" type: string type: object AWSLogsServicesRequest: - description: A list of current AWS services for which Datadog offers automatic - log collection. + description: A list of current AWS services for which Datadog offers automatic log collection. properties: account_id: - description: Your AWS Account ID without dashes. - example: '1234567' + description: >- + Your AWS Account ID without dashes. + example: "1234567" type: string services: - description: Array of services IDs set to enable automatic log collection. - Discover the list of available services with the get list of AWS log ready - services API endpoint. - example: - - s3 - - elb - - elbv2 - - cloudfront - - redshift - - lambda + description: >- + Array of services IDs set to enable automatic log collection. Discover the list of available services with the get list of AWS log ready services API endpoint. + example: ["s3", "elb", "elbv2", "cloudfront", "redshift", "lambda"] items: description: Description of services. type: string type: array required: - - account_id - - services + - account_id + - services type: object AWSNamespace: description: The namespace associated with the tag filter entry. - enum: - - elb - - application_elb - - sqs - - rds - - custom - - network_elb - - lambda - - step_functions - type: string - x-enum-varnames: - - ELB - - APPLICATION_ELB - - SQS - - RDS - - CUSTOM - - NETWORK_ELB - - LAMBDA - - STEP_FUNCTIONS + enum: [elb, application_elb, sqs, rds, custom, network_elb, lambda, step_functions] + type: string + x-enum-varnames: ["ELB", "APPLICATION_ELB", "SQS", "RDS", "CUSTOM", "NETWORK_ELB", "LAMBDA", "STEP_FUNCTIONS"] AWSTagFilter: description: A tag filter. properties: namespace: - $ref: '#/components/schemas/AWSNamespace' + $ref: "#/components/schemas/AWSNamespace" tag_filter_str: description: The tag filter string. - example: prod* + example: "prod*" type: string type: object AWSTagFilterCreateRequest: @@ -474,13 +409,13 @@ components: properties: account_id: description: Your AWS Account ID without dashes. - example: '123456789012' + example: "123456789012" type: string namespace: - $ref: '#/components/schemas/AWSNamespace' + $ref: "#/components/schemas/AWSNamespace" tag_filter_str: description: The tag filter string. - example: prod* + example: "prod*" type: string type: object AWSTagFilterDeleteRequest: @@ -488,10 +423,10 @@ components: properties: account_id: description: The unique identifier of your AWS account. - example: FAKEAC0FAKEAC2FAKEAC + example: "FAKEAC0FAKEAC2FAKEAC" type: string namespace: - $ref: '#/components/schemas/AWSNamespace' + $ref: "#/components/schemas/AWSNamespace" type: object AWSTagFilterListResponse: description: An array of tag filter rules by `namespace` and tag filter string. @@ -499,25 +434,24 @@ components: filters: description: An array of tag filters. items: - $ref: '#/components/schemas/AWSTagFilter' + $ref: "#/components/schemas/AWSTagFilter" type: array type: object AccessRole: - description: The access role of the user. Options are **st** (standard user), - **adm** (admin user), or **ro** (read-only user). - enum: - - st - - adm - - ro - - ERROR - example: ro + description: The access role of the user. Options are **st** (standard user), **adm** (admin user), or **ro** (read-only user). + enum: + - st + - adm + - ro + - ERROR + example: "ro" nullable: true type: string x-enum-varnames: - - STANDARD - - ADMIN - - READ_ONLY - - ERROR + - STANDARD + - ADMIN + - READ_ONLY + - ERROR AddSignalToIncidentRequest: description: Attributes describing which incident to add the signal to. properties: @@ -525,154 +459,137 @@ components: description: Whether to post the signal on the incident timeline. type: boolean incident_id: - description: Public ID attribute of the incident to which the signal will - be added. + description: Public ID attribute of the incident to which the signal will be added. example: 2066 format: int64 type: integer version: - $ref: '#/components/schemas/Version' + $ref: "#/components/schemas/Version" required: - - incident_id + - incident_id type: object AgentCheck: description: Array of strings. - example: - - ntp - - ntp - - ntp:d884b5186b651429 - - OK - - '' - - '' + example: ["ntp", "ntp", "ntp:d884b5186b651429", "OK", "", ""] items: description: Agent check running on the host. type: array AlertGraphWidgetDefinition: - description: Alert graphs are timeseries graphs showing the current status of - any monitor defined on your system. + description: Alert graphs are timeseries graphs showing the current status of any monitor defined on your system. properties: alert_id: description: ID of the alert to use in the widget. - example: '' + example: "" type: string time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: The title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/AlertGraphWidgetDefinitionType' + $ref: "#/components/schemas/AlertGraphWidgetDefinitionType" viz_type: - $ref: '#/components/schemas/WidgetVizType' + $ref: "#/components/schemas/WidgetVizType" required: - - type - - alert_id - - viz_type + - type + - alert_id + - viz_type type: object AlertGraphWidgetDefinitionType: default: alert_graph description: Type of the alert graph widget. enum: - - alert_graph + - alert_graph example: alert_graph type: string x-enum-varnames: - - ALERT_GRAPH + - ALERT_GRAPH AlertValueWidgetDefinition: - description: Alert values are query values showing the current value of the - metric in any monitor defined on your system. + description: Alert values are query values showing the current value of the metric in any monitor defined on your system. properties: alert_id: description: ID of the alert to use in the widget. - example: '' + example: "" type: string precision: - description: Number of decimal to show. If not defined, will use the raw - value. + description: Number of decimal to show. If not defined, will use the raw value. format: int64 type: integer text_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title: description: Title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of value in the widget. type: string type: - $ref: '#/components/schemas/AlertValueWidgetDefinitionType' + $ref: "#/components/schemas/AlertValueWidgetDefinitionType" unit: description: Unit to display with the value. type: string required: - - type - - alert_id + - type + - alert_id type: object AlertValueWidgetDefinitionType: default: alert_value description: Type of the alert value widget. enum: - - alert_value + - alert_value example: alert_value type: string x-enum-varnames: - - ALERT_VALUE + - ALERT_VALUE ApiKey: - description: Datadog API key. + description: |- + Datadog API key. properties: created: description: Date of creation of the API key. - example: '2019-08-02 15:31:07' + example: "2019-08-02 15:31:07" readOnly: true type: string created_by: description: Datadog user handle that created the API key. - example: john@example.com + example: "john@example.com" readOnly: true type: string key: description: API key. - example: 1234512345123456abcabc912349abcd + example: "1234512345123456abcabc912349abcd" maxLength: 32 minLength: 32 readOnly: true type: string name: description: Name of your API key. - example: example user + example: "example user" type: string type: object ApiKeyListResponse: description: List of API and application keys available for a given organization. - example: - api_keys: - - created_by: test_user - key: 1234512345123456abcabc912349abcd - name: app_key + example: {"api_keys": [{"created_by": "test_user", "key": "1234512345123456abcabc912349abcd", "name": "app_key"}]} properties: api_keys: description: Array of API keys. items: - $ref: '#/components/schemas/ApiKey' + $ref: "#/components/schemas/ApiKey" type: array type: object ApiKeyResponse: description: An API key with its associated metadata. - example: - api_key: - created_by: test_user - key: 1234512345123456abcabc912349abcd - name: app_key + example: {"api_key": {"created_by": "test_user", "key": "1234512345123456abcabc912349abcd", "name": "app_key"}} properties: api_key: - $ref: '#/components/schemas/ApiKey' + $ref: "#/components/schemas/ApiKey" type: object ApmStatsQueryColumnType: description: Column properties. @@ -682,15 +599,15 @@ components: example: Requests type: string cell_display_mode: - $ref: '#/components/schemas/TableWidgetCellDisplayMode' + $ref: "#/components/schemas/TableWidgetCellDisplayMode" name: description: Column name. example: Reqs type: string order: - $ref: '#/components/schemas/WidgetSort' + $ref: "#/components/schemas/WidgetSort" required: - - name + - name type: object ApmStatsQueryDefinition: description: The APM stats query for table and distributions widgets. @@ -698,7 +615,7 @@ components: columns: description: Column properties used by the front end for display. items: - $ref: '#/components/schemas/ApmStatsQueryColumnType' + $ref: "#/components/schemas/ApmStatsQueryColumnType" type: array env: description: Environment name. @@ -706,85 +623,77 @@ components: type: string name: description: Operation name associated with service. - example: rack.request + example: "rack.request" type: string primary_tag: description: The organization's host group name and value. - example: datacenter:* + example: "datacenter:*" type: string resource: description: Resource name. example: CartsController type: string row_type: - $ref: '#/components/schemas/ApmStatsQueryRowType' + $ref: "#/components/schemas/ApmStatsQueryRowType" service: description: Service name. - example: web-store + example: "web-store" type: string required: - - service - - env - - name - - primary_tag - - row_type + - service + - env + - name + - primary_tag + - row_type type: object ApmStatsQueryRowType: description: The level of detail for the request. enum: - - service - - resource - - span - example: service + - service + - resource + - span + example: "service" type: string x-enum-varnames: - - SERVICE - - RESOURCE - - SPAN + - SERVICE + - RESOURCE + - SPAN ApplicationKey: description: An application key with its associated metadata. properties: hash: description: Hash of an application key. - example: 1234512345123459cda4eb9ced49a3d84fd0138c + example: "1234512345123459cda4eb9ced49a3d84fd0138c" maxLength: 40 minLength: 40 readOnly: true type: string name: description: Name of an application key. - example: example user + example: "example user" type: string owner: description: Owner of an application key. - example: example.com + example: "example.com" readOnly: true type: string type: object ApplicationKeyListResponse: description: An application key response. - example: - application_keys: - - hash: 1234512345123459cda4eb9ced49a3d84fd0138c - name: app_key - owner: test_user + example: {"application_keys": [{"hash": "1234512345123459cda4eb9ced49a3d84fd0138c", "name": "app_key", "owner": "test_user"}]} properties: application_keys: description: Array of application keys. items: - $ref: '#/components/schemas/ApplicationKey' + $ref: "#/components/schemas/ApplicationKey" type: array type: object ApplicationKeyResponse: description: An application key response. - example: - application_key: - hash: 1234512345123459cda4eb9ced49a3d84fd0138c - name: app_key - owner: test_user + example: {"application_key": {"hash": "1234512345123459cda4eb9ced49a3d84fd0138c", "name": "app_key", "owner": "test_user"}} properties: application_key: - $ref: '#/components/schemas/ApplicationKey' + $ref: "#/components/schemas/ApplicationKey" type: object AuthenticationValidationResponse: description: Represent validation endpoint responses. @@ -799,224 +708,215 @@ components: description: Datadog-Azure integrations configured for your organization. properties: app_service_plan_filters: - description: 'Limit the Azure app service plans that are pulled into Datadog - using tags. - - Only app service plans that match one of the defined tags are imported - into Datadog.' - example: key:value,filter:example + description: |- + Limit the Azure app service plans that are pulled into Datadog using tags. + Only app service plans that match one of the defined tags are imported into Datadog. + example: "key:value,filter:example" type: string automute: - description: Silence monitors for expected Azure VM shutdowns. + description: |- + Silence monitors for expected Azure VM shutdowns. example: true type: boolean client_id: description: Your Azure web application ID. - example: testc7f6-1234-5678-9101-3fcbf464test + example: "testc7f6-1234-5678-9101-3fcbf464test" type: string client_secret: description: Your Azure web application secret key. - example: TestingRh2nx664kUy5dIApvM54T4AtO + example: "TestingRh2nx664kUy5dIApvM54T4AtO" type: string container_app_filters: - description: 'Limit the Azure container apps that are pulled into Datadog - using tags. - - Only container apps that match one of the defined tags are imported into - Datadog.' - example: key:value,filter:example + description: |- + Limit the Azure container apps that are pulled into Datadog using tags. + Only container apps that match one of the defined tags are imported into Datadog. + example: "key:value,filter:example" type: string cspm_enabled: - description: "When enabled, Datadog\u2019s Cloud Security Management product - scans resource configurations monitored by this app registration.\nNote: - This requires resource_collection_enabled to be set to true." + description: |- + When enabled, Datadog’s Cloud Security Management product scans resource configurations monitored by this app registration. + Note: This requires resource_collection_enabled to be set to true. example: true type: boolean custom_metrics_enabled: - description: Enable custom metrics for your organization. + description: |- + Enable custom metrics for your organization. example: true type: boolean errors: description: Errors in your configuration. - example: - - '*' + example: ["*"] items: description: List of errors. readOnly: true type: string type: array host_filters: - description: 'Limit the Azure instances that are pulled into Datadog by - using tags. - - Only hosts that match one of the defined tags are imported into Datadog.' - example: key:value,filter:example + description: |- + Limit the Azure instances that are pulled into Datadog by using tags. + Only hosts that match one of the defined tags are imported into Datadog. + example: "key:value,filter:example" type: string metrics_enabled: - description: Enable Azure metrics for your organization. + description: |- + Enable Azure metrics for your organization. example: true type: boolean metrics_enabled_default: - description: Enable Azure metrics for your organization for resource providers - where no resource provider config is specified. + description: |- + Enable Azure metrics for your organization for resource providers where no resource provider config is specified. example: true type: boolean new_client_id: description: Your New Azure web application ID. - example: new1c7f6-1234-5678-9101-3fcbf464test + example: "new1c7f6-1234-5678-9101-3fcbf464test" type: string new_tenant_name: description: Your New Azure Active Directory ID. - example: new1c44-1234-5678-9101-cc00736ftest + example: "new1c44-1234-5678-9101-cc00736ftest" type: string resource_collection_enabled: - description: When enabled, Datadog collects metadata and configuration info - from cloud resources (compute instances, databases, load balancers, etc.) - monitored by this app registration. + description: |- + When enabled, Datadog collects metadata and configuration info from cloud resources (compute instances, databases, load balancers, etc.) monitored by this app registration. example: true type: boolean resource_provider_configs: - description: Configuration settings applied to resources from the specified - Azure resource providers. + description: Configuration settings applied to resources from the specified Azure resource providers. items: - $ref: '#/components/schemas/ResourceProviderConfig' + $ref: "#/components/schemas/ResourceProviderConfig" type: array tenant_name: description: Your Azure Active Directory ID. - example: testc44-1234-5678-9101-cc00736ftest + example: "testc44-1234-5678-9101-cc00736ftest" type: string usage_metrics_enabled: - description: Enable azure.usage metrics for your organization. + description: |- + Enable azure.usage metrics for your organization. example: true type: boolean type: object AzureAccountListResponse: description: Accounts configured for your organization. items: - $ref: '#/components/schemas/AzureAccount' + $ref: "#/components/schemas/AzureAccount" type: array BarChartWidgetDefinition: - description: The bar chart visualization displays categorical data using vertical - bars, allowing you to compare values across different groups. + description: The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups. properties: custom_links: description: List of custom links. items: - $ref: '#/components/schemas/WidgetCustomLink' + $ref: "#/components/schemas/WidgetCustomLink" type: array requests: description: List of bar chart widget requests. - example: - - q: system.load.1 + example: ["q": "system.load.1"] items: - $ref: '#/components/schemas/BarChartWidgetRequest' + $ref: "#/components/schemas/BarChartWidgetRequest" maxItems: 1 minItems: 1 type: array style: - $ref: '#/components/schemas/BarChartWidgetStyle' + $ref: "#/components/schemas/BarChartWidgetStyle" time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/BarChartWidgetDefinitionType' + $ref: "#/components/schemas/BarChartWidgetDefinitionType" required: - - type - - requests + - type + - requests type: object BarChartWidgetDefinitionType: default: bar_chart description: Type of the bar chart widget. enum: - - bar_chart + - bar_chart example: bar_chart type: string x-enum-varnames: - - BAR_CHART + - BAR_CHART BarChartWidgetDisplay: description: Bar chart widget display options. oneOf: - - $ref: '#/components/schemas/BarChartWidgetStacked' - - $ref: '#/components/schemas/BarChartWidgetFlat' + - $ref: "#/components/schemas/BarChartWidgetStacked" + - $ref: "#/components/schemas/BarChartWidgetFlat" BarChartWidgetFlat: description: Bar chart widget flat display. properties: type: - $ref: '#/components/schemas/BarChartWidgetFlatType' + $ref: "#/components/schemas/BarChartWidgetFlatType" required: - - type + - type type: object BarChartWidgetFlatType: default: flat description: Bar chart widget flat display type. enum: - - flat + - flat example: flat type: string x-enum-varnames: - - FLAT + - FLAT BarChartWidgetLegend: description: Bar chart widget stacked legend behavior. enum: - - automatic - - inline - - none + - automatic + - inline + - none example: automatic type: string x-enum-varnames: - - AUTOMATIC - - INLINE - - NONE + - AUTOMATIC + - INLINE + - NONE BarChartWidgetRequest: description: Updated bar chart widget. properties: apm_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. audit_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. conditional_formats: description: List of conditional formats. - example: - - comparator: '>=' - palette: blue - value: 1.0 + example: [{"comparator": ">=", "palette": "blue", "value": 1.0}] items: - $ref: '#/components/schemas/WidgetConditionalFormat' + $ref: "#/components/schemas/WidgetConditionalFormat" type: array event_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: - $ref: '#/components/schemas/WidgetFormula' + $ref: "#/components/schemas/WidgetFormula" type: array log_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. process_query: - $ref: '#/components/schemas/ProcessQueryDefinition' + $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: @@ -1026,86 +926,81 @@ components: queries: description: List of queries that can be returned directly or used in formulas. items: - $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition' + $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: - $ref: '#/components/schemas/FormulaAndFunctionResponseFormat' + $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" rum_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. sort: - $ref: '#/components/schemas/WidgetSortBy' + $ref: "#/components/schemas/WidgetSortBy" style: - $ref: '#/components/schemas/WidgetRequestStyle' + $ref: "#/components/schemas/WidgetRequestStyle" type: object BarChartWidgetScaling: description: Bar chart widget scaling definition. enum: - - absolute - - relative + - absolute + - relative type: string x-enum-varnames: - - ABSOLUTE - - RELATIVE + - ABSOLUTE + - RELATIVE BarChartWidgetStacked: description: Bar chart widget stacked display options. properties: legend: - $ref: '#/components/schemas/BarChartWidgetLegend' + $ref: "#/components/schemas/BarChartWidgetLegend" type: - $ref: '#/components/schemas/BarChartWidgetStackedType' + $ref: "#/components/schemas/BarChartWidgetStackedType" required: - - type + - type type: object BarChartWidgetStackedType: default: stacked description: Bar chart widget stacked display type. enum: - - stacked + - stacked example: stacked type: string x-enum-varnames: - - STACKED + - STACKED BarChartWidgetStyle: description: Style customization for a bar chart widget. properties: display: - $ref: '#/components/schemas/BarChartWidgetDisplay' + $ref: "#/components/schemas/BarChartWidgetDisplay" palette: description: Color palette to apply to the widget. type: string scaling: - $ref: '#/components/schemas/BarChartWidgetScaling' + $ref: "#/components/schemas/BarChartWidgetScaling" type: object CancelDowntimesByScopeRequest: description: Cancel downtimes according to scope. properties: scope: - description: 'The scope(s) to which the downtime applies and must be in - `key:value` format. For example, `host:app2`. - + description: |- + The scope(s) to which the downtime applies and must be in `key:value` format. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. - - The resulting downtime applies to sources that matches ALL provided scopes - (`env:dev` **AND** `env:prod`).' - example: host:myserver + The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`). + example: "host:myserver" type: string required: - - scope + - scope type: object CanceledDowntimesIds: description: Object containing array of IDs of canceled downtimes. properties: cancelled_ids: description: ID of downtimes that were canceled. - example: - - 123456789 - - 123456790 + example: [123456789, 123456790] items: description: Integer representation of one downtime ID. format: int64 @@ -1113,111 +1008,110 @@ components: type: array type: object ChangeWidgetDefinition: - description: The Change graph shows you the change in a value over the time - period chosen. + description: The Change graph shows you the change in a value over the time period chosen. properties: custom_links: description: List of custom links. items: - $ref: '#/components/schemas/WidgetCustomLink' + $ref: "#/components/schemas/WidgetCustomLink" type: array requests: - description: "Array of one request object to display in the widget.\n\nSee - the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json)\n - to learn how to build the `REQUEST_SCHEMA`." - example: - - q: {} + description: |- + Array of one request object to display in the widget. + + See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) + to learn how to build the `REQUEST_SCHEMA`. + example: ["q": "{}"] items: - $ref: '#/components/schemas/ChangeWidgetRequest' + $ref: "#/components/schemas/ChangeWidgetRequest" maxItems: 1 minItems: 1 type: array time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/ChangeWidgetDefinitionType' + $ref: "#/components/schemas/ChangeWidgetDefinitionType" required: - - type - - requests + - type + - requests type: object ChangeWidgetDefinitionType: default: change description: Type of the change widget. enum: - - change + - change example: change type: string x-enum-varnames: - - CHANGE + - CHANGE ChangeWidgetRequest: description: Updated change widget. properties: apm_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. change_type: - $ref: '#/components/schemas/WidgetChangeType' + $ref: "#/components/schemas/WidgetChangeType" compare_to: - $ref: '#/components/schemas/WidgetCompareTo' + $ref: "#/components/schemas/WidgetCompareTo" event_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: - $ref: '#/components/schemas/WidgetFormula' + $ref: "#/components/schemas/WidgetFormula" type: array increase_good: description: Whether to show increase as good. type: boolean log_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. order_by: - $ref: '#/components/schemas/WidgetOrderBy' + $ref: "#/components/schemas/WidgetOrderBy" order_dir: - $ref: '#/components/schemas/WidgetSort' + $ref: "#/components/schemas/WidgetSort" process_query: - $ref: '#/components/schemas/ProcessQueryDefinition' + $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: deprecated: true - description: Query definition. Deprecated - Use `queries` and `formulas` - instead. + description: Query definition. Deprecated - Use `queries` and `formulas` instead. type: string queries: description: List of queries that can be returned directly or used in formulas. items: - $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition' + $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: - $ref: '#/components/schemas/FormulaAndFunctionResponseFormat' + $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" rum_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. show_present: @@ -1228,7 +1122,7 @@ components: description: Response of monitor IDs that can or can't be safely deleted. properties: data: - $ref: '#/components/schemas/CheckCanDeleteMonitorResponseData' + $ref: "#/components/schemas/CheckCanDeleteMonitorResponseData" errors: additionalProperties: description: Strings denoting where a monitor is used. @@ -1240,7 +1134,7 @@ components: nullable: true type: object required: - - data + - data type: object CheckCanDeleteMonitorResponseData: description: Wrapper object with the list of monitor IDs. @@ -1258,7 +1152,7 @@ components: description: A service level objective response containing the requested object. properties: data: - $ref: '#/components/schemas/CheckCanDeleteSLOResponseData' + $ref: "#/components/schemas/CheckCanDeleteSLOResponseData" errors: additionalProperties: description: Description of the service level objective reference. @@ -1277,12 +1171,11 @@ components: type: array type: object CheckStatusWidgetDefinition: - description: Check status shows the current status or number of results for - any check performed. + description: Check status shows the current status or number of results for any check performed. properties: check: description: Name of the check to use in the widget. - example: '' + example: "" type: string group: description: Group reporting a single check. @@ -1294,49 +1187,48 @@ components: type: string type: array grouping: - $ref: '#/components/schemas/WidgetGrouping' + $ref: "#/components/schemas/WidgetGrouping" tags: - description: List of tags used to filter the groups reporting a cluster - check. + description: List of tags used to filter the groups reporting a cluster check. items: description: Tag name. type: string type: array time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/CheckStatusWidgetDefinitionType' + $ref: "#/components/schemas/CheckStatusWidgetDefinitionType" required: - - type - - check - - grouping + - type + - check + - grouping type: object CheckStatusWidgetDefinitionType: default: check_status description: Type of the check status widget. enum: - - check_status + - check_status example: check_status type: string x-enum-varnames: - - CHECK_STATUS + - CHECK_STATUS ContentEncoding: description: HTTP header used to compress the media-type. enum: - - gzip - - deflate + - gzip + - deflate type: string x-enum-varnames: - - GZIP - - DEFLATE + - GZIP + - DEFLATE Creator: description: Object describing the creator of the shared element. properties: @@ -1353,10 +1245,8 @@ components: readOnly: true type: object CrossOrgUuids: - description: The source organization UUID for cross organization queries. Feature - in Private Beta. - example: - - 6434abde-xxxx-yyyy-zzzz-da7ad0900001 + description: The source organization UUID for cross organization queries. Feature in Private Beta. + example: ["6434abde-xxxx-yyyy-zzzz-da7ad0900001"] items: description: The source organization UUID. example: 6434abde-xxxx-yyyy-zzzz-da7ad0900001 @@ -1364,9 +1254,9 @@ components: maxItems: 1 type: array Dashboard: - description: "A dashboard is Datadog\u2019s tool for visually tracking, analyzing, - and displaying\nkey performance metrics, which enable you to monitor the health - of your infrastructure." + description: |- + A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying + key performance metrics, which enable you to monitor the health of your infrastructure. properties: author_handle: description: Identifier of the dashboard author. @@ -1390,39 +1280,36 @@ components: type: string id: description: ID of the dashboard. - example: 123-abc-456 + example: "123-abc-456" readOnly: true type: string is_read_only: deprecated: true - description: 'Whether this dashboard is read-only. If True, only the author - and admins can make changes to it. + description: |- + Whether this dashboard is read-only. If True, only the author and admins can make changes to it. - - This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) - instead to manage write authorization for individual dashboards.' + This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards. example: false type: boolean layout_type: - $ref: '#/components/schemas/DashboardLayoutType' + $ref: "#/components/schemas/DashboardLayoutType" modified_at: description: Modification date of the dashboard. format: date-time readOnly: true type: string notify_list: - description: List of handles of users to notify when changes are made to - this dashboard. + description: List of handles of users to notify when changes are made to this dashboard. items: description: User handles. type: string nullable: true type: array reflow_type: - $ref: '#/components/schemas/DashboardReflowType' + $ref: "#/components/schemas/DashboardReflowType" restricted_roles: - description: A list of role identifiers. Only the author and users associated - with at least one of these roles can edit this dashboard. + description: |- + A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard. items: description: A role UUID. type: string @@ -1438,18 +1325,18 @@ components: template_variable_presets: description: Array of template variables saved views. items: - $ref: '#/components/schemas/DashboardTemplateVariablePreset' + $ref: "#/components/schemas/DashboardTemplateVariablePreset" nullable: true type: array template_variables: description: List of template variables for this dashboard. items: - $ref: '#/components/schemas/DashboardTemplateVariable' + $ref: "#/components/schemas/DashboardTemplateVariable" nullable: true type: array title: description: Title of the dashboard. - example: '' + example: "" type: string url: description: The URL of the dashboard. @@ -1458,53 +1345,41 @@ components: type: string widgets: description: List of widgets to display on the dashboard. - example: - - definition: - requests: - fill: - q: avg:system.cpu.user{*} - type: hostmap + example: ["definition": {"requests": {"fill": {"q": "avg:system.cpu.user{*}"}}, "type": "hostmap"}] items: - $ref: '#/components/schemas/Widget' + $ref: "#/components/schemas/Widget" type: array required: - - title - - layout_type - - widgets + - title + - layout_type + - widgets type: object DashboardBulkActionData: description: Dashboard bulk action request data. - example: - id: 123-abc-456 - type: dashboard + example: {"id": "123-abc-456", "type": "dashboard"} properties: id: - $ref: '#/components/schemas/DashboardID' + $ref: "#/components/schemas/DashboardID" type: - $ref: '#/components/schemas/DashboardResourceType' + $ref: "#/components/schemas/DashboardResourceType" required: - - type - - id + - type + - id type: object DashboardBulkActionDataList: description: List of dashboard bulk action request data objects. - example: - - id: 123-abc-456 - type: dashboard + example: [{"id": "123-abc-456", "type": "dashboard"}] items: - $ref: '#/components/schemas/DashboardBulkActionData' + $ref: "#/components/schemas/DashboardBulkActionData" type: array DashboardBulkDeleteRequest: description: Dashboard bulk delete request body. - example: - data: - - id: 123-abc-456 - type: dashboard + example: {"data": [{"id": "123-abc-456", "type": "dashboard"}]} properties: data: - $ref: '#/components/schemas/DashboardBulkActionDataList' + $ref: "#/components/schemas/DashboardBulkActionDataList" required: - - data + - data type: object DashboardDeleteResponse: description: Response from the delete dashboard call. @@ -1517,57 +1392,57 @@ components: description: Object containing the live span selection for the dashboard. properties: live_span: - $ref: '#/components/schemas/DashboardGlobalTimeLiveSpan' + $ref: "#/components/schemas/DashboardGlobalTimeLiveSpan" type: object DashboardGlobalTimeLiveSpan: description: Dashboard global time live_span selection enum: - - 15m - - 1h - - 4h - - 1d - - 2d - - 1w - - 1mo - - 3mo - example: 1h - type: string - x-enum-varnames: - - PAST_FIFTEEN_MINUTES - - PAST_ONE_HOUR - - PAST_FOUR_HOURS - - PAST_ONE_DAY - - PAST_TWO_DAYS - - PAST_ONE_WEEK - - PAST_ONE_MONTH - - PAST_THREE_MONTHS + - 15m + - 1h + - 4h + - 1d + - 2d + - 1w + - 1mo + - 3mo + example: "1h" + type: string + x-enum-varnames: + - PAST_FIFTEEN_MINUTES + - PAST_ONE_HOUR + - PAST_FOUR_HOURS + - PAST_ONE_DAY + - PAST_TWO_DAYS + - PAST_ONE_WEEK + - PAST_ONE_MONTH + - PAST_THREE_MONTHS DashboardID: description: Dashboard resource ID. - example: 123-abc-456 + example: "123-abc-456" type: string DashboardInviteType: description: Type for shared dashboard invitation request body. enum: - - public_dashboard_invitation + - public_dashboard_invitation example: public_dashboard_invitation type: string x-enum-varnames: - - PUBLIC_DASHBOARD_INVITATION + - PUBLIC_DASHBOARD_INVITATION DashboardLayoutType: description: Layout type of the dashboard. enum: - - ordered - - free + - ordered + - free example: ordered type: string x-enum-varnames: - - ORDERED - - FREE + - ORDERED + - FREE DashboardList: description: Your Datadog Dashboards. properties: author: - $ref: '#/components/schemas/Creator' + $ref: "#/components/schemas/Creator" created: description: Date of creation of the dashboard list. format: date-time @@ -1598,11 +1473,11 @@ components: type: string type: description: The type of dashboard list. - example: manual_dashboard_list + example: "manual_dashboard_list" readOnly: true type: string required: - - name + - name type: object DashboardListDeleteResponse: description: Deleted dashboard details. @@ -1618,65 +1493,58 @@ components: dashboard_lists: description: List of all your dashboard lists. items: - $ref: '#/components/schemas/DashboardList' + $ref: "#/components/schemas/DashboardList" type: array type: object DashboardReflowType: - description: 'Reflow type for a **new dashboard layout** dashboard. Set this - only when layout type is ''ordered''. - - If set to ''fixed'', the dashboard expects all widgets to have a layout, and - if it''s set to ''auto'', - - widgets should not have layouts.' + description: |- + Reflow type for a **new dashboard layout** dashboard. Set this only when layout type is 'ordered'. + If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', + widgets should not have layouts. enum: - - auto - - fixed + - auto + - fixed type: string x-enum-varnames: - - AUTO - - FIXED + - AUTO + - FIXED DashboardResourceType: default: dashboard description: Dashboard resource type. enum: - - dashboard + - dashboard example: dashboard type: string x-enum-varnames: - - DASHBOARD + - DASHBOARD DashboardRestoreRequest: description: Dashboard restore request body. - example: - data: - - id: 123-abc-456 - type: dashboard + example: {"data": [{"id": "123-abc-456", "type": "dashboard"}]} properties: data: - $ref: '#/components/schemas/DashboardBulkActionDataList' + $ref: "#/components/schemas/DashboardBulkActionDataList" required: - - data + - data type: object DashboardShareType: - description: Type of sharing access (either open to anyone who has the public - URL or invite-only). + description: Type of sharing access (either open to anyone who has the public URL or invite-only). enum: - - open - - invite - - embed + - open + - invite + - embed nullable: true type: string x-enum-varnames: - - OPEN - - INVITE - - EMBED + - OPEN + - INVITE + - EMBED DashboardSummary: description: Dashboard summary response. properties: dashboards: description: List of dashboard definitions. items: - $ref: '#/components/schemas/DashboardSummaryDefinition' + $ref: "#/components/schemas/DashboardSummaryDefinition" type: array type: object DashboardSummaryDefinition: @@ -1698,15 +1566,13 @@ components: type: string is_read_only: deprecated: true - description: 'Whether this dashboard is read-only. If True, only the author - and admins can make changes to it. + description: |- + Whether this dashboard is read-only. If True, only the author and admins can make changes to it. - - This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) - instead to manage write authorization for individual dashboards.' + This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards. type: boolean layout_type: - $ref: '#/components/schemas/DashboardLayoutType' + $ref: "#/components/schemas/DashboardLayoutType" modified_at: description: Modification date of the dashboard. format: date-time @@ -1722,12 +1588,8 @@ components: description: Template variable. properties: available_values: - description: The list of values that the template variable drop-down is - limited to. - example: - - my-host - - host1 - - host2 + description: The list of values that the template variable drop-down is limited to. + example: ["my-host", "host1", "host2"] items: description: Template variable value. type: string @@ -1735,21 +1597,15 @@ components: type: array default: deprecated: true - description: (deprecated) The default value for the template variable on - dashboard load. Cannot be used in conjunction with `defaults`. + description: (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with `defaults`. example: my-host nullable: true type: string defaults: - description: One or many default values for template variables on load. - If more than one default is specified, they will be unioned together with - `OR`. Cannot be used in conjunction with `default`. - example: - - my-host-1 - - my-host-2 + description: One or many default values for template variables on load. If more than one default is specified, they will be unioned together with `OR`. Cannot be used in conjunction with `default`. + example: ["my-host-1", "my-host-2"] items: - description: One of many default values for the template variable on dashboard - load. + description: One of many default values for the template variable on dashboard load. minLength: 1 type: string type: array @@ -1758,20 +1614,17 @@ components: example: host1 type: string prefix: - description: The tag prefix associated with the variable. Only tags with - this prefix appear in the variable drop-down. + description: The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. example: host nullable: true type: string type: - description: The type of variable. This is to differentiate between filter - variables (interpolated in query) and group by variables (interpolated - into group by). + description: The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by). example: group nullable: true type: string required: - - name + - name type: object DashboardTemplateVariablePreset: description: Template variables saved views. @@ -1782,7 +1635,7 @@ components: template_variables: description: List of variables. items: - $ref: '#/components/schemas/DashboardTemplateVariablePresetValue' + $ref: "#/components/schemas/DashboardTemplateVariablePresetValue" type: array type: object DashboardTemplateVariablePresetValue: @@ -1793,16 +1646,12 @@ components: type: string value: deprecated: true - description: (deprecated) The value of the template variable within the - saved view. Cannot be used in conjunction with `values`. + description: (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with `values`. type: string values: - description: One or many template variable values within the saved view, - which will be unioned together using `OR` if more than one is specified. - Cannot be used in conjunction with `value`. + description: One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. Cannot be used in conjunction with `value`. items: - description: One or many values of the template variable within the saved - view. + description: One or many values of the template variable within the saved view. minLength: 1 type: string minItems: 1 @@ -1811,13 +1660,13 @@ components: DashboardType: description: The type of the associated private dashboard. enum: - - custom_timeboard - - custom_screenboard - example: custom_timeboard + - custom_timeboard + - custom_screenboard + example: "custom_timeboard" type: string x-enum-varnames: - - CUSTOM_TIMEBOARD - - CUSTOM_SCREENBOARD + - CUSTOM_TIMEBOARD + - CUSTOM_SCREENBOARD DeleteSharedDashboardResponse: description: Response containing token of deleted shared dashboard. properties: @@ -1837,15 +1686,12 @@ components: type: object DistributionPoint: description: Array of distribution points. - example: - - 1575317847.0 - - - 0.5 - - 1.0 + example: [1575317847.0, [0.5, 1.0]] items: description: List of distribution point. oneOf: - - $ref: '#/components/schemas/DistributionPointTimestamp' - - $ref: '#/components/schemas/DistributionPointData' + - $ref: "#/components/schemas/DistributionPointTimestamp" + - $ref: "#/components/schemas/DistributionPointData" maxItems: 2 minItems: 2 type: array @@ -1863,26 +1709,24 @@ components: DistributionPointsContentEncoding: description: HTTP header used to compress the media-type. enum: - - deflate + - deflate type: string x-enum-varnames: - - DEFLATE + - DEFLATE DistributionPointsPayload: description: The distribution points payload. properties: series: description: A list of distribution points series to submit to Datadog. example: - - metric: system.load.1 - points: - - - 1475317847.0 - - - 1.0 - - 2.0 + - metric: "system.load.1" + points: + - [1475317847.0, [1.0, 2.0]] items: - $ref: '#/components/schemas/DistributionPointsSeries' + $ref: "#/components/schemas/DistributionPointsSeries" type: array required: - - series + - series type: object DistributionPointsSeries: description: A distribution points metric to submit to Datadog. @@ -1896,147 +1740,138 @@ components: example: system.load.1 type: string points: - description: Points relating to the distribution point metric. All points - must be tuples with timestamp and a list of values (cannot be a string). - Timestamps should be in POSIX time in seconds. + description: Points relating to the distribution point metric. All points must be tuples with timestamp and a list of values (cannot be a string). Timestamps should be in POSIX time in seconds. example: - - - 1575317847.0 - - - 0.5 - - 1.0 + - [1575317847.0, [0.5, 1.0]] items: - $ref: '#/components/schemas/DistributionPoint' + $ref: "#/components/schemas/DistributionPoint" type: array tags: description: A list of tags associated with the distribution point metric. - example: - - environment:test + example: ["environment:test"] items: description: Individual tags. type: string type: array type: - $ref: '#/components/schemas/DistributionPointsType' + $ref: "#/components/schemas/DistributionPointsType" required: - - metric - - points + - metric + - points type: object DistributionPointsType: default: distribution description: The type of the distribution point. enum: - - distribution + - distribution example: distribution type: string x-enum-varnames: - - DISTRIBUTION + - DISTRIBUTION DistributionWidgetDefinition: - description: "The Distribution visualization is another way of showing metrics\naggregated - across one or several tags, such as hosts.\nUnlike the heat map, a distribution - graph\u2019s x-axis is quantity rather than time." + description: |- + The Distribution visualization is another way of showing metrics + aggregated across one or several tags, such as hosts. + Unlike the heat map, a distribution graph’s x-axis is quantity rather than time. properties: custom_links: description: A list of custom links. items: - $ref: '#/components/schemas/WidgetCustomLink' + $ref: "#/components/schemas/WidgetCustomLink" type: array legend_size: deprecated: true - description: (Deprecated) The widget legend was replaced by a tooltip and - sidebar. + description: (Deprecated) The widget legend was replaced by a tooltip and sidebar. type: string markers: description: List of markers. - example: - - display_type: percentile - value: '90' + example: [{"display_type": "percentile", "value": "90"}] items: - $ref: '#/components/schemas/WidgetMarker' + $ref: "#/components/schemas/WidgetMarker" type: array requests: - description: "Array of one request object to display in the widget.\n\nSee - the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json)\n - to learn how to build the `REQUEST_SCHEMA`." + description: |- + Array of one request object to display in the widget. + + See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) + to learn how to build the `REQUEST_SCHEMA`. items: - $ref: '#/components/schemas/DistributionWidgetRequest' + $ref: "#/components/schemas/DistributionWidgetRequest" maxItems: 1 minItems: 1 type: array show_legend: deprecated: true - description: (Deprecated) The widget legend was replaced by a tooltip and - sidebar. + description: (Deprecated) The widget legend was replaced by a tooltip and sidebar. type: boolean time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/DistributionWidgetDefinitionType' + $ref: "#/components/schemas/DistributionWidgetDefinitionType" xaxis: - $ref: '#/components/schemas/DistributionWidgetXAxis' + $ref: "#/components/schemas/DistributionWidgetXAxis" yaxis: - $ref: '#/components/schemas/DistributionWidgetYAxis' + $ref: "#/components/schemas/DistributionWidgetYAxis" required: - - type - - requests + - type + - requests type: object DistributionWidgetDefinitionType: default: distribution description: Type of the distribution widget. enum: - - distribution + - distribution example: distribution type: string x-enum-varnames: - - DISTRIBUTION + - DISTRIBUTION DistributionWidgetHistogramRequestQuery: description: Query definition for Distribution Widget Histogram Request - example: - data_source: metrics - name: query1 - query: histogram:trace.Load{*} + example: {"data_source": "metrics", "name": "query1", "query": "histogram:trace.Load{*}"} oneOf: - - $ref: '#/components/schemas/FormulaAndFunctionMetricQueryDefinition' - - $ref: '#/components/schemas/FormulaAndFunctionEventQueryDefinition' - - $ref: '#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition' + - $ref: "#/components/schemas/FormulaAndFunctionMetricQueryDefinition" + - $ref: "#/components/schemas/FormulaAndFunctionEventQueryDefinition" + - $ref: "#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition" DistributionWidgetRequest: description: Updated distribution widget. properties: apm_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. apm_stats_query: - $ref: '#/components/schemas/ApmStatsQueryDefinition' + $ref: "#/components/schemas/ApmStatsQueryDefinition" event_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: - $ref: '#/components/schemas/WidgetFormula' + $ref: "#/components/schemas/WidgetFormula" type: array log_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. process_query: - $ref: '#/components/schemas/ProcessQueryDefinition' + $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: @@ -2046,28 +1881,26 @@ components: queries: description: List of queries that can be returned directly or used in formulas. items: - $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition' + $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array query: - $ref: '#/components/schemas/DistributionWidgetHistogramRequestQuery' + $ref: "#/components/schemas/DistributionWidgetHistogramRequestQuery" request_type: - $ref: '#/components/schemas/WidgetHistogramRequestType' - description: Distribution of point values for distribution metrics. Renders - a histogram of raw metric data points. + $ref: "#/components/schemas/WidgetHistogramRequestType" + description: Distribution of point values for distribution metrics. Renders a histogram of raw metric data points. response_format: - $ref: '#/components/schemas/FormulaAndFunctionResponseFormat' - description: Distribution of aggregated grouped queries. Use `request_type` - instead for distribution of point values from distribution metrics. + $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" + description: Distribution of aggregated grouped queries. Use `request_type` instead for distribution of point values from distribution metrics. rum_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. style: - $ref: '#/components/schemas/WidgetStyle' + $ref: "#/components/schemas/WidgetStyle" type: object DistributionWidgetXAxis: description: X Axis controls for the distribution widget. @@ -2077,17 +1910,14 @@ components: type: boolean max: default: auto - description: Specifies maximum value to show on the x-axis. It takes a number, - percentile (p90 === 90th percentile), or auto for default behavior. + description: Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. type: string min: default: auto - description: Specifies minimum value to show on the x-axis. It takes a number, - percentile (p90 === 90th percentile), or auto for default behavior. + description: Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. type: string num_buckets: - description: Number of value buckets to target, also known as the resolution - of the value bins. + description: Number of value buckets to target, also known as the resolution of the value bins. format: int64 minimum: 1 type: integer @@ -2107,13 +1937,11 @@ components: type: string max: default: auto - description: Specifies the maximum value to show on the y-axis. It takes - a number, or auto for default behavior. + description: Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. type: string min: default: auto - description: Specifies minimum value to show on the y-axis. It takes a number, - or auto for default behavior. + description: Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. type: string scale: default: linear @@ -2121,14 +1949,11 @@ components: type: string type: object Downtime: - description: 'Downtiming gives you greater control over monitor notifications - by - + description: |- + Downtiming gives you greater control over monitor notifications by allowing you to globally exclude scopes from alerting. - Downtime settings, which can be scheduled with start and end times, - - prevent all alerting related to specified Datadog tags.' + prevent all alerting related to specified Datadog tags. properties: active: description: If a scheduled downtime currently exists. @@ -2136,7 +1961,7 @@ components: readOnly: true type: boolean active_child: - $ref: '#/components/schemas/DowntimeChild' + $ref: "#/components/schemas/DowntimeChild" canceled: description: If a scheduled downtime is canceled. example: 1412799983 @@ -2156,20 +1981,19 @@ components: example: false type: boolean downtime_type: - description: '`0` for a downtime applied on `*` or all, - + description: |- + `0` for a downtime applied on `*` or all, `1` when the downtime is only scoped to hosts, - - or `2` when the downtime is scoped to anything but hosts.' + or `2` when the downtime is scoped to anything but hosts. example: 2 format: int32 maximum: 2147483647 readOnly: true type: integer end: - description: 'POSIX timestamp to end the downtime. If not provided, - - the downtime is in effect indefinitely until you cancel it.' + description: |- + POSIX timestamp to end the downtime. If not provided, + the downtime is in effect indefinitely until you cancel it. example: 1412793983 format: int64 nullable: true @@ -2181,47 +2005,39 @@ components: readOnly: true type: integer message: - description: 'A message to include with notifications for this downtime. - - Email notifications can be sent to specific users by using the same `@username` - notation as events.' - example: Message on the downtime + description: |- + A message to include with notifications for this downtime. + Email notifications can be sent to specific users by using the same `@username` notation as events. + example: "Message on the downtime" nullable: true type: string monitor_id: - description: 'A single monitor to which the downtime applies. - - If not provided, the downtime applies to all monitors.' + description: |- + A single monitor to which the downtime applies. + If not provided, the downtime applies to all monitors. example: 123456 format: int64 nullable: true type: integer monitor_tags: - description: 'A comma-separated list of monitor tags. For example, tags - that are applied directly to monitors, - - not tags that are used in monitor queries (which are filtered by the scope - parameter), to which the downtime applies. - - The resulting downtime applies to monitors that match ALL provided monitor - tags. - - For example, `service:postgres` **AND** `team:frontend`.' - example: - - '*' + description: |- + A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, + not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. + The resulting downtime applies to monitors that match ALL provided monitor tags. + For example, `service:postgres` **AND** `team:frontend`. + example: ["*"] items: description: A monitor tag. type: string type: array mute_first_recovery_notification: - description: If the first recovery notification during a downtime should - be muted. + description: If the first recovery notification during a downtime should be muted. example: false type: boolean notify_end_states: - $ref: '#/components/schemas/NotifyEndStates' + $ref: "#/components/schemas/NotifyEndStates" notify_end_types: - $ref: '#/components/schemas/NotifyEndTypes' + $ref: "#/components/schemas/NotifyEndTypes" parent_id: description: ID of the parent Downtime. example: 123 @@ -2229,32 +2045,27 @@ components: nullable: true type: integer recurrence: - $ref: '#/components/schemas/DowntimeRecurrence' + $ref: "#/components/schemas/DowntimeRecurrence" scope: - description: 'The scope(s) to which the downtime applies and must be in - `key:value` format. For example, `host:app2`. - + description: |- + The scope(s) to which the downtime applies and must be in `key:value` format. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. - - The resulting downtime applies to sources that matches ALL provided scopes - (`env:dev` **AND** `env:prod`).' - example: - - env:staging + The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`). + example: ["env:staging"] items: description: A scope. For example, `"env:staging"`. type: string type: array start: - description: 'POSIX timestamp to start the downtime. - - If not provided, the downtime starts the moment it is created.' + description: |- + POSIX timestamp to start the downtime. + If not provided, the downtime starts the moment it is created. example: 1412792983 format: int64 type: integer timezone: - description: The timezone in which to display the downtime's start and end - times in Datadog applications. - example: America/New_York + description: The timezone in which to display the downtime's start and end times in Datadog applications. + example: "America/New_York" type: string updater_id: description: ID of the last user that updated the downtime. @@ -2266,10 +2077,9 @@ components: type: integer type: object DowntimeChild: - description: 'The downtime object definition of the active child for the original - parent recurring downtime. This - - field will only exist on recurring downtimes.' + description: |- + The downtime object definition of the active child for the original parent recurring downtime. This + field will only exist on recurring downtimes. nullable: true properties: active: @@ -2296,20 +2106,19 @@ components: example: false type: boolean downtime_type: - description: '`0` for a downtime applied on `*` or all, - + description: |- + `0` for a downtime applied on `*` or all, `1` when the downtime is only scoped to hosts, - - or `2` when the downtime is scoped to anything but hosts.' + or `2` when the downtime is scoped to anything but hosts. example: 2 format: int32 maximum: 2147483647 readOnly: true type: integer end: - description: 'POSIX timestamp to end the downtime. If not provided, - - the downtime is in effect indefinitely until you cancel it.' + description: |- + POSIX timestamp to end the downtime. If not provided, + the downtime is in effect indefinitely until you cancel it. example: 1412793983 format: int64 nullable: true @@ -2321,47 +2130,39 @@ components: readOnly: true type: integer message: - description: 'A message to include with notifications for this downtime. - - Email notifications can be sent to specific users by using the same `@username` - notation as events.' - example: Message on the downtime + description: |- + A message to include with notifications for this downtime. + Email notifications can be sent to specific users by using the same `@username` notation as events. + example: "Message on the downtime" nullable: true type: string monitor_id: - description: 'A single monitor to which the downtime applies. - - If not provided, the downtime applies to all monitors.' + description: |- + A single monitor to which the downtime applies. + If not provided, the downtime applies to all monitors. example: 123456 format: int64 nullable: true type: integer monitor_tags: - description: 'A comma-separated list of monitor tags. For example, tags - that are applied directly to monitors, - - not tags that are used in monitor queries (which are filtered by the scope - parameter), to which the downtime applies. - - The resulting downtime applies to monitors that match ALL provided monitor - tags. - - For example, `service:postgres` **AND** `team:frontend`.' - example: - - '*' + description: |- + A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, + not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. + The resulting downtime applies to monitors that match ALL provided monitor tags. + For example, `service:postgres` **AND** `team:frontend`. + example: ["*"] items: description: A monitor tag. type: string type: array mute_first_recovery_notification: - description: If the first recovery notification during a downtime should - be muted. + description: If the first recovery notification during a downtime should be muted. example: false type: boolean notify_end_states: - $ref: '#/components/schemas/NotifyEndStates' + $ref: "#/components/schemas/NotifyEndStates" notify_end_types: - $ref: '#/components/schemas/NotifyEndTypes' + $ref: "#/components/schemas/NotifyEndTypes" parent_id: description: ID of the parent Downtime. example: 123 @@ -2369,32 +2170,27 @@ components: nullable: true type: integer recurrence: - $ref: '#/components/schemas/DowntimeRecurrence' + $ref: "#/components/schemas/DowntimeRecurrence" scope: - description: 'The scope(s) to which the downtime applies and must be in - `key:value` format. For example, `host:app2`. - + description: |- + The scope(s) to which the downtime applies and must be in `key:value` format. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. - - The resulting downtime applies to sources that matches ALL provided scopes - (`env:dev` **AND** `env:prod`).' - example: - - env:staging + The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`). + example: ["env:staging"] items: description: A scope. For example, `"env:staging"`. type: string type: array start: - description: 'POSIX timestamp to start the downtime. - - If not provided, the downtime starts the moment it is created.' + description: |- + POSIX timestamp to start the downtime. + If not provided, the downtime starts the moment it is created. example: 1412792983 format: int64 type: integer timezone: - description: The timezone in which to display the downtime's start and end - times in Datadog applications. - example: America/New_York + description: The timezone in which to display the downtime's start and end times in Datadog applications. + example: "America/New_York" type: string updater_id: description: ID of the last user that updated the downtime. @@ -2411,65 +2207,51 @@ components: nullable: true properties: period: - description: 'How often to repeat as an integer. - - For example, to repeat every 3 days, select a type of `days` and a period - of `3`.' + description: |- + How often to repeat as an integer. + For example, to repeat every 3 days, select a type of `days` and a period of `3`. example: 1 format: int32 maximum: 2147483647 type: integer rrule: - description: 'The `RRULE` standard for defining recurring events (**requires - to set "type" to rrule**) - - For example, to have a recurring event on the first day of each month, - set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` - to `1`. - - Most common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) - are supported. - - - **Note**: Attributes specifying the duration in `RRULE` are not supported - (for example, `DTSTART`, `DTEND`, `DURATION`). + description: |- + The `RRULE` standard for defining recurring events (**requires to set "type" to rrule**) + For example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`. + Most common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported. - More examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api)' + **Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`). + More examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api) example: FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1 type: string type: - description: The type of recurrence. Choose from `days`, `weeks`, `months`, - `years`, `rrule`. + description: The type of recurrence. Choose from `days`, `weeks`, `months`, `years`, `rrule`. example: weeks type: string until_date: - description: 'The date at which the recurrence should end as a POSIX timestamp. - - `until_occurences` and `until_date` are mutually exclusive.' + description: |- + The date at which the recurrence should end as a POSIX timestamp. + `until_occurences` and `until_date` are mutually exclusive. example: 1447786293 format: int64 nullable: true type: integer until_occurrences: - description: 'How many times the downtime is rescheduled. - - `until_occurences` and `until_date` are mutually exclusive.' + description: |- + How many times the downtime is rescheduled. + `until_occurences` and `until_date` are mutually exclusive. example: 2 format: int32 maximum: 2147483647 nullable: true type: integer week_days: - description: 'A list of week days to repeat on. Choose from `Mon`, `Tue`, - `Wed`, `Thu`, `Fri`, `Sat` or `Sun`. - - Only applicable when type is weeks. First letter must be capitalized.' - example: - - Mon - - Tue + description: |- + A list of week days to repeat on. Choose from `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat` or `Sun`. + Only applicable when type is weeks. First letter must be capitalized. + example: ["Mon", "Tue"] items: - description: A day of the week, formatted as `Mon`, `Tue`, `Wed`, `Thu`, - `Fri`, `Sat` or `Sun`. + description: A day of the week, formatted as `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat` or `Sun`. type: string nullable: true type: array @@ -2478,21 +2260,20 @@ components: description: Object representing an event. properties: alert_type: - $ref: '#/components/schemas/EventAlertType' + $ref: "#/components/schemas/EventAlertType" date_happened: - description: 'POSIX timestamp of the event. Must be sent as an integer (that - is no quotes). - - Limited to events up to 18 hours in the past and two hours in the future.' + description: |- + POSIX timestamp of the event. Must be sent as an integer (that is no quotes). + Limited to events up to 18 hours in the past and two hours in the future. format: int64 type: integer device_name: description: A device name. type: string host: - description: 'Host name to associate with the event. - - Any tags associated with the host are also applied to this event.' + description: |- + Host name to associate with the event. + Any tags associated with the host are also applied to this event. type: string id: description: Integer ID of the event. @@ -2500,48 +2281,41 @@ components: readOnly: true type: integer id_str: - description: 'Handling IDs as large 64-bit numbers can cause loss of accuracy - issues with some programming languages. - - Instead, use the string representation of the Event ID to avoid losing - accuracy.' + description: |- + Handling IDs as large 64-bit numbers can cause loss of accuracy issues with some programming languages. + Instead, use the string representation of the Event ID to avoid losing accuracy. readOnly: true type: string payload: description: Payload of the event. - example: '{}' + example: "{}" readOnly: true type: string priority: - $ref: '#/components/schemas/EventPriority' + $ref: "#/components/schemas/EventPriority" source_type_name: - description: 'The type of event being posted. Option examples include nagios, - hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc. - - The list of standard source attribute values [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).' + description: |- + The type of event being posted. Option examples include nagios, hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc. + The list of standard source attribute values [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). type: string tags: description: A list of tags to apply to the event. - example: - - environment:test + example: ["environment:test"] items: description: A tag. type: string type: array text: - description: 'The body of the event. Limited to 4000 characters. The text - supports markdown. - - To use markdown in the event text, start the text block with `%%% \n` - and end the text block with `\n %%%`. - - Use `msg_text` with the Datadog Ruby library.' - example: Oh boy! + description: |- + The body of the event. Limited to 4000 characters. The text supports markdown. + To use markdown in the event text, start the text block with `%%% \n` and end the text block with `\n %%%`. + Use `msg_text` with the Datadog Ruby library. + example: "Oh boy!" maxLength: 4000 type: string title: description: The event title. - example: Did you hear the news today? + example: "Did you hear the news today?" type: string url: description: URL of the event. @@ -2549,102 +2323,92 @@ components: type: string type: object EventAlertType: - description: 'If an alert event is enabled, set its type. - + description: |- + If an alert event is enabled, set its type. For example, `error`, `warning`, `info`, `success`, `user_update`, - - `recommendation`, and `snapshot`.' - enum: - - error - - warning - - info - - success - - user_update - - recommendation - - snapshot - example: info - type: string - x-enum-varnames: - - ERROR - - WARNING - - INFO - - SUCCESS - - USER_UPDATE - - RECOMMENDATION - - SNAPSHOT + `recommendation`, and `snapshot`. + enum: + - error + - warning + - info + - success + - user_update + - recommendation + - snapshot + example: "info" + type: string + x-enum-varnames: + - ERROR + - WARNING + - INFO + - SUCCESS + - USER_UPDATE + - RECOMMENDATION + - SNAPSHOT EventCreateRequest: description: Object representing an event. properties: aggregation_key: - description: 'An arbitrary string to use for aggregation. Limited to 100 - characters. - - If you specify a key, all events using that key are grouped together in - the Event Stream.' + description: |- + An arbitrary string to use for aggregation. Limited to 100 characters. + If you specify a key, all events using that key are grouped together in the Event Stream. maxLength: 100 type: string alert_type: - $ref: '#/components/schemas/EventAlertType' + $ref: "#/components/schemas/EventAlertType" date_happened: - description: 'POSIX timestamp of the event. Must be sent as an integer (that - is no quotes). - - Limited to events no older than 18 hours' + description: |- + POSIX timestamp of the event. Must be sent as an integer (that is no quotes). + Limited to events no older than 18 hours format: int64 type: integer device_name: description: A device name. type: string host: - description: 'Host name to associate with the event. - - Any tags associated with the host are also applied to this event.' + description: |- + Host name to associate with the event. + Any tags associated with the host are also applied to this event. type: string priority: - $ref: '#/components/schemas/EventPriority' + $ref: "#/components/schemas/EventPriority" related_event_id: - description: ID of the parent event. Must be sent as an integer (that is - no quotes). + description: ID of the parent event. Must be sent as an integer (that is no quotes). format: int64 type: integer source_type_name: - description: 'The type of event being posted. Option examples include nagios, - hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc. - - A complete list of source attribute values [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).' + description: |- + The type of event being posted. Option examples include nagios, hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc. + A complete list of source attribute values [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). type: string tags: description: A list of tags to apply to the event. - example: - - environment:test + example: ["environment:test"] items: description: A tag. type: string type: array text: - description: 'The body of the event. Limited to 4000 characters. The text - supports markdown. - - To use markdown in the event text, start the text block with `%%% \n` - and end the text block with `\n %%%`. - - Use `msg_text` with the Datadog Ruby library.' - example: Oh boy! + description: |- + The body of the event. Limited to 4000 characters. The text supports markdown. + To use markdown in the event text, start the text block with `%%% \n` and end the text block with `\n %%%`. + Use `msg_text` with the Datadog Ruby library. + example: "Oh boy!" maxLength: 4000 type: string title: description: The event title. - example: Did you hear the news today? + example: "Did you hear the news today?" type: string required: - - title - - text + - title + - text type: object EventCreateResponse: description: Object containing an event response. properties: event: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" status: description: A status. type: string @@ -2655,7 +2419,7 @@ components: events: description: An array of events. items: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" type: array status: description: A status. @@ -2664,393 +2428,379 @@ components: EventPriority: description: The priority of the event. For example, `normal` or `low`. enum: - - normal - - low - example: normal + - normal + - low + example: "normal" nullable: true type: string x-enum-varnames: - - NORMAL - - LOW + - NORMAL + - LOW EventQueryDefinition: description: The event query. properties: search: description: The query being made on the event. - example: '' + example: "" type: string tags_execution: - description: The execution method for multi-value filters. Can be either - and or or. - example: '' + description: The execution method for multi-value filters. Can be either and or or. + example: "" type: string required: - - search - - tags_execution + - search + - tags_execution type: object EventResponse: description: Object containing an event response. properties: event: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" status: description: A status. type: string type: object EventStreamWidgetDefinition: - description: 'The event stream is a widget version of the stream of events - - on the Event Stream view. Only available on FREE layout dashboards.' + description: |- + The event stream is a widget version of the stream of events + on the Event Stream view. Only available on FREE layout dashboards. properties: event_size: - $ref: '#/components/schemas/WidgetEventSize' + $ref: "#/components/schemas/WidgetEventSize" query: description: Query to filter the event stream with. - example: '' + example: "" type: string tags_execution: - description: The execution method for multi-value filters. Can be either - and or or. + description: The execution method for multi-value filters. Can be either and or or. type: string time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/EventStreamWidgetDefinitionType' + $ref: "#/components/schemas/EventStreamWidgetDefinitionType" required: - - type - - query + - type + - query type: object EventStreamWidgetDefinitionType: default: event_stream description: Type of the event stream widget. enum: - - event_stream + - event_stream example: event_stream type: string x-enum-varnames: - - EVENT_STREAM + - EVENT_STREAM EventTimelineWidgetDefinition: - description: The event timeline is a widget version of the timeline that appears - at the top of the Event Stream view. Only available on FREE layout dashboards. + description: The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards. properties: query: description: Query to filter the event timeline with. - example: '' + example: "" type: string tags_execution: - description: The execution method for multi-value filters. Can be either - and or or. + description: The execution method for multi-value filters. Can be either and or or. type: string time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/EventTimelineWidgetDefinitionType' + $ref: "#/components/schemas/EventTimelineWidgetDefinitionType" required: - - type - - query + - type + - query type: object EventTimelineWidgetDefinitionType: default: event_timeline description: Type of the event timeline widget. enum: - - event_timeline + - event_timeline example: event_timeline type: string x-enum-varnames: - - EVENT_TIMELINE + - EVENT_TIMELINE FormulaAndFunctionApmDependencyStatName: description: APM statistic. enum: - - avg_duration - - avg_root_duration - - avg_spans_per_trace - - error_rate - - pct_exec_time - - pct_of_traces - - total_traces_count + - avg_duration + - avg_root_duration + - avg_spans_per_trace + - error_rate + - pct_exec_time + - pct_of_traces + - total_traces_count example: avg_duration type: string x-enum-varnames: - - AVG_DURATION - - AVG_ROOT_DURATION - - AVG_SPANS_PER_TRACE - - ERROR_RATE - - PCT_EXEC_TIME - - PCT_OF_TRACES - - TOTAL_TRACES_COUNT + - AVG_DURATION + - AVG_ROOT_DURATION + - AVG_SPANS_PER_TRACE + - ERROR_RATE + - PCT_EXEC_TIME + - PCT_OF_TRACES + - TOTAL_TRACES_COUNT FormulaAndFunctionApmDependencyStatsDataSource: description: Data source for APM dependency stats queries. enum: - - apm_dependency_stats + - apm_dependency_stats example: apm_dependency_stats type: string x-enum-varnames: - - APM_DEPENDENCY_STATS + - APM_DEPENDENCY_STATS FormulaAndFunctionApmDependencyStatsQueryDefinition: description: A formula and functions APM dependency stats query. properties: cross_org_uuids: - $ref: '#/components/schemas/CrossOrgUuids' + $ref: "#/components/schemas/CrossOrgUuids" data_source: - $ref: '#/components/schemas/FormulaAndFunctionApmDependencyStatsDataSource' + $ref: "#/components/schemas/FormulaAndFunctionApmDependencyStatsDataSource" env: description: APM environment. - example: staging + example: "staging" type: string is_upstream: - description: Determines whether stats for upstream or downstream dependencies - should be queried. + description: Determines whether stats for upstream or downstream dependencies should be queried. example: false type: boolean name: description: Name of query to use in formulas. - example: query_errors + example: "query_errors" type: string operation_name: description: Name of operation on service. - example: cassandra.query + example: "cassandra.query" type: string primary_tag_name: - description: The name of the second primary tag used within APM; required - when `primary_tag_value` is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog. - example: datacenter + description: The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog. + example: "datacenter" type: string primary_tag_value: - description: Filter APM data by the second primary tag. `primary_tag_name` - must also be specified. - example: staging + description: Filter APM data by the second primary tag. `primary_tag_name` must also be specified. + example: "staging" type: string resource_name: description: APM resource. - example: DELETE FROM foo WHERE baz = ? + example: "DELETE FROM foo WHERE baz = ?" type: string service: description: APM service. - example: cassandra + example: "cassandra" type: string stat: - $ref: '#/components/schemas/FormulaAndFunctionApmDependencyStatName' + $ref: "#/components/schemas/FormulaAndFunctionApmDependencyStatName" required: - - data_source - - env - - stat - - operation_name - - resource_name - - service - - name + - data_source + - env + - stat + - operation_name + - resource_name + - service + - name type: object FormulaAndFunctionApmResourceStatName: description: APM resource stat name. enum: - - errors - - error_rate - - hits - - latency_avg - - latency_distribution - - latency_max - - latency_p50 - - latency_p75 - - latency_p90 - - latency_p95 - - latency_p99 - example: hits - type: string - x-enum-varnames: - - ERRORS - - ERROR_RATE - - HITS - - LATENCY_AVG - - LATENCY_DISTRIBUTION - - LATENCY_MAX - - LATENCY_P50 - - LATENCY_P75 - - LATENCY_P90 - - LATENCY_P95 - - LATENCY_P99 + - errors + - error_rate + - hits + - latency_avg + - latency_distribution + - latency_max + - latency_p50 + - latency_p75 + - latency_p90 + - latency_p95 + - latency_p99 + example: "hits" + type: string + x-enum-varnames: + - ERRORS + - ERROR_RATE + - HITS + - LATENCY_AVG + - LATENCY_DISTRIBUTION + - LATENCY_MAX + - LATENCY_P50 + - LATENCY_P75 + - LATENCY_P90 + - LATENCY_P95 + - LATENCY_P99 FormulaAndFunctionApmResourceStatsDataSource: description: Data source for APM resource stats queries. enum: - - apm_resource_stats - example: apm_resource_stats + - apm_resource_stats + example: "apm_resource_stats" type: string x-enum-varnames: - - APM_RESOURCE_STATS + - APM_RESOURCE_STATS FormulaAndFunctionApmResourceStatsQueryDefinition: description: APM resource stats query using formulas and functions. properties: cross_org_uuids: - $ref: '#/components/schemas/CrossOrgUuids' + $ref: "#/components/schemas/CrossOrgUuids" data_source: - $ref: '#/components/schemas/FormulaAndFunctionApmResourceStatsDataSource' + $ref: "#/components/schemas/FormulaAndFunctionApmResourceStatsDataSource" env: description: APM environment. - example: staging + example: "staging" type: string group_by: description: Array of fields to group results by. items: description: Field to group results by. - example: resource_name + example: "resource_name" type: string type: array name: description: Name of this query to use in formulas. - example: query_errors + example: "query_errors" type: string operation_name: description: Name of operation on service. - example: cassandra.query + example: "cassandra.query" type: string primary_tag_name: - description: Name of the second primary tag used within APM. Required when - `primary_tag_value` is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog - example: datacenter + description: Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog + example: "datacenter" type: string primary_tag_value: - description: Value of the second primary tag by which to filter APM data. - `primary_tag_name` must also be specified. - example: us-east-az + description: Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. + example: "us-east-az" type: string resource_name: description: APM resource name. - example: Admin::ProductsController#create + example: "Admin::ProductsController#create" type: string service: description: APM service name. - example: web-store + example: "web-store" type: string stat: - $ref: '#/components/schemas/FormulaAndFunctionApmResourceStatName' + $ref: "#/components/schemas/FormulaAndFunctionApmResourceStatName" required: - - data_source - - env - - name - - service - - stat + - data_source + - env + - name + - service + - stat type: object FormulaAndFunctionCloudCostDataSource: description: Data source for Cloud Cost queries. enum: - - cloud_cost - example: cloud_cost + - cloud_cost + example: "cloud_cost" type: string x-enum-varnames: - - CLOUD_COST + - CLOUD_COST FormulaAndFunctionCloudCostQueryDefinition: description: A formula and functions Cloud Cost query. example: - data_source: cloud_cost - name: query1 - query: sum:aws.cost.amortized{*} + data_source: "cloud_cost" + name: "query1" + query: "sum:aws.cost.amortized{*}" properties: aggregator: - $ref: '#/components/schemas/WidgetAggregator' + $ref: "#/components/schemas/WidgetAggregator" cross_org_uuids: - $ref: '#/components/schemas/CrossOrgUuids' + $ref: "#/components/schemas/CrossOrgUuids" data_source: - $ref: '#/components/schemas/FormulaAndFunctionCloudCostDataSource' + $ref: "#/components/schemas/FormulaAndFunctionCloudCostDataSource" name: description: Name of the query for use in formulas. - example: my_query + example: "my_query" type: string query: description: Query for Cloud Cost data. - example: '' + example: "" type: string required: - - data_source - - query - - name + - data_source + - query + - name type: object FormulaAndFunctionEventAggregation: description: Aggregation methods for event platform queries. enum: - - count - - cardinality - - median - - pc75 - - pc90 - - pc95 - - pc98 - - pc99 - - sum - - min - - max - - avg + - count + - cardinality + - median + - pc75 + - pc90 + - pc95 + - pc98 + - pc99 + - sum + - min + - max + - avg example: avg type: string x-enum-varnames: - - COUNT - - CARDINALITY - - MEDIAN - - PC75 - - PC90 - - PC95 - - PC98 - - PC99 - - SUM - - MIN - - MAX - - AVG + - COUNT + - CARDINALITY + - MEDIAN + - PC75 + - PC90 + - PC95 + - PC98 + - PC99 + - SUM + - MIN + - MAX + - AVG FormulaAndFunctionEventQueryDefinition: description: A formula and functions events query. properties: compute: - $ref: '#/components/schemas/FormulaAndFunctionEventQueryDefinitionCompute' + $ref: "#/components/schemas/FormulaAndFunctionEventQueryDefinitionCompute" cross_org_uuids: - $ref: '#/components/schemas/CrossOrgUuids' + $ref: "#/components/schemas/CrossOrgUuids" data_source: - $ref: '#/components/schemas/FormulaAndFunctionEventsDataSource' + $ref: "#/components/schemas/FormulaAndFunctionEventsDataSource" group_by: - $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupByConfig' + $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupByConfig" indexes: - description: An array of index names to query in the stream. Omit or use - `[]` to query all indexes at once. - example: - - days-3 - - days-7 + description: An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. + example: ["days-3", "days-7"] items: - description: A log index set up for your organization. For additional - indexes, see the [multiple indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - documentation. + description: A log index set up for your organization. For additional indexes, see the [multiple indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) documentation. type: string type: array name: description: Name of the query for use in formulas. - example: query_errors + example: "query_errors" type: string search: - $ref: '#/components/schemas/FormulaAndFunctionEventQueryDefinitionSearch' + $ref: "#/components/schemas/FormulaAndFunctionEventQueryDefinitionSearch" storage: description: Option for storage location. Feature in Private Beta. - example: indexes + example: "indexes" type: string required: - - data_source - - compute - - name + - data_source + - compute + - name type: object FormulaAndFunctionEventQueryDefinitionCompute: description: Compute options. properties: aggregation: - $ref: '#/components/schemas/FormulaAndFunctionEventAggregation' + $ref: "#/components/schemas/FormulaAndFunctionEventAggregation" interval: description: A time interval in milliseconds. example: 60000 @@ -3058,20 +2808,20 @@ components: type: integer metric: description: Measurable attribute to compute. - example: '@duration' + example: "@duration" type: string required: - - aggregation + - aggregation type: object FormulaAndFunctionEventQueryDefinitionSearch: description: Search options. properties: query: description: Events search string. - example: service:query + example: "service:query" type: string required: - - query + - query type: object FormulaAndFunctionEventQueryGroupBy: description: List of objects used to group by. @@ -3086,25 +2836,21 @@ components: format: int64 type: integer sort: - $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupBySort' + $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupBySort" required: - - facet + - facet type: object FormulaAndFunctionEventQueryGroupByConfig: - description: Group by configuration for a formula and functions events query. - Accepts either a list of facet objects or a flat object that specifies a list - of facet fields. + description: Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. oneOf: - - $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupByList' - - $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupByFields' + - $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupByList" + - $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupByFields" FormulaAndFunctionEventQueryGroupByFields: description: Flat group by configuration using multiple event facet fields. properties: fields: description: List of event facets to group by. - example: - - hostname - - service + example: ["hostname", "service"] items: description: Event facet. type: string @@ -3115,148 +2861,147 @@ components: format: int64 type: integer sort: - $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupBySort' + $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupBySort" required: - - fields + - fields type: object FormulaAndFunctionEventQueryGroupByList: description: List of objects used to group by. items: - $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupBy' + $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupBy" type: array FormulaAndFunctionEventQueryGroupBySort: description: Options for sorting group by results. properties: aggregation: - $ref: '#/components/schemas/FormulaAndFunctionEventAggregation' + $ref: "#/components/schemas/FormulaAndFunctionEventAggregation" metric: description: Metric used for sorting group by results. type: string order: - $ref: '#/components/schemas/QuerySortOrder' + $ref: "#/components/schemas/QuerySortOrder" required: - - aggregation + - aggregation type: object FormulaAndFunctionEventsDataSource: description: Data source for event platform-based queries. enum: - - logs - - spans - - network - - rum - - security_signals - - profiles - - audit - - events - - ci_tests - - ci_pipelines - - incident_analytics - - product_analytics - - on_call_events - example: logs - type: string - x-enum-varnames: - - LOGS - - SPANS - - NETWORK - - RUM - - SECURITY_SIGNALS - - PROFILES - - AUDIT - - EVENTS - - CI_TESTS - - CI_PIPELINES - - INCIDENT_ANALYTICS - - PRODUCT_ANALYTICS - - ON_CALL_EVENTS + - logs + - spans + - network + - rum + - security_signals + - profiles + - audit + - events + - ci_tests + - ci_pipelines + - incident_analytics + - product_analytics + - on_call_events + example: "logs" + type: string + x-enum-varnames: + - LOGS + - SPANS + - NETWORK + - RUM + - SECURITY_SIGNALS + - PROFILES + - AUDIT + - EVENTS + - CI_TESTS + - CI_PIPELINES + - INCIDENT_ANALYTICS + - PRODUCT_ANALYTICS + - ON_CALL_EVENTS FormulaAndFunctionMetricAggregation: description: The aggregation methods available for metrics queries. enum: - - avg - - min - - max - - sum - - last - - area - - l2norm - - percentile + - avg + - min + - max + - sum + - last + - area + - l2norm + - percentile example: avg type: string x-enum-varnames: - - AVG - - MIN - - MAX - - SUM - - LAST - - AREA - - L2NORM - - PERCENTILE + - AVG + - MIN + - MAX + - SUM + - LAST + - AREA + - L2NORM + - PERCENTILE FormulaAndFunctionMetricDataSource: description: Data source for metrics queries. enum: - - metrics - example: metrics + - metrics + example: "metrics" type: string x-enum-varnames: - - METRICS + - METRICS FormulaAndFunctionMetricQueryDefinition: description: A formula and functions metrics query. example: - data_source: metrics - name: my_query - query: avg:system.cpu.user{*} + data_source: "metrics" + name: "my_query" + query: "avg:system.cpu.user{*}" properties: aggregator: - $ref: '#/components/schemas/FormulaAndFunctionMetricAggregation' + $ref: "#/components/schemas/FormulaAndFunctionMetricAggregation" cross_org_uuids: - $ref: '#/components/schemas/CrossOrgUuids' + $ref: "#/components/schemas/CrossOrgUuids" data_source: - $ref: '#/components/schemas/FormulaAndFunctionMetricDataSource' + $ref: "#/components/schemas/FormulaAndFunctionMetricDataSource" name: description: Name of the query for use in formulas. - example: my_query + example: "my_query" type: string query: description: Metrics query definition. - example: avg:system.cpu.user{*} + example: "avg:system.cpu.user{*}" type: string semantic_mode: - $ref: '#/components/schemas/FormulaAndFunctionMetricSemanticMode' + $ref: "#/components/schemas/FormulaAndFunctionMetricSemanticMode" required: - - data_source - - query - - name + - data_source + - query + - name type: object FormulaAndFunctionMetricSemanticMode: - description: Semantic mode for metrics queries. This determines how metrics - from different sources are combined or displayed. + description: Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. enum: - - combined - - native - example: combined + - combined + - native + example: "combined" type: string x-enum-varnames: - - COMBINED - - NATIVE + - COMBINED + - NATIVE FormulaAndFunctionProcessQueryDataSource: description: Data sources that rely on the process backend. enum: - - process - - container - example: process + - process + - container + example: "process" type: string x-enum-varnames: - - PROCESS - - CONTAINER + - PROCESS + - CONTAINER FormulaAndFunctionProcessQueryDefinition: description: Process query using formulas and functions. properties: aggregator: - $ref: '#/components/schemas/FormulaAndFunctionMetricAggregation' + $ref: "#/components/schemas/FormulaAndFunctionMetricAggregation" cross_org_uuids: - $ref: '#/components/schemas/CrossOrgUuids' + $ref: "#/components/schemas/CrossOrgUuids" data_source: - $ref: '#/components/schemas/FormulaAndFunctionProcessQueryDataSource' + $ref: "#/components/schemas/FormulaAndFunctionProcessQueryDataSource" is_normalized_cpu: description: Whether to normalize the CPU percentages. type: boolean @@ -3266,14 +3011,14 @@ components: type: integer metric: description: Process metric name. - example: avg:system.cpu.user{*} + example: "avg:system.cpu.user{*}" type: string name: description: Name of query for use in formulas. - example: query_errors + example: "query_errors" type: string sort: - $ref: '#/components/schemas/QuerySortOrder' + $ref: "#/components/schemas/QuerySortOrder" tag_filters: description: An array of tags to filter by. items: @@ -3284,135 +3029,131 @@ components: description: Text to use as filter. type: string required: - - data_source - - metric - - name + - data_source + - metric + - name type: object FormulaAndFunctionQueryDefinition: description: A formula and function query. oneOf: - - $ref: '#/components/schemas/FormulaAndFunctionMetricQueryDefinition' - - $ref: '#/components/schemas/FormulaAndFunctionEventQueryDefinition' - - $ref: '#/components/schemas/FormulaAndFunctionProcessQueryDefinition' - - $ref: '#/components/schemas/FormulaAndFunctionApmDependencyStatsQueryDefinition' - - $ref: '#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition' - - $ref: '#/components/schemas/FormulaAndFunctionSLOQueryDefinition' - - $ref: '#/components/schemas/FormulaAndFunctionCloudCostQueryDefinition' + - $ref: "#/components/schemas/FormulaAndFunctionMetricQueryDefinition" + - $ref: "#/components/schemas/FormulaAndFunctionEventQueryDefinition" + - $ref: "#/components/schemas/FormulaAndFunctionProcessQueryDefinition" + - $ref: "#/components/schemas/FormulaAndFunctionApmDependencyStatsQueryDefinition" + - $ref: "#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition" + - $ref: "#/components/schemas/FormulaAndFunctionSLOQueryDefinition" + - $ref: "#/components/schemas/FormulaAndFunctionCloudCostQueryDefinition" FormulaAndFunctionResponseFormat: - description: Timeseries, scalar, or event list response. Event list response - formats are supported by Geomap widgets. + description: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. enum: - - timeseries - - scalar - - event_list + - timeseries + - scalar + - event_list example: timeseries type: string x-enum-varnames: - - TIMESERIES - - SCALAR - - EVENT_LIST + - TIMESERIES + - SCALAR + - EVENT_LIST FormulaAndFunctionSLODataSource: description: Data source for SLO measures queries. enum: - - slo - example: slo + - slo + example: "slo" type: string x-enum-varnames: - - SLO + - SLO FormulaAndFunctionSLOGroupMode: description: Group mode to query measures. enum: - - overall - - components - example: overall + - overall + - components + example: "overall" type: string x-enum-varnames: - - OVERALL - - COMPONENTS + - OVERALL + - COMPONENTS FormulaAndFunctionSLOMeasure: description: SLO measures queries. enum: - - good_events - - bad_events - - good_minutes - - bad_minutes - - slo_status - - error_budget_remaining - - burn_rate - - error_budget_burndown - example: slo_status - type: string - x-enum-varnames: - - GOOD_EVENTS - - BAD_EVENTS - - GOOD_MINUTES - - BAD_MINUTES - - SLO_STATUS - - ERROR_BUDGET_REMAINING - - BURN_RATE - - ERROR_BUDGET_BURNDOWN + - good_events + - bad_events + - good_minutes + - bad_minutes + - slo_status + - error_budget_remaining + - burn_rate + - error_budget_burndown + example: "slo_status" + type: string + x-enum-varnames: + - GOOD_EVENTS + - BAD_EVENTS + - GOOD_MINUTES + - BAD_MINUTES + - SLO_STATUS + - ERROR_BUDGET_REMAINING + - BURN_RATE + - ERROR_BUDGET_BURNDOWN FormulaAndFunctionSLOQueryDefinition: description: A formula and functions metrics query. example: - additional_query_filters: '*' - data_source: slo - group_mode: overall - measure: good_events - name: my_slo - slo_id: '12345678910' - slo_query_type: metric + additional_query_filters: "*" + data_source: "slo" + group_mode: "overall" + measure: "good_events" + name: "my_slo" + slo_id: "12345678910" + slo_query_type: "metric" properties: additional_query_filters: description: Additional filters applied to the SLO query. - example: host:host_a,env:prod + example: "host:host_a,env:prod" type: string cross_org_uuids: - $ref: '#/components/schemas/CrossOrgUuids' + $ref: "#/components/schemas/CrossOrgUuids" data_source: - $ref: '#/components/schemas/FormulaAndFunctionSLODataSource' + $ref: "#/components/schemas/FormulaAndFunctionSLODataSource" group_mode: - $ref: '#/components/schemas/FormulaAndFunctionSLOGroupMode' + $ref: "#/components/schemas/FormulaAndFunctionSLOGroupMode" measure: - $ref: '#/components/schemas/FormulaAndFunctionSLOMeasure' + $ref: "#/components/schemas/FormulaAndFunctionSLOMeasure" name: description: Name of the query for use in formulas. - example: my_slo + example: "my_slo" type: string slo_id: description: ID of an SLO to query measures. - example: '12345678910' + example: "12345678910" type: string slo_query_type: - $ref: '#/components/schemas/FormulaAndFunctionSLOQueryType' + $ref: "#/components/schemas/FormulaAndFunctionSLOQueryType" required: - - data_source - - slo_id - - measure + - data_source + - slo_id + - measure type: object FormulaAndFunctionSLOQueryType: description: Name of the query for use in formulas. enum: - - metric - - monitor - - time_slice - example: metric + - metric + - monitor + - time_slice + example: "metric" type: string x-enum-varnames: - - METRIC - - MONITOR - - TIME_SLICE + - METRIC + - MONITOR + - TIME_SLICE FormulaType: description: Set the sort type to formula. - enum: - - formula - example: formula + enum: ["formula"] + example: "formula" type: string x-enum-varnames: - - FORMULA + - FORMULA FreeTextWidgetDefinition: - description: Free text is a widget that allows you to add headings to your screenboard. - Commonly used to state the overall purpose of the dashboard. Only available - on FREE layout dashboards. + description: Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards. properties: color: description: Color of the text. @@ -3422,182 +3163,171 @@ components: type: string text: description: Text to display. - example: '' + example: "" type: string text_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" type: - $ref: '#/components/schemas/FreeTextWidgetDefinitionType' + $ref: "#/components/schemas/FreeTextWidgetDefinitionType" required: - - type - - text + - type + - text type: object FreeTextWidgetDefinitionType: default: free_text description: Type of the free text widget. enum: - - free_text + - free_text example: free_text type: string x-enum-varnames: - - FREE_TEXT + - FREE_TEXT FunnelQuery: description: Updated funnel widget. properties: data_source: - $ref: '#/components/schemas/FunnelSource' + $ref: "#/components/schemas/FunnelSource" query_string: description: The widget query. - example: '@browser.name:Chrome' + example: "@browser.name:Chrome" type: string steps: description: List of funnel steps. items: - $ref: '#/components/schemas/FunnelStep' + $ref: "#/components/schemas/FunnelStep" type: array required: - - query_string - - data_source - - steps + - query_string + - data_source + - steps type: object FunnelRequestType: description: Widget request type. enum: - - funnel + - funnel example: funnel type: string x-enum-varnames: - - FUNNEL + - FUNNEL FunnelSource: default: rum description: Source from which to query items to display in the funnel. enum: - - rum + - rum example: rum type: string x-enum-varnames: - - RUM + - RUM FunnelStep: description: The funnel step. properties: facet: description: The facet of the step. - example: '@view.name' + example: "@view.name" type: string value: description: The value of the step. - example: /apm/home + example: "/apm/home" type: string required: - - facet - - value + - facet + - value type: object FunnelWidgetDefinition: - description: The funnel visualization displays a funnel of user sessions that - maps a sequence of view navigation and user interaction in your application. + description: |- + The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application. properties: requests: description: Request payload used to query items. - example: - - query: - data_source: rum - query_string: '@browser.name:Chrome' - steps: - - facet: '@view.name' - value: /logs - - facet: '@view.name' - value: /apm/home - request_type: funnel - items: - $ref: '#/components/schemas/FunnelWidgetRequest' + example: [{"query": {"data_source": "rum", "query_string": "@browser.name:Chrome", "steps": [{"facet": "@view.name", "value": "/logs"}, {"facet": "@view.name", "value": "/apm/home"}]}, "request_type": "funnel"}] + items: + $ref: "#/components/schemas/FunnelWidgetRequest" maxItems: 1 minItems: 1 type: array time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: The title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: The size of the title. type: string type: - $ref: '#/components/schemas/FunnelWidgetDefinitionType' + $ref: "#/components/schemas/FunnelWidgetDefinitionType" required: - - type - - requests + - type + - requests type: object FunnelWidgetDefinitionType: default: funnel description: Type of funnel widget. enum: - - funnel + - funnel example: funnel type: string x-enum-varnames: - - FUNNEL + - FUNNEL FunnelWidgetRequest: description: Updated funnel widget. properties: query: - $ref: '#/components/schemas/FunnelQuery' + $ref: "#/components/schemas/FunnelQuery" request_type: - $ref: '#/components/schemas/FunnelRequestType' + $ref: "#/components/schemas/FunnelRequestType" required: - - query - - request_type + - query + - request_type type: object GCPAccount: description: Your Google Cloud Platform Account. properties: auth_provider_x509_cert_url: - description: Should be `https://www.googleapis.com/oauth2/v1/certs`. - example: https://www.googleapis.com/oauth2/v1/certs + description: |- + Should be `https://www.googleapis.com/oauth2/v1/certs`. + example: "https://www.googleapis.com/oauth2/v1/certs" type: string auth_uri: - description: Should be `https://accounts.google.com/o/oauth2/auth`. - example: https://accounts.google.com/o/oauth2/auth + description: |- + Should be `https://accounts.google.com/o/oauth2/auth`. + example: "https://accounts.google.com/o/oauth2/auth" type: string automute: - description: Silence monitors for expected GCE instance shutdowns. + description: |- + Silence monitors for expected GCE instance shutdowns. type: boolean client_email: - description: Your email found in your JSON service account key. - example: api-dev@datadog-sandbox.iam.gserviceaccount.com + description: |- + Your email found in your JSON service account key. + example: "api-dev@datadog-sandbox.iam.gserviceaccount.com" type: string client_id: - description: Your ID found in your JSON service account key. - example: '123456712345671234567' + description: |- + Your ID found in your JSON service account key. + example: "123456712345671234567" type: string client_x509_cert_url: - description: 'Should be `https://www.googleapis.com/robot/v1/metadata/x509/$CLIENT_EMAIL` - - where `$CLIENT_EMAIL` is the email found in your JSON service account - key.' - example: https://www.googleapis.com/robot/v1/metadata/x509/$CLIENT_EMAIL + description: |- + Should be `https://www.googleapis.com/robot/v1/metadata/x509/$CLIENT_EMAIL` + where `$CLIENT_EMAIL` is the email found in your JSON service account key. + example: "https://www.googleapis.com/robot/v1/metadata/x509/$CLIENT_EMAIL" type: string cloud_run_revision_filters: deprecated: true - description: 'List of filters to limit the Cloud Run revisions that are - pulled into Datadog by using tags. - - Only Cloud Run revision resources that apply to specified filters are - imported into Datadog. - - **Note:** This field is deprecated. Instead, use `monitored_resource_configs` - with `type=cloud_run_revision`' - example: - - $KEY:$VALUE + description: |- + List of filters to limit the Cloud Run revisions that are pulled into Datadog by using tags. + Only Cloud Run revision resources that apply to specified filters are imported into Datadog. + **Note:** This field is deprecated. Instead, use `monitored_resource_configs` with `type=cloud_run_revision` + example: ["$KEY:$VALUE"] items: description: Cloud Run revision filters type: string type: array errors: description: An array of errors. - example: - - '*' + example: ["*"] items: description: String representation of one error. readOnly: true @@ -3605,161 +3335,139 @@ components: type: array host_filters: deprecated: true - description: 'A comma-separated list of filters to limit the VM instances - that are pulled into Datadog by using tags. - - Only VM instance resources that apply to specified filters are imported - into Datadog. - - **Note:** This field is deprecated. Instead, use `monitored_resource_configs` - with `type=gce_instance`' - example: $KEY1:$VALUE1,$KEY2:$VALUE2 + description: |- + A comma-separated list of filters to limit the VM instances that are pulled into Datadog by using tags. + Only VM instance resources that apply to specified filters are imported into Datadog. + **Note:** This field is deprecated. Instead, use `monitored_resource_configs` with `type=gce_instance` + example: "$KEY1:$VALUE1,$KEY2:$VALUE2" type: string is_cspm_enabled: - description: 'When enabled, Datadog will activate the Cloud Security Monitoring - product for this service account. Note: This requires resource_collection_enabled - to be set to true.' + description: |- + When enabled, Datadog will activate the Cloud Security Monitoring product for this service account. Note: This requires resource_collection_enabled to be set to true. example: true type: boolean is_resource_change_collection_enabled: default: false - description: When enabled, Datadog scans for all resource change data in - your Google Cloud environment. + description: |- + When enabled, Datadog scans for all resource change data in your Google Cloud environment. example: true type: boolean is_security_command_center_enabled: default: false - description: 'When enabled, Datadog will attempt to collect Security Command - Center Findings. Note: This requires additional permissions on the service - account.' + description: |- + When enabled, Datadog will attempt to collect Security Command Center Findings. Note: This requires additional permissions on the service account. example: true type: boolean monitored_resource_configs: description: Configurations for GCP monitored resources. - example: - - filters: - - $KEY:$VALUE - type: gce_instance + example: [{"filters": ["$KEY:$VALUE"], "type": "gce_instance"}] items: - $ref: '#/components/schemas/GCPMonitoredResourceConfig' + $ref: "#/components/schemas/GCPMonitoredResourceConfig" type: array private_key: - description: Your private key name found in your JSON service account key. - example: private_key + description: |- + Your private key name found in your JSON service account key. + example: "private_key" type: string private_key_id: - description: Your private key ID found in your JSON service account key. - example: 123456789abcdefghi123456789abcdefghijklm + description: |- + Your private key ID found in your JSON service account key. + example: "123456789abcdefghi123456789abcdefghijklm" type: string project_id: - description: Your Google Cloud project ID found in your JSON service account - key. - example: datadog-apitest + description: |- + Your Google Cloud project ID found in your JSON service account key. + example: "datadog-apitest" type: string resource_collection_enabled: - description: When enabled, Datadog scans for all resources in your GCP environment. + description: |- + When enabled, Datadog scans for all resources in your GCP environment. example: true type: boolean token_uri: - description: Should be `https://accounts.google.com/o/oauth2/token`. - example: https://accounts.google.com/o/oauth2/token + description: |- + Should be `https://accounts.google.com/o/oauth2/token`. + example: "https://accounts.google.com/o/oauth2/token" type: string type: - description: The value for service_account found in your JSON service account - key. - example: service_account + description: |- + The value for service_account found in your JSON service account key. + example: "service_account" type: string type: object GCPAccountListResponse: description: Array of GCP account responses. items: - $ref: '#/components/schemas/GCPAccount' + $ref: "#/components/schemas/GCPAccount" type: array GCPMonitoredResourceConfig: description: Configuration for a GCP monitored resource. properties: filters: - description: 'List of filters to limit the monitored resources that are - pulled into Datadog by using tags. - - Only monitored resources that apply to specified filters are imported - into Datadog.' - example: - - $KEY:$VALUE + description: |- + List of filters to limit the monitored resources that are pulled into Datadog by using tags. + Only monitored resources that apply to specified filters are imported into Datadog. + example: ["$KEY:$VALUE"] items: description: A monitored resource filter type: string type: array type: - $ref: '#/components/schemas/GCPMonitoredResourceConfigType' + $ref: "#/components/schemas/GCPMonitoredResourceConfigType" type: object GCPMonitoredResourceConfigType: - description: The GCP monitored resource type. Only a subset of resource types - are supported. - enum: - - cloud_function - - cloud_run_revision - - gce_instance - example: gce_instance + description: The GCP monitored resource type. Only a subset of resource types are supported. + enum: ["cloud_function", "cloud_run_revision", "gce_instance"] + example: "gce_instance" type: string x-enum-varnames: - - CLOUD_FUNCTION - - CLOUD_RUN_REVISION - - GCE_INSTANCE + - CLOUD_FUNCTION + - CLOUD_RUN_REVISION + - GCE_INSTANCE GeomapWidgetDefinition: - description: This visualization displays a series of values by country on a - world map. + description: This visualization displays a series of values by country on a world map. properties: custom_links: description: A list of custom links. items: - $ref: '#/components/schemas/WidgetCustomLink' + $ref: "#/components/schemas/WidgetCustomLink" type: array requests: - description: 'Array of request objects to display in the widget. May include - an optional request for the region layer and/or an optional request for - the points layer. Region layer requests must contain a `group-by` tag - whose value is a country ISO code. - + description: |- + Array of request objects to display in the widget. May include an optional request for the region layer and/or an optional request for the points layer. Region layer requests must contain a `group-by` tag whose value is a country ISO code. See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) - - for information about building the `REQUEST_SCHEMA`.' - example: - - rum_query: - search: - query: {} + for information about building the `REQUEST_SCHEMA`. + example: ["rum_query": {"search": {"query": "{}"}}] items: - $ref: '#/components/schemas/GeomapWidgetRequest' + $ref: "#/components/schemas/GeomapWidgetRequest" maxItems: 2 minItems: 1 type: array style: - $ref: '#/components/schemas/GeomapWidgetDefinitionStyle' + $ref: "#/components/schemas/GeomapWidgetDefinitionStyle" time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: The title of your widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: The size of the title. type: string type: - $ref: '#/components/schemas/GeomapWidgetDefinitionType' + $ref: "#/components/schemas/GeomapWidgetDefinitionType" view: - $ref: '#/components/schemas/GeomapWidgetDefinitionView' + $ref: "#/components/schemas/GeomapWidgetDefinitionView" required: - - type - - requests - - style - - view + - type + - requests + - style + - view type: object GeomapWidgetDefinitionStyle: description: The style to apply to the widget. - example: - palette: hostmap_blues - palette_flip: false + example: {palette: "hostmap_blues", palette_flip: false} properties: palette: description: The color palette to apply to the widget. @@ -3770,96 +3478,86 @@ components: example: false type: boolean required: - - palette - - palette_flip + - palette + - palette_flip type: object GeomapWidgetDefinitionType: default: geomap description: Type of the geomap widget. enum: - - geomap + - geomap example: geomap type: string x-enum-varnames: - - GEOMAP + - GEOMAP GeomapWidgetDefinitionView: description: The view of the world that the map should render. - example: - focus: WORLD + example: {focus: "WORLD"} properties: focus: - description: The 2-letter ISO code of a country to focus the map on, or - `WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent - (`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`). - example: WORLD + description: The 2-letter ISO code of a country to focus the map on, or `WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent (`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`). + example: "WORLD" type: string required: - - focus + - focus type: object GeomapWidgetRequest: description: An updated geomap widget. properties: columns: description: Widget columns. - example: - - field: timestamp - width: auto - - field: content - width: full + example: [{"field": "timestamp", "width": "auto"}, {"field": "content", "width": "full"}] items: - $ref: '#/components/schemas/ListStreamColumn' + $ref: "#/components/schemas/ListStreamColumn" type: array conditional_formats: - description: Threshold (numeric) conditional formatting rules may be used - by a regions layer. + description: Threshold (numeric) conditional formatting rules may be used by a regions layer. items: - $ref: '#/components/schemas/WidgetConditionalFormat' + $ref: "#/components/schemas/WidgetConditionalFormat" type: array formulas: description: List of formulas that operate on queries. items: - $ref: '#/components/schemas/WidgetFormula' + $ref: "#/components/schemas/WidgetFormula" type: array log_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: deprecated: true - description: The widget metrics query. Deprecated - Use `queries` and `formulas` - instead. + description: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. type: string queries: description: List of queries that can be returned directly or used in formulas. items: - $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition' + $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array query: - $ref: '#/components/schemas/ListStreamQuery' + $ref: "#/components/schemas/ListStreamQuery" response_format: - $ref: '#/components/schemas/FormulaAndFunctionResponseFormat' + $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" rum_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. sort: - $ref: '#/components/schemas/WidgetSortBy' + $ref: "#/components/schemas/WidgetSortBy" style: - $ref: '#/components/schemas/GeomapWidgetRequestStyle' + $ref: "#/components/schemas/GeomapWidgetRequestStyle" text_formats: description: Text formatting rules may be used by a points layer. items: - $ref: '#/components/schemas/TableWidgetTextFormatRule' + $ref: "#/components/schemas/TableWidgetTextFormatRule" type: array type: object GeomapWidgetRequestStyle: description: The style to apply to the request for points layer. - example: - color_by: status + example: {color_by: "status"} properties: color_by: description: The category to color the points by. @@ -3870,12 +3568,10 @@ components: description: Object representing a graph snapshot. properties: graph_def: - description: 'A JSON document defining the graph. `graph_def` can be used - instead of `metric_query`. - + description: |- + A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar) - - and should be formatted to a single line then URL encoded.' + and should be formatted to a single line then URL encoded. type: string metric_query: description: The metric query. One of `metric_query` or `graph_def` is required. @@ -3887,16 +3583,13 @@ components: type: object GroupType: description: Set the sort type to group. - enum: - - group - example: group + enum: ["group"] + example: "group" type: string x-enum-varnames: - - GROUP + - GROUP GroupWidgetDefinition: - description: The groups widget allows you to keep similar graphs together on - your timeboard. Each group has a custom header, can hold one to many graphs, - and is collapsible. + description: The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible. properties: background_color: description: Background color of the group title. @@ -3905,7 +3598,7 @@ components: description: URL of image to display as a banner for the group. type: string layout_type: - $ref: '#/components/schemas/WidgetLayoutType' + $ref: "#/components/schemas/WidgetLayoutType" show_title: default: true description: Whether to show the title or not. @@ -3914,38 +3607,33 @@ components: description: Title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" type: - $ref: '#/components/schemas/GroupWidgetDefinitionType' + $ref: "#/components/schemas/GroupWidgetDefinitionType" widgets: description: List of widget groups. - example: - - definition: - requests: - fill: - q: avg:system.cpu.user{*} - type: hostmap + example: ["definition": {"requests": {"fill": {"q": "avg:system.cpu.user{*}"}}, "type": "hostmap"}] items: - $ref: '#/components/schemas/Widget' + $ref: "#/components/schemas/Widget" type: array required: - - type - - layout_type - - widgets + - type + - layout_type + - widgets type: object GroupWidgetDefinitionType: default: group description: Type of the group widget. enum: - - group + - group example: group type: string x-enum-varnames: - - GROUP + - GROUP HTTPLog: description: Structured log message. items: - $ref: '#/components/schemas/HTTPLogItem' + $ref: "#/components/schemas/HTTPLogItem" type: array HTTPLogError: description: Invalid query performed. @@ -3958,11 +3646,11 @@ components: type: integer message: description: Error message. - example: Your browser sent an invalid request. + example: "Your browser sent an invalid request." type: string required: - - code - - message + - code + - message type: object HTTPLogItem: additionalProperties: @@ -3971,13 +3659,10 @@ components: description: Logs that are sent over HTTP. properties: ddsource: - description: 'The integration name associated with your log: the technology - from which the log originated. - - When it matches an integration name, Datadog automatically installs the - corresponding parsers and facets. - - See [reserved attributes](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes).' + description: |- + The integration name associated with your log: the technology from which the log originated. + When it matches an integration name, Datadog automatically installs the corresponding parsers and facets. + See [reserved attributes](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes). example: nginx type: string ddtags: @@ -3989,61 +3674,49 @@ components: example: i-012345678 type: string message: - description: 'The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes) - - of your log. By default, Datadog ingests the value of the message attribute - as the body of the log entry. - - That value is then highlighted and displayed in the Logstream, where it - is indexed for full text search.' + description: |- + The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes) + of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. + That value is then highlighted and displayed in the Logstream, where it is indexed for full text search. example: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World type: string service: - description: 'The name of the application or service generating the log - events. - - It is used to switch from Logs to APM, so make sure you define the same - value when you use both products. - - See [reserved attributes](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes).' + description: |- + The name of the application or service generating the log events. + It is used to switch from Logs to APM, so make sure you define the same value when you use both products. + See [reserved attributes](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes). example: payment type: string required: - - message + - message type: object HeatMapWidgetDefinition: - description: The heat map visualization shows metrics aggregated across many - tags, such as hosts. The more hosts that have a particular value, the darker - that square is. + description: The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is. properties: custom_links: description: List of custom links. items: - $ref: '#/components/schemas/WidgetCustomLink' + $ref: "#/components/schemas/WidgetCustomLink" type: array events: deprecated: true - description: List of widget events. Deprecated - Use `overlay` request type - instead. + description: List of widget events. Deprecated - Use `overlay` request type instead. items: - $ref: '#/components/schemas/WidgetEvent' + $ref: "#/components/schemas/WidgetEvent" type: array legend_size: - $ref: '#/components/schemas/WidgetLegendSize' + $ref: "#/components/schemas/WidgetLegendSize" markers: description: List of markers. - example: - - display_type: percentile - value: '90' + example: [{"display_type": "percentile", "value": "90"}] items: - $ref: '#/components/schemas/WidgetMarker' + $ref: "#/components/schemas/WidgetMarker" type: array requests: description: List of widget types. - example: - - q: jvm.heap.memory + example: ["q": "jvm.heap.memory"] items: - $ref: '#/components/schemas/HeatMapWidgetRequest' + $ref: "#/components/schemas/HeatMapWidgetRequest" maxItems: 1 minItems: 1 type: array @@ -4051,64 +3724,64 @@ components: description: Whether or not to display the legend on this widget. type: boolean time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/HeatMapWidgetDefinitionType' + $ref: "#/components/schemas/HeatMapWidgetDefinitionType" xaxis: - $ref: '#/components/schemas/HeatMapWidgetXAxis' + $ref: "#/components/schemas/HeatMapWidgetXAxis" yaxis: - $ref: '#/components/schemas/WidgetAxis' + $ref: "#/components/schemas/WidgetAxis" required: - - type - - requests + - type + - requests type: object HeatMapWidgetDefinitionType: default: heatmap description: Type of the heat map widget. enum: - - heatmap + - heatmap example: heatmap type: string x-enum-varnames: - - HEATMAP + - HEATMAP HeatMapWidgetRequest: description: Updated heat map widget. properties: apm_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. event_query: - $ref: '#/components/schemas/EventQueryDefinition' + $ref: "#/components/schemas/EventQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: - $ref: '#/components/schemas/WidgetFormula' + $ref: "#/components/schemas/WidgetFormula" type: array log_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. process_query: - $ref: '#/components/schemas/ProcessQueryDefinition' + $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: @@ -4118,37 +3791,35 @@ components: queries: description: List of queries that can be returned directly or used in formulas. items: - $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition' + $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array query: - $ref: '#/components/schemas/FormulaAndFunctionMetricQueryDefinition' + $ref: "#/components/schemas/FormulaAndFunctionMetricQueryDefinition" request_type: - $ref: '#/components/schemas/WidgetHistogramRequestType' - description: Applicable only for distribution of point values for distribution - metrics. + $ref: "#/components/schemas/WidgetHistogramRequestType" + description: Applicable only for distribution of point values for distribution metrics. response_format: - $ref: '#/components/schemas/FormulaAndFunctionResponseFormat' + $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" description: Applicable only for distribution of aggregated grouped queries. rum_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. style: - $ref: '#/components/schemas/WidgetStyle' + $ref: "#/components/schemas/WidgetStyle" type: object HeatMapWidgetXAxis: description: X Axis controls for the heat map widget. properties: num_buckets: - description: 'Number of time buckets to target, also known as the resolution - + description: |- + Number of time buckets to target, also known as the resolution of the time bins. This is only applicable for distribution of - - points (group distributions use the roll-up modifier).' + points (group distributions use the roll-up modifier). format: int64 type: integer type: object @@ -4159,23 +3830,23 @@ components: description: Host aliases collected by Datadog. items: description: A host alias. - example: mycoolhost-1 + example: "mycoolhost-1" type: string type: array apps: description: The Datadog integrations reporting metrics for the host. items: description: Name of an app. - example: agent + example: "agent" type: string type: array aws_name: description: AWS name of your host. - example: mycoolhost-1 + example: "mycoolhost-1" type: string host_name: description: The host name. - example: i-deadbeef + example: "i-deadbeef" type: string id: description: The host ID. @@ -4192,9 +3863,9 @@ components: format: int64 type: integer meta: - $ref: '#/components/schemas/HostMeta' + $ref: "#/components/schemas/HostMeta" metrics: - $ref: '#/components/schemas/HostMetrics' + $ref: "#/components/schemas/HostMetrics" mute_timeout: description: Timeout of the mute applied to your host. format: int64 @@ -4202,13 +3873,13 @@ components: type: integer name: description: The host name. - example: i-hostname + example: "i-hostname" type: string sources: description: Source or cloud provider associated with your host. items: description: A source or cloud provider name. - example: aws + example: "aws" type: string type: array tags_by_source: @@ -4216,14 +3887,13 @@ components: description: Array of tags for a single source. items: description: A tag. - example: test.example.com.host + example: "test.example.com.host" type: string type: array description: List of tags for each source (AWS, Datadog Agent, Chef..). type: object up: - description: Displays UP when the expected metrics are received and displays - `???` if no metrics are received. + description: Displays UP when the expected metrics are received and displays `???` if no metrics are received. example: true type: boolean type: object @@ -4233,7 +3903,7 @@ components: host_list: description: Array of hosts. items: - $ref: '#/components/schemas/Host' + $ref: "#/components/schemas/Host" type: array total_matching: description: Number of host matching the query. @@ -4250,49 +3920,48 @@ components: description: Updated host map. properties: apm_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. event_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. log_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. process_query: - $ref: '#/components/schemas/ProcessQueryDefinition' + $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: description: Query definition. type: string rum_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. type: object HostMapWidgetDefinition: - description: The host map widget graphs any metric across your hosts using the - same visualization available from the main Host Map page. + description: The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page. properties: custom_links: description: List of custom links. items: - $ref: '#/components/schemas/WidgetCustomLink' + $ref: "#/components/schemas/WidgetCustomLink" type: array group: description: List of tag prefixes to group by. @@ -4301,18 +3970,18 @@ components: type: string type: array no_group_hosts: - description: "Whether to show the hosts that don\u2019t fit in a group." + description: Whether to show the hosts that don’t fit in a group. type: boolean no_metric_hosts: description: Whether to show the hosts with no metrics. type: boolean node_type: - $ref: '#/components/schemas/WidgetNodeType' + $ref: "#/components/schemas/WidgetNodeType" notes: description: Notes on the title. type: string requests: - $ref: '#/components/schemas/HostMapWidgetDefinitionRequests' + $ref: "#/components/schemas/HostMapWidgetDefinitionRequests" scope: description: List of tags used to filter the map. items: @@ -4320,29 +3989,29 @@ components: type: string type: array style: - $ref: '#/components/schemas/HostMapWidgetDefinitionStyle' + $ref: "#/components/schemas/HostMapWidgetDefinitionStyle" title: description: Title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/HostMapWidgetDefinitionType' + $ref: "#/components/schemas/HostMapWidgetDefinitionType" required: - - type - - requests + - type + - requests type: object HostMapWidgetDefinitionRequests: description: List of definitions. example: {} properties: fill: - $ref: '#/components/schemas/HostMapRequest' + $ref: "#/components/schemas/HostMapRequest" size: - $ref: '#/components/schemas/HostMapRequest' + $ref: "#/components/schemas/HostMapRequest" type: object HostMapWidgetDefinitionStyle: description: The style to apply to the widget. @@ -4364,22 +4033,22 @@ components: default: hostmap description: Type of the host map widget. enum: - - hostmap + - hostmap example: hostmap type: string x-enum-varnames: - - HOSTMAP + - HOSTMAP HostMeta: description: Metadata associated with your host. properties: agent_checks: description: A list of Agent checks running on the host. items: - $ref: '#/components/schemas/AgentCheck' + $ref: "#/components/schemas/AgentCheck" type: array agent_version: description: The Datadog Agent version. - example: 7.32.3 + example: "7.32.3" type: string cpuCores: description: The number of cores. @@ -4390,57 +4059,56 @@ components: description: An array of Mac versions. items: description: The version name. - example: FreeBSD + example: "FreeBSD" type: array gohai: description: JSON string containing system information. - example: '{"cpu":{"cache_size":"8192 KB","cpu_cores":"1","cpu_logical_processors":"1","family":"6","mhz":"2712.000","model":"142","model_name":"Intel(R) - Core(TM) i7-8559U CPU @ 2.70GHz","stepping":"10","vendor_id":"GenuineIntel"},"filesystem":[{"kb_size":"3966896","mounted_on":"/dev","name":"udev"},{"kb_size":"797396","mounted_on":"/run","name":"tmpfs"},{"kb_size":"64800356","mounted_on":"/","name":"/dev/mapper/vagrant--vg-root"},{"kb_size":"3986972","mounted_on":"/dev/shm","name":"tmpfs"},{"kb_size":"5120","mounted_on":"/run/lock","name":"tmpfs"},{"kb_size":"3986972","mounted_on":"/sys/fs/cgroup","name":"tmpfs"},{"kb_size":"488245288","mounted_on":"/vagrant","name":"vagrant"},{"kb_size":"797392","mounted_on":"/run/user/1000","name":"tmpfs"}],"memory":{"swap_total":"1003516kB","total":"7973944kB"},"network":{"interfaces":[{"ipv4":"10.0.2.15","ipv4-network":"10.0.2.0/24","ipv6":"fe80::a00:27ff:fec2:be11","ipv6-network":"fe80::/64","macaddress":"08:00:27:c2:be:11","name":"eth0"},{"ipv4":"192.168.122.1","ipv4-network":"192.168.122.0/24","macaddress":"52:54:00:6f:1c:bf","name":"virbr0"}],"ipaddress":"10.0.2.15","ipaddressv6":"fe80::a00:27ff:fec2:be11","macaddress":"08:00:27:c2:be:11"},"platform":{"GOOARCH":"amd64","GOOS":"linux","goV":"1.16.7","hardware_platform":"x86_64","hostname":"vagrant","kernel_name":"Linux","kernel_release":"4.15.0-29-generic","kernel_version":"#31-Ubuntu + example: '{"cpu":{"cache_size":"8192 KB","cpu_cores":"1","cpu_logical_processors":"1","family":"6","mhz":"2712.000","model":"142","model_name":"Intel(R) Core(TM) i7-8559U CPU @ 2.70GHz","stepping":"10","vendor_id":"GenuineIntel"},"filesystem":[{"kb_size":"3966896","mounted_on":"/dev","name":"udev"},{"kb_size":"797396","mounted_on":"/run","name":"tmpfs"},{"kb_size":"64800356","mounted_on":"/","name":"/dev/mapper/vagrant--vg-root"},{"kb_size":"3986972","mounted_on":"/dev/shm","name":"tmpfs"},{"kb_size":"5120","mounted_on":"/run/lock","name":"tmpfs"},{"kb_size":"3986972","mounted_on":"/sys/fs/cgroup","name":"tmpfs"},{"kb_size":"488245288","mounted_on":"/vagrant","name":"vagrant"},{"kb_size":"797392","mounted_on":"/run/user/1000","name":"tmpfs"}],"memory":{"swap_total":"1003516kB","total":"7973944kB"},"network":{"interfaces":[{"ipv4":"10.0.2.15","ipv4-network":"10.0.2.0/24","ipv6":"fe80::a00:27ff:fec2:be11","ipv6-network":"fe80::/64","macaddress":"08:00:27:c2:be:11","name":"eth0"},{"ipv4":"192.168.122.1","ipv4-network":"192.168.122.0/24","macaddress":"52:54:00:6f:1c:bf","name":"virbr0"}],"ipaddress":"10.0.2.15","ipaddressv6":"fe80::a00:27ff:fec2:be11","macaddress":"08:00:27:c2:be:11"},"platform":{"GOOARCH":"amd64","GOOS":"linux","goV":"1.16.7","hardware_platform":"x86_64","hostname":"vagrant","kernel_name":"Linux","kernel_release":"4.15.0-29-generic","kernel_version":"#31-Ubuntu SMP Tue Jul 17 15:39:52 UTC 2018","machine":"x86_64","os":"GNU/Linux","processor":"x86_64","pythonV":"2.7.15rc1"}}' type: string install_method: - $ref: '#/components/schemas/HostMetaInstallMethod' + $ref: "#/components/schemas/HostMetaInstallMethod" macV: description: An array of Mac versions. items: description: Version name. - example: Mac + example: "Mac" type: array machine: description: The machine architecture. - example: amd64 + example: "amd64" type: string nixV: description: Array of Unix versions. items: description: Version name. - example: Ubuntu + example: "Ubuntu" type: array platform: description: The OS platform. - example: linux + example: "linux" type: string processor: description: The processor. - example: Intel(R) Core(TM) i7-8559U CPU @ 2.70GHz + example: "Intel(R) Core(TM) i7-8559U CPU @ 2.70GHz" type: string pythonV: description: The Python version. - example: 3.8.11 + example: "3.8.11" type: string socket-fqdn: description: The socket fqdn. - example: vagrant.vm. + example: "vagrant.vm." type: string socket-hostname: description: The socket hostname. - example: vagrant + example: "vagrant" type: string winV: description: An array of Windows versions. items: description: Version name. - example: Windows + example: "Windows" type: array type: object HostMetaInstallMethod: @@ -4448,15 +4116,15 @@ components: properties: installer_version: description: The installer version. - example: install_script-1.7.1 + example: "install_script-1.7.1" type: string tool: description: Tool used to install the agent. - example: install_script + example: "install_script" type: string tool_version: description: The tool version. - example: install_script + example: "install_script" type: string type: object HostMetrics: @@ -4468,8 +4136,7 @@ components: format: double type: number iowait: - description: The percent of CPU spent waiting on the IO (not reported for - all platforms). + description: The percent of CPU spent waiting on the IO (not reported for all platforms). example: 3.2 format: double type: number @@ -4484,7 +4151,7 @@ components: properties: action: description: Action applied to the hosts. - example: Muted + example: "Muted" type: string end: description: POSIX timestamp in seconds when the host is unmuted. @@ -4493,29 +4160,27 @@ components: type: integer hostname: description: The host name. - example: test.host + example: "test.host" type: string message: description: Message associated with the mute. - example: Muting this host for a test! + example: "Muting this host for a test!" type: string type: object HostMuteSettings: description: Combination of settings to mute a host. properties: end: - description: POSIX timestamp in seconds when the host is unmuted. If omitted, - the host remains muted until explicitly unmuted. + description: POSIX timestamp in seconds when the host is unmuted. If omitted, the host remains muted until explicitly unmuted. example: 1579098130 format: int64 type: integer message: description: Message to associate with the muting of this host. - example: Muting this host for a test! + example: "Muting this host for a test!" type: string override: - description: If true and the host is already muted, replaces existing host - mute settings. + description: If true and the host is already muted, replaces existing host mute settings. example: false type: boolean type: object @@ -4524,13 +4189,13 @@ components: properties: host: description: Your host name. - example: test.host + example: "test.host" type: string tags: description: A list of tags associated with a host. items: description: A given tag in a list. - example: environment:production + example: "environment:production" type: string type: array type: object @@ -4560,39 +4225,34 @@ components: description: The organization public ID. type: string region: - description: The region of the Datadog instance that the organization belongs - to. + description: The region of the Datadog instance that the organization belongs to. type: string tag_config_source: - description: The source of the usage attribution tag configuration and the - selected tags in the format of `::://////`. + description: The source of the usage attribution tag configuration and the selected tags in the format of `::://////`. type: string tags: - $ref: '#/components/schemas/UsageAttributionTagNames' + $ref: "#/components/schemas/UsageAttributionTagNames" total_usage_sum: description: Total product usage for the given tags within the hour. format: double type: number updated_at: - description: Shows the most recent hour in the current month for all organizations - where usages are calculated. + description: Shows the most recent hour in the current month for all organizations where usages are calculated. type: string usage_type: - $ref: '#/components/schemas/HourlyUsageAttributionUsageType' + $ref: "#/components/schemas/HourlyUsageAttributionUsageType" type: object HourlyUsageAttributionMetadata: description: The object containing document metadata. properties: pagination: - $ref: '#/components/schemas/HourlyUsageAttributionPagination' + $ref: "#/components/schemas/HourlyUsageAttributionPagination" type: object HourlyUsageAttributionPagination: description: The metadata for the current pagination. properties: next_record_id: - description: The cursor to get the next results (if any). To make the next - request, use the same parameters and add `next_record_id`. + description: The cursor to get the next results (if any). To make the next request, use the same parameters and add `next_record_id`. nullable: true type: string type: object @@ -4600,215 +4260,212 @@ components: description: Response containing the hourly usage attribution by tag(s). properties: metadata: - $ref: '#/components/schemas/HourlyUsageAttributionMetadata' + $ref: "#/components/schemas/HourlyUsageAttributionMetadata" usage: description: Get the hourly usage attribution by tag(s). items: - $ref: '#/components/schemas/HourlyUsageAttributionBody' + $ref: "#/components/schemas/HourlyUsageAttributionBody" type: array type: object HourlyUsageAttributionUsageType: - description: 'Supported products for hourly usage attribution requests. Usage - types are in the format `_usage`. - - To obtain the complete list of valid usage types, make a request to the [Get - usage attribution types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types).' - enum: - - api_usage - - apm_fargate_usage - - apm_host_usage - - apm_usm_usage - - appsec_fargate_usage - - appsec_usage - - asm_serverless_traced_invocations_usage - - asm_serverless_traced_invocations_percentage - - bits_ai_investigations_usage - - browser_usage - - ci_code_coverage_committers_percentage - - ci_code_coverage_committers_usage - - ci_pipeline_indexed_spans_usage - - ci_test_indexed_spans_usage - - ci_visibility_itr_usage - - cloud_siem_usage - - code_security_host_usage - - container_excl_agent_usage - - container_usage - - cspm_containers_usage - - cspm_hosts_usage - - custom_event_usage - - custom_ingested_timeseries_usage - - custom_timeseries_usage - - cws_containers_usage - - cws_fargate_task_usage - - cws_hosts_usage - - data_jobs_monitoring_usage - - data_stream_monitoring_usage - - dbm_hosts_usage - - dbm_queries_usage - - error_tracking_usage - - error_tracking_percentage - - estimated_indexed_spans_usage - - estimated_ingested_spans_usage - - fargate_usage - - flex_logs_starter - - flex_stored_logs - - functions_usage - - incident_management_monthly_active_users_usage - - indexed_spans_usage - - infra_host_usage - - ingested_logs_bytes_usage - - ingested_spans_bytes_usage - - invocations_usage - - lambda_traced_invocations_usage - - llm_observability_usage - - llm_spans_usage - - logs_indexed_15day_usage - - logs_indexed_180day_usage - - logs_indexed_1day_usage - - logs_indexed_30day_usage - - logs_indexed_360day_usage - - logs_indexed_3day_usage - - logs_indexed_45day_usage - - logs_indexed_60day_usage - - logs_indexed_7day_usage - - logs_indexed_90day_usage - - logs_indexed_custom_retention_usage - - mobile_app_testing_usage - - ndm_netflow_usage - - npm_host_usage - - network_device_wireless_usage - - obs_pipeline_bytes_usage - - obs_pipelines_vcpu_usage - - online_archive_usage - - product_analytics_session_usage - - profiled_container_usage - - profiled_fargate_usage - - profiled_host_usage - - published_app - - rum_browser_mobile_sessions_usage - - rum_ingested_usage - - rum_investigate_usage - - rum_replay_sessions_usage - - rum_session_replay_add_on_usage - - sca_fargate_usage - - sds_scanned_bytes_usage - - serverless_apps_usage - - siem_analyzed_logs_add_on_usage - - siem_ingested_bytes_usage - - snmp_usage - - universal_service_monitoring_usage - - vuln_management_hosts_usage - - workflow_executions_usage - type: string - x-enum-varnames: - - API_USAGE - - APM_FARGATE_USAGE - - APM_HOST_USAGE - - APM_USM_USAGE - - APPSEC_FARGATE_USAGE - - APPSEC_USAGE - - ASM_SERVERLESS_TRACED_INVOCATIONS_USAGE - - ASM_SERVERLESS_TRACED_INVOCATIONS_PERCENTAGE - - BITS_AI_INVESTIGATIONS_USAGE - - BROWSER_USAGE - - CI_CODE_COVERAGE_COMMITTERS_PERCENTAGE - - CI_CODE_COVERAGE_COMMITTERS_USAGE - - CI_PIPELINE_INDEXED_SPANS_USAGE - - CI_TEST_INDEXED_SPANS_USAGE - - CI_VISIBILITY_ITR_USAGE - - CLOUD_SIEM_USAGE - - CODE_SECURITY_HOST_USAGE - - CONTAINER_EXCL_AGENT_USAGE - - CONTAINER_USAGE - - CSPM_CONTAINERS_USAGE - - CSPM_HOSTS_USAGE - - CUSTOM_EVENT_USAGE - - CUSTOM_INGESTED_TIMESERIES_USAGE - - CUSTOM_TIMESERIES_USAGE - - CWS_CONTAINERS_USAGE - - CWS_FARGATE_TASK_USAGE - - CWS_HOSTS_USAGE - - DATA_JOBS_MONITORING_USAGE - - DATA_STREAM_MONITORING_USAGE - - DBM_HOSTS_USAGE - - DBM_QUERIES_USAGE - - ERROR_TRACKING_USAGE - - ERROR_TRACKING_PERCENTAGE - - ESTIMATED_INDEXED_SPANS_USAGE - - ESTIMATED_INGESTED_SPANS_USAGE - - FARGATE_USAGE - - FLEX_LOGS_STARTER - - FLEX_STORED_LOGS - - FUNCTIONS_USAGE - - INCIDENT_MANAGEMENT_MONTHLY_ACTIVE_USERS_USAGE - - INDEXED_SPANS_USAGE - - INFRA_HOST_USAGE - - INGESTED_LOGS_BYTES_USAGE - - INGESTED_SPANS_BYTES_USAGE - - INVOCATIONS_USAGE - - LAMBDA_TRACED_INVOCATIONS_USAGE - - LLM_OBSERVABILITY_USAGE - - LLM_SPANS_USAGE - - LOGS_INDEXED_15DAY_USAGE - - LOGS_INDEXED_180DAY_USAGE - - LOGS_INDEXED_1DAY_USAGE - - LOGS_INDEXED_30DAY_USAGE - - LOGS_INDEXED_360DAY_USAGE - - LOGS_INDEXED_3DAY_USAGE - - LOGS_INDEXED_45DAY_USAGE - - LOGS_INDEXED_60DAY_USAGE - - LOGS_INDEXED_7DAY_USAGE - - LOGS_INDEXED_90DAY_USAGE - - LOGS_INDEXED_CUSTOM_RETENTION_USAGE - - MOBILE_APP_TESTING_USAGE - - NDM_NETFLOW_USAGE - - NETWORK_DEVICE_WIRELESS_USAGE - - NPM_HOST_USAGE - - OBS_PIPELINE_BYTES_USAGE - - OBS_PIPELINE_VCPU_USAGE - - ONLINE_ARCHIVE_USAGE - - PRODUCT_ANALYTICS_SESSION_USAGE - - PROFILED_CONTAINER_USAGE - - PROFILED_FARGATE_USAGE - - PROFILED_HOST_USAGE - - PUBLISHED_APP_USAGE - - RUM_BROWSER_MOBILE_SESSIONS_USAGE - - RUM_INGESTED_USAGE - - RUM_INVESTIGATE_USAGE - - RUM_REPLAY_SESSIONS_USAGE - - RUM_SESSION_REPLAY_ADD_ON_USAGE - - SCA_FARGATE_USAGE - - SDS_SCANNED_BYTES_USAGE - - SERVERLESS_APPS_USAGE - - SIEM_ANALYZED_LOGS_ADD_ON_USAGE - - SIEM_INGESTED_BYTES_USAGE - - SNMP_USAGE - - UNIVERSAL_SERVICE_MONITORING_USAGE - - VULN_MANAGEMENT_HOSTS_USAGE - - WORKFLOW_EXECUTIONS_USAGE + description: |- + Supported products for hourly usage attribution requests. Usage types are in the format `_usage`. + To obtain the complete list of valid usage types, make a request to the [Get usage attribution types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types). + enum: + - api_usage + - apm_fargate_usage + - apm_host_usage + - apm_usm_usage + - appsec_fargate_usage + - appsec_usage + - asm_serverless_traced_invocations_usage + - asm_serverless_traced_invocations_percentage + - bits_ai_investigations_usage + - browser_usage + - ci_code_coverage_committers_percentage + - ci_code_coverage_committers_usage + - ci_pipeline_indexed_spans_usage + - ci_test_indexed_spans_usage + - ci_visibility_itr_usage + - cloud_siem_usage + - code_security_host_usage + - container_excl_agent_usage + - container_usage + - cspm_containers_usage + - cspm_hosts_usage + - custom_event_usage + - custom_ingested_timeseries_usage + - custom_timeseries_usage + - cws_containers_usage + - cws_fargate_task_usage + - cws_hosts_usage + - data_jobs_monitoring_usage + - data_stream_monitoring_usage + - dbm_hosts_usage + - dbm_queries_usage + - error_tracking_usage + - error_tracking_percentage + - estimated_indexed_spans_usage + - estimated_ingested_spans_usage + - fargate_usage + - flex_logs_starter + - flex_stored_logs + - functions_usage + - incident_management_monthly_active_users_usage + - indexed_spans_usage + - infra_host_usage + - ingested_logs_bytes_usage + - ingested_spans_bytes_usage + - invocations_usage + - lambda_traced_invocations_usage + - llm_observability_usage + - llm_spans_usage + - logs_indexed_15day_usage + - logs_indexed_180day_usage + - logs_indexed_1day_usage + - logs_indexed_30day_usage + - logs_indexed_360day_usage + - logs_indexed_3day_usage + - logs_indexed_45day_usage + - logs_indexed_60day_usage + - logs_indexed_7day_usage + - logs_indexed_90day_usage + - logs_indexed_custom_retention_usage + - mobile_app_testing_usage + - ndm_netflow_usage + - npm_host_usage + - network_device_wireless_usage + - obs_pipeline_bytes_usage + - obs_pipelines_vcpu_usage + - online_archive_usage + - product_analytics_session_usage + - profiled_container_usage + - profiled_fargate_usage + - profiled_host_usage + - published_app + - rum_browser_mobile_sessions_usage + - rum_ingested_usage + - rum_investigate_usage + - rum_replay_sessions_usage + - rum_session_replay_add_on_usage + - sca_fargate_usage + - sds_scanned_bytes_usage + - serverless_apps_usage + - siem_analyzed_logs_add_on_usage + - siem_ingested_bytes_usage + - snmp_usage + - universal_service_monitoring_usage + - vuln_management_hosts_usage + - workflow_executions_usage + type: string + x-enum-varnames: + - API_USAGE + - APM_FARGATE_USAGE + - APM_HOST_USAGE + - APM_USM_USAGE + - APPSEC_FARGATE_USAGE + - APPSEC_USAGE + - ASM_SERVERLESS_TRACED_INVOCATIONS_USAGE + - ASM_SERVERLESS_TRACED_INVOCATIONS_PERCENTAGE + - BITS_AI_INVESTIGATIONS_USAGE + - BROWSER_USAGE + - CI_CODE_COVERAGE_COMMITTERS_PERCENTAGE + - CI_CODE_COVERAGE_COMMITTERS_USAGE + - CI_PIPELINE_INDEXED_SPANS_USAGE + - CI_TEST_INDEXED_SPANS_USAGE + - CI_VISIBILITY_ITR_USAGE + - CLOUD_SIEM_USAGE + - CODE_SECURITY_HOST_USAGE + - CONTAINER_EXCL_AGENT_USAGE + - CONTAINER_USAGE + - CSPM_CONTAINERS_USAGE + - CSPM_HOSTS_USAGE + - CUSTOM_EVENT_USAGE + - CUSTOM_INGESTED_TIMESERIES_USAGE + - CUSTOM_TIMESERIES_USAGE + - CWS_CONTAINERS_USAGE + - CWS_FARGATE_TASK_USAGE + - CWS_HOSTS_USAGE + - DATA_JOBS_MONITORING_USAGE + - DATA_STREAM_MONITORING_USAGE + - DBM_HOSTS_USAGE + - DBM_QUERIES_USAGE + - ERROR_TRACKING_USAGE + - ERROR_TRACKING_PERCENTAGE + - ESTIMATED_INDEXED_SPANS_USAGE + - ESTIMATED_INGESTED_SPANS_USAGE + - FARGATE_USAGE + - FLEX_LOGS_STARTER + - FLEX_STORED_LOGS + - FUNCTIONS_USAGE + - INCIDENT_MANAGEMENT_MONTHLY_ACTIVE_USERS_USAGE + - INDEXED_SPANS_USAGE + - INFRA_HOST_USAGE + - INGESTED_LOGS_BYTES_USAGE + - INGESTED_SPANS_BYTES_USAGE + - INVOCATIONS_USAGE + - LAMBDA_TRACED_INVOCATIONS_USAGE + - LLM_OBSERVABILITY_USAGE + - LLM_SPANS_USAGE + - LOGS_INDEXED_15DAY_USAGE + - LOGS_INDEXED_180DAY_USAGE + - LOGS_INDEXED_1DAY_USAGE + - LOGS_INDEXED_30DAY_USAGE + - LOGS_INDEXED_360DAY_USAGE + - LOGS_INDEXED_3DAY_USAGE + - LOGS_INDEXED_45DAY_USAGE + - LOGS_INDEXED_60DAY_USAGE + - LOGS_INDEXED_7DAY_USAGE + - LOGS_INDEXED_90DAY_USAGE + - LOGS_INDEXED_CUSTOM_RETENTION_USAGE + - MOBILE_APP_TESTING_USAGE + - NDM_NETFLOW_USAGE + - NETWORK_DEVICE_WIRELESS_USAGE + - NPM_HOST_USAGE + - OBS_PIPELINE_BYTES_USAGE + - OBS_PIPELINE_VCPU_USAGE + - ONLINE_ARCHIVE_USAGE + - PRODUCT_ANALYTICS_SESSION_USAGE + - PROFILED_CONTAINER_USAGE + - PROFILED_FARGATE_USAGE + - PROFILED_HOST_USAGE + - PUBLISHED_APP_USAGE + - RUM_BROWSER_MOBILE_SESSIONS_USAGE + - RUM_INGESTED_USAGE + - RUM_INVESTIGATE_USAGE + - RUM_REPLAY_SESSIONS_USAGE + - RUM_SESSION_REPLAY_ADD_ON_USAGE + - SCA_FARGATE_USAGE + - SDS_SCANNED_BYTES_USAGE + - SERVERLESS_APPS_USAGE + - SIEM_ANALYZED_LOGS_ADD_ON_USAGE + - SIEM_INGESTED_BYTES_USAGE + - SNMP_USAGE + - UNIVERSAL_SERVICE_MONITORING_USAGE + - VULN_MANAGEMENT_HOSTS_USAGE + - WORKFLOW_EXECUTIONS_USAGE IFrameWidgetDefinition: - description: The iframe widget allows you to embed a portion of any other web - page on your dashboard. Only available on FREE layout dashboards. + description: The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards. properties: type: - $ref: '#/components/schemas/IFrameWidgetDefinitionType' + $ref: "#/components/schemas/IFrameWidgetDefinitionType" url: description: URL of the iframe. - example: '' + example: "" type: string required: - - type - - url + - type + - url type: object IFrameWidgetDefinitionType: default: iframe description: Type of the iframe widget. enum: - - iframe + - iframe example: iframe type: string x-enum-varnames: - - IFRAME + - IFRAME IPPrefixesAPI: description: Available prefix information for the API endpoints. properties: @@ -4972,8 +4629,7 @@ components: type: object type: object IPPrefixesSyntheticsPrivateLocations: - description: Available prefix information for the Synthetics Private Locations - endpoints. + description: Available prefix information for the Synthetics Private Locations endpoints. properties: prefixes_ipv4: description: List of IPv4 prefixes. @@ -5008,62 +4664,60 @@ components: description: IP ranges. properties: agents: - $ref: '#/components/schemas/IPPrefixesAgents' + $ref: "#/components/schemas/IPPrefixesAgents" api: - $ref: '#/components/schemas/IPPrefixesAPI' + $ref: "#/components/schemas/IPPrefixesAPI" apm: - $ref: '#/components/schemas/IPPrefixesAPM' + $ref: "#/components/schemas/IPPrefixesAPM" global: - $ref: '#/components/schemas/IPPrefixesGlobal' + $ref: "#/components/schemas/IPPrefixesGlobal" logs: - $ref: '#/components/schemas/IPPrefixesLogs' + $ref: "#/components/schemas/IPPrefixesLogs" modified: description: Date when last updated, in the form `YYYY-MM-DD-hh-mm-ss`. example: 2019-10-31-20-00-00 type: string orchestrator: - $ref: '#/components/schemas/IPPrefixesOrchestrator' + $ref: "#/components/schemas/IPPrefixesOrchestrator" process: - $ref: '#/components/schemas/IPPrefixesProcess' + $ref: "#/components/schemas/IPPrefixesProcess" remote-configuration: - $ref: '#/components/schemas/IPPrefixesRemoteConfiguration' + $ref: "#/components/schemas/IPPrefixesRemoteConfiguration" synthetics: - $ref: '#/components/schemas/IPPrefixesSynthetics' + $ref: "#/components/schemas/IPPrefixesSynthetics" synthetics-private-locations: - $ref: '#/components/schemas/IPPrefixesSyntheticsPrivateLocations' + $ref: "#/components/schemas/IPPrefixesSyntheticsPrivateLocations" version: description: Version of the IP list. example: 11 format: int64 type: integer webhooks: - $ref: '#/components/schemas/IPPrefixesWebhooks' + $ref: "#/components/schemas/IPPrefixesWebhooks" type: object IdpFormData: description: Object describing the IdP configuration. properties: idp_file: description: The path to the XML metadata file you wish to upload. - example: '' + example: "" format: binary type: string required: - - idp_file + - idp_file type: object IdpResponse: description: The IdP response object. properties: message: description: Identity provider response. - example: IdP metadata successfully uploaded for example org + example: "IdP metadata successfully uploaded for example org" type: string required: - - message + - message type: object ImageWidgetDefinition: - description: The image widget allows you to embed an image on your dashboard. - An image can be a PNG, JPG, or animated GIF. Only available on FREE layout - dashboards. + description: The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards. properties: has_background: default: true @@ -5076,36 +4730,36 @@ components: example: true type: boolean horizontal_align: - $ref: '#/components/schemas/WidgetHorizontalAlign' + $ref: "#/components/schemas/WidgetHorizontalAlign" margin: - $ref: '#/components/schemas/WidgetMargin' + $ref: "#/components/schemas/WidgetMargin" sizing: - $ref: '#/components/schemas/WidgetImageSizing' + $ref: "#/components/schemas/WidgetImageSizing" type: - $ref: '#/components/schemas/ImageWidgetDefinitionType' + $ref: "#/components/schemas/ImageWidgetDefinitionType" url: description: URL of the image. - example: https://example.com/image.png + example: "https://example.com/image.png" type: string url_dark_theme: description: URL of the image in dark mode. - example: https://example.com/image-dark-mode.png + example: "https://example.com/image-dark-mode.png" type: string vertical_align: - $ref: '#/components/schemas/WidgetVerticalAlign' + $ref: "#/components/schemas/WidgetVerticalAlign" required: - - type - - url + - type + - url type: object ImageWidgetDefinitionType: default: image description: Type of the image widget. enum: - - image + - image example: image type: string x-enum-varnames: - - IMAGE + - IMAGE IntakePayloadAccepted: description: The payload accepted for intake. properties: @@ -5116,79 +4770,77 @@ components: type: object ListStreamColumn: description: Widget column. - example: - field: timestamp - width: auto + example: {"field": "timestamp", "width": "auto"} properties: field: description: Widget column field. - example: content + example: "content" type: string width: - $ref: '#/components/schemas/ListStreamColumnWidth' + $ref: "#/components/schemas/ListStreamColumnWidth" required: - - width - - field + - width + - field type: object ListStreamColumnWidth: description: Widget column width. enum: - - auto - - compact - - full + - auto + - compact + - full example: compact type: string x-enum-varnames: - - AUTO - - COMPACT - - FULL + - AUTO + - COMPACT + - FULL ListStreamComputeAggregation: description: Aggregation value. enum: - - count - - cardinality - - median - - pc75 - - pc90 - - pc95 - - pc98 - - pc99 - - sum - - min - - max - - avg - - earliest - - latest - - most_frequent + - count + - cardinality + - median + - pc75 + - pc90 + - pc95 + - pc98 + - pc99 + - sum + - min + - max + - avg + - earliest + - latest + - most_frequent example: count type: string x-enum-varnames: - - COUNT - - CARDINALITY - - MEDIAN - - PC75 - - PC90 - - PC95 - - PC98 - - PC99 - - SUM - - MIN - - MAX - - AVG - - EARLIEST - - LATEST - - MOST_FREQUENT + - COUNT + - CARDINALITY + - MEDIAN + - PC75 + - PC90 + - PC95 + - PC98 + - PC99 + - SUM + - MIN + - MAX + - AVG + - EARLIEST + - LATEST + - MOST_FREQUENT ListStreamComputeItems: description: List of facets and aggregations which to compute. properties: aggregation: - $ref: '#/components/schemas/ListStreamComputeAggregation' + $ref: "#/components/schemas/ListStreamComputeAggregation" facet: description: Facet name. example: resource_name type: string required: - - aggregation + - aggregation type: object ListStreamGroupByItems: description: List of facets on which to group. @@ -5198,35 +4850,30 @@ components: example: resource_name type: string required: - - facet + - facet type: object ListStreamQuery: description: Updated list stream widget. properties: clustering_pattern_field_path: - description: Specifies the field for logs pattern clustering. Usable only - with logs_pattern_stream. - example: message + description: Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. + example: "message" type: string compute: - description: Compute configuration for the List Stream Widget. Compute can - be used only with the logs_transaction_stream (from 1 to 5 items) list - stream source. + description: Compute configuration for the List Stream Widget. Compute can be used only with the logs_transaction_stream (from 1 to 5 items) list stream source. items: - $ref: '#/components/schemas/ListStreamComputeItems' + $ref: "#/components/schemas/ListStreamComputeItems" maxItems: 5 minItems: 1 type: array data_source: - $ref: '#/components/schemas/ListStreamSource' + $ref: "#/components/schemas/ListStreamSource" event_size: - $ref: '#/components/schemas/WidgetEventSize' + $ref: "#/components/schemas/WidgetEventSize" group_by: - description: Group by configuration for the List Stream Widget. Group by - can be used only with logs_pattern_stream (up to 4 items) or logs_transaction_stream - (one group by item is required) list stream source. + description: Group by configuration for the List Stream Widget. Group by can be used only with logs_pattern_stream (up to 4 items) or logs_transaction_stream (one group by item is required) list stream source. items: - $ref: '#/components/schemas/ListStreamGroupByItems' + $ref: "#/components/schemas/ListStreamGroupByItems" maxItems: 4 type: array indexes: @@ -5237,79 +4884,71 @@ components: type: array query_string: description: Widget query. - example: '@service:app' + example: "@service:app" type: string sort: - $ref: '#/components/schemas/WidgetFieldSort' + $ref: "#/components/schemas/WidgetFieldSort" storage: description: Option for storage location. Feature in Private Beta. - example: indexes + example: "indexes" type: string required: - - query_string - - data_source + - query_string + - data_source type: object ListStreamResponseFormat: description: Widget response format. enum: - - event_list + - event_list example: event_list type: string x-enum-varnames: - - EVENT_LIST + - EVENT_LIST ListStreamSource: default: apm_issue_stream description: Source from which to query items to display in the stream. enum: - - logs_stream - - audit_stream - - ci_pipeline_stream - - ci_test_stream - - rum_issue_stream - - apm_issue_stream - - trace_stream - - logs_issue_stream - - logs_pattern_stream - - logs_transaction_stream - - event_stream - - rum_stream - - llm_observability_stream + - logs_stream + - audit_stream + - ci_pipeline_stream + - ci_test_stream + - rum_issue_stream + - apm_issue_stream + - trace_stream + - logs_issue_stream + - logs_pattern_stream + - logs_transaction_stream + - event_stream + - rum_stream + - llm_observability_stream example: apm_issue_stream type: string x-enum-varnames: - - LOGS_STREAM - - AUDIT_STREAM - - CI_PIPELINE_STREAM - - CI_TEST_STREAM - - RUM_ISSUE_STREAM - - APM_ISSUE_STREAM - - TRACE_STREAM - - LOGS_ISSUE_STREAM - - LOGS_PATTERN_STREAM - - LOGS_TRANSACTION_STREAM - - EVENT_STREAM - - RUM_STREAM - - LLM_OBSERVABILITY_STREAM + - LOGS_STREAM + - AUDIT_STREAM + - CI_PIPELINE_STREAM + - CI_TEST_STREAM + - RUM_ISSUE_STREAM + - APM_ISSUE_STREAM + - TRACE_STREAM + - LOGS_ISSUE_STREAM + - LOGS_PATTERN_STREAM + - LOGS_TRANSACTION_STREAM + - EVENT_STREAM + - RUM_STREAM + - LLM_OBSERVABILITY_STREAM ListStreamWidgetDefinition: - description: 'The list stream visualization displays a table of recent events - in your application that - - match a search criteria using user-defined columns.' + description: |- + The list stream visualization displays a table of recent events in your application that + match a search criteria using user-defined columns. properties: legend_size: - $ref: '#/components/schemas/WidgetLegendSize' + $ref: "#/components/schemas/WidgetLegendSize" requests: description: Request payload used to query items. - example: - - columns: - - field: timestamp - width: auto - query: - data_source: apm_issue_stream - query_string: '@data_source:APM' - response_format: event_list - items: - $ref: '#/components/schemas/ListStreamWidgetRequest' + example: [{"columns": [{"field": "timestamp", "width": "auto"}], "query": {"data_source": "apm_issue_stream", "query_string": "@data_source:APM"}, "response_format": "event_list"}] + items: + $ref: "#/components/schemas/ListStreamWidgetRequest" maxItems: 1 minItems: 1 type: array @@ -5317,107 +4956,95 @@ components: description: Whether or not to display the legend on this widget. type: boolean time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/ListStreamWidgetDefinitionType' + $ref: "#/components/schemas/ListStreamWidgetDefinitionType" required: - - type - - requests + - type + - requests type: object ListStreamWidgetDefinitionType: default: list_stream description: Type of the list stream widget. enum: - - list_stream + - list_stream example: list_stream type: string x-enum-varnames: - - LIST_STREAM + - LIST_STREAM ListStreamWidgetRequest: description: Updated list stream widget. properties: columns: description: Widget columns. - example: - - field: timestamp - width: auto - - field: content - width: full + example: [{"field": "timestamp", "width": "auto"}, {"field": "content", "width": "full"}] items: - $ref: '#/components/schemas/ListStreamColumn' + $ref: "#/components/schemas/ListStreamColumn" type: array query: - $ref: '#/components/schemas/ListStreamQuery' + $ref: "#/components/schemas/ListStreamQuery" response_format: - $ref: '#/components/schemas/ListStreamResponseFormat' + $ref: "#/components/schemas/ListStreamResponseFormat" required: - - columns - - query - - response_format + - columns + - query + - response_format type: object Log: description: Object describing a log after being processed and stored by Datadog. properties: content: - $ref: '#/components/schemas/LogContent' + $ref: "#/components/schemas/LogContent" id: description: ID of the Log. - example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA" type: string type: object LogContent: - description: JSON object containing all log attributes and their associated - values. + description: JSON object containing all log attributes and their associated values. properties: attributes: additionalProperties: {} description: JSON object of attributes from your log. - example: - customAttribute: 123 - duration: 2345 + example: {"customAttribute": 123, "duration": 2345} type: object host: - description: Name of the machine from where the logs are being sent. + description: |- + Name of the machine from where the logs are being sent. example: i-0123 type: string message: - description: 'The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes) - - of your log. By default, Datadog ingests the value of the message attribute - as the body of the log entry. - - That value is then highlighted and displayed in the Logstream, where it - is indexed for full text search.' + description: |- + The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes) + of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. + That value is then highlighted and displayed in the Logstream, where it is indexed for full text search. example: Host connected to remote type: string service: - description: 'The name of the application or service generating the log - events. - + description: |- + The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same - - value when you use both products.' + value when you use both products. example: agent type: string tags: description: Array of tags associated with your log. - example: - - team:A + example: ["team:A"] items: description: Tag associated with your log. type: string type: array timestamp: description: Timestamp of your log. - example: '2020-05-26T13:36:14Z' + example: "2020-05-26T13:36:14Z" format: date-time type: string type: object @@ -5425,24 +5052,23 @@ components: description: The log query. properties: compute: - $ref: '#/components/schemas/LogsQueryCompute' + $ref: "#/components/schemas/LogsQueryCompute" group_by: description: List of tag prefixes to group by in the case of a cluster check. items: - $ref: '#/components/schemas/LogQueryDefinitionGroupBy' + $ref: "#/components/schemas/LogQueryDefinitionGroupBy" type: array index: - description: A coma separated-list of index names. Use "*" query all indexes - at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - example: days-3,days-7 + description: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) + example: "days-3,days-7" type: string multi_compute: description: This field is mutually exclusive with `compute`. items: - $ref: '#/components/schemas/LogsQueryCompute' + $ref: "#/components/schemas/LogsQueryCompute" type: array search: - $ref: '#/components/schemas/LogQueryDefinitionSearch' + $ref: "#/components/schemas/LogQueryDefinitionSearch" type: object LogQueryDefinitionGroupBy: description: Defined items in the group. @@ -5457,9 +5083,9 @@ components: format: int64 type: integer sort: - $ref: '#/components/schemas/LogQueryDefinitionGroupBySort' + $ref: "#/components/schemas/LogQueryDefinitionGroupBySort" required: - - facet + - facet type: object LogQueryDefinitionGroupBySort: description: Define a sorting method. @@ -5470,27 +5096,26 @@ components: type: string facet: description: Facet name. - example: '@string_query.interval' + example: "@string_query.interval" type: string order: - $ref: '#/components/schemas/WidgetSort' + $ref: "#/components/schemas/WidgetSort" required: - - aggregation - - order + - aggregation + - order type: object LogQueryDefinitionSearch: description: The query being made on the logs. properties: query: description: Search value to apply. - example: '' + example: "" type: string required: - - query + - query type: object LogStreamWidgetDefinition: - description: The Log Stream displays a log flow matching the defined query. - Only available on FREE layout dashboards. + description: The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards. properties: columns: description: Which columns to display on the widget. @@ -5499,14 +5124,10 @@ components: type: string type: array indexes: - description: An array of index names to query in the stream. Use [] to query - all indexes at once. - example: - - days-3 - - days-7 + description: An array of index names to query in the stream. Use [] to query all indexes at once. + example: ["days-3", "days-7"] items: - description: One of the log indexes set up for your organization. [Multiple - Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) + description: One of the log indexes set up for your organization. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) type: string type: array logset: @@ -5514,7 +5135,7 @@ components: description: ID of the log set to use. type: string message_display: - $ref: '#/components/schemas/WidgetMessageDisplay' + $ref: "#/components/schemas/WidgetMessageDisplay" query: description: Query to filter the log stream with. type: string @@ -5525,31 +5146,31 @@ components: description: Whether to show the message column or not type: boolean sort: - $ref: '#/components/schemas/WidgetFieldSort' + $ref: "#/components/schemas/WidgetFieldSort" time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/LogStreamWidgetDefinitionType' + $ref: "#/components/schemas/LogStreamWidgetDefinitionType" required: - - type + - type type: object LogStreamWidgetDefinitionType: default: log_stream description: Type of the log stream widget. enum: - - log_stream + - log_stream example: log_stream type: string x-enum-varnames: - - LOG_STREAM + - LOG_STREAM LogsAPIError: description: Error returned by the Logs API properties: @@ -5559,7 +5180,7 @@ components: details: description: Additional error details items: - $ref: '#/components/schemas/LogsAPIError' + $ref: "#/components/schemas/LogsAPIError" type: array message: description: Error message @@ -5569,35 +5190,41 @@ components: description: Response returned by the Logs API when errors occur. properties: error: - $ref: '#/components/schemas/LogsAPIError' + $ref: "#/components/schemas/LogsAPIError" type: object LogsAPILimitReachedResponse: description: Response returned by the Logs API when the max limit has been reached. properties: error: - $ref: '#/components/schemas/LogsAPIError' + $ref: "#/components/schemas/LogsAPIError" type: object LogsArithmeticProcessor: - description: "Use the Arithmetic Processor to add a new attribute (without spaces - or special characters\nin the new attribute name) to a log with the result - of the provided formula.\nThis enables you to remap different time attributes - with different units into a single attribute,\nor to compute operations on - attributes within the same log.\n\nThe formula can use parentheses and the - basic arithmetic operators `-`, `+`, `*`, `/`.\n\nBy default, the calculation - is skipped if an attribute is missing.\nSelect \u201CReplace missing attribute - by 0\u201D to automatically populate\nmissing attribute values with 0 to ensure - that the calculation is done.\nAn attribute is missing if it is not found - in the log attributes,\nor if it cannot be converted to a number.\n\n*Notes*:\n\n- - The operator `-` needs to be space split in the formula as it can also be - contained in attribute names.\n- If the target attribute already exists, it - is overwritten by the result of the formula.\n- Results are rounded up to - the 9th decimal. For example, if the result of the formula is `0.1234567891`,\n - \ the actual value stored for the attribute is `0.123456789`.\n- If you need - to scale a unit of measure,\n see [Scale Filter](https://docs.datadoghq.com/logs/log_configuration/parsing/?tab=filter#matcher-and-filter)." + description: |- + Use the Arithmetic Processor to add a new attribute (without spaces or special characters + in the new attribute name) to a log with the result of the provided formula. + This enables you to remap different time attributes with different units into a single attribute, + or to compute operations on attributes within the same log. + + The formula can use parentheses and the basic arithmetic operators `-`, `+`, `*`, `/`. + + By default, the calculation is skipped if an attribute is missing. + Select “Replace missing attribute by 0” to automatically populate + missing attribute values with 0 to ensure that the calculation is done. + An attribute is missing if it is not found in the log attributes, + or if it cannot be converted to a number. + + *Notes*: + + - The operator `-` needs to be space split in the formula as it can also be contained in attribute names. + - If the target attribute already exists, it is overwritten by the result of the formula. + - Results are rounded up to the 9th decimal. For example, if the result of the formula is `0.1234567891`, + the actual value stored for the attribute is `0.123456789`. + - If you need to scale a unit of measure, + see [Scale Filter](https://docs.datadoghq.com/logs/log_configuration/parsing/?tab=filter#matcher-and-filter). properties: expression: description: Arithmetic operation between one or more log attributes. - example: '' + example: "" type: string is_enabled: default: false @@ -5605,46 +5232,40 @@ components: type: boolean is_replace_missing: default: false - description: 'If `true`, it replaces all missing attributes of expression - by `0`, `false` - - skip the operation if an attribute is missing.' + description: |- + If `true`, it replaces all missing attributes of expression by `0`, `false` + skip the operation if an attribute is missing. type: boolean name: description: Name of the processor. type: string target: - description: Name of the attribute that contains the result of the arithmetic - operation. - example: '' + description: Name of the attribute that contains the result of the arithmetic operation. + example: "" type: string type: - $ref: '#/components/schemas/LogsArithmeticProcessorType' + $ref: "#/components/schemas/LogsArithmeticProcessorType" required: - - target - - expression - - type + - target + - expression + - type type: object LogsArithmeticProcessorType: default: arithmetic-processor description: Type of logs arithmetic processor. enum: - - arithmetic-processor + - arithmetic-processor example: arithmetic-processor type: string x-enum-varnames: - - ARITHMETIC_PROCESSOR + - ARITHMETIC_PROCESSOR LogsArrayProcessor: - description: 'A processor for extracting, aggregating, or transforming values - from JSON arrays within your logs. - + description: |- + A processor for extracting, aggregating, or transforming values from JSON arrays within your logs. Supported operations are: - - Select value from matching element - - Compute array length - - - Append a value to an array' + - Append a value to an array properties: is_enabled: default: false @@ -5654,19 +5275,19 @@ components: description: Name of the processor. type: string operation: - $ref: '#/components/schemas/LogsArrayProcessorOperation' + $ref: "#/components/schemas/LogsArrayProcessorOperation" type: - $ref: '#/components/schemas/LogsArrayProcessorType' + $ref: "#/components/schemas/LogsArrayProcessorType" required: - - operation - - type + - operation + - type type: object LogsArrayProcessorOperation: description: Configuration of the array processor operation to perform. oneOf: - - $ref: '#/components/schemas/LogsArrayProcessorOperationAppend' - - $ref: '#/components/schemas/LogsArrayProcessorOperationLength' - - $ref: '#/components/schemas/LogsArrayProcessorOperationSelect' + - $ref: "#/components/schemas/LogsArrayProcessorOperationAppend" + - $ref: "#/components/schemas/LogsArrayProcessorOperationLength" + - $ref: "#/components/schemas/LogsArrayProcessorOperationSelect" LogsArrayProcessorOperationAppend: description: Operation that appends a value to a target array attribute. properties: @@ -5683,23 +5304,21 @@ components: example: sourceIps type: string type: - $ref: '#/components/schemas/LogsArrayProcessorOperationAppendType' + $ref: "#/components/schemas/LogsArrayProcessorOperationAppendType" required: - - type - - source - - target + - type + - source + - target type: object LogsArrayProcessorOperationAppendType: description: Operation type. - enum: - - append + enum: [append] example: append type: string x-enum-varnames: - - APPEND + - APPEND LogsArrayProcessorOperationLength: - description: Operation that computes the length of a `source` array and stores - the result in the `target` attribute. + description: Operation that computes the length of a `source` array and stores the result in the `target` attribute. properties: source: description: Attribute path of the array to measure. @@ -5710,27 +5329,24 @@ components: example: tagCount type: string type: - $ref: '#/components/schemas/LogsArrayProcessorOperationLengthType' + $ref: "#/components/schemas/LogsArrayProcessorOperationLengthType" required: - - type - - source - - target + - type + - source + - target type: object LogsArrayProcessorOperationLengthType: description: Operation type. - enum: - - length + enum: [length] example: length type: string x-enum-varnames: - - LENGTH + - LENGTH LogsArrayProcessorOperationSelect: - description: Operation that finds an object in a `source` array using a `filter`, - and then extracts a specific value into the `target` attribute. + description: Operation that finds an object in a `source` array using a `filter`, and then extracts a specific value into the `target` attribute. properties: filter: - description: Filter condition expressed as `key:value` used to find the - matching element. + description: Filter condition expressed as `key:value` used to find the matching element. example: name:Referrer type: string source: @@ -5742,44 +5358,39 @@ components: example: referrer type: string type: - $ref: '#/components/schemas/LogsArrayProcessorOperationSelectType' + $ref: "#/components/schemas/LogsArrayProcessorOperationSelectType" value_to_extract: description: Key of the value to extract from the matching element. example: value type: string required: - - type - - source - - target - - filter - - value_to_extract + - type + - source + - target + - filter + - value_to_extract type: object LogsArrayProcessorOperationSelectType: description: Operation type. - enum: - - select + enum: [select] example: select type: string x-enum-varnames: - - SELECT + - SELECT LogsArrayProcessorType: default: array-processor description: Type of logs array processor. enum: - - array-processor + - array-processor example: array-processor type: string x-enum-varnames: - - ARRAY_PROCESSOR + - ARRAY_PROCESSOR LogsAttributeRemapper: - description: 'The remapper processor remaps any source attribute(s) or tag to - another target attribute or tag. - - Constraints on the tag/attribute name are explained in the [Tag Best Practice - documentation](https://docs.datadoghq.com/logs/guide/log-parsing-best-practice). - - Some additional constraints are applied as `:` or `,` are not allowed in the - target tag/attribute name.' + description: |- + The remapper processor remaps any source attribute(s) or tag to another target attribute or tag. + Constraints on the tag/attribute name are explained in the [Tag Best Practice documentation](https://docs.datadoghq.com/logs/guide/log-parsing-best-practice). + Some additional constraints are applied as `:` or `,` are not allowed in the target tag/attribute name. properties: is_enabled: default: false @@ -5802,12 +5413,9 @@ components: type: string sources: description: Array of source attributes. - example: - - web - - gateway + example: ["web", "gateway"] items: - description: Attribute used as a source to remap its value to the target - attribute. + description: Attribute used as a source to remap its value to the target attribute. type: string type: array target: @@ -5815,45 +5423,42 @@ components: example: operation_id type: string target_format: - $ref: '#/components/schemas/TargetFormatType' + $ref: "#/components/schemas/TargetFormatType" target_type: default: attribute - description: Defines if the final attribute or tag name is from log `attribute` - or `tag`. + description: Defines if the final attribute or tag name is from log `attribute` or `tag`. type: string type: - $ref: '#/components/schemas/LogsAttributeRemapperType' + $ref: "#/components/schemas/LogsAttributeRemapperType" required: - - sources - - target - - type + - sources + - target + - type type: object LogsAttributeRemapperType: default: attribute-remapper description: Type of logs attribute remapper. enum: - - attribute-remapper + - attribute-remapper example: attribute-remapper type: string x-enum-varnames: - - ATTRIBUTE_REMAPPER + - ATTRIBUTE_REMAPPER LogsByRetention: description: Object containing logs usage data broken down by retention period. properties: orgs: - $ref: '#/components/schemas/LogsByRetentionOrgs' + $ref: "#/components/schemas/LogsByRetentionOrgs" usage: - description: Aggregated index logs usage for each retention period with - usage. + description: Aggregated index logs usage for each retention period with usage. items: - $ref: '#/components/schemas/LogsRetentionAggSumUsage' + $ref: "#/components/schemas/LogsRetentionAggSumUsage" type: array usage_by_month: - $ref: '#/components/schemas/LogsByRetentionMonthlyUsage' + $ref: "#/components/schemas/LogsByRetentionMonthlyUsage" type: object LogsByRetentionMonthlyUsage: - description: Object containing a summary of indexed logs usage by retention - period for a single month. + description: Object containing a summary of indexed logs usage by retention period for a single month. properties: date: description: The month for the usage. @@ -5862,7 +5467,7 @@ components: usage: description: Indexed logs usage for each active retention for the month. items: - $ref: '#/components/schemas/LogsRetentionSumUsage' + $ref: "#/components/schemas/LogsRetentionSumUsage" type: array type: object LogsByRetentionOrgUsage: @@ -5871,39 +5476,41 @@ components: usage: description: Indexed logs usage for each active retention for the organization. items: - $ref: '#/components/schemas/LogsRetentionSumUsage' + $ref: "#/components/schemas/LogsRetentionSumUsage" type: array type: object LogsByRetentionOrgs: - description: Indexed logs usage summary for each organization for each retention - period with usage. + description: Indexed logs usage summary for each organization for each retention period with usage. properties: usage: description: Indexed logs usage summary for each organization. items: - $ref: '#/components/schemas/LogsByRetentionOrgUsage' + $ref: "#/components/schemas/LogsByRetentionOrgUsage" type: array type: object LogsCategoryProcessor: - description: "Use the Category Processor to add a new attribute (without spaces - or special characters in the new attribute name)\nto a log matching a provided - search query. Use categories to create groups for an analytical view.\nFor - example, URL groups, machine groups, environments, and response time buckets.\n\n**Notes**:\n\n- - The syntax of the query is the one of Logs Explorer search bar.\n The query - can be done on any log attribute or tag, whether it is a facet or not.\n Wildcards - can also be used inside your query.\n- Once the log has matched one of the - Processor queries, it stops.\n Make sure they are properly ordered in case - a log could match several queries.\n- The names of the categories must be - unique.\n- Once defined in the Category Processor, you can map categories - to log status using the Log Status Remapper." + description: |- + Use the Category Processor to add a new attribute (without spaces or special characters in the new attribute name) + to a log matching a provided search query. Use categories to create groups for an analytical view. + For example, URL groups, machine groups, environments, and response time buckets. + + **Notes**: + + - The syntax of the query is the one of Logs Explorer search bar. + The query can be done on any log attribute or tag, whether it is a facet or not. + Wildcards can also be used inside your query. + - Once the log has matched one of the Processor queries, it stops. + Make sure they are properly ordered in case a log could match several queries. + - The names of the categories must be unique. + - Once defined in the Category Processor, you can map categories to log status using the Log Status Remapper. properties: categories: - description: 'Array of filters to match or not a log and their - - corresponding `name` to assign a custom value to the log.' + description: |- + Array of filters to match or not a log and their + corresponding `name` to assign a custom value to the log. example: [] items: - $ref: '#/components/schemas/LogsCategoryProcessorCategory' + $ref: "#/components/schemas/LogsCategoryProcessorCategory" type: array is_enabled: default: false @@ -5913,22 +5520,21 @@ components: description: Name of the processor. type: string target: - description: Name of the target attribute which value is defined by the - matching category. - example: '' + description: Name of the target attribute which value is defined by the matching category. + example: "" type: string type: - $ref: '#/components/schemas/LogsCategoryProcessorType' + $ref: "#/components/schemas/LogsCategoryProcessorType" required: - - categories - - target - - type + - categories + - target + - type type: object LogsCategoryProcessorCategory: description: Object describing the logs filter. properties: filter: - $ref: '#/components/schemas/LogsFilter' + $ref: "#/components/schemas/LogsFilter" name: description: Value to assign to the target attribute. type: string @@ -5937,38 +5543,44 @@ components: default: category-processor description: Type of logs category processor. enum: - - category-processor + - category-processor example: category-processor type: string x-enum-varnames: - - CATEGORY_PROCESSOR + - CATEGORY_PROCESSOR LogsDailyLimitReset: - description: Object containing options to override the default daily limit reset - time. + description: Object containing options to override the default daily limit reset time. properties: reset_time: - description: String in `HH:00` format representing the time of day the daily - limit should be reset. The hours must be between 00 and 23 (inclusive). - example: '14:00' + description: String in `HH:00` format representing the time of day the daily limit should be reset. The hours must be between 00 and 23 (inclusive). + example: "14:00" type: string reset_utc_offset: - description: String in `(-|+)HH:00` format representing the UTC offset to - apply to the given reset time. The hours must be between -12 and +14 (inclusive). - example: +02:00 + description: String in `(-|+)HH:00` format representing the UTC offset to apply to the given reset time. The hours must be between -12 and +14 (inclusive). + example: "+02:00" type: string type: object LogsDateRemapper: - description: "As Datadog receives logs, it timestamps them using the value(s) - from any of these default attributes.\n\n - `timestamp`\n - `date`\n - - `_timestamp`\n - `Timestamp`\n - `eventTime`\n - `published_date`\n\n If - your logs put their dates in an attribute not in this list,\n use the log - date Remapper Processor to define their date attribute as the official log - timestamp.\n The recognized date formats are ISO8601, UNIX (the milliseconds - EPOCH format), and RFC3164.\n\n **Note:** If your logs don\u2019t contain - any of the default attributes\n and you haven\u2019t defined your own date - attribute, Datadog timestamps\n the logs with the date it received them.\n\n - \ If multiple log date remapper processors can be applied to a given log,\n - \ only the first one (according to the pipelines order) is taken into account." + description: |- + As Datadog receives logs, it timestamps them using the value(s) from any of these default attributes. + + - `timestamp` + - `date` + - `_timestamp` + - `Timestamp` + - `eventTime` + - `published_date` + + If your logs put their dates in an attribute not in this list, + use the log date Remapper Processor to define their date attribute as the official log timestamp. + The recognized date formats are ISO8601, UNIX (the milliseconds EPOCH format), and RFC3164. + + **Note:** If your logs don’t contain any of the default attributes + and you haven’t defined your own date attribute, Datadog timestamps + the logs with the date it received them. + + If multiple log date remapper processors can be applied to a given log, + only the first one (according to the pipelines order) is taken into account. properties: is_enabled: default: false @@ -5979,41 +5591,36 @@ components: type: string sources: description: Array of source attributes. - example: - - web - - gateway + example: ["web", "gateway"] items: description: Attribute used as a source to define the log associated date. type: string type: array type: - $ref: '#/components/schemas/LogsDateRemapperType' + $ref: "#/components/schemas/LogsDateRemapperType" required: - - sources - - type + - sources + - type type: object LogsDateRemapperType: default: date-remapper description: Type of logs date remapper. enum: - - date-remapper + - date-remapper example: date-remapper type: string x-enum-varnames: - - DATE_REMAPPER + - DATE_REMAPPER LogsDecoderProcessor: - description: 'The decoder processor decodes any source attribute containing - a - - base64/base16-encoded UTF-8/ASCII string back to its original value, storing - the - - result in a target attribute.' + description: |- + The decoder processor decodes any source attribute containing a + base64/base16-encoded UTF-8/ASCII string back to its original value, storing the + result in a target attribute. properties: binary_to_text_encoding: - $ref: '#/components/schemas/LogsDecoderProcessorBinaryToTextEncoding' + $ref: "#/components/schemas/LogsDecoderProcessorBinaryToTextEncoding" input_representation: - $ref: '#/components/schemas/LogsDecoderProcessorInputRepresentation' + $ref: "#/components/schemas/LogsDecoderProcessorInputRepresentation" is_enabled: default: false description: Whether the processor is enabled. @@ -6030,49 +5637,48 @@ components: example: decoded.field type: string type: - $ref: '#/components/schemas/LogsDecoderProcessorType' + $ref: "#/components/schemas/LogsDecoderProcessorType" required: - - source - - target - - binary_to_text_encoding - - input_representation - - type + - source + - target + - binary_to_text_encoding + - input_representation + - type type: object LogsDecoderProcessorBinaryToTextEncoding: description: The encoding used to represent the binary data. enum: - - base64 - - base16 + - base64 + - base16 example: base64 type: string x-enum-varnames: - - BASE64 - - BASE16 + - BASE64 + - BASE16 LogsDecoderProcessorInputRepresentation: description: The original representation of input string. enum: - - utf_8 - - integer + - utf_8 + - integer example: utf_8 type: string x-enum-varnames: - - UTF_8 - - INTEGER + - UTF_8 + - INTEGER LogsDecoderProcessorType: default: decoder-processor description: Type of logs decoder processor. enum: - - decoder-processor + - decoder-processor example: decoder-processor type: string x-enum-varnames: - - DECODER_PROCESSOR + - DECODER_PROCESSOR LogsExclusion: - description: Represents the index exclusion filter object from configuration - API. + description: Represents the index exclusion filter object from configuration API. properties: filter: - $ref: '#/components/schemas/LogsExclusionFilter' + $ref: "#/components/schemas/LogsExclusionFilter" is_enabled: description: Whether or not the exclusion filter is active. type: boolean @@ -6081,29 +5687,26 @@ components: example: payment type: string required: - - name + - name type: object LogsExclusionFilter: - description: Exclusion filter is defined by a query, a sampling rule, and a - active/inactive toggle. + description: Exclusion filter is defined by a query, a sampling rule, and a active/inactive toggle. properties: query: - description: 'Default query is `*`, meaning all logs flowing in the index - would be excluded. - - Scope down exclusion filter to only a subset of logs with a log query.' - example: '*' + description: |- + Default query is `*`, meaning all logs flowing in the index would be excluded. + Scope down exclusion filter to only a subset of logs with a log query. + example: "*" type: string sample_rate: - description: 'Sample rate to apply to logs going through this exclusion - filter, - - a value of 1.0 excludes all logs matching the query.' + description: |- + Sample rate to apply to logs going through this exclusion filter, + a value of 1.0 excludes all logs matching the query. example: 1.0 format: double type: number required: - - sample_rate + - sample_rate type: object LogsFilter: description: Filter for logs. @@ -6114,11 +5717,9 @@ components: type: string type: object LogsGeoIPParser: - description: 'The GeoIP parser takes an IP address attribute and extracts if - available - - the Continent, Country, Subdivision, and City information in the target attribute - path.' + description: |- + The GeoIP parser takes an IP address attribute and extracts if available + the Continent, Country, Subdivision, and City information in the target attribute path. properties: is_enabled: default: false @@ -6128,45 +5729,41 @@ components: description: Name of the processor. type: string sources: - default: - - network.client.ip + default: ["network.client.ip"] description: Array of source attributes. - example: - - network.client.ip + example: ["network.client.ip"] items: description: Attribute to geo-localize the IP from. type: string type: array target: default: network.client.geoip - description: Name of the parent attribute that contains all the extracted - details from the `sources`. + description: Name of the parent attribute that contains all the extracted details from the `sources`. example: network.client.geoip type: string type: - $ref: '#/components/schemas/LogsGeoIPParserType' + $ref: "#/components/schemas/LogsGeoIPParserType" required: - - sources - - target - - type + - sources + - target + - type type: object LogsGeoIPParserType: default: geo-ip-parser description: Type of GeoIP parser. enum: - - geo-ip-parser + - geo-ip-parser example: geo-ip-parser type: string x-enum-varnames: - - GEO_IP_PARSER + - GEO_IP_PARSER LogsGrokParser: - description: 'Create custom grok rules to parse the full message or [a specific - attribute of your raw event](https://docs.datadoghq.com/logs/log_configuration/parsing/#advanced-settings). - - For more information, see the [parsing section](https://docs.datadoghq.com/logs/log_configuration/parsing).' + description: |- + Create custom grok rules to parse the full message or [a specific attribute of your raw event](https://docs.datadoghq.com/logs/log_configuration/parsing/#advanced-settings). + For more information, see the [parsing section](https://docs.datadoghq.com/logs/log_configuration/parsing). properties: grok: - $ref: '#/components/schemas/LogsGrokParserRules' + $ref: "#/components/schemas/LogsGrokParserRules" is_enabled: default: false description: Whether or not the processor is enabled. @@ -6188,123 +5785,104 @@ components: example: message type: string type: - $ref: '#/components/schemas/LogsGrokParserType' + $ref: "#/components/schemas/LogsGrokParserType" required: - - source - - grok - - type + - source + - grok + - type type: object LogsGrokParserRules: description: Set of rules for the grok parser. properties: match_rules: - description: List of match rules for the grok parser, separated by a new - line. - example: 'rule_name_1 foo - - rule_name_2 bar' + description: List of match rules for the grok parser, separated by a new line. + example: |- + rule_name_1 foo + rule_name_2 bar type: string support_rules: - default: '' - description: List of support rules for the grok parser, separated by a new - line. - example: 'rule_name_1 foo - - rule_name_2 bar' + default: "" + description: List of support rules for the grok parser, separated by a new line. + example: |- + rule_name_1 foo + rule_name_2 bar type: string required: - - match_rules + - match_rules type: object LogsGrokParserType: default: grok-parser description: Type of logs grok parser. enum: - - grok-parser + - grok-parser example: grok-parser type: string x-enum-varnames: - - GROK_PARSER + - GROK_PARSER LogsIndex: description: Object describing a Datadog Log index. properties: daily_limit: - description: The number of log events you can send in this index per day - before you are rate-limited. + description: The number of log events you can send in this index per day before you are rate-limited. example: 300000000 format: int64 type: integer daily_limit_reset: - $ref: '#/components/schemas/LogsDailyLimitReset' + $ref: "#/components/schemas/LogsDailyLimitReset" daily_limit_warning_threshold_percentage: - description: A percentage threshold of the daily quota at which a Datadog - warning event is generated. + description: A percentage threshold of the daily quota at which a Datadog warning event is generated. example: 70 format: double maximum: 99.99 minimum: 50 type: number exclusion_filters: - description: 'An array of exclusion objects. The logs are tested against - the query of each filter, - - following the order of the array. Only the first matching active exclusion - matters, - - others (if any) are ignored.' + description: |- + An array of exclusion objects. The logs are tested against the query of each filter, + following the order of the array. Only the first matching active exclusion matters, + others (if any) are ignored. items: - $ref: '#/components/schemas/LogsExclusion' + $ref: "#/components/schemas/LogsExclusion" type: array filter: - $ref: '#/components/schemas/LogsFilter' + $ref: "#/components/schemas/LogsFilter" is_rate_limited: - description: 'A boolean stating if the index is rate limited, meaning more - logs than the daily limit have been sent. - - Rate limit is reset every-day at 2pm UTC.' + description: |- + A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent. + Rate limit is reset every-day at 2pm UTC. example: false readOnly: true type: boolean name: description: The name of the index. - example: main + example: "main" type: string num_flex_logs_retention_days: - description: 'The total number of days logs are stored in Standard and Flex - Tier before being deleted from the index. - - If Standard Tier is enabled on this index, logs are first retained in - Standard Tier for the number of days specified through `num_retention_days`, - - and then stored in Flex Tier until the number of days specified in `num_flex_logs_retention_days` - is reached. - - The available values depend on retention plans specified in your organization''s - contract/subscriptions.' + description: |- + The total number of days logs are stored in Standard and Flex Tier before being deleted from the index. + If Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through `num_retention_days`, + and then stored in Flex Tier until the number of days specified in `num_flex_logs_retention_days` is reached. + The available values depend on retention plans specified in your organization's contract/subscriptions. example: 360 format: int64 type: integer num_retention_days: - description: 'The number of days logs are stored in Standard Tier before - aging into the Flex Tier or being deleted from the index. - - The available values depend on retention plans specified in your organization''s - contract/subscriptions.' + description: |- + The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index. + The available values depend on retention plans specified in your organization's contract/subscriptions. example: 15 format: int64 type: integer tags: - description: A list of tags associated with the index. Tags must be in `key:value` - format. - example: - - team:backend - - env:production + description: A list of tags associated with the index. Tags must be in `key:value` format. + example: ["team:backend", "env:production"] items: description: A single tag using the format `key:value`. type: string type: array required: - - name - - filter + - name + - filter type: object LogsIndexListResponse: description: Object with all Index configurations for a given organization. @@ -6312,129 +5890,97 @@ components: indexes: description: Array of Log index configurations. items: - $ref: '#/components/schemas/LogsIndex' + $ref: "#/components/schemas/LogsIndex" type: array type: object LogsIndexUpdateRequest: description: Object for updating a Datadog Log index. properties: daily_limit: - description: The number of log events you can send in this index per day - before you are rate-limited. + description: The number of log events you can send in this index per day before you are rate-limited. example: 300000000 format: int64 type: integer daily_limit_reset: - $ref: '#/components/schemas/LogsDailyLimitReset' + $ref: "#/components/schemas/LogsDailyLimitReset" daily_limit_warning_threshold_percentage: - description: A percentage threshold of the daily quota at which a Datadog - warning event is generated. + description: A percentage threshold of the daily quota at which a Datadog warning event is generated. example: 70 format: double maximum: 99.99 minimum: 50 type: number disable_daily_limit: - description: 'If true, sets the `daily_limit` value to null and the index - is not limited on a daily basis (any - - specified `daily_limit` value in the request is ignored). If false or - omitted, the index''s current - - `daily_limit` is maintained.' + description: |- + If true, sets the `daily_limit` value to null and the index is not limited on a daily basis (any + specified `daily_limit` value in the request is ignored). If false or omitted, the index's current + `daily_limit` is maintained. example: false type: boolean exclusion_filters: - description: 'An array of exclusion objects. The logs are tested against - the query of each filter, - - following the order of the array. Only the first matching active exclusion - matters, - - others (if any) are ignored.' + description: |- + An array of exclusion objects. The logs are tested against the query of each filter, + following the order of the array. Only the first matching active exclusion matters, + others (if any) are ignored. items: - $ref: '#/components/schemas/LogsExclusion' + $ref: "#/components/schemas/LogsExclusion" type: array filter: - $ref: '#/components/schemas/LogsFilter' + $ref: "#/components/schemas/LogsFilter" num_flex_logs_retention_days: - description: 'The total number of days logs are stored in Standard and Flex - Tier before being deleted from the index. - - If Standard Tier is enabled on this index, logs are first retained in - Standard Tier for the number of days specified through `num_retention_days`, - - and then stored in Flex Tier until the number of days specified in `num_flex_logs_retention_days` - is reached. + description: |- + The total number of days logs are stored in Standard and Flex Tier before being deleted from the index. + If Standard Tier is enabled on this index, logs are first retained in Standard Tier for the number of days specified through `num_retention_days`, + and then stored in Flex Tier until the number of days specified in `num_flex_logs_retention_days` is reached. + The available values depend on retention plans specified in your organization's contract/subscriptions. - The available values depend on retention plans specified in your organization''s - contract/subscriptions. - - - **Note**: Changing this value affects all logs already in this index. - It may also affect billing.' + **Note**: Changing this value affects all logs already in this index. It may also affect billing. example: 360 format: int64 type: integer num_retention_days: - description: 'The number of days logs are stored in Standard Tier before - aging into the Flex Tier or being deleted from the index. - - The available values depend on retention plans specified in your organization''s - contract/subscriptions. - + description: |- + The number of days logs are stored in Standard Tier before aging into the Flex Tier or being deleted from the index. + The available values depend on retention plans specified in your organization's contract/subscriptions. - **Note**: Changing this value affects all logs already in this index. - It may also affect billing.' + **Note**: Changing this value affects all logs already in this index. It may also affect billing. example: 15 format: int64 type: integer tags: - description: A list of tags associated with the index. Tags must be in `key:value` - format. - example: - - team:backend - - env:production + description: A list of tags associated with the index. Tags must be in `key:value` format. + example: ["team:backend", "env:production"] items: description: A single tag using the format `key:value`. type: string type: array required: - - filter + - filter type: object LogsIndexesOrder: description: Object containing the ordered list of log index names. properties: index_names: - description: 'Array of strings identifying by their name(s) the index(es) - of your organization. - - Logs are tested against the query filter of each index one by one, following - the order of the array. - - Logs are eventually stored in the first matching index.' - example: - - main - - payments - - web + description: |- + Array of strings identifying by their name(s) the index(es) of your organization. + Logs are tested against the query filter of each index one by one, following the order of the array. + Logs are eventually stored in the first matching index. + example: ["main", "payments", "web"] items: description: An index name. type: string type: array required: - - index_names + - index_names type: object LogsListRequest: - description: Object to send with the request to retrieve a list of logs from - your Organization. + description: Object to send with the request to retrieve a list of logs from your Organization. properties: index: - description: 'The log index on which the request is performed. For multi-index - organizations, - - the default is all live indexes. Historical indexes of rehydrated logs - must be specified.' - example: retention-3,retention-15 + description: |- + The log index on which the request is performed. For multi-index organizations, + the default is all live indexes. Historical indexes of rehydrated logs must be specified. + example: "retention-3,retention-15" type: string limit: description: Number of logs return in the response. @@ -6443,61 +5989,57 @@ components: type: integer query: description: The search query - following the log search syntax. - example: service:web* AND @http.status_code:[200 TO 299] + example: "service:web* AND @http.status_code:[200 TO 299]" type: string sort: - $ref: '#/components/schemas/LogsSort' + $ref: "#/components/schemas/LogsSort" startAt: - description: 'Hash identifier of the first log to return in the list, available - in a log `id` attribute. - + description: |- + Hash identifier of the first log to return in the list, available in a log `id` attribute. This parameter is used for the pagination feature. - **Note**: This parameter is ignored if the corresponding log - - is out of the scope of the specified time window.' + is out of the scope of the specified time window. type: string time: - $ref: '#/components/schemas/LogsListRequestTime' + $ref: "#/components/schemas/LogsListRequestTime" required: - - time + - time type: object LogsListRequestTime: description: Timeframe to retrieve the log from. properties: from: description: Minimum timestamp for requested logs. - example: '2020-02-02T02:02:02.202Z' + example: "2020-02-02T02:02:02.202Z" format: date-time type: string timezone: - description: 'Timezone can be specified both as an offset (for example "UTC+03:00") - - or a regional zone (for example "Europe/Paris").' + description: |- + Timezone can be specified both as an offset (for example "UTC+03:00") + or a regional zone (for example "Europe/Paris"). type: string to: description: Maximum timestamp for requested logs. - example: '2020-02-20T02:02:02.202Z' + example: "2020-02-20T02:02:02.202Z" format: date-time type: string required: - - from - - to + - from + - to type: object LogsListResponse: - description: Response object with all logs matching the request and pagination - information. + description: Response object with all logs matching the request and pagination information. properties: logs: description: Array of logs matching the request and the `nextLogId` if sent. items: - $ref: '#/components/schemas/Log' + $ref: "#/components/schemas/Log" type: array nextLogId: - description: 'Hash identifier of the next log to return in the list. - - This parameter is used for the pagination feature.' + description: |- + Hash identifier of the next log to return in the list. + This parameter is used for the pagination feature. nullable: true type: string status: @@ -6505,38 +6047,28 @@ components: type: string type: object LogsLookupProcessor: - description: 'Use the Lookup Processor to define a mapping between a log attribute - + description: |- + Use the Lookup Processor to define a mapping between a log attribute and a human readable value saved in the processors mapping table. - For example, you can use the Lookup Processor to map an internal service ID - - into a human readable service name. Alternatively, you could also use it to - check - + into a human readable service name. Alternatively, you could also use it to check if the MAC address that just attempted to connect to the production - - environment belongs to your list of stolen machines.' + environment belongs to your list of stolen machines. properties: default_lookup: - description: Value to set the target attribute if the source value is not - found in the list. + description: Value to set the target attribute if the source value is not found in the list. type: string is_enabled: default: false description: Whether or not the processor is enabled. type: boolean lookup_table: - description: 'Mapping table of values for the source attribute and their - associated target attribute values, - - formatted as `["source_key1,target_value1", "source_key2,target_value2"]`' - example: - - source_key1,target_value1 - - source_key2,target_value2 + description: |- + Mapping table of values for the source attribute and their associated target attribute values, + formatted as `["source_key1,target_value1", "source_key2,target_value2"]` + example: ["source_key1,target_value1", "source_key2,target_value2"] items: - description: Mapping between a source and a value, it should follow the - format `","`. + description: Mapping between a source and a value, it should follow the format `","`. type: string type: array name: @@ -6547,42 +6079,36 @@ components: example: service_id type: string target: - description: 'Name of the attribute that contains the corresponding value - in the mapping list - - or the `default_lookup` if not found in the mapping list.' + description: |- + Name of the attribute that contains the corresponding value in the mapping list + or the `default_lookup` if not found in the mapping list. example: service type: string type: - $ref: '#/components/schemas/LogsLookupProcessorType' + $ref: "#/components/schemas/LogsLookupProcessorType" required: - - source - - target - - lookup_table - - type + - source + - target + - lookup_table + - type type: object LogsLookupProcessorType: default: lookup-processor description: Type of logs lookup processor. enum: - - lookup-processor + - lookup-processor example: lookup-processor type: string x-enum-varnames: - - LOOKUP_PROCESSOR + - LOOKUP_PROCESSOR LogsMessageRemapper: - description: 'The message is a key attribute in Datadog. - - It is displayed in the message column of the Log Explorer and you can do full - string search on it. - + description: |- + The message is a key attribute in Datadog. + It is displayed in the message column of the Log Explorer and you can do full string search on it. Use this Processor to define one or more attributes as the official log message. - - **Note:** If multiple log message remapper processors can be applied to a - given log, - - only the first one (according to the pipeline order) is taken into account.' + **Note:** If multiple log message remapper processors can be applied to a given log, + only the first one (according to the pipeline order) is taken into account. properties: is_enabled: default: false @@ -6592,45 +6118,41 @@ components: description: Name of the processor. type: string sources: - default: - - msg + default: ["msg"] description: Array of source attributes. - example: - - msg + example: ["msg"] items: description: Attribute used as a source to define the log associated message. type: string type: array type: - $ref: '#/components/schemas/LogsMessageRemapperType' + $ref: "#/components/schemas/LogsMessageRemapperType" required: - - sources - - type + - sources + - type type: object LogsMessageRemapperType: default: message-remapper description: Type of logs message remapper. enum: - - message-remapper + - message-remapper example: message-remapper type: string x-enum-varnames: - - MESSAGE_REMAPPER + - MESSAGE_REMAPPER LogsPipeline: - description: 'Pipelines and processors operate on incoming logs, - + description: |- + Pipelines and processors operate on incoming logs, parsing and transforming them into structured attributes for easier querying. - **Note**: These endpoints are only available for admin users. - - Make sure to use an application key created by an admin.' + Make sure to use an application key created by an admin. properties: description: description: A description of the pipeline. type: string filter: - $ref: '#/components/schemas/LogsFilter' + $ref: "#/components/schemas/LogsFilter" id: description: ID of the pipeline. readOnly: true @@ -6644,12 +6166,12 @@ components: type: boolean name: description: Name of the pipeline. - example: '' + example: "" type: string processors: description: Ordered list of processors in this pipeline. items: - $ref: '#/components/schemas/LogsProcessor' + $ref: "#/components/schemas/LogsProcessor" type: array tags: description: A list of tags associated with the pipeline. @@ -6663,28 +6185,23 @@ components: readOnly: true type: string required: - - name + - name type: object LogsPipelineList: description: Array of all log pipeline objects configured for the organization. items: - $ref: '#/components/schemas/LogsPipeline' + $ref: "#/components/schemas/LogsPipeline" type: array LogsPipelineProcessor: - description: 'Nested Pipelines are pipelines within a pipeline. Use Nested Pipelines - to split the processing into two steps. - - For example, first use a high-level filtering such as team and then a second - level of filtering based on the - + description: |- + Nested Pipelines are pipelines within a pipeline. Use Nested Pipelines to split the processing into two steps. + For example, first use a high-level filtering such as team and then a second level of filtering based on the integration, service, or any other tag or attribute. - - A pipeline can contain Nested Pipelines and Processors whereas a Nested Pipeline - can only contain Processors.' + A pipeline can contain Nested Pipelines and Processors whereas a Nested Pipeline can only contain Processors. properties: filter: - $ref: '#/components/schemas/LogsFilter' + $ref: "#/components/schemas/LogsFilter" is_enabled: default: false description: Whether or not the processor is enabled. @@ -6695,64 +6212,60 @@ components: processors: description: Ordered list of processors in this pipeline. items: - $ref: '#/components/schemas/LogsProcessor' + $ref: "#/components/schemas/LogsProcessor" type: array type: - $ref: '#/components/schemas/LogsPipelineProcessorType' + $ref: "#/components/schemas/LogsPipelineProcessorType" required: - - type + - type type: object LogsPipelineProcessorType: default: pipeline description: Type of logs pipeline processor. enum: - - pipeline + - pipeline example: pipeline type: string x-enum-varnames: - - PIPELINE + - PIPELINE LogsPipelinesOrder: description: Object containing the ordered list of pipeline IDs. properties: pipeline_ids: - description: 'Ordered Array of `` strings, the order of pipeline - IDs in the array - - define the overall Pipelines order for Datadog.' - example: - - tags - - org_ids - - products + description: |- + Ordered Array of `` strings, the order of pipeline IDs in the array + define the overall Pipelines order for Datadog. + example: ["tags", "org_ids", "products"] items: description: A given pipeline ID. type: string type: array required: - - pipeline_ids + - pipeline_ids type: object LogsProcessor: description: Definition of a logs processor. oneOf: - - $ref: '#/components/schemas/LogsGrokParser' - - $ref: '#/components/schemas/LogsDateRemapper' - - $ref: '#/components/schemas/LogsStatusRemapper' - - $ref: '#/components/schemas/LogsServiceRemapper' - - $ref: '#/components/schemas/LogsMessageRemapper' - - $ref: '#/components/schemas/LogsAttributeRemapper' - - $ref: '#/components/schemas/LogsURLParser' - - $ref: '#/components/schemas/LogsUserAgentParser' - - $ref: '#/components/schemas/LogsCategoryProcessor' - - $ref: '#/components/schemas/LogsArithmeticProcessor' - - $ref: '#/components/schemas/LogsStringBuilderProcessor' - - $ref: '#/components/schemas/LogsPipelineProcessor' - - $ref: '#/components/schemas/LogsGeoIPParser' - - $ref: '#/components/schemas/LogsLookupProcessor' - - $ref: '#/components/schemas/ReferenceTableLogsLookupProcessor' - - $ref: '#/components/schemas/LogsTraceRemapper' - - $ref: '#/components/schemas/LogsSpanRemapper' - - $ref: '#/components/schemas/LogsArrayProcessor' - - $ref: '#/components/schemas/LogsDecoderProcessor' - - $ref: '#/components/schemas/LogsSchemaProcessor' + - $ref: "#/components/schemas/LogsGrokParser" + - $ref: "#/components/schemas/LogsDateRemapper" + - $ref: "#/components/schemas/LogsStatusRemapper" + - $ref: "#/components/schemas/LogsServiceRemapper" + - $ref: "#/components/schemas/LogsMessageRemapper" + - $ref: "#/components/schemas/LogsAttributeRemapper" + - $ref: "#/components/schemas/LogsURLParser" + - $ref: "#/components/schemas/LogsUserAgentParser" + - $ref: "#/components/schemas/LogsCategoryProcessor" + - $ref: "#/components/schemas/LogsArithmeticProcessor" + - $ref: "#/components/schemas/LogsStringBuilderProcessor" + - $ref: "#/components/schemas/LogsPipelineProcessor" + - $ref: "#/components/schemas/LogsGeoIPParser" + - $ref: "#/components/schemas/LogsLookupProcessor" + - $ref: "#/components/schemas/ReferenceTableLogsLookupProcessor" + - $ref: "#/components/schemas/LogsTraceRemapper" + - $ref: "#/components/schemas/LogsSpanRemapper" + - $ref: "#/components/schemas/LogsArrayProcessor" + - $ref: "#/components/schemas/LogsDecoderProcessor" + - $ref: "#/components/schemas/LogsSchemaProcessor" LogsQueryCompute: description: Define computation for a log query. properties: @@ -6762,7 +6275,7 @@ components: type: string facet: description: Facet name. - example: '@duration' + example: "@duration" type: string interval: description: Define a time interval in seconds. @@ -6770,11 +6283,10 @@ components: format: int64 type: integer required: - - aggregation + - aggregation type: object LogsRetentionAggSumUsage: - description: Object containing indexed logs usage aggregated across organizations - and months for a retention period. + description: Object containing indexed logs usage aggregated across organizations and months for a retention period. properties: logs_indexed_logs_usage_agg_sum: description: Total indexed logs for this retention period. @@ -6789,13 +6301,11 @@ components: format: int64 type: integer retention: - description: The retention period in days or "custom" for all custom retention - periods. + description: The retention period in days or "custom" for all custom retention periods. type: string type: object LogsRetentionSumUsage: - description: Object containing indexed logs usage grouped by retention period - and summed. + description: Object containing indexed logs usage grouped by retention period and summed. properties: logs_indexed_logs_usage_sum: description: Total indexed logs for this retention period. @@ -6810,63 +6320,62 @@ components: format: int64 type: integer retention: - description: The retention period in days or "custom" for all custom retention - periods. + description: The retention period in days or "custom" for all custom retention periods. type: string type: object LogsSchemaCategoryMapper: - description: "Use the Schema Category Mapper to categorize log event into enum - fields.\nIn the case of OCSF, they can be used to map sibling fields which - are composed of an ID and a name.\n\n**Notes**:\n\n- The syntax of the query - is the one of Logs Explorer search bar.\n The query can be done on any log - attribute or tag, whether it is a facet or not.\n Wildcards can also be used - inside your query.\n- Categories are executed in order and processing stops - at the first match.\n Make sure categories are properly ordered in case a - log could match multiple queries.\n- Sibling fields always have a numerical - ID field and a human-readable string name.\n- A fallback section handles cases - where the name or ID value matches a specific value.\n If the name matches - \"Other\" or the ID matches 99, the value of the sibling name field will be - pulled from a source field from the original log." + description: |- + Use the Schema Category Mapper to categorize log event into enum fields. + In the case of OCSF, they can be used to map sibling fields which are composed of an ID and a name. + + **Notes**: + + - The syntax of the query is the one of Logs Explorer search bar. + The query can be done on any log attribute or tag, whether it is a facet or not. + Wildcards can also be used inside your query. + - Categories are executed in order and processing stops at the first match. + Make sure categories are properly ordered in case a log could match multiple queries. + - Sibling fields always have a numerical ID field and a human-readable string name. + - A fallback section handles cases where the name or ID value matches a specific value. + If the name matches "Other" or the ID matches 99, the value of the sibling name field will be pulled from a source field from the original log. properties: categories: - description: 'Array of filters to match or not a log and their - - corresponding `name` to assign a custom value to the log.' + description: |- + Array of filters to match or not a log and their + corresponding `name` to assign a custom value to the log. example: - - filter: - query: '@eventName:(ConsoleLogin OR ExternalIdPDirectoryLogin OR UserAuthentication - OR Authenticate)' - id: 1 - name: Logon - - filter: - query: '@eventName:*' - id: 99 - name: Other - items: - $ref: '#/components/schemas/LogsSchemaCategoryMapperCategory' + - filter: + query: "@eventName:(ConsoleLogin OR ExternalIdPDirectoryLogin OR UserAuthentication OR Authenticate)" + id: 1 + name: "Logon" + - filter: + query: "@eventName:*" + id: 99 + name: "Other" + items: + $ref: "#/components/schemas/LogsSchemaCategoryMapperCategory" type: array fallback: - $ref: '#/components/schemas/LogsSchemaCategoryMapperFallback' + $ref: "#/components/schemas/LogsSchemaCategoryMapperFallback" name: description: Name of the logs schema category mapper. - example: activity_id and activity_name + example: "activity_id and activity_name" type: string targets: - $ref: '#/components/schemas/LogsSchemaCategoryMapperTargets' + $ref: "#/components/schemas/LogsSchemaCategoryMapperTargets" type: - $ref: '#/components/schemas/LogsSchemaCategoryMapperType' + $ref: "#/components/schemas/LogsSchemaCategoryMapperType" required: - - categories - - targets - - type - - name + - categories + - targets + - type + - name type: object LogsSchemaCategoryMapperCategory: - description: Object describing the logs filter with corresponding category ID - and name assignment. + description: Object describing the logs filter with corresponding category ID and name assignment. properties: filter: - $ref: '#/components/schemas/LogsFilter' + $ref: "#/components/schemas/LogsFilter" id: description: ID to inject into the category. example: 1 @@ -6874,16 +6383,15 @@ components: type: integer name: description: Value to assign to target schema field. - example: Password Change + example: "Password Change" type: string required: - - filter - - id - - name + - filter + - id + - name type: object LogsSchemaCategoryMapperFallback: - description: Used to override hardcoded category values with a value pulled - from a source attribute on the log. + description: Used to override hardcoded category values with a value pulled from a source attribute on the log. properties: sources: additionalProperties: @@ -6901,8 +6409,7 @@ components: type: object type: object LogsSchemaCategoryMapperTargets: - description: Name of the target attributes which value is defined by the matching - category. + description: Name of the target attributes which value is defined by the matching category. properties: id: description: ID of the field to map log attributes to. @@ -6916,11 +6423,11 @@ components: LogsSchemaCategoryMapperType: description: Type of logs schema category mapper. enum: - - schema-category-mapper + - schema-category-mapper example: schema-category-mapper type: string x-enum-varnames: - - SCHEMA_CATEGORY_MAPPER + - SCHEMA_CATEGORY_MAPPER LogsSchemaData: description: Configuration of the schema data to use. properties: @@ -6935,9 +6442,7 @@ components: type: integer profiles: description: Optional list of profiles to modify the schema. - example: - - security_control - - host + example: ["security_control", "host"] items: type: string type: array @@ -6950,19 +6455,19 @@ components: example: 1.5.0 type: string required: - - schema_type - - version - - class_uid - - class_name + - schema_type + - version + - class_uid + - class_name type: object LogsSchemaMapper: description: Configuration of the schema processor mapper to use. oneOf: - - $ref: '#/components/schemas/LogsSchemaRemapper' - - $ref: '#/components/schemas/LogsSchemaCategoryMapper' + - $ref: "#/components/schemas/LogsSchemaRemapper" + - $ref: "#/components/schemas/LogsSchemaCategoryMapper" LogsSchemaProcessor: - description: A processor that has additional validations and checks for a given - schema. Currently supported schema types include OCSF. + description: |- + A processor that has additional validations and checks for a given schema. Currently supported schema types include OCSF. properties: is_enabled: default: false @@ -6971,44 +6476,43 @@ components: mappers: description: The `LogsSchemaProcessor` `mappers`. example: - - name: Map userIdentity to ocsf.user.uid - sources: - - userIdentity.principalId - target: ocsf.user.uid - type: schema-remapper + - name: Map userIdentity to ocsf.user.uid + sources: + - userIdentity.principalId + target: ocsf.user.uid + type: schema-remapper items: - $ref: '#/components/schemas/LogsSchemaMapper' + $ref: "#/components/schemas/LogsSchemaMapper" type: array name: description: Name of the processor. - example: Map additionalEventData.LoginTo to ocsf.dst_endpoint.svc_name + example: "Map additionalEventData.LoginTo to ocsf.dst_endpoint.svc_name" type: string schema: - $ref: '#/components/schemas/LogsSchemaData' + $ref: "#/components/schemas/LogsSchemaData" type: - $ref: '#/components/schemas/LogsSchemaProcessorType' + $ref: "#/components/schemas/LogsSchemaProcessorType" required: - - name - - mappers - - type - - schema + - name + - mappers + - type + - schema type: object LogsSchemaProcessorType: default: schema-processor description: Type of logs schema processor. enum: - - schema-processor + - schema-processor example: schema-processor type: string x-enum-varnames: - - SCHEMA_PROCESSOR + - SCHEMA_PROCESSOR LogsSchemaRemapper: description: The schema remapper maps source log fields to their correct fields. properties: name: description: Name of the logs schema remapper. - example: Map userIdentity.principalId, responseElements.role.roleId, responseElements.user.userId - to ocsf.user.uid + example: "Map userIdentity.principalId, responseElements.role.roleId, responseElements.user.userId to ocsf.user.uid" type: string override_on_conflict: default: false @@ -7020,13 +6524,9 @@ components: type: boolean sources: description: Array of source attributes. - example: - - userIdentity.principalId - - responseElements.role.roleId - - responseElements.user.userId + example: ["userIdentity.principalId", "responseElements.role.roleId", "responseElements.user.userId"] items: - description: Attribute used as a source to remap its value to the target - attribute. + description: Attribute used as a source to remap its value to the target attribute. type: string type: array target: @@ -7034,32 +6534,29 @@ components: example: ocsf.user.uid type: string target_format: - $ref: '#/components/schemas/TargetFormatType' + $ref: "#/components/schemas/TargetFormatType" type: - $ref: '#/components/schemas/LogsSchemaRemapperType' + $ref: "#/components/schemas/LogsSchemaRemapperType" required: - - name - - sources - - target - - type + - name + - sources + - target + - type type: object LogsSchemaRemapperType: description: Type of logs schema remapper. enum: - - schema-remapper + - schema-remapper example: schema-remapper type: string x-enum-varnames: - - SCHEMA_REMAPPER + - SCHEMA_REMAPPER LogsServiceRemapper: - description: 'Use this processor if you want to assign one or more attributes - as the official service. - + description: |- + Use this processor if you want to assign one or more attributes as the official service. - **Note:** If multiple service remapper processors can be applied to a given - log, - - only the first one (according to the pipeline order) is taken into account.' + **Note:** If multiple service remapper processors can be applied to a given log, + only the first one (according to the pipeline order) is taken into account. properties: is_enabled: default: false @@ -7070,44 +6567,43 @@ components: type: string sources: description: Array of source attributes. - example: - - web - - gateway + example: ["web", "gateway"] items: description: Attribute used as a source to define the log associated service. type: string type: array type: - $ref: '#/components/schemas/LogsServiceRemapperType' + $ref: "#/components/schemas/LogsServiceRemapperType" required: - - sources - - type + - sources + - type type: object LogsServiceRemapperType: default: service-remapper description: Type of logs service remapper. enum: - - service-remapper + - service-remapper example: service-remapper type: string x-enum-varnames: - - SERVICE_REMAPPER + - SERVICE_REMAPPER LogsSort: description: Time-ascending `asc` or time-descending `desc` results. enum: - - asc - - desc + - asc + - desc type: string x-enum-varnames: - - TIME_ASCENDING - - TIME_DESCENDING + - TIME_ASCENDING + - TIME_DESCENDING LogsSpanRemapper: - description: "There are two ways to define correlation between application spans - and logs:\n\n 1. Follow the documentation on [how to inject a span ID in - the application logs](https://docs.datadoghq.com/tracing/connect_logs_and_traces).\n - \ Log integrations automatically handle all remaining setup steps by default.\n\n - \ 2. Use the span remapper processor to define a log attribute as its associated - span ID." + description: |- + There are two ways to define correlation between application spans and logs: + + 1. Follow the documentation on [how to inject a span ID in the application logs](https://docs.datadoghq.com/tracing/connect_logs_and_traces). + Log integrations automatically handle all remaining setup steps by default. + + 2. Use the span remapper processor to define a log attribute as its associated span ID. properties: is_enabled: default: false @@ -7117,42 +6613,46 @@ components: description: Name of the processor. type: string sources: - default: - - dd.span_id + default: ["dd.span_id"] description: Array of source attributes. items: description: Attribute to extract the span ID from. type: string type: array type: - $ref: '#/components/schemas/LogsSpanRemapperType' + $ref: "#/components/schemas/LogsSpanRemapperType" required: - - type + - type type: object LogsSpanRemapperType: default: span-id-remapper description: Type of logs span remapper. enum: - - span-id-remapper + - span-id-remapper example: span-id-remapper type: string x-enum-varnames: - - SPAN_ID_REMAPPER + - SPAN_ID_REMAPPER LogsStatusRemapper: - description: "Use this Processor if you want to assign some attributes as the - official status.\n\nEach incoming status value is mapped as follows.\n\n - - Integers from 0 to 7 map to the Syslog severity standards\n - Strings beginning - with `emerg` or f (case-insensitive) map to `emerg` (0)\n - Strings beginning - with `a` (case-insensitive) map to `alert` (1)\n - Strings beginning with - `c` (case-insensitive) map to `critical` (2)\n - Strings beginning with `err` - (case-insensitive) map to `error` (3)\n - Strings beginning with `w` (case-insensitive) - map to `warning` (4)\n - Strings beginning with `n` (case-insensitive) map - to `notice` (5)\n - Strings beginning with `i` (case-insensitive) map to - `info` (6)\n - Strings beginning with `d`, `trace` or `verbose` (case-insensitive) - map to `debug` (7)\n - Strings beginning with `o` or matching `OK` or `Success` - (case-insensitive) map to OK\n - All others map to `info` (6)\n\n **Note:** - If multiple log status remapper processors can be applied to a given log,\n - \ only the first one (according to the pipelines order) is taken into account." + description: |- + Use this Processor if you want to assign some attributes as the official status. + + Each incoming status value is mapped as follows. + + - Integers from 0 to 7 map to the Syslog severity standards + - Strings beginning with `emerg` or f (case-insensitive) map to `emerg` (0) + - Strings beginning with `a` (case-insensitive) map to `alert` (1) + - Strings beginning with `c` (case-insensitive) map to `critical` (2) + - Strings beginning with `err` (case-insensitive) map to `error` (3) + - Strings beginning with `w` (case-insensitive) map to `warning` (4) + - Strings beginning with `n` (case-insensitive) map to `notice` (5) + - Strings beginning with `i` (case-insensitive) map to `info` (6) + - Strings beginning with `d`, `trace` or `verbose` (case-insensitive) map to `debug` (7) + - Strings beginning with `o` or matching `OK` or `Success` (case-insensitive) map to OK + - All others map to `info` (6) + + **Note:** If multiple log status remapper processors can be applied to a given log, + only the first one (according to the pipelines order) is taken into account. properties: is_enabled: default: false @@ -7169,31 +6669,35 @@ components: type: string type: array type: - $ref: '#/components/schemas/LogsStatusRemapperType' + $ref: "#/components/schemas/LogsStatusRemapperType" required: - - sources - - type + - sources + - type type: object LogsStatusRemapperType: default: status-remapper description: Type of logs status remapper. enum: - - status-remapper + - status-remapper example: status-remapper type: string x-enum-varnames: - - STATUS_REMAPPER + - STATUS_REMAPPER LogsStringBuilderProcessor: - description: "Use the string builder processor to add a new attribute (without - spaces or special characters)\nto a log with the result of the provided template.\nThis - enables aggregation of different attributes or raw strings into a single attribute.\n\nThe - template is defined by both raw text and blocks with the syntax `%{attribute_path}`.\n\n**Notes**:\n\n- - The processor only accepts attributes with values or an array of values in - the blocks.\n- If an attribute cannot be used (object or array of object),\n - \ it is replaced by an empty string or the entire operation is skipped depending - on your selection.\n- If the target attribute already exists, it is overwritten - by the result of the template.\n- Results of the template cannot exceed 256 - characters." + description: |- + Use the string builder processor to add a new attribute (without spaces or special characters) + to a log with the result of the provided template. + This enables aggregation of different attributes or raw strings into a single attribute. + + The template is defined by both raw text and blocks with the syntax `%{attribute_path}`. + + **Notes**: + + - The processor only accepts attributes with values or an array of values in the blocks. + - If an attribute cannot be used (object or array of object), + it is replaced by an empty string or the entire operation is skipped depending on your selection. + - If the target attribute already exists, it is overwritten by the result of the template. + - Results of the template cannot exceed 256 characters. properties: is_enabled: default: false @@ -7201,45 +6705,45 @@ components: type: boolean is_replace_missing: default: false - description: 'If true, it replaces all missing attributes of `template` - by an empty string. - - If `false` (default), skips the operation for missing attributes.' + description: |- + If true, it replaces all missing attributes of `template` by an empty string. + If `false` (default), skips the operation for missing attributes. type: boolean name: description: Name of the processor. type: string target: description: The name of the attribute that contains the result of the template. - example: '' + example: "" type: string template: description: A formula with one or more attributes and raw text. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/LogsStringBuilderProcessorType' + $ref: "#/components/schemas/LogsStringBuilderProcessorType" required: - - target - - template - - type + - target + - template + - type type: object LogsStringBuilderProcessorType: default: string-builder-processor description: Type of logs string builder processor. enum: - - string-builder-processor + - string-builder-processor example: string-builder-processor type: string x-enum-varnames: - - STRING_BUILDER_PROCESSOR + - STRING_BUILDER_PROCESSOR LogsTraceRemapper: - description: "There are two ways to improve correlation between application - traces and logs.\n\n 1. Follow the documentation on [how to inject a trace - ID in the application logs](https://docs.datadoghq.com/tracing/connect_logs_and_traces)\n - \ and by default log integrations take care of all the rest of the setup.\n\n - \ 2. Use the Trace remapper processor to define a log attribute as its associated - trace ID." + description: |- + There are two ways to improve correlation between application traces and logs. + + 1. Follow the documentation on [how to inject a trace ID in the application logs](https://docs.datadoghq.com/tracing/connect_logs_and_traces) + and by default log integrations take care of all the rest of the setup. + + 2. Use the Trace remapper processor to define a log attribute as its associated trace ID. properties: is_enabled: default: false @@ -7249,30 +6753,28 @@ components: description: Name of the processor. type: string sources: - default: - - dd.trace_id + default: ["dd.trace_id"] description: Array of source attributes. items: description: Attribute to extract the trace ID from. type: string type: array type: - $ref: '#/components/schemas/LogsTraceRemapperType' + $ref: "#/components/schemas/LogsTraceRemapperType" required: - - type + - type type: object LogsTraceRemapperType: default: trace-id-remapper description: Type of logs trace remapper. enum: - - trace-id-remapper + - trace-id-remapper example: trace-id-remapper type: string x-enum-varnames: - - TRACE_ID_REMAPPER + - TRACE_ID_REMAPPER LogsURLParser: - description: This processor extracts query parameters and other important parameters - from a URL. + description: This processor extracts query parameters and other important parameters from a URL. properties: is_enabled: default: false @@ -7287,42 +6789,38 @@ components: nullable: true type: boolean sources: - default: - - http.url + default: ["http.url"] description: Array of source attributes. - example: - - http.url + example: ["http.url"] items: description: Attribute to extract the URL from. type: string type: array target: - default: http.url_details - description: Name of the parent attribute that contains all the extracted - details from the `sources`. - example: http.url_details + default: "http.url_details" + description: Name of the parent attribute that contains all the extracted details from the `sources`. + example: "http.url_details" type: string type: - $ref: '#/components/schemas/LogsURLParserType' + $ref: "#/components/schemas/LogsURLParserType" required: - - sources - - target - - type + - sources + - target + - type type: object LogsURLParserType: default: url-parser description: Type of logs URL parser. enum: - - url-parser + - url-parser example: url-parser type: string x-enum-varnames: - - URL_PARSER + - URL_PARSER LogsUserAgentParser: - description: 'The User-Agent parser takes a User-Agent attribute and extracts - the OS, browser, device, and other user data. - - It recognizes major bots like the Google Bot, Yahoo Slurp, and Bing.' + description: |- + The User-Agent parser takes a User-Agent attribute and extracts the OS, browser, device, and other user data. + It recognizes major bots like the Google Bot, Yahoo Slurp, and Bing. properties: is_enabled: default: false @@ -7336,37 +6834,34 @@ components: description: Name of the processor. type: string sources: - default: - - http.useragent + default: ["http.useragent"] description: Array of source attributes. - example: - - http.useragent + example: ["http.useragent"] items: description: Attribute to extract the User-Agent from. type: string type: array target: default: http.useragent_details - description: Name of the parent attribute that contains all the extracted - details from the `sources`. + description: Name of the parent attribute that contains all the extracted details from the `sources`. example: http.useragent_details type: string type: - $ref: '#/components/schemas/LogsUserAgentParserType' + $ref: "#/components/schemas/LogsUserAgentParserType" required: - - sources - - target - - type + - sources + - target + - type type: object LogsUserAgentParserType: default: user-agent-parser description: Type of logs User-Agent parser. enum: - - user-agent-parser + - user-agent-parser example: user-agent-parser type: string x-enum-varnames: - - USER_AGENT_PARSER + - USER_AGENT_PARSER MatchingDowntime: description: Object describing a downtime that matches this monitor. properties: @@ -7383,15 +6878,11 @@ components: readOnly: true type: integer scope: - description: 'The scope(s) to which the downtime applies. Must be in `key:value` - format. For example, `host:app2`. - + description: |- + The scope(s) to which the downtime applies. Must be in `key:value` format. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. - - The resulting downtime applies to sources that matches ALL provided scopes - (`env:dev` **AND** `env:prod`).' - example: - - env:staging + The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`). + example: ["env:staging"] items: description: A scope. For example, `"env:staging"`. type: string @@ -7402,19 +6893,19 @@ components: format: int64 type: integer required: - - id + - id type: object MetricContentEncoding: default: deflate description: HTTP header used to compress the media-type. enum: - - deflate - - gzip + - deflate + - gzip example: deflate type: string x-enum-varnames: - - DEFLATE - - GZIP + - DEFLATE + - GZIP MetricMetadata: description: Object with all metric related metadata. properties: @@ -7430,8 +6921,7 @@ components: example: second type: string short_name: - description: A more human-readable and abbreviated version of the metric - name. + description: A more human-readable and abbreviated version of the metric name. type: string statsd_interval: description: StatsD flush interval of the metric in seconds if applicable. @@ -7450,7 +6940,7 @@ components: description: Object containing the list of metrics matching the search query. properties: results: - $ref: '#/components/schemas/MetricSearchResponseResults' + $ref: "#/components/schemas/MetricSearchResponseResults" type: object MetricSearchResponseResults: description: Search result. @@ -7463,8 +6953,7 @@ components: type: array type: object MetricsListResponse: - description: Object listing all metric names stored by Datadog since a given - time. + description: Object listing all metric names stored by Datadog since a given time. properties: from: description: Time when the metrics were active, seconds since the Unix epoch. @@ -7482,23 +6971,21 @@ components: series: description: A list of timeseries to submit to Datadog. example: - - metric: system.load.1 - points: - - - 1475317847.0 - - 0.7 + - metric: "system.load.1" + points: + - [1475317847.0, 0.7] items: - $ref: '#/components/schemas/Series' + $ref: "#/components/schemas/Series" type: array required: - - series + - series type: object MetricsQueryMetadata: - description: Object containing all metric names returned and their associated - metadata. + description: Object containing all metric names returned and their associated metadata. properties: aggr: description: Aggregation type. - example: avg + example: "avg" nullable: true readOnly: true type: string @@ -7535,10 +7022,9 @@ components: pointlist: description: List of points of the timeseries in milliseconds. example: - - - 1681683300000.0 - - 77.62145685254418 + - [1681683300000.0, 77.62145685254418] items: - $ref: '#/components/schemas/Point' + $ref: "#/components/schemas/Point" readOnly: true type: array query_index: @@ -7564,25 +7050,20 @@ components: readOnly: true type: array unit: - description: 'Detailed information about the metric unit. - - The first element describes the "primary unit" (for example, `bytes` in - `bytes per second`). - - The second element describes the "per unit" (for example, `second` in - `bytes per second`). - - If the second element is not present, the API returns null.' + description: |- + Detailed information about the metric unit. + The first element describes the "primary unit" (for example, `bytes` in `bytes per second`). + The second element describes the "per unit" (for example, `second` in `bytes per second`). + If the second element is not present, the API returns null. items: - $ref: '#/components/schemas/MetricsQueryUnit' + $ref: "#/components/schemas/MetricsQueryUnit" maxItems: 2 minItems: 2 readOnly: true type: array type: object MetricsQueryResponse: - description: Response Object that includes your query and the list of metrics - retrieved. + description: Response Object that includes your query and the list of metrics retrieved. properties: error: description: Message indicating the errors if status is not `ok`. @@ -7616,7 +7097,7 @@ components: series: description: List of timeseries queried. items: - $ref: '#/components/schemas/MetricsQueryMetadata' + $ref: "#/components/schemas/MetricsQueryMetadata" readOnly: true type: array status: @@ -7631,13 +7112,11 @@ components: type: integer type: object MetricsQueryUnit: - description: Object containing the metric unit family, scale factor, name, and - short name. + description: Object containing the metric unit family, scale factor, name, and short name. nullable: true properties: family: - description: Unit family, allows for conversion between units of the same - family, for scaling. + description: Unit family, allows for conversion between units of the same family, for scaling. example: time readOnly: true type: string @@ -7667,10 +7146,9 @@ components: description: Object describing a monitor. properties: assets: - description: The list of monitor assets tied to a monitor, which represents - key links for users to take action on monitor alerts (for example, runbooks). + description: The list of monitor assets tied to a monitor, which represents key links for users to take action on monitor alerts (for example, runbooks). items: - $ref: '#/components/schemas/MonitorAsset' + $ref: "#/components/schemas/MonitorAsset" type: array created: description: Timestamp of the monitor creation. @@ -7678,7 +7156,7 @@ components: readOnly: true type: string creator: - $ref: '#/components/schemas/Creator' + $ref: "#/components/schemas/Creator" deleted: description: Whether or not the monitor is deleted. (Always `null`) format: date-time @@ -7686,7 +7164,7 @@ components: readOnly: true type: string draft_status: - $ref: '#/components/schemas/MonitorDraftStatus' + $ref: "#/components/schemas/MonitorDraftStatus" id: description: ID of this monitor. format: int64 @@ -7695,7 +7173,7 @@ components: matching_downtimes: description: A list of active v1 downtimes that match this monitor. items: - $ref: '#/components/schemas/MatchingDowntime' + $ref: "#/components/schemas/MatchingDowntime" type: array message: description: A message to include with notifications for this monitor. @@ -7711,12 +7189,12 @@ components: type: boolean name: description: The monitor name. - example: My monitor + example: "My monitor" type: string options: - $ref: '#/components/schemas/MonitorOptions' + $ref: "#/components/schemas/MonitorOptions" overall_state: - $ref: '#/components/schemas/MonitorOverallStates' + $ref: "#/components/schemas/MonitorOverallStates" priority: description: Integer from 1 (high) to 5 (low) indicating alert severity. format: int64 @@ -7724,25 +7202,17 @@ components: type: integer query: description: The monitor query. - example: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100 + example: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" type: string restricted_roles: - description: A list of unique role identifiers to define which roles are - allowed to edit the monitor. The unique identifiers for all roles can - be pulled from the [Roles API](https://docs.datadoghq.com/api/latest/roles/#list-roles) - and are located in the `data.id` field. Editing a monitor includes any - updates to the monitor configuration, monitor deletion, and muting of - the monitor for any amount of time. You can use the [Restriction Policies - API](https://docs.datadoghq.com/api/latest/restriction-policies/) to manage - write authorization for individual monitors by teams and users, in addition - to roles. + description: A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the [Roles API](https://docs.datadoghq.com/api/latest/roles/#list-roles) and are located in the `data.id` field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) to manage write authorization for individual monitors by teams and users, in addition to roles. items: description: A role UUID. type: string nullable: true type: array state: - $ref: '#/components/schemas/MonitorState' + $ref: "#/components/schemas/MonitorState" tags: description: Tags associated to your monitor. items: @@ -7750,206 +7220,191 @@ components: type: string type: array type: - $ref: '#/components/schemas/MonitorType' + $ref: "#/components/schemas/MonitorType" required: - - type - - query + - type + - query type: object MonitorAsset: - description: 'Represents key links tied to a monitor to help users take action - on alerts. - - This feature is in Preview and only available to users with the feature enabled.' + description: |- + Represents key links tied to a monitor to help users take action on alerts. + This feature is in Preview and only available to users with the feature enabled. properties: category: - $ref: '#/components/schemas/MonitorAssetCategory' + $ref: "#/components/schemas/MonitorAssetCategory" name: description: Name for the monitor asset - example: Monitor Runbook + example: "Monitor Runbook" type: string resource_key: - description: Represents the identifier of the internal Datadog resource - that this asset represents. IDs in this field should be passed in as strings. - example: '12345' + description: Represents the identifier of the internal Datadog resource that this asset represents. IDs in this field should be passed in as strings. + example: "12345" type: string resource_type: - $ref: '#/components/schemas/MonitorAssetResourceType' + $ref: "#/components/schemas/MonitorAssetResourceType" url: - description: URL link for the asset. For links with an internal resource - type set, this should be the relative path to where the Datadog domain - is appended internally. For external links, this should be the full URL - path. - example: /notebooks/12345 + description: URL link for the asset. For links with an internal resource type set, this should be the relative path to where the Datadog domain is appended internally. For external links, this should be the full URL path. + example: "/notebooks/12345" type: string required: - - name - - url - - category + - name + - url + - category type: object MonitorAssetCategory: description: Indicates the type of asset this entity represents on a monitor. enum: - - runbook + - runbook example: runbook type: string x-enum-varnames: - - RUNBOOK + - RUNBOOK MonitorAssetResourceType: description: Type of internal Datadog resource associated with a monitor asset. enum: - - notebook + - notebook type: string x-enum-varnames: - - NOTEBOOK + - NOTEBOOK MonitorDeviceID: - description: ID of the device the Synthetics monitor is running on. Same as - `SyntheticsDeviceID`. - enum: - - laptop_large - - tablet - - mobile_small - - chrome.laptop_large - - chrome.tablet - - chrome.mobile_small - - firefox.laptop_large - - firefox.tablet - - firefox.mobile_small - type: string - x-enum-varnames: - - LAPTOP_LARGE - - TABLET - - MOBILE_SMALL - - CHROME_LAPTOP_LARGE - - CHROME_TABLET - - CHROME_MOBILE_SMALL - - FIREFOX_LAPTOP_LARGE - - FIREFOX_TABLET - - FIREFOX_MOBILE_SMALL + description: ID of the device the Synthetics monitor is running on. Same as `SyntheticsDeviceID`. + enum: + - laptop_large + - tablet + - mobile_small + - chrome.laptop_large + - chrome.tablet + - chrome.mobile_small + - firefox.laptop_large + - firefox.tablet + - firefox.mobile_small + type: string + x-enum-varnames: + - LAPTOP_LARGE + - TABLET + - MOBILE_SMALL + - CHROME_LAPTOP_LARGE + - CHROME_TABLET + - CHROME_MOBILE_SMALL + - FIREFOX_LAPTOP_LARGE + - FIREFOX_TABLET + - FIREFOX_MOBILE_SMALL MonitorDraftStatus: default: published - description: 'Indicates whether the monitor is in a draft or published state. - + description: |- + Indicates whether the monitor is in a draft or published state. `draft`: The monitor appears as Draft and does not send notifications. + `published`: The monitor is active and evaluates conditions and notify as configured. - `published`: The monitor is active and evaluates conditions and notify as - configured. - - - This field is in preview. The draft value is only available to customers with - the feature enabled.' + This field is in preview. The draft value is only available to customers with the feature enabled. enum: - - draft - - published + - draft + - published type: string x-enum-varnames: - - DRAFT - - PUBLISHED + - DRAFT + - PUBLISHED MonitorFormulaAndFunctionAggregateAugmentQuery: - description: Augment query for aggregate augmented queries. Can be an events - query or a reference table query. + description: Augment query for aggregate augmented queries. Can be an events query or a reference table query. oneOf: - - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition' - - $ref: '#/components/schemas/MonitorFormulaAndFunctionReferenceTableQueryDefinition' + - $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition" + - $ref: "#/components/schemas/MonitorFormulaAndFunctionReferenceTableQueryDefinition" MonitorFormulaAndFunctionAggregateAugmentedDataSource: description: Data source for aggregate augmented queries. enum: - - aggregate_augmented_query - example: aggregate_augmented_query + - aggregate_augmented_query + example: "aggregate_augmented_query" type: string x-enum-varnames: - - AGGREGATE_AUGMENTED_QUERY + - AGGREGATE_AUGMENTED_QUERY MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition: additionalProperties: false - description: A formula and functions aggregate augmented query. Used to enrich - base query results with data from a reference table. + description: A formula and functions aggregate augmented query. Used to enrich base query results with data from a reference table. properties: augment_query: - $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateAugmentQuery' + $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateAugmentQuery" base_query: - $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateBaseQuery' + $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateBaseQuery" compute: description: Compute options for the query. items: - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionCompute' + $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionCompute" minItems: 1 type: array data_source: - $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateAugmentedDataSource' + $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateAugmentedDataSource" group_by: description: Group by options for the query. items: - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBy' + $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBy" type: array join_condition: - $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateQueryJoinCondition' + $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateQueryJoinCondition" name: description: Name of the query for use in formulas. - example: query1 + example: "query1" type: string required: - - data_source - - base_query - - augment_query - - join_condition - - compute - - group_by + - data_source + - base_query + - augment_query + - join_condition + - compute + - group_by type: object MonitorFormulaAndFunctionAggregateBaseQuery: - description: Base query for aggregate queries. Can be an events query or a metrics - query. + description: Base query for aggregate queries. Can be an events query or a metrics query. oneOf: - - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition' - - $ref: '#/components/schemas/MonitorFormulaAndFunctionMetricsQueryDefinition' + - $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition" + - $ref: "#/components/schemas/MonitorFormulaAndFunctionMetricsQueryDefinition" MonitorFormulaAndFunctionAggregateFilterQuery: - description: Filter query for aggregate filtered queries. Can be an events query - or a reference table query. + description: Filter query for aggregate filtered queries. Can be an events query or a reference table query. oneOf: - - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition' - - $ref: '#/components/schemas/MonitorFormulaAndFunctionReferenceTableQueryDefinition' + - $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition" + - $ref: "#/components/schemas/MonitorFormulaAndFunctionReferenceTableQueryDefinition" MonitorFormulaAndFunctionAggregateFilteredDataSource: description: Data source for aggregate filtered queries. enum: - - aggregate_filtered_query - example: aggregate_filtered_query + - aggregate_filtered_query + example: "aggregate_filtered_query" type: string x-enum-varnames: - - AGGREGATE_FILTERED_QUERY + - AGGREGATE_FILTERED_QUERY MonitorFormulaAndFunctionAggregateFilteredQueryDefinition: additionalProperties: false - description: A formula and functions aggregate filtered query. Used to filter - base query results using data from another source. + description: A formula and functions aggregate filtered query. Used to filter base query results using data from another source. properties: base_query: - $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateBaseQuery' + $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateBaseQuery" compute: description: Compute options for the query. items: - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionCompute' + $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionCompute" type: array data_source: - $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateFilteredDataSource' + $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateFilteredDataSource" filter_query: - $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateFilterQuery' + $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateFilterQuery" filters: description: Filter conditions for the query. items: - $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateQueryFilter' + $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateQueryFilter" type: array group_by: description: Group by options for the query. items: - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBy' + $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBy" type: array name: description: Name of the query for use in formulas. - example: query1 + example: "query1" type: string required: - - data_source - - base_query - - filter_query - - filters + - data_source + - base_query + - filter_query + - filters type: object MonitorFormulaAndFunctionAggregateQueryFilter: additionalProperties: false @@ -7957,7 +7412,7 @@ components: properties: base_attribute: description: Attribute from the base query to filter on. - example: org_id + example: "org_id" type: string exclude: default: false @@ -7965,11 +7420,11 @@ components: type: boolean filter_attribute: description: Attribute from the filter query to match against. - example: org_id + example: "org_id" type: string required: - - base_attribute - - filter_attribute + - base_attribute + - filter_attribute type: object MonitorFormulaAndFunctionAggregateQueryJoinCondition: additionalProperties: false @@ -7977,253 +7432,241 @@ components: properties: augment_attribute: description: Attribute from the augment query to join on. - example: org_id + example: "org_id" type: string base_attribute: description: Attribute from the base query to join on. - example: org_id + example: "org_id" type: string join_type: - $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateQueryJoinType' + $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateQueryJoinType" required: - - base_attribute - - augment_attribute - - join_type + - base_attribute + - augment_attribute + - join_type type: object MonitorFormulaAndFunctionAggregateQueryJoinType: description: Join type for aggregate query join conditions. enum: - - inner - - left - example: inner + - inner + - left + example: "inner" type: string x-enum-varnames: - - INNER - - LEFT + - INNER + - LEFT MonitorFormulaAndFunctionCostAggregator: description: Aggregation methods for metric queries. enum: - - avg - - sum - - max - - min - - last - - area - - l2norm - - percentile - - stddev + - avg + - sum + - max + - min + - last + - area + - l2norm + - percentile + - stddev example: avg type: string x-enum-varnames: - - AVG - - SUM - - MAX - - MIN - - LAST - - AREA - - L2NORM - - PERCENTILE - - STDDEV + - AVG + - SUM + - MAX + - MIN + - LAST + - AREA + - L2NORM + - PERCENTILE + - STDDEV MonitorFormulaAndFunctionCostDataSource: description: Data source for cost queries. enum: - - metrics - - cloud_cost - - datadog_usage - example: cloud_cost + - metrics + - cloud_cost + - datadog_usage + example: "cloud_cost" type: string x-enum-varnames: - - METRICS - - CLOUD_COST - - DATADOG_USAGE + - METRICS + - CLOUD_COST + - DATADOG_USAGE MonitorFormulaAndFunctionCostQueryDefinition: description: A formula and functions cost query. properties: aggregator: - $ref: '#/components/schemas/MonitorFormulaAndFunctionCostAggregator' + $ref: "#/components/schemas/MonitorFormulaAndFunctionCostAggregator" data_source: - $ref: '#/components/schemas/MonitorFormulaAndFunctionCostDataSource' + $ref: "#/components/schemas/MonitorFormulaAndFunctionCostDataSource" name: description: Name of the query for use in formulas. - example: query1 + example: "query1" type: string query: description: The monitor query. - example: sum:all.cost{*}.rollup(sum, 86400) + example: "sum:all.cost{*}.rollup(sum, 86400)" type: string required: - - name - - data_source - - query + - name + - data_source + - query type: object MonitorFormulaAndFunctionDataQualityDataSource: description: Data source for data quality queries. enum: - - data_quality_metrics - example: data_quality_metrics + - data_quality_metrics + example: "data_quality_metrics" type: string x-enum-varnames: - - DATA_QUALITY_METRICS + - DATA_QUALITY_METRICS MonitorFormulaAndFunctionDataQualityMeasure: - description: 'The data quality measure to query. Common values include: - + description: |- + The data quality measure to query. Common values include: `bytes`, `cardinality`, `custom`, `freshness`, `max`, `mean`, `min`, - `nullness`, `percent_negative`, `percent_zero`, `row_count`, `stddev`, - - `sum`, `uniqueness`. Additional values may be supported.' - example: row_count + `sum`, `uniqueness`. Additional values may be supported. + example: "row_count" type: string MonitorFormulaAndFunctionDataQualityModelTypeOverride: description: Override for the model type used in anomaly detection. enum: - - freshness - - percentage - - any + - freshness + - percentage + - any type: string x-enum-varnames: - - FRESHNESS - - PERCENTAGE - - ANY + - FRESHNESS + - PERCENTAGE + - ANY MonitorFormulaAndFunctionDataQualityMonitorOptions: description: Monitor configuration options for data quality queries. properties: crontab_override: description: Crontab expression to override the default schedule. - example: '* * * 10' + example: "* * * 10" type: string custom_sql: description: Custom SQL query for the monitor. - example: SELECT COUNT(*) FROM users AS dd_value + example: "SELECT COUNT(*) FROM users AS dd_value" type: string custom_where: description: Custom WHERE clause for the query. - example: USER_ID = 123 + example: "USER_ID = 123" type: string group_by_columns: description: Columns to group results by. - example: - - col1 - - col2 + example: ["col1", "col2"] items: type: string type: array model_type_override: - $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityModelTypeOverride' + $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityModelTypeOverride" type: object MonitorFormulaAndFunctionDataQualityQueryDefinition: description: A formula and functions data quality query. properties: data_source: - $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityDataSource' + $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityDataSource" filter: - description: Filter expression used to match on data entities. Uses Aastra - query syntax. - example: search for column where `database:production AND table:users` + description: |- + Filter expression used to match on data entities. Uses Aastra query syntax. + example: "search for column where `database:production AND table:users`" type: string group_by: description: Optional grouping fields for aggregation. - example: - - entity_id + example: ["entity_id"] items: type: string type: array measure: - $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityMeasure' + $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityMeasure" monitor_options: - $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityMonitorOptions' + $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityMonitorOptions" name: description: Name of the query for use in formulas. - example: query1 + example: "query1" type: string schema_version: description: Schema version for the data quality query. - example: 0.0.1 + example: "0.0.1" type: string scope: - description: 'Optional scoping expression to further filter metrics. Uses - metrics filter syntax. - - This is useful when an entity has been configured to emit metrics with - additional tags.' - example: env:production + description: |- + Optional scoping expression to further filter metrics. Uses metrics filter syntax. + This is useful when an entity has been configured to emit metrics with additional tags. + example: "env:production" type: string required: - - name - - data_source - - measure - - filter + - name + - data_source + - measure + - filter type: object MonitorFormulaAndFunctionEventAggregation: description: Aggregation methods for event platform queries. enum: - - count - - cardinality - - median - - pc75 - - pc90 - - pc95 - - pc98 - - pc99 - - sum - - min - - max - - avg + - count + - cardinality + - median + - pc75 + - pc90 + - pc95 + - pc98 + - pc99 + - sum + - min + - max + - avg example: avg type: string x-enum-varnames: - - COUNT - - CARDINALITY - - MEDIAN - - PC75 - - PC90 - - PC95 - - PC98 - - PC99 - - SUM - - MIN - - MAX - - AVG + - COUNT + - CARDINALITY + - MEDIAN + - PC75 + - PC90 + - PC95 + - PC98 + - PC99 + - SUM + - MIN + - MAX + - AVG MonitorFormulaAndFunctionEventQueryDefinition: description: A formula and functions events query. properties: compute: - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionCompute' + $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionCompute" data_source: - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventsDataSource' + $ref: "#/components/schemas/MonitorFormulaAndFunctionEventsDataSource" group_by: description: Group by options. items: - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBy' + $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBy" type: array indexes: - description: An array of index names to query in the stream. Omit or use - `[]` to query all indexes at once. - example: - - days-3 - - days-7 + description: An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. + example: ["days-3", "days-7"] items: - description: A log index set up for your organization. For additional - indexes, see the [multiple indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - documentation. + description: A log index set up for your organization. For additional indexes, see the [multiple indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) documentation. type: string type: array name: description: Name of the query for use in formulas. - example: query_errors + example: "query_errors" type: string search: - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionSearch' + $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionSearch" required: - - data_source - - compute - - name + - data_source + - compute + - name type: object MonitorFormulaAndFunctionEventQueryDefinitionCompute: description: Compute options. properties: aggregation: - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventAggregation' + $ref: "#/components/schemas/MonitorFormulaAndFunctionEventAggregation" interval: description: A time interval in milliseconds. example: 60000 @@ -8231,25 +7674,24 @@ components: type: integer metric: description: Measurable attribute to compute. - example: '@duration' + example: "@duration" type: string name: - description: The name assigned to this aggregation, when multiple aggregations - are defined for a query. - example: compute_result + description: The name assigned to this aggregation, when multiple aggregations are defined for a query. + example: "compute_result" type: string required: - - aggregation + - aggregation type: object MonitorFormulaAndFunctionEventQueryDefinitionSearch: description: Search options. properties: query: description: Events search string. - example: service:query + example: "service:query" type: string required: - - query + - query type: object MonitorFormulaAndFunctionEventQueryGroupBy: description: List of objects used to group by. @@ -8264,117 +7706,117 @@ components: format: int64 type: integer sort: - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBySort' + $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBySort" required: - - facet + - facet type: object MonitorFormulaAndFunctionEventQueryGroupBySort: description: Options for sorting group by results. properties: aggregation: - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventAggregation' + $ref: "#/components/schemas/MonitorFormulaAndFunctionEventAggregation" metric: description: Metric used for sorting group by results. type: string order: - $ref: '#/components/schemas/QuerySortOrder' + $ref: "#/components/schemas/QuerySortOrder" required: - - aggregation + - aggregation type: object MonitorFormulaAndFunctionEventsDataSource: description: Data source for event platform-based queries. enum: - - rum - - ci_pipelines - - ci_tests - - audit - - events - - logs - - spans - - database_queries - - network - - network_path - example: rum - type: string - x-enum-varnames: - - RUM - - CI_PIPELINES - - CI_TESTS - - AUDIT - - EVENTS - - LOGS - - SPANS - - DATABASE_QUERIES - - NETWORK - - NETWORK_PATH + - rum + - ci_pipelines + - ci_tests + - audit + - events + - logs + - spans + - database_queries + - network + - network_path + example: "rum" + type: string + x-enum-varnames: + - RUM + - CI_PIPELINES + - CI_TESTS + - AUDIT + - EVENTS + - LOGS + - SPANS + - DATABASE_QUERIES + - NETWORK + - NETWORK_PATH MonitorFormulaAndFunctionMetricsAggregator: description: Aggregator for metrics queries. enum: - - avg - - min - - max - - sum - - last - - mean - - area - - l2norm - - percentile - - stddev - - count_unique - example: avg - type: string - x-enum-varnames: - - AVG - - MIN - - MAX - - SUM - - LAST - - MEAN - - AREA - - L2NORM - - PERCENTILE - - STDDEV - - COUNT_UNIQUE + - avg + - min + - max + - sum + - last + - mean + - area + - l2norm + - percentile + - stddev + - count_unique + example: "avg" + type: string + x-enum-varnames: + - AVG + - MIN + - MAX + - SUM + - LAST + - MEAN + - AREA + - L2NORM + - PERCENTILE + - STDDEV + - COUNT_UNIQUE MonitorFormulaAndFunctionMetricsDataSource: description: Data source for metrics queries. enum: - - metrics - - cloud_cost - - datadog_usage - example: metrics + - metrics + - cloud_cost + - datadog_usage + example: "metrics" type: string x-enum-varnames: - - METRICS - - CLOUD_COST - - DATADOG_USAGE + - METRICS + - CLOUD_COST + - DATADOG_USAGE MonitorFormulaAndFunctionMetricsQueryDefinition: additionalProperties: false description: A formula and functions metrics query for use in aggregate queries. properties: aggregator: - $ref: '#/components/schemas/MonitorFormulaAndFunctionMetricsAggregator' + $ref: "#/components/schemas/MonitorFormulaAndFunctionMetricsAggregator" data_source: - $ref: '#/components/schemas/MonitorFormulaAndFunctionMetricsDataSource' + $ref: "#/components/schemas/MonitorFormulaAndFunctionMetricsDataSource" name: description: Name of the query for use in formulas. - example: query1 + example: "query1" type: string query: description: The metrics query definition. - example: avg:system.cpu.user{*} + example: "avg:system.cpu.user{*}" type: string required: - - data_source - - query + - data_source + - query type: object MonitorFormulaAndFunctionQueryDefinition: description: A formula and function query. oneOf: - - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition' - - $ref: '#/components/schemas/MonitorFormulaAndFunctionCostQueryDefinition' - - $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityQueryDefinition' - - $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition' - - $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateFilteredQueryDefinition' + - $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition" + - $ref: "#/components/schemas/MonitorFormulaAndFunctionCostQueryDefinition" + - $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityQueryDefinition" + - $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition" + - $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateFilteredQueryDefinition" MonitorFormulaAndFunctionReferenceTableColumn: additionalProperties: false description: A column definition for reference table queries. @@ -8384,19 +7826,19 @@ components: type: string name: description: Name of the column. - example: org_id + example: "org_id" type: string required: - - name + - name type: object MonitorFormulaAndFunctionReferenceTableDataSource: description: Data source for reference table queries. enum: - - reference_table - example: reference_table + - reference_table + example: "reference_table" type: string x-enum-varnames: - - REFERENCE_TABLE + - REFERENCE_TABLE MonitorFormulaAndFunctionReferenceTableQueryDefinition: additionalProperties: false description: A reference table query for use in aggregate queries. @@ -8404,52 +7846,52 @@ components: columns: description: List of columns to retrieve from the reference table. items: - $ref: '#/components/schemas/MonitorFormulaAndFunctionReferenceTableColumn' + $ref: "#/components/schemas/MonitorFormulaAndFunctionReferenceTableColumn" type: array data_source: - $ref: '#/components/schemas/MonitorFormulaAndFunctionReferenceTableDataSource' + $ref: "#/components/schemas/MonitorFormulaAndFunctionReferenceTableDataSource" name: description: Name of the query. - example: filter_query + example: "filter_query" type: string query_filter: description: Optional filter expression for the reference table query. type: string table_name: description: Name of the reference table. - example: test_table + example: "test_table" type: string required: - - data_source - - table_name + - data_source + - table_name type: object MonitorGroupSearchResponse: description: The response of a monitor group search. example: counts: status: - - count: 2 - name: OK + - count: 2 + name: OK type: - - count: 2 - name: metric + - count: 2 + name: metric groups: - - group: '*' - group_tags: - - '*' - last_nodata_ts: 0 - last_triggered_ts: 1525702966 - monitor_id: 2738266 - monitor_name: '[demo] Cassandra disk usage is high on {{host.name}}' - status: OK - - group: '*' - group_tags: - - '*' - last_nodata_ts: 0 - last_triggered_ts: 1525703008 - monitor_id: 1576648 - monitor_name: '[demo] Disk usage is high on {{host.name}}' - status: OK + - group: "*" + group_tags: + - "*" + last_nodata_ts: 0 + last_triggered_ts: 1525702966 + monitor_id: 2738266 + monitor_name: "[demo] Cassandra disk usage is high on {{host.name}}" + status: OK + - group: "*" + group_tags: + - "*" + last_nodata_ts: 0 + last_triggered_ts: 1525703008 + monitor_id: 1576648 + monitor_name: "[demo] Disk usage is high on {{host.name}}" + status: OK metadata: page: 0 page_count: 2 @@ -8457,23 +7899,23 @@ components: total_count: 2 properties: counts: - $ref: '#/components/schemas/MonitorGroupSearchResponseCounts' + $ref: "#/components/schemas/MonitorGroupSearchResponseCounts" groups: description: The list of found monitor groups. items: - $ref: '#/components/schemas/MonitorGroupSearchResult' + $ref: "#/components/schemas/MonitorGroupSearchResult" readOnly: true type: array metadata: - $ref: '#/components/schemas/MonitorSearchResponseMetadata' + $ref: "#/components/schemas/MonitorSearchResponseMetadata" type: object MonitorGroupSearchResponseCounts: description: The counts of monitor groups per different criteria. properties: status: - $ref: '#/components/schemas/MonitorSearchCount' + $ref: "#/components/schemas/MonitorSearchCount" type: - $ref: '#/components/schemas/MonitorSearchCount' + $ref: "#/components/schemas/MonitorSearchCount" readOnly: true type: object MonitorGroupSearchResult: @@ -8512,86 +7954,68 @@ components: readOnly: true type: string status: - $ref: '#/components/schemas/MonitorOverallStates' + $ref: "#/components/schemas/MonitorOverallStates" type: object MonitorOptions: description: List of options associated with your monitor. properties: aggregation: - $ref: '#/components/schemas/MonitorOptionsAggregation' + $ref: "#/components/schemas/MonitorOptionsAggregation" device_ids: deprecated: true description: IDs of the device the Synthetics monitor is running on. items: - $ref: '#/components/schemas/MonitorDeviceID' + $ref: "#/components/schemas/MonitorDeviceID" readOnly: true type: array enable_logs_sample: description: Whether or not to send a log sample when the log monitor triggers. type: boolean enable_samples: - description: Whether or not to send a list of samples when the monitor triggers. - This is only used by CI Test and Pipeline monitors. + description: Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors. type: boolean escalation_message: - description: 'We recommend using the [is_renotify](https://docs.datadoghq.com/monitors/notify/?tab=is_alert#renotify), - + description: |- + We recommend using the [is_renotify](https://docs.datadoghq.com/monitors/notify/?tab=is_alert#renotify), block in the original message instead. - - A message to include with a re-notification. Supports the `@username` - notification we allow elsewhere. - - Not applicable if `renotify_interval` is `None`.' + A message to include with a re-notification. Supports the `@username` notification we allow elsewhere. + Not applicable if `renotify_interval` is `None`. type: string evaluation_delay: - description: 'Time (in seconds) to delay evaluation, as a non-negative integer. - For example, if the value is set to `300` (5min), - - the timeframe is set to `last_5m` and the time is 7:00, the monitor evaluates - data from 6:50 to 6:55. - - This is useful for AWS CloudWatch and other backfilled metrics to ensure - the monitor always has data during evaluation.' + description: |- + Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to `300` (5min), + the timeframe is set to `last_5m` and the time is 7:00, the monitor evaluates data from 6:50 to 6:55. + This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation. format: int64 nullable: true type: integer group_retention_duration: - description: 'The time span after which groups with missing data are dropped - from the monitor state. - + description: |- + The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. - Example values are: "60m", "1h", and "2d". - - This option is only available for APM Trace Analytics, Audit Trail, CI, - Error Tracking, Event, Logs, and RUM monitors.' + This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. type: string groupby_simple_monitor: deprecated: true - description: Whether the log alert monitor triggers a single alert or multiple - alerts when any group breaches a threshold. Use `notify_by` instead. + description: Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. Use `notify_by` instead. type: boolean include_tags: default: true - description: 'A Boolean indicating whether notifications from this monitor - automatically inserts its triggering tags into the title. - + description: |- + A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title. **Examples** - - If `True`, `[Triggered on {host:h1}] Monitor Title` - - - If `False`, `[Triggered] Monitor Title`' + - If `False`, `[Triggered] Monitor Title` type: boolean locked: deprecated: true - description: Whether or not the monitor is locked (only editable by creator - and admins). Use `restricted_roles` instead. + description: Whether or not the monitor is locked (only editable by creator and admins). Use `restricted_roles` instead. type: boolean min_failure_duration: default: 0 - description: How long the test should be in failure before alerting (integer, - number of seconds, max 7200). + description: How long the test should be in failure before alerting (integer, number of seconds, max 7200). format: int64 maximum: 7200 minimum: 0 @@ -8599,131 +8023,106 @@ components: type: integer min_location_failed: default: 1 - description: 'The minimum number of locations in failure at the same time - during - - at least one moment in the `min_failure_duration` period (`min_location_failed` - and `min_failure_duration` - - are part of the advanced alerting rules - integer, >= 1).' + description: |- + The minimum number of locations in failure at the same time during + at least one moment in the `min_failure_duration` period (`min_location_failed` and `min_failure_duration` + are part of the advanced alerting rules - integer, >= 1). format: int64 nullable: true type: integer new_group_delay: - description: 'Time (in seconds) to skip evaluations for new groups. - - - For example, this option can be used to skip evaluations for new hosts - while they initialize. + description: |- + Time (in seconds) to skip evaluations for new groups. + For example, this option can be used to skip evaluations for new hosts while they initialize. - Must be a non negative integer.' + Must be a non negative integer. format: int64 nullable: true type: integer new_host_delay: default: 300 deprecated: true - description: 'Time (in seconds) to allow a host to boot and applications - + description: |- + Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. - Should be a non negative integer. - - Use new_group_delay instead.' + Use new_group_delay instead. format: int64 nullable: true type: integer no_data_timeframe: - description: 'The number of minutes before a monitor notifies after data - stops reporting. - - Datadog recommends at least 2x the monitor timeframe for query alerts - or 2 minutes for service checks. - - If omitted, 2x the evaluation timeframe is used for query alerts, and - 24 hours is used for service checks.' + description: |- + The number of minutes before a monitor notifies after data stops reporting. + Datadog recommends at least 2x the monitor timeframe for query alerts or 2 minutes for service checks. + If omitted, 2x the evaluation timeframe is used for query alerts, and 24 hours is used for service checks. format: int64 nullable: true type: integer notification_preset_name: - $ref: '#/components/schemas/MonitorOptionsNotificationPresets' + $ref: "#/components/schemas/MonitorOptionsNotificationPresets" notify_audit: default: false - description: A Boolean indicating whether tagged users is notified on changes - to this monitor. + description: A Boolean indicating whether tagged users is notified on changes to this monitor. type: boolean notify_by: - description: 'Controls what granularity a monitor alerts on. Only available - for monitors with groupings. - - For instance, a monitor grouped by `cluster`, `namespace`, and `pod` can - be configured to only notify on each - - new `cluster` violating the alert conditions by setting `notify_by` to - `["cluster"]`. Tags mentioned - + description: |- + Controls what granularity a monitor alerts on. Only available for monitors with groupings. + For instance, a monitor grouped by `cluster`, `namespace`, and `pod` can be configured to only notify on each + new `cluster` violating the alert conditions by setting `notify_by` to `["cluster"]`. Tags mentioned in `notify_by` must be a subset of the grouping tags in the query. - - For example, a query grouped by `cluster` and `namespace` cannot notify - on `region`. - - Setting `notify_by` to `["*"]` configures the monitor to notify as a simple-alert.' + For example, a query grouped by `cluster` and `namespace` cannot notify on `region`. + Setting `notify_by` to `["*"]` configures the monitor to notify as a simple-alert. items: description: A grouping tag. type: string type: array notify_no_data: - description: A Boolean indicating whether this monitor notifies when data - stops reporting. Defaults to `false`. + description: A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to `false`. type: boolean on_missing_data: - $ref: '#/components/schemas/OnMissingDataOption' + $ref: "#/components/schemas/OnMissingDataOption" renotify_interval: - default: null - description: "The number of minutes after the last notification before a - monitor re-notifies on the current status.\nIt only re-notifies if it\u2019s - not resolved." + default: + description: |- + The number of minutes after the last notification before a monitor re-notifies on the current status. + It only re-notifies if it’s not resolved. format: int64 nullable: true type: integer renotify_occurrences: - description: The number of times re-notification messages should be sent - on the current status at the provided re-notification interval. + description: |- + The number of times re-notification messages should be sent on the current status at the provided re-notification interval. format: int64 nullable: true type: integer renotify_statuses: - description: 'The types of monitor statuses for which re-notification messages - are sent. - + description: |- + The types of monitor statuses for which re-notification messages are sent. Default: **null** if `renotify_interval` is **null**. - - If `renotify_interval` is set, defaults to renotify on `Alert` and `No - Data`.' + If `renotify_interval` is set, defaults to renotify on `Alert` and `No Data`. items: - $ref: '#/components/schemas/MonitorRenotifyStatusType' + $ref: "#/components/schemas/MonitorRenotifyStatusType" nullable: true type: array require_full_window: - description: "A Boolean indicating whether this monitor needs a full window - of data before it\u2019s evaluated.\nWe highly recommend you set this - to `false` for sparse metrics,\notherwise some evaluations are skipped. - Default is false. This setting only applies to\nmetric monitors." + description: |- + A Boolean indicating whether this monitor needs a full window of data before it’s evaluated. + We highly recommend you set this to `false` for sparse metrics, + otherwise some evaluations are skipped. Default is false. This setting only applies to + metric monitors. type: boolean scheduling_options: - $ref: '#/components/schemas/MonitorOptionsSchedulingOptions' + $ref: "#/components/schemas/MonitorOptionsSchedulingOptions" silenced: additionalProperties: - description: UTC epoch timestamp in seconds when the downtime for the - group expires. + description: UTC epoch timestamp in seconds when the downtime for the group expires. format: int64 nullable: true type: integer deprecated: true - description: Information about the downtime applied to the monitor. Only - shows v1 downtimes. + description: Information about the downtime applied to the monitor. Only shows v1 downtimes. type: object synthetics_check_id: deprecated: true @@ -8731,22 +8130,19 @@ components: nullable: true type: string threshold_windows: - $ref: '#/components/schemas/MonitorThresholdWindowOptions' + $ref: "#/components/schemas/MonitorThresholdWindowOptions" thresholds: - $ref: '#/components/schemas/MonitorThresholds' + $ref: "#/components/schemas/MonitorThresholds" timeout_h: - default: null - description: The number of hours of the monitor not reporting data before - it automatically resolves from a triggered state. The minimum allowed - value is 0 hours. The maximum allowed value is 24 hours. + default: + description: The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours. format: int64 nullable: true type: integer variables: - description: List of requests that can be used in the monitor query. **This - feature is currently in beta.** + description: List of requests that can be used in the monitor query. **This feature is currently in beta.** items: - $ref: '#/components/schemas/MonitorFormulaAndFunctionQueryDefinition' + $ref: "#/components/schemas/MonitorFormulaAndFunctionQueryDefinition" type: array type: object MonitorOptionsAggregation: @@ -8767,127 +8163,119 @@ components: readOnly: true type: object MonitorOptionsCustomSchedule: - description: Configuration options for the custom schedule. **This feature is - in private beta.** + description: Configuration options for the custom schedule. **This feature is in private beta.** properties: recurrences: description: Array of custom schedule recurrences. items: - $ref: '#/components/schemas/MonitorOptionsCustomScheduleRecurrence' + $ref: "#/components/schemas/MonitorOptionsCustomScheduleRecurrence" type: array type: object MonitorOptionsCustomScheduleRecurrence: - description: Configuration for a recurrence set on the monitor options for custom - schedule. + description: Configuration for a recurrence set on the monitor options for custom schedule. properties: rrule: description: Defines the recurrence rule (RRULE) for a given schedule. - example: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR + example: "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR" type: string start: description: Defines the start date and time of the recurring schedule. - example: '2023-08-31T16:30:00' + example: "2023-08-31T16:30:00" type: string timezone: description: Defines the timezone the schedule runs on. - example: Europe/Paris + example: "Europe/Paris" type: string type: object MonitorOptionsNotificationPresets: - default: show_all + default: "show_all" description: Toggles the display of additional content sent in the monitor notification. enum: - - show_all - - hide_query - - hide_handles - - hide_all - - hide_query_and_handles - - show_only_snapshot - - hide_handles_and_footer - type: string - x-enum-varnames: - - SHOW_ALL - - HIDE_QUERY - - HIDE_HANDLES - - HIDE_ALL - - HIDE_QUERY_AND_HANDLES - - SHOW_ONLY_SNAPSHOT - - HIDE_HANDLES_AND_FOOTER + - "show_all" + - "hide_query" + - "hide_handles" + - "hide_all" + - "hide_query_and_handles" + - "show_only_snapshot" + - "hide_handles_and_footer" + type: string + x-enum-varnames: + - SHOW_ALL + - HIDE_QUERY + - HIDE_HANDLES + - HIDE_ALL + - HIDE_QUERY_AND_HANDLES + - SHOW_ONLY_SNAPSHOT + - HIDE_HANDLES_AND_FOOTER MonitorOptionsSchedulingOptions: description: Configuration options for scheduling. properties: custom_schedule: - $ref: '#/components/schemas/MonitorOptionsCustomSchedule' + $ref: "#/components/schemas/MonitorOptionsCustomSchedule" evaluation_window: - $ref: '#/components/schemas/MonitorOptionsSchedulingOptionsEvaluationWindow' + $ref: "#/components/schemas/MonitorOptionsSchedulingOptionsEvaluationWindow" type: object MonitorOptionsSchedulingOptionsEvaluationWindow: - description: Configuration options for the evaluation window. If `hour_starts` - is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` - must be set together. + description: Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together. properties: day_starts: - description: The time of the day at which a one day cumulative evaluation - window starts. - example: 04:00 + description: The time of the day at which a one day cumulative evaluation window starts. + example: "04:00" type: string hour_starts: - description: The minute of the hour at which a one hour cumulative evaluation - window starts. + description: The minute of the hour at which a one hour cumulative evaluation window starts. example: 0 format: int32 maximum: 59 minimum: 0 type: integer month_starts: - description: The day of the month at which a one month cumulative evaluation - window starts. + description: The day of the month at which a one month cumulative evaluation window starts. example: 1 format: int32 maximum: 1 minimum: 1 type: integer timezone: - description: The timezone of the time of the day of the cumulative evaluation - window start. - example: Europe/Paris + description: The timezone of the time of the day of the cumulative evaluation window start. + example: "Europe/Paris" type: string type: object MonitorOverallStates: description: The different states your monitor can be in. enum: - - Alert - - Ignored - - No Data - - OK - - Skipped - - Unknown - - Warn + - Alert + - Ignored + - No Data + - OK + - Skipped + - Unknown + - Warn readOnly: true type: string x-enum-varnames: - - ALERT - - IGNORED - - NO_DATA - - OK - - SKIPPED - - UNKNOWN - - WARN + - ALERT + - IGNORED + - NO_DATA + - OK + - SKIPPED + - UNKNOWN + - WARN MonitorRenotifyStatusType: description: The different statuses for which renotification is supported. enum: - - alert - - warn - - no data + - "alert" + - "warn" + - "no data" type: string x-enum-varnames: - - ALERT - - WARN - - NO_DATA + - ALERT + - WARN + - NO_DATA MonitorSearchCount: description: Search facets. items: - $ref: '#/components/schemas/MonitorSearchCountItem' + $ref: "#/components/schemas/MonitorSearchCountItem" type: array MonitorSearchCountItem: description: A facet item. @@ -8906,59 +8294,59 @@ components: example: counts: muted: - - count: 3 - name: false - - count: 3 - name: true + - count: 3 + name: false + - count: 3 + name: true status: - - count: 4 - name: No Data - - count: 2 - name: OK + - count: 4 + name: No Data + - count: 2 + name: OK tag: - - count: 6 - name: service:cassandra + - count: 6 + name: service:cassandra type: - - count: 6 - name: metric + - count: 6 + name: metric metadata: page: 0 page_count: 6 per_page: 30 total_count: 6 monitors: - - classification: metric - creator: - handle: john@datadoghq.com - name: John Doe - id: 2699850 - last_triggered_ts: null - metrics: - - system.cpu.user - name: Cassandra CPU is high on {{host.name}} in {{availability-zone.name}} - notifications: - - handle: jane@datadoghq.com - name: Jane Doe - org_id: 1234 - quality_issues: - - broken_at_handle - - noisy_monitor - scopes: - - '!availability-zone:us-east-1c' - - name:cassandra - status: No Data - tags: - - service:cassandra - type: query alert + - classification: metric + creator: + handle: john@datadoghq.com + name: John Doe + id: 2699850 + last_triggered_ts: + metrics: + - system.cpu.user + name: Cassandra CPU is high on {{host.name}} in {{availability-zone.name}} + notifications: + - handle: jane@datadoghq.com + name: Jane Doe + org_id: 1234 + quality_issues: + - "broken_at_handle" + - "noisy_monitor" + scopes: + - "!availability-zone:us-east-1c" + - name:cassandra + status: No Data + tags: + - service:cassandra + type: query alert properties: counts: - $ref: '#/components/schemas/MonitorSearchResponseCounts' + $ref: "#/components/schemas/MonitorSearchResponseCounts" metadata: - $ref: '#/components/schemas/MonitorSearchResponseMetadata' + $ref: "#/components/schemas/MonitorSearchResponseMetadata" monitors: description: The list of found monitors. items: - $ref: '#/components/schemas/MonitorSearchResult' + $ref: "#/components/schemas/MonitorSearchResult" readOnly: true type: array type: object @@ -8966,13 +8354,13 @@ components: description: The counts of monitors per different criteria. properties: muted: - $ref: '#/components/schemas/MonitorSearchCount' + $ref: "#/components/schemas/MonitorSearchCount" status: - $ref: '#/components/schemas/MonitorSearchCount' + $ref: "#/components/schemas/MonitorSearchCount" tag: - $ref: '#/components/schemas/MonitorSearchCount' + $ref: "#/components/schemas/MonitorSearchCount" type: - $ref: '#/components/schemas/MonitorSearchCount' + $ref: "#/components/schemas/MonitorSearchCount" readOnly: true type: object MonitorSearchResponseMetadata: @@ -9007,7 +8395,7 @@ components: readOnly: true type: string creator: - $ref: '#/components/schemas/Creator' + $ref: "#/components/schemas/Creator" id: description: ID of the monitor. format: int64 @@ -9034,7 +8422,7 @@ components: notifications: description: The notification triggered by the monitor. items: - $ref: '#/components/schemas/MonitorSearchResultNotification' + $ref: "#/components/schemas/MonitorSearchResultNotification" readOnly: true type: array org_id: @@ -9052,26 +8440,22 @@ components: type: array query: description: The monitor query. - example: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100 + example: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" type: string scopes: - description: 'The scope(s) to which the downtime applies, for example `host:app2`. - + description: |- + The scope(s) to which the downtime applies, for example `host:app2`. Provide multiple scopes as a comma-separated list, for example `env:dev,env:prod`. - The resulting downtime applies to sources that matches ALL provided scopes - - (that is `env:dev AND env:prod`), NOT any of them.' - example: - - host:app2 - - env:dev,env:prod + (that is `env:dev AND env:prod`), NOT any of them. + example: ["host:app2", "env:dev,env:prod"] items: description: Scope value(s). readOnly: true type: string type: array status: - $ref: '#/components/schemas/MonitorOverallStates' + $ref: "#/components/schemas/MonitorOverallStates" tags: description: Tags associated with the monitor. items: @@ -9081,7 +8465,7 @@ components: readOnly: true type: array type: - $ref: '#/components/schemas/MonitorType' + $ref: "#/components/schemas/MonitorType" type: object MonitorSearchResultNotification: description: A notification triggered by the monitor. @@ -9101,11 +8485,10 @@ components: properties: groups: additionalProperties: - $ref: '#/components/schemas/MonitorStateGroup' - description: 'Dictionary where the keys are groups (comma separated lists - of tags) and the values are - - the list of groups your monitor is broken down on.' + $ref: "#/components/schemas/MonitorStateGroup" + description: |- + Dictionary where the keys are groups (comma separated lists of tags) and the values are + the list of groups your monitor is broken down on. type: object readOnly: true type: object @@ -9117,8 +8500,7 @@ components: format: int64 type: integer last_notified_ts: - description: Latest timestamp of the notification sent for this monitor - group. + description: Latest timestamp of the notification sent for this monitor group. format: int64 type: integer last_resolved_ts: @@ -9133,80 +8515,75 @@ components: description: The name of the monitor. type: string status: - $ref: '#/components/schemas/MonitorOverallStates' + $ref: "#/components/schemas/MonitorOverallStates" type: object MonitorSummaryWidgetDefinition: - description: The monitor summary widget displays a summary view of all your - Datadog monitors, or a subset based on a query. Only available on FREE layout - dashboards. + description: The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards. properties: color_preference: - $ref: '#/components/schemas/WidgetColorPreference' + $ref: "#/components/schemas/WidgetColorPreference" count: deprecated: true description: The number of monitors to display. format: int64 type: integer display_format: - $ref: '#/components/schemas/WidgetMonitorSummaryDisplayFormat' + $ref: "#/components/schemas/WidgetMonitorSummaryDisplayFormat" hide_zero_counts: description: Whether to show counts of 0 or not. type: boolean query: description: Query to filter the monitors with. - example: '' + example: "" type: string show_last_triggered: - description: Whether to show the time that has elapsed since the monitor/group - triggered. + description: Whether to show the time that has elapsed since the monitor/group triggered. type: boolean show_priority: default: false description: Whether to show the priorities column. type: boolean sort: - $ref: '#/components/schemas/WidgetMonitorSummarySort' + $ref: "#/components/schemas/WidgetMonitorSummarySort" start: deprecated: true description: The start of the list. Typically 0. format: int64 type: integer summary_type: - $ref: '#/components/schemas/WidgetSummaryType' + $ref: "#/components/schemas/WidgetSummaryType" title: description: Title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/MonitorSummaryWidgetDefinitionType' + $ref: "#/components/schemas/MonitorSummaryWidgetDefinitionType" required: - - type - - query + - type + - query type: object MonitorSummaryWidgetDefinitionType: default: manage_status description: Type of the monitor summary widget. enum: - - manage_status + - manage_status example: manage_status type: string x-enum-varnames: - - MANAGE_STATUS + - MANAGE_STATUS MonitorThresholdWindowOptions: description: Alerting time window options. properties: recovery_window: - description: Describes how long an anomalous metric must be normal before - the alert recovers. + description: Describes how long an anomalous metric must be normal before the alert recovers. nullable: true type: string trigger_window: - description: Describes how long a metric must be anomalous before an alert - triggers. + description: Describes how long a metric must be anomalous before an alert triggers. nullable: true type: string type: object @@ -9244,63 +8621,60 @@ components: type: number type: object MonitorType: - description: The type of the monitor. For more information about `type`, see - the [monitor options](https://docs.datadoghq.com/monitors/guide/monitor_api_options/) - docs. - enum: - - composite - - event alert - - log alert - - metric alert - - process alert - - query alert - - rum alert - - service check - - synthetics alert - - trace-analytics alert - - slo alert - - event-v2 alert - - audit alert - - ci-pipelines alert - - ci-tests alert - - error-tracking alert - - database-monitoring alert - - network-performance alert - - cost alert - - data-quality alert - - network-path alert - example: query alert - type: string - x-enum-varnames: - - COMPOSITE - - EVENT_ALERT - - LOG_ALERT - - METRIC_ALERT - - PROCESS_ALERT - - QUERY_ALERT - - RUM_ALERT - - SERVICE_CHECK - - SYNTHETICS_ALERT - - TRACE_ANALYTICS_ALERT - - SLO_ALERT - - EVENT_V2_ALERT - - AUDIT_ALERT - - CI_PIPELINES_ALERT - - CI_TESTS_ALERT - - ERROR_TRACKING_ALERT - - DATABASE_MONITORING_ALERT - - NETWORK_PERFORMANCE_ALERT - - COST_ALERT - - DATA_QUALITY_ALERT - - NETWORK_PATH_ALERT + description: The type of the monitor. For more information about `type`, see the [monitor options](https://docs.datadoghq.com/monitors/guide/monitor_api_options/) docs. + enum: + - "composite" + - "event alert" + - "log alert" + - "metric alert" + - "process alert" + - "query alert" + - "rum alert" + - "service check" + - "synthetics alert" + - "trace-analytics alert" + - "slo alert" + - "event-v2 alert" + - "audit alert" + - "ci-pipelines alert" + - "ci-tests alert" + - "error-tracking alert" + - "database-monitoring alert" + - "network-performance alert" + - "cost alert" + - "data-quality alert" + - "network-path alert" + example: "query alert" + type: string + x-enum-varnames: + - COMPOSITE + - EVENT_ALERT + - LOG_ALERT + - METRIC_ALERT + - PROCESS_ALERT + - QUERY_ALERT + - RUM_ALERT + - SERVICE_CHECK + - SYNTHETICS_ALERT + - TRACE_ANALYTICS_ALERT + - SLO_ALERT + - EVENT_V2_ALERT + - AUDIT_ALERT + - CI_PIPELINES_ALERT + - CI_TESTS_ALERT + - ERROR_TRACKING_ALERT + - DATABASE_MONITORING_ALERT + - NETWORK_PERFORMANCE_ALERT + - COST_ALERT + - DATA_QUALITY_ALERT + - NETWORK_PATH_ALERT MonitorUpdateRequest: description: Object describing a monitor update request. properties: assets: - description: The list of monitor assets tied to a monitor, which represents - key links for users to take action on monitor alerts (for example, runbooks). + description: The list of monitor assets tied to a monitor, which represents key links for users to take action on monitor alerts (for example, runbooks). items: - $ref: '#/components/schemas/MonitorAsset' + $ref: "#/components/schemas/MonitorAsset" nullable: true type: array created: @@ -9309,7 +8683,7 @@ components: readOnly: true type: string creator: - $ref: '#/components/schemas/Creator' + $ref: "#/components/schemas/Creator" deleted: description: Whether or not the monitor is deleted. (Always `null`) format: date-time @@ -9317,7 +8691,7 @@ components: readOnly: true type: string draft_status: - $ref: '#/components/schemas/MonitorDraftStatus' + $ref: "#/components/schemas/MonitorDraftStatus" id: description: ID of this monitor. format: int64 @@ -9339,9 +8713,9 @@ components: description: The monitor name. type: string options: - $ref: '#/components/schemas/MonitorOptions' + $ref: "#/components/schemas/MonitorOptions" overall_state: - $ref: '#/components/schemas/MonitorOverallStates' + $ref: "#/components/schemas/MonitorOverallStates" priority: description: Integer from 1 (high) to 5 (low) indicating alert severity. format: int64 @@ -9351,22 +8725,14 @@ components: description: The monitor query. type: string restricted_roles: - description: A list of unique role identifiers to define which roles are - allowed to edit the monitor. The unique identifiers for all roles can - be pulled from the [Roles API](https://docs.datadoghq.com/api/latest/roles/#list-roles) - and are located in the `data.id` field. Editing a monitor includes any - updates to the monitor configuration, monitor deletion, and muting of - the monitor for any amount of time. You can use the [Restriction Policies - API](https://docs.datadoghq.com/api/latest/restriction-policies/) to manage - write authorization for individual monitors by teams and users, in addition - to roles. + description: A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the [Roles API](https://docs.datadoghq.com/api/latest/roles/#list-roles) and are located in the `data.id` field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. You can use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) to manage write authorization for individual monitors by teams and users, in addition to roles. items: description: A role UUID. type: string nullable: true type: array state: - $ref: '#/components/schemas/MonitorState' + $ref: "#/components/schemas/MonitorState" tags: description: Tags associated to your monitor. items: @@ -9374,13 +8740,13 @@ components: type: string type: array type: - $ref: '#/components/schemas/MonitorType' + $ref: "#/components/schemas/MonitorType" type: object MonthlyUsageAttributionBody: description: Usage Summary by tag for a given organization. properties: month: - description: 'Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM].' + description: "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]." format: date-time type: string org_name: @@ -9390,37 +8756,33 @@ components: description: The organization public ID. type: string region: - description: The region of the Datadog instance that the organization belongs - to. + description: The region of the Datadog instance that the organization belongs to. type: string tag_config_source: - description: The source of the usage attribution tag configuration and the - selected tags in the format `::://////`. + description: The source of the usage attribution tag configuration and the selected tags in the format `::://////`. type: string tags: - $ref: '#/components/schemas/UsageAttributionTagNames' + $ref: "#/components/schemas/UsageAttributionTagNames" updated_at: description: Datetime of the most recent update to the usage values. format: date-time type: string values: - $ref: '#/components/schemas/MonthlyUsageAttributionValues' + $ref: "#/components/schemas/MonthlyUsageAttributionValues" type: object MonthlyUsageAttributionMetadata: description: The object containing document metadata. properties: aggregates: - $ref: '#/components/schemas/UsageAttributionAggregates' + $ref: "#/components/schemas/UsageAttributionAggregates" pagination: - $ref: '#/components/schemas/MonthlyUsageAttributionPagination' + $ref: "#/components/schemas/MonthlyUsageAttributionPagination" type: object MonthlyUsageAttributionPagination: description: The metadata for the current pagination. properties: next_record_id: - description: The cursor to use to get the next results, if any. To make - the next request, use the same parameters with the addition of the `next_record_id`. + description: The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of the `next_record_id`. nullable: true type: string type: object @@ -9428,350 +8790,349 @@ components: description: Response containing the monthly Usage Summary by tag(s). properties: metadata: - $ref: '#/components/schemas/MonthlyUsageAttributionMetadata' + $ref: "#/components/schemas/MonthlyUsageAttributionMetadata" usage: description: Get usage summary by tag(s). items: - $ref: '#/components/schemas/MonthlyUsageAttributionBody' + $ref: "#/components/schemas/MonthlyUsageAttributionBody" type: array type: object MonthlyUsageAttributionSupportedMetrics: - description: 'Supported metrics for monthly usage attribution requests. Usage - types are in the format `_usage`. - - To obtain the complete list of valid usage types, make a request to the [Get - usage attribution types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types).' - enum: - - api_usage - - api_percentage - - apm_fargate_usage - - apm_fargate_percentage - - appsec_fargate_usage - - appsec_fargate_percentage - - apm_host_usage - - apm_host_percentage - - apm_usm_usage - - apm_usm_percentage - - appsec_usage - - appsec_percentage - - asm_serverless_traced_invocations_usage - - asm_serverless_traced_invocations_percentage - - bits_ai_investigations_usage - - bits_ai_investigations_percentage - - browser_usage - - browser_percentage - - ci_visibility_itr_usage - - ci_visibility_itr_percentage - - cloud_siem_usage - - cloud_siem_percentage - - code_security_host_usage - - code_security_host_percentage - - container_excl_agent_usage - - container_excl_agent_percentage - - container_usage - - container_percentage - - cspm_containers_percentage - - cspm_containers_usage - - cspm_hosts_percentage - - cspm_hosts_usage - - custom_timeseries_usage - - custom_timeseries_percentage - - custom_ingested_timeseries_usage - - custom_ingested_timeseries_percentage - - cws_containers_percentage - - cws_containers_usage - - cws_fargate_task_percentage - - cws_fargate_task_usage - - cws_hosts_percentage - - cws_hosts_usage - - data_jobs_monitoring_usage - - data_jobs_monitoring_percentage - - data_stream_monitoring_usage - - data_stream_monitoring_percentage - - dbm_hosts_percentage - - dbm_hosts_usage - - dbm_queries_percentage - - dbm_queries_usage - - error_tracking_usage - - error_tracking_percentage - - estimated_indexed_spans_usage - - estimated_indexed_spans_percentage - - estimated_ingested_spans_usage - - estimated_ingested_spans_percentage - - fargate_usage - - fargate_percentage - - flex_logs_starter_usage - - flex_logs_starter_percentage - - flex_stored_logs_usage - - flex_stored_logs_percentage - - functions_usage - - functions_percentage - - incident_management_monthly_active_users_usage - - incident_management_monthly_active_users_percentage - - infra_host_usage - - infra_host_percentage - - invocations_usage - - invocations_percentage - - lambda_traced_invocations_usage - - lambda_traced_invocations_percentage - - llm_observability_usage - - llm_observability_percentage - - llm_spans_usage - - llm_spans_percentage - - mobile_app_testing_percentage - - mobile_app_testing_usage - - ndm_netflow_usage - - ndm_netflow_percentage - - network_device_wireless_usage - - network_device_wireless_percentage - - npm_host_usage - - npm_host_percentage - - obs_pipeline_bytes_usage - - obs_pipeline_bytes_percentage - - obs_pipelines_vcpu_usage - - obs_pipelines_vcpu_percentage - - online_archive_usage - - online_archive_percentage - - product_analytics_session_usage - - product_analytics_session_percentage - - profiled_container_usage - - profiled_container_percentage - - profiled_fargate_usage - - profiled_fargate_percentage - - profiled_host_usage - - profiled_host_percentage - - published_app_usage - - published_app_percentage - - serverless_apps_usage - - serverless_apps_percentage - - snmp_usage - - snmp_percentage - - universal_service_monitoring_usage - - universal_service_monitoring_percentage - - vuln_management_hosts_usage - - vuln_management_hosts_percentage - - sds_scanned_bytes_usage - - sds_scanned_bytes_percentage - - ci_test_indexed_spans_usage - - ci_test_indexed_spans_percentage - - ingested_logs_bytes_usage - - ingested_logs_bytes_percentage - - ci_pipeline_indexed_spans_usage - - ci_pipeline_indexed_spans_percentage - - indexed_spans_usage - - indexed_spans_percentage - - custom_event_usage - - custom_event_percentage - - logs_indexed_custom_retention_usage - - logs_indexed_custom_retention_percentage - - logs_indexed_360day_usage - - logs_indexed_360day_percentage - - logs_indexed_180day_usage - - logs_indexed_180day_percentage - - logs_indexed_90day_usage - - logs_indexed_90day_percentage - - logs_indexed_60day_usage - - logs_indexed_60day_percentage - - logs_indexed_45day_usage - - logs_indexed_45day_percentage - - logs_indexed_30day_usage - - logs_indexed_30day_percentage - - logs_indexed_15day_usage - - logs_indexed_15day_percentage - - logs_indexed_7day_usage - - logs_indexed_7day_percentage - - logs_indexed_3day_usage - - logs_indexed_3day_percentage - - logs_indexed_1day_usage - - logs_indexed_1day_percentage - - rum_ingested_usage - - rum_ingested_percentage - - rum_investigate_usage - - rum_investigate_percentage - - rum_replay_sessions_usage - - rum_replay_sessions_percentage - - rum_session_replay_add_on_usage - - rum_session_replay_add_on_percentage - - rum_browser_mobile_sessions_usage - - rum_browser_mobile_sessions_percentage - - ingested_spans_bytes_usage - - ingested_spans_bytes_percentage - - siem_analyzed_logs_add_on_usage - - siem_analyzed_logs_add_on_percentage - - siem_ingested_bytes_usage - - siem_ingested_bytes_percentage - - workflow_executions_usage - - workflow_executions_percentage - - sca_fargate_usage - - sca_fargate_percentage - - '*' - type: string - x-enum-varnames: - - API_USAGE - - API_PERCENTAGE - - APM_FARGATE_USAGE - - APM_FARGATE_PERCENTAGE - - APPSEC_FARGATE_USAGE - - APPSEC_FARGATE_PERCENTAGE - - APM_HOST_USAGE - - APM_HOST_PERCENTAGE - - APM_USM_USAGE - - APM_USM_PERCENTAGE - - APPSEC_USAGE - - APPSEC_PERCENTAGE - - ASM_SERVERLESS_TRACED_INVOCATIONS_USAGE - - ASM_SERVERLESS_TRACED_INVOCATIONS_PERCENTAGE - - BITS_AI_INVESTIGATIONS_USAGE - - BITS_AI_INVESTIGATIONS_PERCENTAGE - - BROWSER_USAGE - - BROWSER_PERCENTAGE - - CI_VISIBILITY_ITR_USAGE - - CI_VISIBILITY_ITR_PERCENTAGE - - CLOUD_SIEM_USAGE - - CLOUD_SIEM_PERCENTAGE - - CODE_SECURITY_HOST_USAGE - - CODE_SECURITY_HOST_PERCENTAGE - - CONTAINER_EXCL_AGENT_USAGE - - CONTAINER_EXCL_AGENT_PERCENTAGE - - CONTAINER_USAGE - - CONTAINER_PERCENTAGE - - CSPM_CONTAINERS_PERCENTAGE - - CSPM_CONTAINERS_USAGE - - CSPM_HOSTS_PERCENTAGE - - CSPM_HOSTS_USAGE - - CUSTOM_TIMESERIES_USAGE - - CUSTOM_TIMESERIES_PERCENTAGE - - CUSTOM_INGESTED_TIMESERIES_USAGE - - CUSTOM_INGESTED_TIMESERIES_PERCENTAGE - - CWS_CONTAINERS_PERCENTAGE - - CWS_CONTAINERS_USAGE - - CWS_FARGATE_TASK_PERCENTAGE - - CWS_FARGATE_TASK_USAGE - - CWS_HOSTS_PERCENTAGE - - CWS_HOSTS_USAGE - - DATA_JOBS_MONITORING_USAGE - - DATA_JOBS_MONITORING_PERCENTAGE - - DATA_STREAM_MONITORING_USAGE - - DATA_STREAM_MONITORING_PERCENTAGE - - DBM_HOSTS_PERCENTAGE - - DBM_HOSTS_USAGE - - DBM_QUERIES_PERCENTAGE - - DBM_QUERIES_USAGE - - ERROR_TRACKING_USAGE - - ERROR_TRACKING_PERCENTAGE - - ESTIMATED_INDEXED_SPANS_USAGE - - ESTIMATED_INDEXED_SPANS_PERCENTAGE - - ESTIMATED_INGESTED_SPANS_USAGE - - ESTIMATED_INGESTED_SPANS_PERCENTAGE - - FARGATE_USAGE - - FARGATE_PERCENTAGE - - FLEX_LOGS_STARTER_USAGE - - FLEX_LOGS_STARTER_PERCENTAGE - - FLEX_STORED_LOGS_USAGE - - FLEX_STORED_LOGS_PERCENTAGE - - FUNCTIONS_USAGE - - FUNCTIONS_PERCENTAGE - - INCIDENT_MANAGEMENT_MONTHLY_ACTIVE_USERS_USAGE - - INCIDENT_MANAGEMENT_MONTHLY_ACTIVE_USERS_PERCENTAGE - - INFRA_HOST_USAGE - - INFRA_HOST_PERCENTAGE - - INVOCATIONS_USAGE - - INVOCATIONS_PERCENTAGE - - LAMBDA_TRACED_INVOCATIONS_USAGE - - LAMBDA_TRACED_INVOCATIONS_PERCENTAGE - - LLM_OBSERVABILITY_USAGE - - LLM_OBSERVABILITY_PERCENTAGE - - LLM_SPANS_USAGE - - LLM_SPANS_PERCENTAGE - - MOBILE_APP_TESTING_USAGE - - MOBILE_APP_TESTING_PERCENTAGE - - NDM_NETFLOW_USAGE - - NDM_NETFLOW_PERCENTAGE - - NETWORK_DEVICE_WIRELESS_USAGE - - NETWORK_DEVICE_WIRELESS_PERCENTAGE - - NPM_HOST_USAGE - - NPM_HOST_PERCENTAGE - - OBS_PIPELINE_BYTES_USAGE - - OBS_PIPELINE_BYTES_PERCENTAGE - - OBS_PIPELINES_VCPU_USAGE - - OBS_PIPELINES_VCPU_PERCENTAGE - - ONLINE_ARCHIVE_USAGE - - ONLINE_ARCHIVE_PERCENTAGE - - PRODUCT_ANALYTICS_SESSION_USAGE - - PRODUCT_ANALYTICS_SESSION_PERCENTAGE - - PROFILED_CONTAINER_USAGE - - PROFILED_CONTAINER_PERCENTAGE - - PROFILED_FARGATE_USAGE - - PROFILED_FARGATE_PERCENTAGE - - PROFILED_HOST_USAGE - - PROFILED_HOST_PERCENTAGE - - PUBLISHED_APP_USAGE - - PUBLISHED_APP_PERCENTAGE - - SERVERLESS_APPS_USAGE - - SERVERLESS_APPS_PERCENTAGE - - SNMP_USAGE - - SNMP_PERCENTAGE - - UNIVERSAL_SERVICE_MONITORING_USAGE - - UNIVERSAL_SERVICE_MONITORING_PERCENTAGE - - VULN_MANAGEMENT_HOSTS_USAGE - - VULN_MANAGEMENT_HOSTS_PERCENTAGE - - SDS_SCANNED_BYTES_USAGE - - SDS_SCANNED_BYTES_PERCENTAGE - - CI_TEST_INDEXED_SPANS_USAGE - - CI_TEST_INDEXED_SPANS_PERCENTAGE - - INGESTED_LOGS_BYTES_USAGE - - INGESTED_LOGS_BYTES_PERCENTAGE - - CI_PIPELINE_INDEXED_SPANS_USAGE - - CI_PIPELINE_INDEXED_SPANS_PERCENTAGE - - INDEXED_SPANS_USAGE - - INDEXED_SPANS_PERCENTAGE - - CUSTOM_EVENT_USAGE - - CUSTOM_EVENT_PERCENTAGE - - LOGS_INDEXED_CUSTOM_RETENTION_USAGE - - LOGS_INDEXED_CUSTOM_RETENTION_PERCENTAGE - - LOGS_INDEXED_360DAY_USAGE - - LOGS_INDEXED_360DAY_PERCENTAGE - - LOGS_INDEXED_180DAY_USAGE - - LOGS_INDEXED_180DAY_PERCENTAGE - - LOGS_INDEXED_90DAY_USAGE - - LOGS_INDEXED_90DAY_PERCENTAGE - - LOGS_INDEXED_60DAY_USAGE - - LOGS_INDEXED_60DAY_PERCENTAGE - - LOGS_INDEXED_45DAY_USAGE - - LOGS_INDEXED_45DAY_PERCENTAGE - - LOGS_INDEXED_30DAY_USAGE - - LOGS_INDEXED_30DAY_PERCENTAGE - - LOGS_INDEXED_15DAY_USAGE - - LOGS_INDEXED_15DAY_PERCENTAGE - - LOGS_INDEXED_7DAY_USAGE - - LOGS_INDEXED_7DAY_PERCENTAGE - - LOGS_INDEXED_3DAY_USAGE - - LOGS_INDEXED_3DAY_PERCENTAGE - - LOGS_INDEXED_1DAY_USAGE - - LOGS_INDEXED_1DAY_PERCENTAGE - - RUM_INGESTED_USAGE - - RUM_INGESTED_PERCENTAGE - - RUM_INVESTIGATE_USAGE - - RUM_INVESTIGATE_PERCENTAGE - - RUM_REPLAY_SESSIONS_USAGE - - RUM_REPLAY_SESSIONS_PERCENTAGE - - RUM_SESSION_REPLAY_ADD_ON_USAGE - - RUM_SESSION_REPLAY_ADD_ON_PERCENTAGE - - RUM_BROWSER_MOBILE_SESSIONS_USAGE - - RUM_BROWSER_MOBILE_SESSIONS_PERCENTAGE - - INGESTED_SPANS_BYTES_USAGE - - INGESTED_SPANS_BYTES_PERCENTAGE - - SIEM_ANALYZED_LOGS_ADD_ON_USAGE - - SIEM_ANALYZED_LOGS_ADD_ON_PERCENTAGE - - SIEM_INGESTED_BYTES_USAGE - - SIEM_INGESTED_BYTES_PERCENTAGE - - WORKFLOW_EXECUTIONS_USAGE - - WORKFLOW_EXECUTIONS_PERCENTAGE - - SCA_FARGATE_USAGE - - SCA_FARGATE_PERCENTAGE - - ALL + description: |- + Supported metrics for monthly usage attribution requests. Usage types are in the format `_usage`. + To obtain the complete list of valid usage types, make a request to the [Get usage attribution types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types). + enum: + - api_usage + - api_percentage + - apm_fargate_usage + - apm_fargate_percentage + - appsec_fargate_usage + - appsec_fargate_percentage + - apm_host_usage + - apm_host_percentage + - apm_usm_usage + - apm_usm_percentage + - appsec_usage + - appsec_percentage + - asm_serverless_traced_invocations_usage + - asm_serverless_traced_invocations_percentage + - bits_ai_investigations_usage + - bits_ai_investigations_percentage + - browser_usage + - browser_percentage + - ci_visibility_itr_usage + - ci_visibility_itr_percentage + - cloud_siem_usage + - cloud_siem_percentage + - code_security_host_usage + - code_security_host_percentage + - container_excl_agent_usage + - container_excl_agent_percentage + - container_usage + - container_percentage + - cspm_containers_percentage + - cspm_containers_usage + - cspm_hosts_percentage + - cspm_hosts_usage + - custom_timeseries_usage + - custom_timeseries_percentage + - custom_ingested_timeseries_usage + - custom_ingested_timeseries_percentage + - cws_containers_percentage + - cws_containers_usage + - cws_fargate_task_percentage + - cws_fargate_task_usage + - cws_hosts_percentage + - cws_hosts_usage + - data_jobs_monitoring_usage + - data_jobs_monitoring_percentage + - data_stream_monitoring_usage + - data_stream_monitoring_percentage + - dbm_hosts_percentage + - dbm_hosts_usage + - dbm_queries_percentage + - dbm_queries_usage + - error_tracking_usage + - error_tracking_percentage + - estimated_indexed_spans_usage + - estimated_indexed_spans_percentage + - estimated_ingested_spans_usage + - estimated_ingested_spans_percentage + - fargate_usage + - fargate_percentage + - flex_logs_starter_usage + - flex_logs_starter_percentage + - flex_stored_logs_usage + - flex_stored_logs_percentage + - functions_usage + - functions_percentage + - incident_management_monthly_active_users_usage + - incident_management_monthly_active_users_percentage + - infra_host_usage + - infra_host_percentage + - invocations_usage + - invocations_percentage + - lambda_traced_invocations_usage + - lambda_traced_invocations_percentage + - llm_observability_usage + - llm_observability_percentage + - llm_spans_usage + - llm_spans_percentage + - mobile_app_testing_percentage + - mobile_app_testing_usage + - ndm_netflow_usage + - ndm_netflow_percentage + - network_device_wireless_usage + - network_device_wireless_percentage + - npm_host_usage + - npm_host_percentage + - obs_pipeline_bytes_usage + - obs_pipeline_bytes_percentage + - obs_pipelines_vcpu_usage + - obs_pipelines_vcpu_percentage + - online_archive_usage + - online_archive_percentage + - product_analytics_session_usage + - product_analytics_session_percentage + - profiled_container_usage + - profiled_container_percentage + - profiled_fargate_usage + - profiled_fargate_percentage + - profiled_host_usage + - profiled_host_percentage + - published_app_usage + - published_app_percentage + - serverless_apps_usage + - serverless_apps_percentage + - snmp_usage + - snmp_percentage + - universal_service_monitoring_usage + - universal_service_monitoring_percentage + - vuln_management_hosts_usage + - vuln_management_hosts_percentage + - sds_scanned_bytes_usage + - sds_scanned_bytes_percentage + - ci_test_indexed_spans_usage + - ci_test_indexed_spans_percentage + - ingested_logs_bytes_usage + - ingested_logs_bytes_percentage + - ci_pipeline_indexed_spans_usage + - ci_pipeline_indexed_spans_percentage + - indexed_spans_usage + - indexed_spans_percentage + - custom_event_usage + - custom_event_percentage + - logs_indexed_custom_retention_usage + - logs_indexed_custom_retention_percentage + - logs_indexed_360day_usage + - logs_indexed_360day_percentage + - logs_indexed_180day_usage + - logs_indexed_180day_percentage + - logs_indexed_90day_usage + - logs_indexed_90day_percentage + - logs_indexed_60day_usage + - logs_indexed_60day_percentage + - logs_indexed_45day_usage + - logs_indexed_45day_percentage + - logs_indexed_30day_usage + - logs_indexed_30day_percentage + - logs_indexed_15day_usage + - logs_indexed_15day_percentage + - logs_indexed_7day_usage + - logs_indexed_7day_percentage + - logs_indexed_3day_usage + - logs_indexed_3day_percentage + - logs_indexed_1day_usage + - logs_indexed_1day_percentage + - rum_ingested_usage + - rum_ingested_percentage + - rum_investigate_usage + - rum_investigate_percentage + - rum_replay_sessions_usage + - rum_replay_sessions_percentage + - rum_session_replay_add_on_usage + - rum_session_replay_add_on_percentage + - rum_browser_mobile_sessions_usage + - rum_browser_mobile_sessions_percentage + - ingested_spans_bytes_usage + - ingested_spans_bytes_percentage + - siem_analyzed_logs_add_on_usage + - siem_analyzed_logs_add_on_percentage + - siem_ingested_bytes_usage + - siem_ingested_bytes_percentage + - workflow_executions_usage + - workflow_executions_percentage + - sca_fargate_usage + - sca_fargate_percentage + - "*" + type: string + x-enum-varnames: + - API_USAGE + - API_PERCENTAGE + - APM_FARGATE_USAGE + - APM_FARGATE_PERCENTAGE + - APPSEC_FARGATE_USAGE + - APPSEC_FARGATE_PERCENTAGE + - APM_HOST_USAGE + - APM_HOST_PERCENTAGE + - APM_USM_USAGE + - APM_USM_PERCENTAGE + - APPSEC_USAGE + - APPSEC_PERCENTAGE + - ASM_SERVERLESS_TRACED_INVOCATIONS_USAGE + - ASM_SERVERLESS_TRACED_INVOCATIONS_PERCENTAGE + - BITS_AI_INVESTIGATIONS_USAGE + - BITS_AI_INVESTIGATIONS_PERCENTAGE + - BROWSER_USAGE + - BROWSER_PERCENTAGE + - CI_VISIBILITY_ITR_USAGE + - CI_VISIBILITY_ITR_PERCENTAGE + - CLOUD_SIEM_USAGE + - CLOUD_SIEM_PERCENTAGE + - CODE_SECURITY_HOST_USAGE + - CODE_SECURITY_HOST_PERCENTAGE + - CONTAINER_EXCL_AGENT_USAGE + - CONTAINER_EXCL_AGENT_PERCENTAGE + - CONTAINER_USAGE + - CONTAINER_PERCENTAGE + - CSPM_CONTAINERS_PERCENTAGE + - CSPM_CONTAINERS_USAGE + - CSPM_HOSTS_PERCENTAGE + - CSPM_HOSTS_USAGE + - CUSTOM_TIMESERIES_USAGE + - CUSTOM_TIMESERIES_PERCENTAGE + - CUSTOM_INGESTED_TIMESERIES_USAGE + - CUSTOM_INGESTED_TIMESERIES_PERCENTAGE + - CWS_CONTAINERS_PERCENTAGE + - CWS_CONTAINERS_USAGE + - CWS_FARGATE_TASK_PERCENTAGE + - CWS_FARGATE_TASK_USAGE + - CWS_HOSTS_PERCENTAGE + - CWS_HOSTS_USAGE + - DATA_JOBS_MONITORING_USAGE + - DATA_JOBS_MONITORING_PERCENTAGE + - DATA_STREAM_MONITORING_USAGE + - DATA_STREAM_MONITORING_PERCENTAGE + - DBM_HOSTS_PERCENTAGE + - DBM_HOSTS_USAGE + - DBM_QUERIES_PERCENTAGE + - DBM_QUERIES_USAGE + - ERROR_TRACKING_USAGE + - ERROR_TRACKING_PERCENTAGE + - ESTIMATED_INDEXED_SPANS_USAGE + - ESTIMATED_INDEXED_SPANS_PERCENTAGE + - ESTIMATED_INGESTED_SPANS_USAGE + - ESTIMATED_INGESTED_SPANS_PERCENTAGE + - FARGATE_USAGE + - FARGATE_PERCENTAGE + - FLEX_LOGS_STARTER_USAGE + - FLEX_LOGS_STARTER_PERCENTAGE + - FLEX_STORED_LOGS_USAGE + - FLEX_STORED_LOGS_PERCENTAGE + - FUNCTIONS_USAGE + - FUNCTIONS_PERCENTAGE + - INCIDENT_MANAGEMENT_MONTHLY_ACTIVE_USERS_USAGE + - INCIDENT_MANAGEMENT_MONTHLY_ACTIVE_USERS_PERCENTAGE + - INFRA_HOST_USAGE + - INFRA_HOST_PERCENTAGE + - INVOCATIONS_USAGE + - INVOCATIONS_PERCENTAGE + - LAMBDA_TRACED_INVOCATIONS_USAGE + - LAMBDA_TRACED_INVOCATIONS_PERCENTAGE + - LLM_OBSERVABILITY_USAGE + - LLM_OBSERVABILITY_PERCENTAGE + - LLM_SPANS_USAGE + - LLM_SPANS_PERCENTAGE + - MOBILE_APP_TESTING_USAGE + - MOBILE_APP_TESTING_PERCENTAGE + - NDM_NETFLOW_USAGE + - NDM_NETFLOW_PERCENTAGE + - NETWORK_DEVICE_WIRELESS_USAGE + - NETWORK_DEVICE_WIRELESS_PERCENTAGE + - NPM_HOST_USAGE + - NPM_HOST_PERCENTAGE + - OBS_PIPELINE_BYTES_USAGE + - OBS_PIPELINE_BYTES_PERCENTAGE + - OBS_PIPELINES_VCPU_USAGE + - OBS_PIPELINES_VCPU_PERCENTAGE + - ONLINE_ARCHIVE_USAGE + - ONLINE_ARCHIVE_PERCENTAGE + - PRODUCT_ANALYTICS_SESSION_USAGE + - PRODUCT_ANALYTICS_SESSION_PERCENTAGE + - PROFILED_CONTAINER_USAGE + - PROFILED_CONTAINER_PERCENTAGE + - PROFILED_FARGATE_USAGE + - PROFILED_FARGATE_PERCENTAGE + - PROFILED_HOST_USAGE + - PROFILED_HOST_PERCENTAGE + - PUBLISHED_APP_USAGE + - PUBLISHED_APP_PERCENTAGE + - SERVERLESS_APPS_USAGE + - SERVERLESS_APPS_PERCENTAGE + - SNMP_USAGE + - SNMP_PERCENTAGE + - UNIVERSAL_SERVICE_MONITORING_USAGE + - UNIVERSAL_SERVICE_MONITORING_PERCENTAGE + - VULN_MANAGEMENT_HOSTS_USAGE + - VULN_MANAGEMENT_HOSTS_PERCENTAGE + - SDS_SCANNED_BYTES_USAGE + - SDS_SCANNED_BYTES_PERCENTAGE + - CI_TEST_INDEXED_SPANS_USAGE + - CI_TEST_INDEXED_SPANS_PERCENTAGE + - INGESTED_LOGS_BYTES_USAGE + - INGESTED_LOGS_BYTES_PERCENTAGE + - CI_PIPELINE_INDEXED_SPANS_USAGE + - CI_PIPELINE_INDEXED_SPANS_PERCENTAGE + - INDEXED_SPANS_USAGE + - INDEXED_SPANS_PERCENTAGE + - CUSTOM_EVENT_USAGE + - CUSTOM_EVENT_PERCENTAGE + - LOGS_INDEXED_CUSTOM_RETENTION_USAGE + - LOGS_INDEXED_CUSTOM_RETENTION_PERCENTAGE + - LOGS_INDEXED_360DAY_USAGE + - LOGS_INDEXED_360DAY_PERCENTAGE + - LOGS_INDEXED_180DAY_USAGE + - LOGS_INDEXED_180DAY_PERCENTAGE + - LOGS_INDEXED_90DAY_USAGE + - LOGS_INDEXED_90DAY_PERCENTAGE + - LOGS_INDEXED_60DAY_USAGE + - LOGS_INDEXED_60DAY_PERCENTAGE + - LOGS_INDEXED_45DAY_USAGE + - LOGS_INDEXED_45DAY_PERCENTAGE + - LOGS_INDEXED_30DAY_USAGE + - LOGS_INDEXED_30DAY_PERCENTAGE + - LOGS_INDEXED_15DAY_USAGE + - LOGS_INDEXED_15DAY_PERCENTAGE + - LOGS_INDEXED_7DAY_USAGE + - LOGS_INDEXED_7DAY_PERCENTAGE + - LOGS_INDEXED_3DAY_USAGE + - LOGS_INDEXED_3DAY_PERCENTAGE + - LOGS_INDEXED_1DAY_USAGE + - LOGS_INDEXED_1DAY_PERCENTAGE + - RUM_INGESTED_USAGE + - RUM_INGESTED_PERCENTAGE + - RUM_INVESTIGATE_USAGE + - RUM_INVESTIGATE_PERCENTAGE + - RUM_REPLAY_SESSIONS_USAGE + - RUM_REPLAY_SESSIONS_PERCENTAGE + - RUM_SESSION_REPLAY_ADD_ON_USAGE + - RUM_SESSION_REPLAY_ADD_ON_PERCENTAGE + - RUM_BROWSER_MOBILE_SESSIONS_USAGE + - RUM_BROWSER_MOBILE_SESSIONS_PERCENTAGE + - INGESTED_SPANS_BYTES_USAGE + - INGESTED_SPANS_BYTES_PERCENTAGE + - SIEM_ANALYZED_LOGS_ADD_ON_USAGE + - SIEM_ANALYZED_LOGS_ADD_ON_PERCENTAGE + - SIEM_INGESTED_BYTES_USAGE + - SIEM_INGESTED_BYTES_PERCENTAGE + - WORKFLOW_EXECUTIONS_USAGE + - WORKFLOW_EXECUTIONS_PERCENTAGE + - SCA_FARGATE_USAGE + - SCA_FARGATE_PERCENTAGE + - ALL MonthlyUsageAttributionValues: - description: Fields in Usage Summary by tag(s). + description: |- + Fields in Usage Summary by tag(s). properties: api_percentage: description: The percentage of synthetic API test usage by tag(s). @@ -9798,8 +9159,7 @@ components: format: double type: number apm_usm_percentage: - description: The percentage of APM and Universal Service Monitoring host - usage by tag(s). + description: The percentage of APM and Universal Service Monitoring host usage by tag(s). format: double type: number apm_usm_usage: @@ -9807,18 +9167,15 @@ components: format: double type: number appsec_fargate_percentage: - description: The percentage of Application Security Monitoring ECS Fargate - task usage by tag(s). + description: The percentage of Application Security Monitoring ECS Fargate task usage by tag(s). format: double type: number appsec_fargate_usage: - description: The Application Security Monitoring ECS Fargate task usage - by tag(s). + description: The Application Security Monitoring ECS Fargate task usage by tag(s). format: double type: number appsec_percentage: - description: The percentage of Application Security Monitoring host usage - by tag(s). + description: The percentage of Application Security Monitoring host usage by tag(s). format: double type: number appsec_usage: @@ -9826,13 +9183,11 @@ components: format: double type: number asm_serverless_traced_invocations_percentage: - description: The percentage of Application Security Monitoring Serverless - traced invocations usage by tag(s). + description: The percentage of Application Security Monitoring Serverless traced invocations usage by tag(s). format: double type: number asm_serverless_traced_invocations_usage: - description: The Application Security Monitoring Serverless traced invocations - usage by tag(s). + description: The Application Security Monitoring Serverless traced invocations usage by tag(s). format: double type: number bits_ai_investigations_percentage: @@ -9876,8 +9231,7 @@ components: format: double type: number ci_visibility_itr_percentage: - description: The percentage of Git committers for Intelligent Test Runner - usage by tag(s). + description: The percentage of Git committers for Intelligent Test Runner usage by tag(s). format: double type: number ci_visibility_itr_usage: @@ -9885,13 +9239,11 @@ components: format: double type: number cloud_siem_percentage: - description: The percentage of Cloud Security Information and Event Management - usage by tag(s). + description: The percentage of Cloud Security Information and Event Management usage by tag(s). format: double type: number cloud_siem_usage: - description: The Cloud Security Information and Event Management usage by - tag(s). + description: The Cloud Security Information and Event Management usage by tag(s). format: double type: number code_security_host_percentage: @@ -9903,8 +9255,7 @@ components: format: double type: number container_excl_agent_percentage: - description: The percentage of container usage without the Datadog Agent - by tag(s). + description: The percentage of container usage without the Datadog Agent by tag(s). format: double type: number container_excl_agent_usage: @@ -9920,8 +9271,7 @@ components: format: double type: number cspm_containers_percentage: - description: The percentage of Cloud Security Management Pro container usage - by tag(s). + description: The percentage of Cloud Security Management Pro container usage by tag(s). format: double type: number cspm_containers_usage: @@ -9929,8 +9279,7 @@ components: format: double type: number cspm_hosts_percentage: - description: The percentage of Cloud Security Management Pro host usage - by tag(s). + description: The percentage of Cloud Security Management Pro host usage by tag(s). format: double type: number cspm_hosts_usage: @@ -9962,8 +9311,7 @@ components: format: double type: number cws_containers_percentage: - description: The percentage of Cloud Workload Security container usage by - tag(s). + description: The percentage of Cloud Workload Security container usage by tag(s). format: double type: number cws_containers_usage: @@ -9971,8 +9319,7 @@ components: format: double type: number cws_fargate_task_percentage: - description: The percentage of Cloud Workload Security Fargate task usage - by tag(s). + description: The percentage of Cloud Workload Security Fargate task usage by tag(s). format: double type: number cws_fargate_task_usage: @@ -10068,8 +9415,7 @@ components: format: double type: number incident_management_monthly_active_users_percentage: - description: The percentage of Incident Management monthly active users - usage by tag(s). + description: The percentage of Incident Management monthly active users usage by tag(s). format: double type: number incident_management_monthly_active_users_usage: @@ -10141,8 +9487,7 @@ components: format: double type: number logs_indexed_15day_percentage: - description: The percentage of Indexed Logs (15-day Retention) usage by - tag(s). + description: The percentage of Indexed Logs (15-day Retention) usage by tag(s). format: double type: number logs_indexed_15day_usage: @@ -10150,8 +9495,7 @@ components: format: double type: number logs_indexed_180day_percentage: - description: The percentage of Indexed Logs (180-day Retention) usage by - tag(s). + description: The percentage of Indexed Logs (180-day Retention) usage by tag(s). format: double type: number logs_indexed_180day_usage: @@ -10167,8 +9511,7 @@ components: format: double type: number logs_indexed_30day_percentage: - description: The percentage of Indexed Logs (30-day Retention) usage by - tag(s). + description: The percentage of Indexed Logs (30-day Retention) usage by tag(s). format: double type: number logs_indexed_30day_usage: @@ -10176,8 +9519,7 @@ components: format: double type: number logs_indexed_360day_percentage: - description: The percentage of Indexed Logs (360-day Retention) usage by - tag(s). + description: The percentage of Indexed Logs (360-day Retention) usage by tag(s). format: double type: number logs_indexed_360day_usage: @@ -10193,8 +9535,7 @@ components: format: double type: number logs_indexed_45day_percentage: - description: The percentage of Indexed Logs (45-day Retention) usage by - tag(s). + description: The percentage of Indexed Logs (45-day Retention) usage by tag(s). format: double type: number logs_indexed_45day_usage: @@ -10202,8 +9543,7 @@ components: format: double type: number logs_indexed_60day_percentage: - description: The percentage of Indexed Logs (60-day Retention) usage by - tag(s). + description: The percentage of Indexed Logs (60-day Retention) usage by tag(s). format: double type: number logs_indexed_60day_usage: @@ -10219,8 +9559,7 @@ components: format: double type: number logs_indexed_90day_percentage: - description: The percentage of Indexed Logs (90-day Retention) usage by - tag(s). + description: The percentage of Indexed Logs (90-day Retention) usage by tag(s). format: double type: number logs_indexed_90day_usage: @@ -10228,8 +9567,7 @@ components: format: double type: number logs_indexed_custom_retention_percentage: - description: The percentage of Indexed Logs (Custom Retention) usage by - tag(s). + description: The percentage of Indexed Logs (Custom Retention) usage by tag(s). format: double type: number logs_indexed_custom_retention_usage: @@ -10237,8 +9575,7 @@ components: format: double type: number mobile_app_testing_percentage: - description: The percentage of Synthetic mobile application test usage by - tag(s). + description: The percentage of Synthetic mobile application test usage by tag(s). format: double type: number mobile_app_testing_usage: @@ -10246,8 +9583,7 @@ components: format: double type: number ndm_netflow_percentage: - description: The percentage of Network Device Monitoring NetFlow usage by - tag(s). + description: The percentage of Network Device Monitoring NetFlow usage by tag(s). format: double type: number ndm_netflow_usage: @@ -10279,8 +9615,7 @@ components: format: double type: number obs_pipelines_vcpu_percentage: - description: The percentage of observability pipeline per core usage by - tag(s). + description: The percentage of observability pipeline per core usage by tag(s). format: double type: number obs_pipelines_vcpu_usage: @@ -10376,13 +9711,11 @@ components: format: double type: number sca_fargate_percentage: - description: The percentage of Software Composition Analysis Fargate task - usage by tag(s). + description: The percentage of Software Composition Analysis Fargate task usage by tag(s). format: double type: number sca_fargate_usage: - description: The total Software Composition Analysis Fargate task usage - by tag(s). + description: The total Software Composition Analysis Fargate task usage by tag(s). format: double type: number sds_scanned_bytes_percentage: @@ -10402,8 +9735,7 @@ components: format: double type: number siem_analyzed_logs_add_on_percentage: - description: The percentage of log events analyzed by Cloud SIEM usage by - tag(s). + description: The percentage of log events analyzed by Cloud SIEM usage by tag(s). format: double type: number siem_analyzed_logs_add_on_usage: @@ -10435,8 +9767,7 @@ components: format: double type: number vuln_management_hosts_percentage: - description: The percentage of Application Vulnerability Management usage - by tag(s). + description: The percentage of Application Vulnerability Management usage by tag(s). format: double type: number vuln_management_hosts_usage: @@ -10453,15 +9784,14 @@ components: type: number type: object NoteWidgetDefinition: - description: The notes and links widget is similar to free text widget, but - allows for more formatting options. + description: The notes and links widget is similar to free text widget, but allows for more formatting options. properties: background_color: description: Background color of the note. type: string content: description: Content of the note. - example: '' + example: "" type: string font_size: description: Size of the text. @@ -10474,52 +9804,51 @@ components: description: Whether to show a tick or not. type: boolean text_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" tick_edge: - $ref: '#/components/schemas/WidgetTickEdge' + $ref: "#/components/schemas/WidgetTickEdge" tick_pos: description: Where to position the tick on an edge. type: string type: - $ref: '#/components/schemas/NoteWidgetDefinitionType' + $ref: "#/components/schemas/NoteWidgetDefinitionType" vertical_align: - $ref: '#/components/schemas/WidgetVerticalAlign' + $ref: "#/components/schemas/WidgetVerticalAlign" required: - - type - - content + - type + - content type: object NoteWidgetDefinitionType: default: note description: Type of the note widget. enum: - - note + - note example: note type: string x-enum-varnames: - - NOTE + - NOTE NotebookAbsoluteTime: description: Absolute timeframe. example: - end: '2021-02-24T20:18:28+00:00' - start: '2021-02-24T19:18:28+00:00' + end: "2021-02-24T20:18:28+00:00" + start: "2021-02-24T19:18:28+00:00" properties: end: description: The end time. - example: '2021-02-24T20:18:28+00:00' + example: "2021-02-24T20:18:28+00:00" format: date-time type: string live: - description: Indicates whether the timeframe should be shifted to end at - the current time. + description: Indicates whether the timeframe should be shifted to end at the current time. type: boolean start: description: The start time. - example: '2021-02-24T19:18:28+00:00' + example: "2021-02-24T19:18:28+00:00" format: date-time type: string required: - - start - - end + - start + - end type: object NotebookAuthor: description: Attributes of user object returned by the API. @@ -10560,327 +9889,236 @@ components: description: The description of a notebook cell create request. properties: attributes: - $ref: '#/components/schemas/NotebookCellCreateRequestAttributes' + $ref: "#/components/schemas/NotebookCellCreateRequestAttributes" type: - $ref: '#/components/schemas/NotebookCellResourceType' + $ref: "#/components/schemas/NotebookCellResourceType" required: - - attributes - - type + - attributes + - type type: object NotebookCellCreateRequestAttributes: - description: 'The attributes of a notebook cell in create cell request. Valid - cell types are `markdown`, `timeseries`, `toplist`, `heatmap`, `distribution`, - - `log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/)' - example: - definition: - requests: - - display_type: line - q: avg:system.load.1{*} - style: - line_type: solid - line_width: normal - palette: dog_classic - show_legend: true - type: timeseries - yaxis: - scale: linear - graph_size: m - split_by: - keys: [] - tags: [] - time: null + description: |- + The attributes of a notebook cell in create cell request. Valid cell types are `markdown`, `timeseries`, `toplist`, `heatmap`, `distribution`, + `log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/) + example: {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null} oneOf: - - $ref: '#/components/schemas/NotebookMarkdownCellAttributes' - - $ref: '#/components/schemas/NotebookTimeseriesCellAttributes' - - $ref: '#/components/schemas/NotebookToplistCellAttributes' - - $ref: '#/components/schemas/NotebookHeatMapCellAttributes' - - $ref: '#/components/schemas/NotebookDistributionCellAttributes' - - $ref: '#/components/schemas/NotebookLogStreamCellAttributes' + - $ref: "#/components/schemas/NotebookMarkdownCellAttributes" + - $ref: "#/components/schemas/NotebookTimeseriesCellAttributes" + - $ref: "#/components/schemas/NotebookToplistCellAttributes" + - $ref: "#/components/schemas/NotebookHeatMapCellAttributes" + - $ref: "#/components/schemas/NotebookDistributionCellAttributes" + - $ref: "#/components/schemas/NotebookLogStreamCellAttributes" NotebookCellResourceType: default: notebook_cells description: Type of the Notebook Cell resource. enum: - - notebook_cells + - notebook_cells example: notebook_cells type: string x-enum-varnames: - - NOTEBOOK_CELLS + - NOTEBOOK_CELLS NotebookCellResponse: description: The description of a notebook cell response. properties: attributes: - $ref: '#/components/schemas/NotebookCellResponseAttributes' + $ref: "#/components/schemas/NotebookCellResponseAttributes" id: description: Notebook cell ID. - example: abcd1234 + example: "abcd1234" type: string type: - $ref: '#/components/schemas/NotebookCellResourceType' + $ref: "#/components/schemas/NotebookCellResourceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object NotebookCellResponseAttributes: - description: 'The attributes of a notebook cell response. Valid cell types are - `markdown`, `timeseries`, `toplist`, `heatmap`, `distribution`, - - `log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/)' - example: - definition: - requests: - - display_type: line - q: avg:system.load.1{*} - style: - line_type: solid - line_width: normal - palette: dog_classic - show_legend: true - type: timeseries - yaxis: - scale: linear - graph_size: m - split_by: - keys: [] - tags: [] - time: null + description: |- + The attributes of a notebook cell response. Valid cell types are `markdown`, `timeseries`, `toplist`, `heatmap`, `distribution`, + `log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/) + example: {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null} oneOf: - - $ref: '#/components/schemas/NotebookMarkdownCellAttributes' - - $ref: '#/components/schemas/NotebookTimeseriesCellAttributes' - - $ref: '#/components/schemas/NotebookToplistCellAttributes' - - $ref: '#/components/schemas/NotebookHeatMapCellAttributes' - - $ref: '#/components/schemas/NotebookDistributionCellAttributes' - - $ref: '#/components/schemas/NotebookLogStreamCellAttributes' + - $ref: "#/components/schemas/NotebookMarkdownCellAttributes" + - $ref: "#/components/schemas/NotebookTimeseriesCellAttributes" + - $ref: "#/components/schemas/NotebookToplistCellAttributes" + - $ref: "#/components/schemas/NotebookHeatMapCellAttributes" + - $ref: "#/components/schemas/NotebookDistributionCellAttributes" + - $ref: "#/components/schemas/NotebookLogStreamCellAttributes" NotebookCellTime: - description: Timeframe for the notebook cell. When 'null', the notebook global - time is used. + description: Timeframe for the notebook cell. When 'null', the notebook global time is used. nullable: true oneOf: - - $ref: '#/components/schemas/NotebookRelativeTime' - - $ref: '#/components/schemas/NotebookAbsoluteTime' + - $ref: "#/components/schemas/NotebookRelativeTime" + - $ref: "#/components/schemas/NotebookAbsoluteTime" type: object NotebookCellUpdateRequest: description: The description of a notebook cell update request. properties: attributes: - $ref: '#/components/schemas/NotebookCellUpdateRequestAttributes' + $ref: "#/components/schemas/NotebookCellUpdateRequestAttributes" id: description: Notebook cell ID. - example: abcd1234 + example: "abcd1234" type: string type: - $ref: '#/components/schemas/NotebookCellResourceType' + $ref: "#/components/schemas/NotebookCellResourceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object NotebookCellUpdateRequestAttributes: - description: 'The attributes of a notebook cell in update cell request. Valid - cell types are `markdown`, `timeseries`, `toplist`, `heatmap`, `distribution`, - - `log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/)' - example: - definition: - requests: - - display_type: line - q: avg:system.load.1{*} - style: - line_type: solid - line_width: normal - palette: dog_classic - show_legend: true - type: timeseries - yaxis: - scale: linear - graph_size: m - split_by: - keys: [] - tags: [] - time: null + description: |- + The attributes of a notebook cell in update cell request. Valid cell types are `markdown`, `timeseries`, `toplist`, `heatmap`, `distribution`, + `log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/) + example: {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null} oneOf: - - $ref: '#/components/schemas/NotebookMarkdownCellAttributes' - - $ref: '#/components/schemas/NotebookTimeseriesCellAttributes' - - $ref: '#/components/schemas/NotebookToplistCellAttributes' - - $ref: '#/components/schemas/NotebookHeatMapCellAttributes' - - $ref: '#/components/schemas/NotebookDistributionCellAttributes' - - $ref: '#/components/schemas/NotebookLogStreamCellAttributes' + - $ref: "#/components/schemas/NotebookMarkdownCellAttributes" + - $ref: "#/components/schemas/NotebookTimeseriesCellAttributes" + - $ref: "#/components/schemas/NotebookToplistCellAttributes" + - $ref: "#/components/schemas/NotebookHeatMapCellAttributes" + - $ref: "#/components/schemas/NotebookDistributionCellAttributes" + - $ref: "#/components/schemas/NotebookLogStreamCellAttributes" NotebookCreateData: description: The data for a notebook create request. properties: attributes: - $ref: '#/components/schemas/NotebookCreateDataAttributes' + $ref: "#/components/schemas/NotebookCreateDataAttributes" type: - $ref: '#/components/schemas/NotebookResourceType' + $ref: "#/components/schemas/NotebookResourceType" required: - - type - - attributes + - type + - attributes type: object NotebookCreateDataAttributes: description: The data attributes of a notebook. properties: cells: description: List of cells to display in the notebook. - example: - - attributes: - definition: - text: '## Some test markdown - - - ``` - - var x, y; - - x = 5; - - y = 6; - - ```' - type: markdown - type: notebook_cells - - attributes: - definition: - requests: - - display_type: line - q: avg:system.load.1{*} - style: - line_type: solid - line_width: normal - palette: dog_classic - show_legend: true - type: timeseries - yaxis: - scale: linear - graph_size: m - split_by: - keys: [] - tags: [] - time: null - type: notebook_cells - items: - $ref: '#/components/schemas/NotebookCellCreateRequest' + example: [{"attributes": {"definition": {"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```", "type": "markdown"}}, "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "type": "notebook_cells"}] + items: + $ref: "#/components/schemas/NotebookCellCreateRequest" type: array metadata: - $ref: '#/components/schemas/NotebookMetadata' + $ref: "#/components/schemas/NotebookMetadata" name: description: The name of the notebook. - example: Example Notebook + example: "Example Notebook" maxLength: 80 minLength: 0 type: string status: - $ref: '#/components/schemas/NotebookStatus' + $ref: "#/components/schemas/NotebookStatus" time: - $ref: '#/components/schemas/NotebookGlobalTime' + $ref: "#/components/schemas/NotebookGlobalTime" required: - - name - - cells - - time + - name + - cells + - time type: object NotebookCreateRequest: description: The description of a notebook create request. properties: data: - $ref: '#/components/schemas/NotebookCreateData' + $ref: "#/components/schemas/NotebookCreateData" required: - - data + - data type: object NotebookDistributionCellAttributes: description: The attributes of a notebook `distribution` cell. properties: definition: - $ref: '#/components/schemas/DistributionWidgetDefinition' + $ref: "#/components/schemas/DistributionWidgetDefinition" graph_size: - $ref: '#/components/schemas/NotebookGraphSize' + $ref: "#/components/schemas/NotebookGraphSize" split_by: - $ref: '#/components/schemas/NotebookSplitBy' + $ref: "#/components/schemas/NotebookSplitBy" time: - $ref: '#/components/schemas/NotebookCellTime' + $ref: "#/components/schemas/NotebookCellTime" required: - - definition + - definition type: object NotebookGlobalTime: description: Notebook global timeframe. example: live_span: 1h oneOf: - - $ref: '#/components/schemas/NotebookRelativeTime' - - $ref: '#/components/schemas/NotebookAbsoluteTime' + - $ref: "#/components/schemas/NotebookRelativeTime" + - $ref: "#/components/schemas/NotebookAbsoluteTime" NotebookGraphSize: description: The size of the graph. enum: - - xs - - s - - m - - l - - xl - example: m + - xs + - s + - m + - l + - xl + example: "m" type: string x-enum-varnames: - - EXTRA_SMALL - - SMALL - - MEDIUM - - LARGE - - EXTRA_LARGE + - EXTRA_SMALL + - SMALL + - MEDIUM + - LARGE + - EXTRA_LARGE NotebookHeatMapCellAttributes: description: The attributes of a notebook `heatmap` cell. properties: definition: - $ref: '#/components/schemas/HeatMapWidgetDefinition' + $ref: "#/components/schemas/HeatMapWidgetDefinition" graph_size: - $ref: '#/components/schemas/NotebookGraphSize' + $ref: "#/components/schemas/NotebookGraphSize" split_by: - $ref: '#/components/schemas/NotebookSplitBy' + $ref: "#/components/schemas/NotebookSplitBy" time: - $ref: '#/components/schemas/NotebookCellTime' + $ref: "#/components/schemas/NotebookCellTime" required: - - definition + - definition type: object NotebookLogStreamCellAttributes: description: The attributes of a notebook `log_stream` cell. properties: definition: - $ref: '#/components/schemas/LogStreamWidgetDefinition' + $ref: "#/components/schemas/LogStreamWidgetDefinition" graph_size: - $ref: '#/components/schemas/NotebookGraphSize' + $ref: "#/components/schemas/NotebookGraphSize" time: - $ref: '#/components/schemas/NotebookCellTime' + $ref: "#/components/schemas/NotebookCellTime" required: - - definition + - definition type: object NotebookMarkdownCellAttributes: description: The attributes of a notebook `markdown` cell. properties: definition: - $ref: '#/components/schemas/NotebookMarkdownCellDefinition' + $ref: "#/components/schemas/NotebookMarkdownCellDefinition" required: - - definition + - definition type: object NotebookMarkdownCellDefinition: - description: Text in a notebook is formatted with [Markdown](https://daringfireball.net/projects/markdown/), - which enables the use of headings, subheadings, links, images, lists, and - code blocks. + description: >- + Text in a notebook is formatted with [Markdown](https://daringfireball.net/projects/markdown/), which enables the use of headings, subheadings, links, images, lists, and code blocks. properties: text: description: The markdown content. example: "# Example Header \nexample content" type: string type: - $ref: '#/components/schemas/NotebookMarkdownCellDefinitionType' + $ref: "#/components/schemas/NotebookMarkdownCellDefinitionType" required: - - type - - text + - type + - text type: object NotebookMarkdownCellDefinitionType: default: markdown description: Type of the markdown cell. enum: - - markdown + - markdown example: markdown type: string x-enum-varnames: - - MARKDOWN + - MARKDOWN NotebookMetadata: description: Metadata associated with the notebook. properties: @@ -10891,30 +10129,29 @@ components: type: boolean take_snapshots: default: false - description: Whether or not the notebook takes snapshot image backups of - the notebook's fixed-time graphs. + description: Whether or not the notebook takes snapshot image backups of the notebook's fixed-time graphs. example: false type: boolean type: - $ref: '#/components/schemas/NotebookMetadataType' + $ref: "#/components/schemas/NotebookMetadataType" type: object NotebookMetadataType: description: Metadata type of the notebook. enum: - - postmortem - - runbook - - investigation - - documentation - - report + - postmortem + - runbook + - investigation + - documentation + - report example: investigation nullable: true type: string x-enum-varnames: - - POSTMORTEM - - RUNBOOK - - INVESTIGATION - - DOCUMENTATION - - REPORT + - POSTMORTEM + - RUNBOOK + - INVESTIGATION + - DOCUMENTATION + - REPORT NotebookRelativeTime: description: Relative timeframe. example: @@ -10922,30 +10159,30 @@ components: nullable: true properties: live_span: - $ref: '#/components/schemas/WidgetLiveSpan' + $ref: "#/components/schemas/WidgetLiveSpan" required: - - live_span + - live_span type: object NotebookResourceType: default: notebooks description: Type of the Notebook resource. enum: - - notebooks + - notebooks example: notebooks type: string x-enum-varnames: - - NOTEBOOKS + - NOTEBOOKS NotebookResponse: description: The description of a notebook response. properties: data: - $ref: '#/components/schemas/NotebookResponseData' + $ref: "#/components/schemas/NotebookResponseData" type: object NotebookResponseData: description: The data for a notebook. properties: attributes: - $ref: '#/components/schemas/NotebookResponseDataAttributes' + $ref: "#/components/schemas/NotebookResponseDataAttributes" id: description: Unique notebook ID, assigned when you create the notebook. example: 123456 @@ -10953,100 +10190,60 @@ components: readOnly: true type: integer type: - $ref: '#/components/schemas/NotebookResourceType' + $ref: "#/components/schemas/NotebookResourceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object NotebookResponseDataAttributes: description: The attributes of a notebook. properties: author: - $ref: '#/components/schemas/NotebookAuthor' + $ref: "#/components/schemas/NotebookAuthor" cells: description: List of cells to display in the notebook. - example: - - attributes: - definition: - text: '## Some test markdown - - - ``` - - var x, y; - - x = 5; - - y = 6; - - ```' - type: markdown - id: bzbycoya - type: notebook_cells - - attributes: - definition: - requests: - - display_type: line - q: avg:system.load.1{*} - style: - line_type: solid - line_width: normal - palette: dog_classic - show_legend: true - type: timeseries - yaxis: - scale: linear - graph_size: m - split_by: - keys: [] - tags: [] - time: null - id: 9k6bc6xc - type: notebook_cells - items: - $ref: '#/components/schemas/NotebookCellResponse' + example: [{"attributes": {"definition": {"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```", "type": "markdown"}}, "id": "bzbycoya", "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "id": "9k6bc6xc", "type": "notebook_cells"}] + items: + $ref: "#/components/schemas/NotebookCellResponse" type: array created: description: UTC time stamp for when the notebook was created. - example: '2021-02-24T23:14:15.173964+00:00' + example: "2021-02-24T23:14:15.173964+00:00" format: date-time readOnly: true type: string metadata: - $ref: '#/components/schemas/NotebookMetadata' + $ref: "#/components/schemas/NotebookMetadata" modified: description: UTC time stamp for when the notebook was last modified. - example: '2021-02-24T23:15:23.274966+00:00' + example: "2021-02-24T23:15:23.274966+00:00" format: date-time readOnly: true type: string name: description: The name of the notebook. - example: Example Notebook + example: "Example Notebook" maxLength: 80 minLength: 0 type: string status: - $ref: '#/components/schemas/NotebookStatus' + $ref: "#/components/schemas/NotebookStatus" time: - $ref: '#/components/schemas/NotebookGlobalTime' + $ref: "#/components/schemas/NotebookGlobalTime" required: - - cells - - time - - name + - cells + - time + - name type: object NotebookSplitBy: - description: Object describing how to split the graph to display multiple visualizations - per request. - example: - keys: [] - tags: [] + description: Object describing how to split the graph to display multiple visualizations per request. + example: {"keys": [], "tags": []} properties: keys: description: Keys to split on. example: - - environment + - environment items: description: A key to split on. example: environment @@ -11055,142 +10252,104 @@ components: tags: description: Tags to split on. example: - - environment:staging + - environment:staging items: description: A tag to split on. example: environment:staging type: string type: array required: - - keys - - tags + - keys + - tags type: object NotebookStatus: default: published description: Publication status of the notebook. For now, always "published". enum: - - published + - published example: published type: string x-enum-varnames: - - PUBLISHED + - PUBLISHED NotebookTimeseriesCellAttributes: description: The attributes of a notebook `timeseries` cell. properties: definition: - $ref: '#/components/schemas/TimeseriesWidgetDefinition' + $ref: "#/components/schemas/TimeseriesWidgetDefinition" graph_size: - $ref: '#/components/schemas/NotebookGraphSize' + $ref: "#/components/schemas/NotebookGraphSize" split_by: - $ref: '#/components/schemas/NotebookSplitBy' + $ref: "#/components/schemas/NotebookSplitBy" time: - $ref: '#/components/schemas/NotebookCellTime' + $ref: "#/components/schemas/NotebookCellTime" required: - - definition + - definition type: object NotebookToplistCellAttributes: description: The attributes of a notebook `toplist` cell. properties: definition: - $ref: '#/components/schemas/ToplistWidgetDefinition' + $ref: "#/components/schemas/ToplistWidgetDefinition" graph_size: - $ref: '#/components/schemas/NotebookGraphSize' + $ref: "#/components/schemas/NotebookGraphSize" split_by: - $ref: '#/components/schemas/NotebookSplitBy' + $ref: "#/components/schemas/NotebookSplitBy" time: - $ref: '#/components/schemas/NotebookCellTime' + $ref: "#/components/schemas/NotebookCellTime" required: - - definition + - definition type: object NotebookUpdateCell: - description: 'Updating a notebook can either insert new cell(s) or update existing - cell(s) by including the cell `id`. - - To delete existing cell(s), simply omit it from the list of cells.' + description: |- + Updating a notebook can either insert new cell(s) or update existing cell(s) by including the cell `id`. + To delete existing cell(s), simply omit it from the list of cells. oneOf: - - $ref: '#/components/schemas/NotebookCellCreateRequest' - - $ref: '#/components/schemas/NotebookCellUpdateRequest' + - $ref: "#/components/schemas/NotebookCellCreateRequest" + - $ref: "#/components/schemas/NotebookCellUpdateRequest" NotebookUpdateData: description: The data for a notebook update request. properties: attributes: - $ref: '#/components/schemas/NotebookUpdateDataAttributes' + $ref: "#/components/schemas/NotebookUpdateDataAttributes" type: - $ref: '#/components/schemas/NotebookResourceType' + $ref: "#/components/schemas/NotebookResourceType" required: - - type - - attributes + - type + - attributes type: object NotebookUpdateDataAttributes: description: The data attributes of a notebook. properties: cells: description: List of cells to display in the notebook. - example: - - attributes: - definition: - text: '## Some test markdown - - - ``` - - var x, y; - - x = 5; - - y = 6; - - ```' - type: markdown - id: bzbycoya - type: notebook_cells - - attributes: - definition: - requests: - - display_type: line - q: avg:system.load.1{*} - style: - line_type: solid - line_width: normal - palette: dog_classic - show_legend: true - type: timeseries - yaxis: - scale: linear - graph_size: m - split_by: - keys: [] - tags: [] - time: null - id: 9k6bc6xc - type: notebook_cells - items: - $ref: '#/components/schemas/NotebookUpdateCell' + example: [{"attributes": {"definition": {"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```", "type": "markdown"}}, "id": "bzbycoya", "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "id": "9k6bc6xc", "type": "notebook_cells"}] + items: + $ref: "#/components/schemas/NotebookUpdateCell" type: array metadata: - $ref: '#/components/schemas/NotebookMetadata' + $ref: "#/components/schemas/NotebookMetadata" name: description: The name of the notebook. - example: Example Notebook + example: "Example Notebook" maxLength: 80 minLength: 0 type: string status: - $ref: '#/components/schemas/NotebookStatus' + $ref: "#/components/schemas/NotebookStatus" time: - $ref: '#/components/schemas/NotebookGlobalTime' + $ref: "#/components/schemas/NotebookGlobalTime" required: - - name - - cells - - time + - name + - cells + - time type: object NotebookUpdateRequest: description: The description of a notebook update request. properties: data: - $ref: '#/components/schemas/NotebookUpdateData' + $ref: "#/components/schemas/NotebookUpdateData" required: - - data + - data type: object NotebooksResponse: description: Notebooks get all response. @@ -11198,16 +10357,16 @@ components: data: description: List of notebook definitions. items: - $ref: '#/components/schemas/NotebooksResponseData' + $ref: "#/components/schemas/NotebooksResponseData" type: array meta: - $ref: '#/components/schemas/NotebooksResponseMeta' + $ref: "#/components/schemas/NotebooksResponseMeta" type: object NotebooksResponseData: description: The data for a notebook in get all response. properties: attributes: - $ref: '#/components/schemas/NotebooksResponseDataAttributes' + $ref: "#/components/schemas/NotebooksResponseDataAttributes" id: description: Unique notebook ID, assigned when you create the notebook. example: 123456 @@ -11215,61 +10374,61 @@ components: readOnly: true type: integer type: - $ref: '#/components/schemas/NotebookResourceType' + $ref: "#/components/schemas/NotebookResourceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object NotebooksResponseDataAttributes: description: The attributes of a notebook in get all response. properties: author: - $ref: '#/components/schemas/NotebookAuthor' + $ref: "#/components/schemas/NotebookAuthor" cells: description: List of cells to display in the notebook. items: - $ref: '#/components/schemas/NotebookCellResponse' + $ref: "#/components/schemas/NotebookCellResponse" type: array created: description: UTC time stamp for when the notebook was created. - example: '2021-02-24T23:14:15.173964+00:00' + example: "2021-02-24T23:14:15.173964+00:00" format: date-time readOnly: true type: string metadata: - $ref: '#/components/schemas/NotebookMetadata' + $ref: "#/components/schemas/NotebookMetadata" modified: description: UTC time stamp for when the notebook was last modified. - example: '2021-02-24T23:15:23.274966+00:00' + example: "2021-02-24T23:15:23.274966+00:00" format: date-time readOnly: true type: string name: description: The name of the notebook. - example: Example Notebook + example: "Example Notebook" maxLength: 80 minLength: 0 type: string status: - $ref: '#/components/schemas/NotebookStatus' + $ref: "#/components/schemas/NotebookStatus" time: - $ref: '#/components/schemas/NotebookGlobalTime' + $ref: "#/components/schemas/NotebookGlobalTime" required: - - name + - name type: object NotebooksResponseMeta: description: Searches metadata returned by the API. properties: page: - $ref: '#/components/schemas/NotebooksResponsePage' + $ref: "#/components/schemas/NotebooksResponsePage" type: object NotebooksResponsePage: description: Pagination metadata returned by the API. properties: total_count: - description: The total number of notebooks that would be returned if the - request was not filtered by `start` and `count` parameters. + description: >- + The total number of notebooks that would be returned if the request was not filtered by `start` and `count` parameters. format: int64 type: integer total_filtered_count: @@ -11280,74 +10439,60 @@ components: NotifyEndState: description: A notification end state. enum: - - alert - - no data - - warn + - alert + - no data + - warn example: alert type: string x-enum-varnames: - - ALERT - - NO_DATA - - WARN + - ALERT + - NO_DATA + - WARN NotifyEndStates: - default: - - alert - - no data - - warn + default: ["alert", "no data", "warn"] description: States for which `notify_end_types` sends out notifications for. - example: - - alert - - no data - - warn + example: ["alert", "no data", "warn"] items: - $ref: '#/components/schemas/NotifyEndState' + $ref: "#/components/schemas/NotifyEndState" type: array NotifyEndType: description: A notification end type. enum: - - canceled - - expired + - canceled + - expired example: expired type: string x-enum-varnames: - - CANCELED - - EXPIRED + - CANCELED + - EXPIRED NotifyEndTypes: - default: - - expired - description: 'If set, notifies if a monitor is in an alert-worthy state (`ALERT`, - `WARNING`, or `NO DATA`) - - when this downtime expires or is canceled. Applied to monitors that change - states during - - the downtime (such as from `OK` to `ALERT`, `WARNING`, or `NO DATA`), and - to monitors that - - already have an alert-worthy state when downtime begins.' - example: - - canceled - - expired + default: ["expired"] + description: |- + If set, notifies if a monitor is in an alert-worthy state (`ALERT`, `WARNING`, or `NO DATA`) + when this downtime expires or is canceled. Applied to monitors that change states during + the downtime (such as from `OK` to `ALERT`, `WARNING`, or `NO DATA`), and to monitors that + already have an alert-worthy state when downtime begins. + example: ["canceled", "expired"] items: - $ref: '#/components/schemas/NotifyEndType' + $ref: "#/components/schemas/NotifyEndType" type: array NumberFormatUnit: description: Number format unit. oneOf: - - $ref: '#/components/schemas/NumberFormatUnitCanonical' - - $ref: '#/components/schemas/NumberFormatUnitCustom' + - $ref: "#/components/schemas/NumberFormatUnitCanonical" + - $ref: "#/components/schemas/NumberFormatUnitCustom" NumberFormatUnitCanonical: description: Canonical unit. properties: per_unit_name: description: The name of the unit per item. - example: bytes + example: "bytes" type: string type: - $ref: '#/components/schemas/NumberFormatUnitScaleType' + $ref: "#/components/schemas/NumberFormatUnitScaleType" unit_name: description: The name of the unit. - example: bytes + example: "bytes" type: string type: object NumberFormatUnitCustom: @@ -11359,60 +10504,52 @@ components: minLength: 1 type: string type: - $ref: '#/components/schemas/NumberFormatUnitCustomType' + $ref: "#/components/schemas/NumberFormatUnitCustomType" type: object NumberFormatUnitCustomType: description: The type of custom unit. enum: - - custom_unit_label + - custom_unit_label type: string x-enum-varnames: - - CUSTOM_UNIT_LABEL + - CUSTOM_UNIT_LABEL NumberFormatUnitScale: description: The definition of `NumberFormatUnitScale` object. nullable: true properties: type: - $ref: '#/components/schemas/NumberFormatUnitScaleType' + $ref: "#/components/schemas/NumberFormatUnitScaleType" unit_name: description: The name of the unit. - example: bytes + example: "bytes" type: string type: object NumberFormatUnitScaleType: description: The type of unit scale. enum: - - canonical_unit + - canonical_unit example: canonical_unit type: string x-enum-varnames: - - CANONICAL_UNIT + - CANONICAL_UNIT OnMissingDataOption: - description: 'Controls how groups or monitors are treated if an evaluation does - not return any data points. - - The default option results in different behavior depending on the monitor - query type. - - For monitors using Count queries, an empty monitor evaluation is treated as - 0 and is compared to the threshold conditions. - - For monitors using any query type other than Count, for example Gauge, Measure, - or Rate, the monitor shows the last known status. - - This option is only available for APM Trace Analytics, Audit Trail, CI, Error - Tracking, Event, Logs, and RUM monitors.' - enum: - - default - - show_no_data - - show_and_notify_no_data - - resolve - type: string - x-enum-varnames: - - DEFAULT - - SHOW_NO_DATA - - SHOW_AND_NOTIFY_NO_DATA - - RESOLVE + description: |- + Controls how groups or monitors are treated if an evaluation does not return any data points. + The default option results in different behavior depending on the monitor query type. + For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. + For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. + This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. + enum: + - "default" + - "show_no_data" + - "show_and_notify_no_data" + - "resolve" + type: string + x-enum-varnames: + - DEFAULT + - SHOW_NO_DATA + - SHOW_AND_NOTIFY_NO_DATA + - RESOLVE OrgDowngradedResponse: description: Status of downgrade properties: @@ -11424,40 +10561,38 @@ components: description: Create, edit, and manage organizations. properties: billing: - $ref: '#/components/schemas/OrganizationBilling' + $ref: "#/components/schemas/OrganizationBilling" created: description: Date of the organization creation. - example: '2019-09-26T17:28:28Z' + example: "2019-09-26T17:28:28Z" readOnly: true type: string description: description: Description of the organization. - example: some description + example: "some description" type: string name: description: The name of the child organization, limited to 32 characters. - example: New child org + example: "New child org" maxLength: 32 type: string public_id: description: The `public_id` of the organization you are operating within. - example: abcdef12345 + example: "abcdef12345" type: string settings: - $ref: '#/components/schemas/OrganizationSettings' + $ref: "#/components/schemas/OrganizationSettings" subscription: - $ref: '#/components/schemas/OrganizationSubscription' + $ref: "#/components/schemas/OrganizationSubscription" trial: - description: Only available for MSP customers. Allows child organizations - to be created on a trial plan. + description: Only available for MSP customers. Allows child organizations to be created on a trial plan. example: false type: boolean type: object OrganizationBilling: deprecated: true description: A JSON array of billing type. - example: - type: parent_billing + example: {"type": "parent_billing"} properties: type: description: The type of billing. Only `parent_billing` is supported. @@ -11467,28 +10602,28 @@ components: description: Object describing an organization to create. properties: billing: - $ref: '#/components/schemas/OrganizationBilling' + $ref: "#/components/schemas/OrganizationBilling" name: description: The name of the new child-organization, limited to 32 characters. - example: New child org + example: "New child org" maxLength: 32 type: string subscription: - $ref: '#/components/schemas/OrganizationSubscription' + $ref: "#/components/schemas/OrganizationSubscription" required: - - name + - name type: object OrganizationCreateResponse: description: Response object for an organization creation. properties: api_key: - $ref: '#/components/schemas/ApiKey' + $ref: "#/components/schemas/ApiKey" application_key: - $ref: '#/components/schemas/ApplicationKey' + $ref: "#/components/schemas/ApplicationKey" org: - $ref: '#/components/schemas/Organization' + $ref: "#/components/schemas/Organization" user: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" type: object OrganizationListResponse: description: Response with the list of organizations. @@ -11496,56 +10631,53 @@ components: orgs: description: Array of organization objects. items: - $ref: '#/components/schemas/Organization' + $ref: "#/components/schemas/Organization" type: array type: object OrganizationResponse: description: Response with an organization. properties: org: - $ref: '#/components/schemas/Organization' + $ref: "#/components/schemas/Organization" type: object OrganizationSettings: description: A JSON array of settings. properties: private_widget_share: - description: Whether or not the organization users can share widgets outside - of Datadog. + description: Whether or not the organization users can share widgets outside of Datadog. example: false type: boolean saml: - $ref: '#/components/schemas/OrganizationSettingsSaml' + $ref: "#/components/schemas/OrganizationSettingsSaml" saml_autocreate_access_role: - $ref: '#/components/schemas/AccessRole' + $ref: "#/components/schemas/AccessRole" saml_autocreate_users_domains: - $ref: '#/components/schemas/OrganizationSettingsSamlAutocreateUsersDomains' + $ref: "#/components/schemas/OrganizationSettingsSamlAutocreateUsersDomains" saml_can_be_enabled: description: Whether or not SAML can be enabled for this organization. example: false type: boolean saml_idp_endpoint: description: Identity provider endpoint for SAML authentication. - example: https://my.saml.endpoint + example: "https://my.saml.endpoint" type: string saml_idp_initiated_login: - $ref: '#/components/schemas/OrganizationSettingsSamlIdpInitiatedLogin' + $ref: "#/components/schemas/OrganizationSettingsSamlIdpInitiatedLogin" saml_idp_metadata_uploaded: - description: Whether or not a SAML identity provider metadata file was provided - to the Datadog organization. + description: Whether or not a SAML identity provider metadata file was provided to the Datadog organization. example: false type: boolean saml_login_url: description: URL for SAML logging. - example: https://my.saml.login.url + example: "https://my.saml.login.url" type: string saml_strict_mode: - $ref: '#/components/schemas/OrganizationSettingsSamlStrictMode' + $ref: "#/components/schemas/OrganizationSettingsSamlStrictMode" type: object OrganizationSettingsSaml: - description: 'Set the boolean property enabled to enable or disable single sign - on with SAML. - - See the SAML documentation for more information about all SAML settings.' + description: |- + Set the boolean property enabled to enable or disable single sign on with SAML. + See the SAML documentation for more information about all SAML settings. properties: enabled: description: Whether or not SAML is enabled for this organization. @@ -11553,19 +10685,17 @@ components: type: boolean type: object OrganizationSettingsSamlAutocreateUsersDomains: - description: Has two properties, `enabled` (boolean) and `domains`, which is - a list of domains without the @ symbol. + description: Has two properties, `enabled` (boolean) and `domains`, which is a list of domains without the @ symbol. properties: domains: description: List of domains where the SAML automated user creation is enabled. items: description: Domain to automate user creation from. - example: example.com + example: "example.com" type: string type: array enabled: - description: Whether or not the automated user creation based on SAML domain - is enabled. + description: Whether or not the automated user creation based on SAML domain is enabled. example: false type: boolean type: object @@ -11573,9 +10703,9 @@ components: description: Has one property enabled (boolean). properties: enabled: - description: 'Whether SAML IdP initiated login is enabled, learn more - - in the [SAML documentation](https://docs.datadoghq.com/account_management/saml/#idp-initiated-login).' + description: |- + Whether SAML IdP initiated login is enabled, learn more + in the [SAML documentation](https://docs.datadoghq.com/account_management/saml/#idp-initiated-login). example: false type: boolean type: object @@ -11583,58 +10713,56 @@ components: description: Has one property enabled (boolean). properties: enabled: - description: 'Whether or not the SAML strict mode is enabled. If true, all - users must log in with SAML. - - Learn more on the [SAML Strict documentation](https://docs.datadoghq.com/account_management/saml/#saml-strict).' + description: |- + Whether or not the SAML strict mode is enabled. If true, all users must log in with SAML. + Learn more on the [SAML Strict documentation](https://docs.datadoghq.com/account_management/saml/#saml-strict). example: false type: boolean type: object OrganizationSubscription: deprecated: true description: Subscription definition. - example: - type: pro + example: {"type": "pro"} properties: type: - description: The subscription type. Types available are `trial`, `free`, - and `pro`. + description: The subscription type. Types available are `trial`, `free`, and `pro`. type: string type: object PagerDutyService: - description: The PagerDuty service that is available for integration with Datadog. + description: |- + The PagerDuty service that is available for integration with Datadog. properties: service_key: description: Your service key in PagerDuty. - example: '' + example: "" type: string service_name: description: Your service name associated with a service key in PagerDuty. - example: '' + example: "" type: string required: - - service_name - - service_key + - service_name + - service_key type: object PagerDutyServiceKey: description: PagerDuty service object key. properties: service_key: description: Your service key in PagerDuty. - example: '' + example: "" type: string required: - - service_key + - service_key type: object PagerDutyServiceName: description: PagerDuty service object name. properties: service_name: description: Your service name associated service key in PagerDuty. - example: '' + example: "" type: string required: - - service_name + - service_name type: object Pagination: description: Pagination object. @@ -11650,18 +10778,13 @@ components: type: object Point: description: Array of timeseries points. - example: - - 1575317847.0 - - 0.5 + example: [1575317847.0, 0.5] items: - description: 'Each point is of the form `[POSIX_timestamp, numeric_value]`. - + description: |- + Each point is of the form `[POSIX_timestamp, numeric_value]`. The timestamp should be in seconds and current. - The numeric value format should be a 32bit float gauge-type value. - - Current is defined as not more than 10 minutes in the future or more than - 1 hour in the past.' + Current is defined as not more than 10 minutes in the future or more than 1 hour in the past. format: double nullable: true type: number @@ -11679,20 +10802,19 @@ components: description: The tag prefix associated with the variable. type: string values: - description: One or many template variable values within the saved view, - which will be unioned together using `OR` if more than one is specified. + description: One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. example: - - my-host - - host1 - - host2 + - my-host + - host1 + - host2 items: description: One or more possible values of the template variable. minLength: 1 type: string type: array required: - - name - - values + - name + - values type: object PowerpackTemplateVariables: description: Powerpack template variables. @@ -11700,19 +10822,16 @@ components: controlled_by_powerpack: description: Template variables controlled at the powerpack level. items: - $ref: '#/components/schemas/PowerpackTemplateVariableContents' + $ref: "#/components/schemas/PowerpackTemplateVariableContents" type: array controlled_externally: - description: Template variables controlled by the external resource, such - as the dashboard this powerpack is on. + description: "Template variables controlled by the external resource, such as the dashboard this powerpack is on." items: - $ref: '#/components/schemas/PowerpackTemplateVariableContents' + $ref: "#/components/schemas/PowerpackTemplateVariableContents" type: array type: object PowerpackWidgetDefinition: - description: The powerpack widget allows you to keep similar graphs together - on your timeboard. Each group has a custom header, can hold one to many graphs, - and is collapsible. + description: The powerpack widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible. properties: background_color: description: Background color of the powerpack title. @@ -11722,32 +10841,32 @@ components: type: string powerpack_id: description: UUID of the associated powerpack. - example: df43cf2a-6475-490d-b686-6fbc6cb9a49c + example: "df43cf2a-6475-490d-b686-6fbc6cb9a49c" type: string show_title: default: true description: Whether to show the title or not. type: boolean template_variables: - $ref: '#/components/schemas/PowerpackTemplateVariables' + $ref: "#/components/schemas/PowerpackTemplateVariables" title: description: Title of the widget. type: string type: - $ref: '#/components/schemas/PowerpackWidgetDefinitionType' + $ref: "#/components/schemas/PowerpackWidgetDefinitionType" required: - - type - - powerpack_id + - type + - powerpack_id type: object PowerpackWidgetDefinitionType: default: powerpack description: Type of the powerpack widget. enum: - - powerpack + - powerpack example: powerpack type: string x-enum-varnames: - - POWERPACK + - POWERPACK ProcessQueryDefinition: description: The process query to use in the widget. properties: @@ -11764,27 +10883,26 @@ components: type: integer metric: description: Your chosen metric. - example: system.load.1 + example: "system.load.1" type: string search_by: description: Your chosen search term. type: string required: - - metric + - metric type: object QuerySortOrder: default: desc description: Direction of sort. enum: - - asc - - desc + - asc + - desc type: string x-enum-varnames: - - ASC - - DESC + - ASC + - DESC QueryValueWidgetDefinition: - description: Query values display the current value of a given metric, APM, - or log query. + description: Query values display the current value of a given metric, APM, or log query. properties: autoscale: description: Whether to use auto-scaling or not. @@ -11792,95 +10910,93 @@ components: custom_links: description: List of custom links. items: - $ref: '#/components/schemas/WidgetCustomLink' + $ref: "#/components/schemas/WidgetCustomLink" type: array custom_unit: description: Display a unit of your choice on the widget. type: string precision: - description: Number of decimals to show. If not defined, the widget uses - the raw value. + description: Number of decimals to show. If not defined, the widget uses the raw value. format: int64 type: integer requests: description: Widget definition. - example: - - q/apm_query/log_query: {} + example: ["q/apm_query/log_query": "{}"] items: - $ref: '#/components/schemas/QueryValueWidgetRequest' + $ref: "#/components/schemas/QueryValueWidgetRequest" maxItems: 1 minItems: 1 type: array text_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" timeseries_background: - $ref: '#/components/schemas/TimeseriesBackground' + $ref: "#/components/schemas/TimeseriesBackground" title: description: Title of your widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/QueryValueWidgetDefinitionType' + $ref: "#/components/schemas/QueryValueWidgetDefinitionType" required: - - type - - requests + - type + - requests type: object QueryValueWidgetDefinitionType: default: query_value description: Type of the query value widget. enum: - - query_value + - query_value example: query_value type: string x-enum-varnames: - - QUERY_VALUE + - QUERY_VALUE QueryValueWidgetRequest: description: Updated query value widget. properties: aggregator: - $ref: '#/components/schemas/WidgetAggregator' + $ref: "#/components/schemas/WidgetAggregator" apm_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. audit_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. conditional_formats: description: List of conditional formats. items: - $ref: '#/components/schemas/WidgetConditionalFormat' + $ref: "#/components/schemas/WidgetConditionalFormat" type: array event_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: - $ref: '#/components/schemas/WidgetFormula' + $ref: "#/components/schemas/WidgetFormula" type: array log_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. process_query: - $ref: '#/components/schemas/ProcessQueryDefinition' + $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: @@ -11890,43 +11006,37 @@ components: queries: description: List of queries that can be returned directly or used in formulas. items: - $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition' + $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: - $ref: '#/components/schemas/FormulaAndFunctionResponseFormat' + $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" rum_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. type: object ReferenceTableLogsLookupProcessor: - description: '**Note**: Reference Tables are in public beta. - + description: |- + **Note**: Reference Tables are in public beta. Use the Lookup Processor to define a mapping between a log attribute - and a human readable value saved in a Reference Table. - For example, you can use the Lookup Processor to map an internal service ID - - into a human readable service name. Alternatively, you could also use it to - check - + into a human readable service name. Alternatively, you could also use it to check if the MAC address that just attempted to connect to the production - - environment belongs to your list of stolen machines.' + environment belongs to your list of stolen machines. properties: is_enabled: default: false description: Whether or not the processor is enabled. type: boolean lookup_enrichment_table: - description: Name of the Reference Table for the source attribute and their - associated target attribute values. - example: service_id_to_service_name_table + description: |- + Name of the Reference Table for the source attribute and their associated target attribute values. + example: "service_id_to_service_name_table" type: string name: description: Name of the processor. @@ -11936,21 +11046,20 @@ components: example: service_id type: string target: - description: Name of the attribute that contains the corresponding value - in the mapping list. + description: |- + Name of the attribute that contains the corresponding value in the mapping list. example: service type: string type: - $ref: '#/components/schemas/LogsLookupProcessorType' + $ref: "#/components/schemas/LogsLookupProcessorType" required: - - source - - target - - lookup_enrichment_table - - type + - source + - target + - lookup_enrichment_table + - type type: object ResourceProviderConfig: - description: Configuration settings applied to resources from the specified - Azure resource provider. + description: Configuration settings applied to resources from the specified Azure resource provider. properties: metrics_enabled: description: Collect metrics for resources from this provider. @@ -11965,51 +11074,50 @@ components: description: Object describing meta attributes of response. properties: page: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" type: object RunWorkflowWidgetDefinition: - description: Run workflow is widget that allows you to run a workflow from a - dashboard. + description: Run workflow is widget that allows you to run a workflow from a dashboard. properties: custom_links: description: List of custom links. items: - $ref: '#/components/schemas/WidgetCustomLink' + $ref: "#/components/schemas/WidgetCustomLink" type: array inputs: description: Array of workflow inputs to map to dashboard template variables. items: - $ref: '#/components/schemas/RunWorkflowWidgetInput' + $ref: "#/components/schemas/RunWorkflowWidgetInput" type: array time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/RunWorkflowWidgetDefinitionType' + $ref: "#/components/schemas/RunWorkflowWidgetDefinitionType" workflow_id: description: Workflow id. - example: + example: "" type: string required: - - type - - workflow_id + - type + - workflow_id type: object RunWorkflowWidgetDefinitionType: default: run_workflow description: Type of the run workflow widget. enum: - - run_workflow + - run_workflow example: run_workflow type: string x-enum-varnames: - - RUN_WORKFLOW + - RUN_WORKFLOW RunWorkflowWidgetInput: description: Object to map a dashboard template variable to a workflow input. properties: @@ -12018,145 +11126,137 @@ components: example: Environment type: string value: - description: Dashboard template variable. Can be suffixed with '.value' - or '.key'. - example: $env.value + description: Dashboard template variable. Can be suffixed with '.value' or '.key'. + example: "$env.value" type: string required: - - name - - value + - name + - value type: object SLOBulkDelete: additionalProperties: description: An array of all SLO timeframes. items: - $ref: '#/components/schemas/SLOTimeframe' + $ref: "#/components/schemas/SLOTimeframe" type: array - description: 'A map of service level objective object IDs to arrays of timeframes, - - which indicate the thresholds to delete for each ID.' + description: |- + A map of service level objective object IDs to arrays of timeframes, + which indicate the thresholds to delete for each ID. example: - id1: - - 7d - - 30d - id2: - - 7d - - 30d + id1: ["7d", "30d"] + id2: ["7d", "30d"] type: object SLOBulkDeleteError: description: Object describing the error. properties: id: - description: 'The ID of the service level objective object associated with - - this error.' - example: '' + description: |- + The ID of the service level objective object associated with + this error. + example: "" type: string message: description: The error message. - example: '' + example: "" type: string timeframe: - $ref: '#/components/schemas/SLOErrorTimeframe' + $ref: "#/components/schemas/SLOErrorTimeframe" required: - - id - - timeframe - - message + - id + - timeframe + - message type: object SLOBulkDeleteResponse: - description: 'The bulk partial delete service level objective object endpoint - + description: |- + The bulk partial delete service level objective object endpoint response. - This endpoint operates on multiple service level objective objects, so - it may be partially successful. In such cases, the "data" and "error" - - fields in this response indicate which deletions succeeded and failed.' + fields in this response indicate which deletions succeeded and failed. properties: data: - $ref: '#/components/schemas/SLOBulkDeleteResponseData' + $ref: "#/components/schemas/SLOBulkDeleteResponseData" errors: description: Array of errors object returned. items: - $ref: '#/components/schemas/SLOBulkDeleteError' + $ref: "#/components/schemas/SLOBulkDeleteError" type: array type: object SLOBulkDeleteResponseData: description: An array of service level objective objects. properties: deleted: - description: 'An array of service level objective object IDs that indicates - - which objects that were completely deleted.' + description: |- + An array of service level objective object IDs that indicates + which objects that were completely deleted. items: description: A deleted SLO ID. type: string type: array updated: - description: 'An array of service level objective object IDs that indicates - + description: |- + An array of service level objective object IDs that indicates which objects that were modified (objects for which at least one - - threshold was deleted, but that were not completely deleted).' + threshold was deleted, but that were not completely deleted). items: description: An updated SLO ID. type: string type: array type: object SLOCorrection: - description: The response object of a list of SLO corrections. + description: |- + The response object of a list of SLO corrections. properties: attributes: - $ref: '#/components/schemas/SLOCorrectionResponseAttributes' + $ref: "#/components/schemas/SLOCorrectionResponseAttributes" id: description: The ID of the SLO correction. type: string type: - $ref: '#/components/schemas/SLOCorrectionType' + $ref: "#/components/schemas/SLOCorrectionType" type: object SLOCorrectionCategory: description: Category the SLO correction belongs to. enum: - - Scheduled Maintenance - - Outside Business Hours - - Deployment - - Other + - Scheduled Maintenance + - Outside Business Hours + - Deployment + - Other example: Scheduled Maintenance type: string x-enum-varnames: - - SCHEDULED_MAINTENANCE - - OUTSIDE_BUSINESS_HOURS - - DEPLOYMENT - - OTHER + - SCHEDULED_MAINTENANCE + - OUTSIDE_BUSINESS_HOURS + - DEPLOYMENT + - OTHER SLOCorrectionCreateData: description: The data object associated with the SLO correction to be created. properties: attributes: - $ref: '#/components/schemas/SLOCorrectionCreateRequestAttributes' + $ref: "#/components/schemas/SLOCorrectionCreateRequestAttributes" type: - $ref: '#/components/schemas/SLOCorrectionType' + $ref: "#/components/schemas/SLOCorrectionType" required: - - type + - type type: object SLOCorrectionCreateRequest: - description: An object that defines a correction to be applied to an SLO. + description: |- + An object that defines a correction to be applied to an SLO. properties: data: - $ref: '#/components/schemas/SLOCorrectionCreateData' + $ref: "#/components/schemas/SLOCorrectionCreateData" type: object SLOCorrectionCreateRequestAttributes: description: The attribute object associated with the SLO correction to be created. properties: category: - $ref: '#/components/schemas/SLOCorrectionCategory' + $ref: "#/components/schemas/SLOCorrectionCategory" description: description: Description of the correction being made. type: string duration: - description: Length of time (in seconds) for a specified `rrule` recurring - SLO correction. + description: Length of time (in seconds) for a specified `rrule` recurring SLO correction. example: 1600000000 format: int64 type: integer @@ -12166,10 +11266,9 @@ components: format: int64 type: integer rrule: - description: 'The recurrence rules as defined in the iCalendar RFC 5545. - The supported rules for SLO corrections - - are `FREQ`, `INTERVAL`, `COUNT`, `UNTIL` and `BYDAY`.' + description: |- + The recurrence rules as defined in the iCalendar RFC 5545. The supported rules for SLO corrections + are `FREQ`, `INTERVAL`, `COUNT`, `UNTIL` and `BYDAY`. example: FREQ=DAILY;INTERVAL=10;COUNT=5 type: string slo_id: @@ -12182,50 +11281,50 @@ components: format: int64 type: integer timezone: - description: The timezone to display in the UI for the correction times - (defaults to "UTC"). + description: The timezone to display in the UI for the correction times (defaults to "UTC"). example: UTC type: string required: - - slo_id - - start - - category + - slo_id + - start + - category type: object SLOCorrectionListResponse: description: A list of SLO correction objects. properties: data: - description: The list of SLO corrections objects. + description: |- + The list of SLO corrections objects. items: - $ref: '#/components/schemas/SLOCorrection' + $ref: "#/components/schemas/SLOCorrection" type: array meta: - $ref: '#/components/schemas/ResponseMetaAttributes' + $ref: "#/components/schemas/ResponseMetaAttributes" type: object SLOCorrectionResponse: - description: The response object of an SLO correction. + description: |- + The response object of an SLO correction. properties: data: - $ref: '#/components/schemas/SLOCorrection' + $ref: "#/components/schemas/SLOCorrection" type: object SLOCorrectionResponseAttributes: description: The attribute object associated with the SLO correction. properties: category: - $ref: '#/components/schemas/SLOCorrectionCategory' + $ref: "#/components/schemas/SLOCorrectionCategory" created_at: description: The epoch timestamp of when the correction was created at. format: int64 nullable: true type: integer creator: - $ref: '#/components/schemas/Creator' + $ref: "#/components/schemas/Creator" description: description: Description of the correction being made. type: string duration: - description: Length of time (in seconds) for a specified `rrule` recurring - SLO correction. + description: Length of time (in seconds) for a specified `rrule` recurring SLO correction. example: 3600 format: int64 nullable: true @@ -12241,12 +11340,11 @@ components: nullable: true type: integer modifier: - $ref: '#/components/schemas/SLOCorrectionResponseAttributesModifier' + $ref: "#/components/schemas/SLOCorrectionResponseAttributesModifier" rrule: - description: 'The recurrence rules as defined in the iCalendar RFC 5545. - The supported rules for SLO corrections - - are `FREQ`, `INTERVAL`, `COUNT`, `UNTIL` and `BYDAY`.' + description: |- + The recurrence rules as defined in the iCalendar RFC 5545. The supported rules for SLO corrections + are `FREQ`, `INTERVAL`, `COUNT`, `UNTIL` and `BYDAY`. example: FREQ=DAILY;INTERVAL=10;COUNT=5 nullable: true type: string @@ -12258,8 +11356,7 @@ components: format: int64 type: integer timezone: - description: The timezone to display in the UI for the correction times - (defaults to "UTC"). + description: The timezone to display in the UI for the correction times (defaults to "UTC"). type: string type: object SLOCorrectionResponseAttributesModifier: @@ -12280,36 +11377,36 @@ components: default: correction description: SLO correction resource type. enum: - - correction + - correction example: correction type: string x-enum-varnames: - - CORRECTION + - CORRECTION SLOCorrectionUpdateData: description: The data object associated with the SLO correction to be updated. properties: attributes: - $ref: '#/components/schemas/SLOCorrectionUpdateRequestAttributes' + $ref: "#/components/schemas/SLOCorrectionUpdateRequestAttributes" type: - $ref: '#/components/schemas/SLOCorrectionType' + $ref: "#/components/schemas/SLOCorrectionType" type: object SLOCorrectionUpdateRequest: - description: An object that defines a correction to be applied to an SLO. + description: |- + An object that defines a correction to be applied to an SLO. properties: data: - $ref: '#/components/schemas/SLOCorrectionUpdateData' + $ref: "#/components/schemas/SLOCorrectionUpdateData" type: object SLOCorrectionUpdateRequestAttributes: description: The attribute object associated with the SLO correction to be updated. properties: category: - $ref: '#/components/schemas/SLOCorrectionCategory' + $ref: "#/components/schemas/SLOCorrectionCategory" description: description: Description of the correction being made. type: string duration: - description: Length of time (in seconds) for a specified `rrule` recurring - SLO correction. + description: Length of time (in seconds) for a specified `rrule` recurring SLO correction. example: 3600 format: int64 type: integer @@ -12319,10 +11416,9 @@ components: format: int64 type: integer rrule: - description: 'The recurrence rules as defined in the iCalendar RFC 5545. - The supported rules for SLO corrections - - are `FREQ`, `INTERVAL`, `COUNT`, `UNTIL` and `BYDAY`.' + description: |- + The recurrence rules as defined in the iCalendar RFC 5545. The supported rules for SLO corrections + are `FREQ`, `INTERVAL`, `COUNT`, `UNTIL` and `BYDAY`. example: FREQ=DAILY;INTERVAL=10;COUNT=5 type: string start: @@ -12331,104 +11427,100 @@ components: format: int64 type: integer timezone: - description: The timezone to display in the UI for the correction times - (defaults to "UTC"). + description: The timezone to display in the UI for the correction times (defaults to "UTC"). example: UTC type: string type: object SLOCountDefinition: - description: 'A count-based (metric) SLI specification, composed of three parts: - the good events formula, - + description: |- + A count-based (metric) SLI specification, composed of three parts: the good events formula, the bad or total events formula, and the underlying queries. - - Exactly one of `total_events_formula` or `bad_events_formula` must be provided.' + Exactly one of `total_events_formula` or `bad_events_formula` must be provided. example: - bad_events_formula: query2 - good_events_formula: query1 + bad_events_formula: "query2" + good_events_formula: "query1" queries: - - data_source: metrics - name: query1 - query: sum:trace.servlet.request.hits{!http.status_code:500} by {env}.as_count() - - data_source: metrics - name: query2 - query: sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count() + - data_source: metrics + name: "query1" + query: "sum:trace.servlet.request.hits{!http.status_code:500} by {env}.as_count()" + - data_source: metrics + name: "query2" + query: "sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count()" oneOf: - - $ref: '#/components/schemas/SLOCountDefinitionWithTotalEventsFormula' - - $ref: '#/components/schemas/SLOCountDefinitionWithBadEventsFormula' + - $ref: "#/components/schemas/SLOCountDefinitionWithTotalEventsFormula" + - $ref: "#/components/schemas/SLOCountDefinitionWithBadEventsFormula" SLOCountDefinitionWithBadEventsFormula: additionalProperties: false properties: bad_events_formula: - $ref: '#/components/schemas/SLOFormula' - description: The bad events formula (recommended). Total events queries - can be defined using the `total_events_formula` field as an alternative. - Only one of `total_events_formula` or `bad_events_formula` must be provided. + $ref: "#/components/schemas/SLOFormula" + description: |- + The bad events formula (recommended). Total events queries can be defined using the `total_events_formula` field as an alternative. Only one of `total_events_formula` or `bad_events_formula` must be provided. good_events_formula: - $ref: '#/components/schemas/SLOFormula' + $ref: "#/components/schemas/SLOFormula" queries: example: - - data_source: metrics - name: query1 - query: sum:trace.servlet.request.hits{!http.status_code:500} by {env}.as_count() - - data_source: metrics - name: query2 - query: sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count() + - data_source: metrics + name: "query1" + query: "sum:trace.servlet.request.hits{!http.status_code:500} by {env}.as_count()" + - data_source: metrics + name: "query2" + query: "sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count()" items: - $ref: '#/components/schemas/SLODataSourceQueryDefinition' + $ref: "#/components/schemas/SLODataSourceQueryDefinition" minItems: 1 type: array required: - - good_events_formula - - bad_events_formula - - queries + - good_events_formula + - bad_events_formula + - queries type: object SLOCountDefinitionWithTotalEventsFormula: additionalProperties: false properties: good_events_formula: - $ref: '#/components/schemas/SLOFormula' + $ref: "#/components/schemas/SLOFormula" queries: example: - - data_source: metrics - name: query1 - query: sum:trace.servlet.request.hits{!http.status_code:500} by {env}.as_count() - - data_source: metrics - name: query2 - query: sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count() + - data_source: metrics + name: "query1" + query: "sum:trace.servlet.request.hits{!http.status_code:500} by {env}.as_count()" + - data_source: metrics + name: "query2" + query: "sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count()" items: - $ref: '#/components/schemas/SLODataSourceQueryDefinition' + $ref: "#/components/schemas/SLODataSourceQueryDefinition" minItems: 1 type: array total_events_formula: - $ref: '#/components/schemas/SLOFormula' - description: The total events formula. Bad events queries can be defined - using the `bad_events_formula` field as an alternative. Only one of `total_events_formula` - or `bad_events_formula` must be provided. + $ref: "#/components/schemas/SLOFormula" + description: |- + The total events formula. Bad events queries can be defined using the `bad_events_formula` field as an alternative. Only one of `total_events_formula` or `bad_events_formula` must be provided. required: - - good_events_formula - - total_events_formula - - queries + - good_events_formula + - total_events_formula + - queries type: object SLOCountSpec: additionalProperties: false - description: A metric SLI specification. + description: |- + A metric SLI specification. example: count: - bad_events_formula: query2 - good_events_formula: query1 + bad_events_formula: "query2" + good_events_formula: "query1" queries: - - data_source: metrics - name: query1 - query: sum:trace.servlet.request.hits{!http.status_code:500} by {env}.as_count() - - data_source: metrics - name: query2 - query: sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count() + - data_source: metrics + name: "query1" + query: "sum:trace.servlet.request.hits{!http.status_code:500} by {env}.as_count()" + - data_source: metrics + name: "query2" + query: "sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count()" properties: count: - $ref: '#/components/schemas/SLOCountDefinition' + $ref: "#/components/schemas/SLOCountDefinition" required: - - count + - count type: object SLOCreator: description: The creator of the SLO @@ -12450,16 +11542,15 @@ components: description: A formula and function query. example: data_source: metrics - name: query1 - query: sum:trace.servlet.request.hits{*} by {env}.as_count() + name: "query1" + query: "sum:trace.servlet.request.hits{*} by {env}.as_count()" oneOf: - - $ref: '#/components/schemas/FormulaAndFunctionMetricQueryDefinition' + - $ref: "#/components/schemas/FormulaAndFunctionMetricQueryDefinition" SLODeleteResponse: description: A response list of all service level objective deleted. properties: data: - description: An array containing the ID of the deleted service level objective - object. + description: An array containing the ID of the deleted service level objective object. items: description: ID of a deleted SLO. type: string @@ -12468,8 +11559,7 @@ components: additionalProperties: description: Error preventing the SLO deletion. type: string - description: An dictionary containing the ID of the SLO as key and a deletion - error as value. + description: An dictionary containing the ID of the SLO as key and a deletion error as value. type: object type: object SLOErrorBudgetRemainingData: @@ -12477,72 +11567,70 @@ components: description: Remaining error budget. format: double type: number - description: A mapping of threshold `timeframe` to the remaining error budget. + description: |- + A mapping of threshold `timeframe` to the remaining error budget. example: 7d: 100.0 type: object SLOErrorTimeframe: - description: 'The timeframe of the threshold associated with this error - - or "all" if all thresholds are affected.' + description: |- + The timeframe of the threshold associated with this error + or "all" if all thresholds are affected. enum: - - 7d - - 30d - - 90d - - all + - 7d + - 30d + - 90d + - all example: 30d type: string x-enum-varnames: - - SEVEN_DAYS - - THIRTY_DAYS - - NINETY_DAYS - - ALL + - SEVEN_DAYS + - THIRTY_DAYS + - NINETY_DAYS + - ALL SLOFormula: - description: A formula that specifies how to combine the results of multiple - queries. + description: |- + A formula that specifies how to combine the results of multiple queries. example: - formula: query1 - default_zero(query2) + formula: "query1 - default_zero(query2)" properties: formula: - description: The formula string, which is an expression involving named - queries. - example: query1 - default_zero(query2) + description: |- + The formula string, which is an expression involving named queries. + example: "query1 - default_zero(query2)" type: string required: - - formula + - formula type: object SLOHistoryMetrics: - description: 'A `metric` based SLO history response. - + description: |- + A `metric` based SLO history response. - This is not included in responses for `monitor` based SLOs.' + This is not included in responses for `monitor` based SLOs. properties: denominator: - $ref: '#/components/schemas/SLOHistoryMetricsSeries' + $ref: "#/components/schemas/SLOHistoryMetricsSeries" interval: - description: The aggregated query interval for the series data. It's implicit - based on the query time window. + description: The aggregated query interval for the series data. It's implicit based on the query time window. example: 0 format: int64 type: integer message: description: Optional message if there are specific query issues/warnings. - example: '' + example: "" type: string numerator: - $ref: '#/components/schemas/SLOHistoryMetricsSeries' + $ref: "#/components/schemas/SLOHistoryMetricsSeries" query: description: The combined numerator and denominator query CSV. - example: '' + example: "" type: string res_type: - description: The series result type. This mimics `batch_query` response - type. - example: '' + description: The series result type. This mimics `batch_query` response type. + example: "" type: string resp_version: - description: The series response version type. This mimics `batch_query` - response type. + description: The series response version type. This mimics `batch_query` response type. example: 0 format: int64 type: integer @@ -12555,19 +11643,18 @@ components: type: number type: array required: - - res_type - - interval - - resp_version - - query - - times - - numerator - - denominator + - res_type + - interval + - resp_version + - query + - times + - numerator + - denominator type: object SLOHistoryMetricsSeries: - description: 'A representation of `metric` based SLO timeseries for the provided - queries. - - This is the same response type from `batch_query` endpoint.' + description: |- + A representation of `metric` based SLO timeseries for the provided queries. + This is the same response type from `batch_query` endpoint. properties: count: description: Count of submitted metrics. @@ -12575,7 +11662,7 @@ components: format: int64 type: integer metadata: - $ref: '#/components/schemas/SLOHistoryMetricsSeriesMetadata' + $ref: "#/components/schemas/SLOHistoryMetricsSeriesMetadata" sum: description: Total sum of the query. example: 0.0 @@ -12590,9 +11677,9 @@ components: type: number type: array required: - - count - - sum - - values + - count + - sum + - values type: object SLOHistoryMetricsSeriesMetadata: description: Query metadata. @@ -12620,23 +11707,13 @@ components: description: Query scope. type: string unit: - description: 'An array of metric units that contains up to two unit objects. - - For example, bytes represents one unit object and bytes per second represents - two unit objects. - - If a metric query only has one unit object, the second array element is - null.' - example: - - family: bytes - id: 2 - name: byte - plural: bytes - scale_factor: 1.0 - short_name: B - - null - items: - $ref: '#/components/schemas/SLOHistoryMetricsSeriesMetadataUnit' + description: |- + An array of metric units that contains up to two unit objects. + For example, bytes represents one unit object and bytes per second represents two unit objects. + If a metric query only has one unit object, the second array element is null. + example: [{"family": "bytes", "id": 2, "name": "byte", "plural": "bytes", "scale_factor": 1.0, "short_name": "B"}, null] + items: + $ref: "#/components/schemas/SLOHistoryMetricsSeriesMetadataUnit" nullable: true type: array type: object @@ -12645,8 +11722,8 @@ components: nullable: true properties: family: - description: The family of metric unit, for example `bytes` is the family - for `kibibyte`, `byte`, and `bit` units. + description: |- + The family of metric unit, for example `bytes` is the family for `kibibyte`, `byte`, and `bit` units. type: string id: description: The ID of the metric unit. @@ -12664,60 +11741,42 @@ components: format: double type: number short_name: - description: A shorter and abbreviated version of the metric unit, for instance - `B`. + description: A shorter and abbreviated version of the metric unit, for instance `B`. nullable: true type: string type: object SLOHistoryMonitor: - description: 'An object that holds an SLI value and its associated data. It - can represent an SLO''s overall SLI value. - - This can also represent the SLI value for a specific monitor in multi-monitor - SLOs, or a group in grouped SLOs.' + description: |- + An object that holds an SLI value and its associated data. It can represent an SLO's overall SLI value. + This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs. properties: error_budget_remaining: - $ref: '#/components/schemas/SLOErrorBudgetRemainingData' + $ref: "#/components/schemas/SLOErrorBudgetRemainingData" errors: - description: An array of error objects returned while querying the history - data for the service level objective. + description: An array of error objects returned while querying the history data for the service level objective. items: - $ref: '#/components/schemas/SLOHistoryResponseErrorWithType' + $ref: "#/components/schemas/SLOHistoryResponseErrorWithType" type: array group: description: For groups in a grouped SLO, this is the group name. - example: name + example: "name" type: string history: - description: 'The state transition history for the monitor. It is represented - as - - an array of pairs. Each pair is an array containing the timestamp of the - transition - - as an integer in Unix epoch format in the first element, and the state - as an integer in the - - second element. An integer value of `0` for state means uptime, `1` means - downtime, and `2` means no data. - - Periods of no data are counted either as uptime or downtime depending - on monitor settings. - + description: |- + The state transition history for the monitor. It is represented as + an array of pairs. Each pair is an array containing the timestamp of the transition + as an integer in Unix epoch format in the first element, and the state as an integer in the + second element. An integer value of `0` for state means uptime, `1` means downtime, and `2` means no data. + Periods of no data are counted either as uptime or downtime depending on monitor settings. See [SLO documentation](https://docs.datadoghq.com/service_management/service_level_objectives/monitor/#missing-data) - - for detailed information.' - example: - - - 1579212382 - - 0 + for detailed information. + example: [[1579212382, 0]] items: - description: Represents an array timeseries data. - example: - - 1579212382 - - 0 + description: |- + Represents an array timeseries data. + example: [1579212382, 0] items: - description: A timeseries data point which is a tuple of (timestamp, - value). + description: A timeseries data point which is a tuple of (timestamp, value). format: double type: number maxItems: 2 @@ -12725,32 +11784,29 @@ components: type: array type: array monitor_modified: - description: For `monitor` based SLOs, this is the last modified timestamp - in epoch seconds of the monitor. + description: For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor. example: 1615867200 format: int64 type: integer monitor_type: description: For `monitor` based SLOs, this describes the type of monitor. - example: string + example: "string" type: string name: - description: For groups in a grouped SLO, this is the group name. For monitors - in a multi-monitor SLO, this is the monitor name. - example: string + description: >- + For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name. + example: "string" type: string precision: deprecated: true - description: The amount of decimal places the SLI value is accurate to for - the given from `&&` to timestamp. Use `span_precision` instead. + description: The amount of decimal places the SLI value is accurate to for the given from `&&` to timestamp. Use `span_precision` instead. example: 2.0 format: double type: number preview: - description: 'For `monitor` based SLOs, when `true` this indicates that - a replay is in progress to give an accurate uptime - - calculation.' + description: |- + For `monitor` based SLOs, when `true` this indicates that a replay is in progress to give an accurate uptime + calculation. example: true type: boolean sli_value: @@ -12760,8 +11816,7 @@ components: nullable: true type: number span_precision: - description: The amount of decimal places the SLI value is accurate to for - the given from `&&` to timestamp. + description: The amount of decimal places the SLI value is accurate to for the given from `&&` to timestamp. example: 2.0 format: double type: number @@ -12776,12 +11831,11 @@ components: description: A service level objective history response. properties: data: - $ref: '#/components/schemas/SLOHistoryResponseData' + $ref: "#/components/schemas/SLOHistoryResponseData" errors: - description: A list of errors while querying the history data for the service - level objective. + description: A list of errors while querying the history data for the service level objective. items: - $ref: '#/components/schemas/SLOHistoryResponseError' + $ref: "#/components/schemas/SLOHistoryResponseError" nullable: true type: array type: object @@ -12794,44 +11848,39 @@ components: format: int64 type: integer group_by: - description: 'For `metric` based SLOs where the query includes a group-by - clause, this represents the list of grouping parameters. + description: |- + For `metric` based SLOs where the query includes a group-by clause, this represents the list of grouping parameters. - - This is not included in responses for `monitor` based SLOs.' + This is not included in responses for `monitor` based SLOs. items: description: A grouping parameter. type: string type: array groups: - description: 'For grouped SLOs, this represents SLI data for specific groups. - + description: |- + For grouped SLOs, this represents SLI data for specific groups. - This is not included in the responses for `metric` based SLOs.' + This is not included in the responses for `metric` based SLOs. items: - $ref: '#/components/schemas/SLOHistoryMonitor' + $ref: "#/components/schemas/SLOHistoryMonitor" type: array monitors: - description: 'For multi-monitor SLOs, this represents SLI data for specific - monitors. + description: |- + For multi-monitor SLOs, this represents SLI data for specific monitors. - - This is not included in the responses for `metric` based SLOs.' + This is not included in the responses for `metric` based SLOs. items: - $ref: '#/components/schemas/SLOHistoryMonitor' + $ref: "#/components/schemas/SLOHistoryMonitor" type: array overall: - $ref: '#/components/schemas/SLOHistorySLIData' + $ref: "#/components/schemas/SLOHistorySLIData" series: - $ref: '#/components/schemas/SLOHistoryMetrics' + $ref: "#/components/schemas/SLOHistoryMetrics" thresholds: additionalProperties: - $ref: '#/components/schemas/SLOThreshold' + $ref: "#/components/schemas/SLOThreshold" description: mapping of string timeframe to the SLO threshold. - example: - my_service: - target: 95 - timeframe: 7d + example: {"my_service": {"target": 95, "timeframe": "7d"}} type: object to_ts: description: The `to` timestamp in epoch seconds. @@ -12839,13 +11888,12 @@ components: format: int64 type: integer type: - $ref: '#/components/schemas/SLOType' + $ref: "#/components/schemas/SLOType" type_id: - $ref: '#/components/schemas/SLOTypeNumeric' + $ref: "#/components/schemas/SLOTypeNumeric" type: object SLOHistoryResponseError: - description: A list of errors while querying the history data for the service - level objective. + description: A list of errors while querying the history data for the service level objective. properties: error: description: Human readable error. @@ -12856,67 +11904,49 @@ components: properties: error_message: description: A message with more details about the error. - example: '' + example: "" type: string error_type: description: Type of the error. - example: '' + example: "" type: string required: - - error_type - - error_message + - error_type + - error_message type: object SLOHistorySLIData: - description: 'An object that holds an SLI value and its associated data. It - can represent an SLO''s overall SLI value. - - This can also represent the SLI value for a specific monitor in multi-monitor - SLOs, or a group in grouped SLOs.' + description: |- + An object that holds an SLI value and its associated data. It can represent an SLO's overall SLI value. + This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs. properties: error_budget_remaining: - $ref: '#/components/schemas/SLOErrorBudgetRemainingData' + $ref: "#/components/schemas/SLOErrorBudgetRemainingData" errors: - description: An array of error objects returned while querying the history - data for the service level objective. + description: An array of error objects returned while querying the history data for the service level objective. items: - $ref: '#/components/schemas/SLOHistoryResponseErrorWithType' + $ref: "#/components/schemas/SLOHistoryResponseErrorWithType" type: array group: description: For groups in a grouped SLO, this is the group name. - example: name + example: "name" type: string history: - description: 'The state transition history for `monitor` or `time-slice` - SLOs. It is represented as - - an array of pairs. Each pair is an array containing the timestamp of the - transition - - as an integer in Unix epoch format in the first element, and the state - as an integer in the - - second element. An integer value of `0` for state means uptime, `1` means - downtime, and `2` means no data. - - Periods of no data count as uptime in time-slice SLOs, while for monitor - SLOs, no data is counted - + description: |- + The state transition history for `monitor` or `time-slice` SLOs. It is represented as + an array of pairs. Each pair is an array containing the timestamp of the transition + as an integer in Unix epoch format in the first element, and the state as an integer in the + second element. An integer value of `0` for state means uptime, `1` means downtime, and `2` means no data. + Periods of no data count as uptime in time-slice SLOs, while for monitor SLOs, no data is counted either as uptime or downtime depending on monitor settings. See - [SLO documentation](https://docs.datadoghq.com/service_management/service_level_objectives/monitor/#missing-data) - - for detailed information.' - example: - - - 1579212382 - - 0 + for detailed information. + example: [[1579212382, 0]] items: - description: Represents an array timeseries data. - example: - - 1579212382 - - 0 + description: |- + Represents an array timeseries data. + example: [1579212382, 0] items: - description: A timeseries data point which is a tuple of (timestamp, - value). + description: A timeseries data point which is a tuple of (timestamp, value). format: double type: number maxItems: 2 @@ -12924,36 +11954,34 @@ components: type: array type: array monitor_modified: - description: For `monitor` based SLOs, this is the last modified timestamp - in epoch seconds of the monitor. + description: For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor. example: 1615867200 format: int64 type: integer monitor_type: description: For `monitor` based SLOs, this describes the type of monitor. - example: string + example: "string" type: string name: - description: For groups in a grouped SLO, this is the group name. For monitors - in a multi-monitor SLO, this is the monitor name. - example: string + description: >- + For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name. + example: "string" type: string precision: additionalProperties: description: The number of accurate decimals. format: double type: number - description: A mapping of threshold `timeframe` to number of accurate decimals, - regardless of the from && to timestamp. + description: |- + A mapping of threshold `timeframe` to number of accurate decimals, regardless of the from && to timestamp. example: 30d: 1 7d: 2 type: object preview: - description: 'For `monitor` based SLOs, when `true` this indicates that - a replay is in progress to give an accurate uptime - - calculation.' + description: |- + For `monitor` based SLOs, when `true` this indicates that a replay is in progress to give an accurate uptime + calculation. example: true type: boolean sli_value: @@ -12963,8 +11991,7 @@ components: nullable: true type: number span_precision: - description: The amount of decimal places the SLI value is accurate to for - the given from `&&` to timestamp. + description: The amount of decimal places the SLI value is accurate to for the given from `&&` to timestamp. example: 2.0 format: double type: number @@ -12982,51 +12009,47 @@ components: data: description: An array of service level objective objects. items: - $ref: '#/components/schemas/ServiceLevelObjective' + $ref: "#/components/schemas/ServiceLevelObjective" type: array errors: - description: 'An array of error messages. Each endpoint documents how/whether - this field is - - used.' + description: |- + An array of error messages. Each endpoint documents how/whether this field is + used. items: description: The error message. type: string type: array metadata: - $ref: '#/components/schemas/SLOListResponseMetadata' + $ref: "#/components/schemas/SLOListResponseMetadata" type: object SLOListResponseMetadata: - description: The metadata object containing additional information about the - list of SLOs. + description: |- + The metadata object containing additional information about the list of SLOs. properties: page: - $ref: '#/components/schemas/SLOListResponseMetadataPage' + $ref: "#/components/schemas/SLOListResponseMetadataPage" type: object SLOListResponseMetadataPage: - description: The object containing information about the pages of the list of - SLOs. + description: The object containing information about the pages of the list of SLOs. properties: total_count: - description: The total number of resources that could be retrieved ignoring - the parameters and filters in the request. + description: |- + The total number of resources that could be retrieved ignoring the parameters and filters in the request. format: int64 type: integer total_filtered_count: - description: The total number of resources that match the parameters and - filters in the request. This attribute can be used by a client to determine - the total number of pages. + description: |- + The total number of resources that match the parameters and filters in the request. This attribute can be used by a client to determine the total number of pages. format: int64 type: integer type: object SLOListWidgetDefinition: - description: Use the SLO List widget to track your SLOs (Service Level Objectives) - on dashboards. + description: Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards. properties: requests: description: Array of one request object to display in the widget. items: - $ref: '#/components/schemas/SLOListWidgetRequest' + $ref: "#/components/schemas/SLOListWidgetRequest" maxItems: 1 minItems: 1 type: array @@ -13034,25 +12057,25 @@ components: description: Title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/SLOListWidgetDefinitionType' + $ref: "#/components/schemas/SLOListWidgetDefinitionType" required: - - type - - requests + - type + - requests type: object SLOListWidgetDefinitionType: default: slo_list description: Type of the SLO List widget. enum: - - slo_list + - slo_list example: slo_list type: string x-enum-varnames: - - SLO_LIST + - SLO_LIST SLOListWidgetQuery: description: Updated SLO List widget. properties: @@ -13065,35 +12088,35 @@ components: type: integer query_string: description: Widget query. - example: env:prod AND service:my-app + example: "env:prod AND service:my-app" type: string sort: description: Options for sorting results. items: - $ref: '#/components/schemas/WidgetFieldSort' + $ref: "#/components/schemas/WidgetFieldSort" type: array required: - - query_string + - query_string type: object SLOListWidgetRequest: description: Updated SLO List widget. properties: query: - $ref: '#/components/schemas/SLOListWidgetQuery' + $ref: "#/components/schemas/SLOListWidgetQuery" request_type: - $ref: '#/components/schemas/SLOListWidgetRequestType' + $ref: "#/components/schemas/SLOListWidgetRequestType" required: - - query - - request_type + - query + - request_type type: object SLOListWidgetRequestType: description: Widget request type. enum: - - slo_list - example: slo_list + - slo_list + example: "slo_list" type: string x-enum-varnames: - - SLO_LIST + - SLO_LIST SLOOverallStatuses: description: Overall status of the SLO by timeframes. properties: @@ -13108,15 +12131,14 @@ components: nullable: true type: number indexed_at: - description: 'timestamp (UNIX time in seconds) of when the SLO status and - error budget - - were calculated.' + description: |- + timestamp (UNIX time in seconds) of when the SLO status and error budget + were calculated. example: 1662496260 format: int64 type: integer raw_error_budget_remaining: - $ref: '#/components/schemas/SLORawErrorBudgetRemaining' + $ref: "#/components/schemas/SLORawErrorBudgetRemaining" span_precision: description: The amount of decimal places the SLI value is accurate to. example: 2 @@ -13124,7 +12146,7 @@ components: nullable: true type: integer state: - $ref: '#/components/schemas/SLOState' + $ref: "#/components/schemas/SLOState" status: description: The status of the SLO. example: 100 @@ -13137,7 +12159,7 @@ components: format: double type: number timeframe: - $ref: '#/components/schemas/SLOTimeframe' + $ref: "#/components/schemas/SLOTimeframe" type: object SLORawErrorBudgetRemaining: description: Error budget remaining for an SLO. @@ -13145,7 +12167,7 @@ components: properties: unit: description: Error budget remaining unit. - example: requests + example: "requests" type: string value: description: Error budget remaining value. @@ -13154,209 +12176,169 @@ components: type: number type: object SLOResponse: - description: A service level objective response containing a single service - level objective. + description: A service level objective response containing a single service level objective. properties: data: - $ref: '#/components/schemas/SLOResponseData' + $ref: "#/components/schemas/SLOResponseData" errors: - description: 'An array of error messages. Each endpoint documents how/whether - this field is - - used.' + description: |- + An array of error messages. Each endpoint documents how/whether this field is + used. items: description: The error message. type: string type: array type: object SLOResponseData: - description: 'A service level objective object includes a service level indicator, - thresholds - - for one or more timeframes, and metadata (`name`, `description`, `tags`, etc.).' + description: |- + A service level objective object includes a service level indicator, thresholds + for one or more timeframes, and metadata (`name`, `description`, `tags`, etc.). properties: configured_alert_ids: - description: A list of SLO monitors IDs that reference this SLO. This field - is returned only when `with_configured_alert_ids` parameter is true in - query. - example: - - 123 - - 456 - - 789 + description: A list of SLO monitors IDs that reference this SLO. This field is returned only when `with_configured_alert_ids` parameter is true in query. + example: [123, 456, 789] items: description: A monitor ID. format: int64 type: integer type: array created_at: - description: 'Creation timestamp (UNIX time in seconds) + description: |- + Creation timestamp (UNIX time in seconds) - - Always included in service level objective responses.' + Always included in service level objective responses. format: int64 readOnly: true type: integer creator: - $ref: '#/components/schemas/Creator' + $ref: "#/components/schemas/Creator" description: - description: 'A user-defined description of the service level objective. - + description: |- + A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). - - Optional in create/update requests.' + Optional in create/update requests. nullable: true type: string groups: - description: 'A list of (up to 20) monitor groups that narrow the scope - of a monitor service level objective. - - - Included in service level objective responses if it is not empty. Optional - in - - create/update requests for monitor service level objectives, but may only - be + description: |- + A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective. - used when then length of the `monitor_ids` field is one.' - example: - - env:prod - - role:mysql + Included in service level objective responses if it is not empty. Optional in + create/update requests for monitor service level objectives, but may only be + used when then length of the `monitor_ids` field is one. + example: ["env:prod", "role:mysql"] items: description: A group name, for instance `env:prod`. type: string type: array id: - description: 'A unique identifier for the service level objective object. - + description: |- + A unique identifier for the service level objective object. - Always included in service level objective responses.' + Always included in service level objective responses. readOnly: true type: string modified_at: - description: 'Modification timestamp (UNIX time in seconds) + description: |- + Modification timestamp (UNIX time in seconds) - - Always included in service level objective responses.' + Always included in service level objective responses. format: int64 readOnly: true type: integer monitor_ids: - description: 'A list of monitor ids that defines the scope of a monitor - service level - - objective. **Required if type is `monitor`**.' + description: |- + A list of monitor ids that defines the scope of a monitor service level + objective. **Required if type is `monitor`**. items: description: A monitor ID. format: int64 type: integer type: array monitor_tags: - description: 'The union of monitor tags for all monitors referenced by the - `monitor_ids` - + description: |- + The union of monitor tags for all monitors referenced by the `monitor_ids` field. - - Always included in service level objective responses for monitor service - level - - objectives (but may be empty). Ignored in create/update requests. Does - not - - affect which monitors are included in the service level objective (that - is - - determined entirely by the `monitor_ids` field).' + Always included in service level objective responses for monitor service level + objectives (but may be empty). Ignored in create/update requests. Does not + affect which monitors are included in the service level objective (that is + determined entirely by the `monitor_ids` field). items: description: A monitor tag. type: string type: array name: description: The name of the service level objective object. - example: Custom Metric SLO + example: "Custom Metric SLO" type: string query: - $ref: '#/components/schemas/ServiceLevelObjectiveQuery' - description: The metric query used to define a count-based SLO as the ratio - of good events to total events. + $ref: "#/components/schemas/ServiceLevelObjectiveQuery" + description: |- + The metric query used to define a count-based SLO as the ratio of good events to total events. sli_specification: - $ref: '#/components/schemas/SLOSliSpec' - description: A generic SLI specification. This is currently used for time-slice - and count-based (metric) SLOs only. + $ref: "#/components/schemas/SLOSliSpec" + description: |- + A generic SLI specification. This is currently used for time-slice and count-based (metric) SLOs only. tags: - description: 'A list of tags associated with this service level objective. - + description: |- + A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). - - Optional in create/update requests.' - example: - - env:prod - - app:core + Optional in create/update requests. + example: ["env:prod", "app:core"] items: description: A tag to apply to your SLO. type: string type: array target_threshold: - description: 'The target threshold such that when the service level indicator - is above this - - threshold over the given timeframe, the objective is being met.' + description: |- + The target threshold such that when the service level indicator is above this + threshold over the given timeframe, the objective is being met. example: 99.9 format: double type: number thresholds: - description: 'The thresholds (timeframes and associated targets) for this - service level - - objective object.' - example: - - target: 95 - timeframe: 7d - - target: 95 - timeframe: 30d - warning: 97 + description: |- + The thresholds (timeframes and associated targets) for this service level + objective object. + example: [{"target": 95, "timeframe": "7d"}, {"target": 95, "timeframe": "30d", "warning": 97}] items: - $ref: '#/components/schemas/SLOThreshold' + $ref: "#/components/schemas/SLOThreshold" type: array timeframe: - $ref: '#/components/schemas/SLOTimeframe' + $ref: "#/components/schemas/SLOTimeframe" type: - $ref: '#/components/schemas/SLOType' + $ref: "#/components/schemas/SLOType" warning_threshold: - description: 'The optional warning threshold such that when the service - level indicator is - - below this value for the given threshold, but above the target threshold, - the - - objective appears in a "warning" state. This value must be greater than - the target - - threshold.' + description: |- + The optional warning threshold such that when the service level indicator is + below this value for the given threshold, but above the target threshold, the + objective appears in a "warning" state. This value must be greater than the target + threshold. example: 99.95 format: double type: number type: object SLOSliSpec: - description: A generic SLI specification. This is used for time-slice and count-based - (metric) SLOs only. + description: |- + A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only. oneOf: - - $ref: '#/components/schemas/SLOTimeSliceSpec' - - $ref: '#/components/schemas/SLOCountSpec' + - $ref: "#/components/schemas/SLOTimeSliceSpec" + - $ref: "#/components/schemas/SLOCountSpec" SLOState: description: State of the SLO. enum: - - breached - - warning - - ok - - no_data + - breached + - warning + - ok + - no_data example: ok type: string x-enum-varnames: - - BREACHED - - WARNING - - OK - - NO_DATA + - BREACHED + - WARNING + - OK + - NO_DATA SLOStatus: description: Status of the SLO's primary timeframe. properties: @@ -13371,18 +12353,17 @@ components: nullable: true type: number indexed_at: - description: 'timestamp (UNIX time in seconds) of when the SLO status and - error budget - - were calculated.' + description: |- + timestamp (UNIX time in seconds) of when the SLO status and error budget + were calculated. example: 1662496260 format: int64 type: integer raw_error_budget_remaining: - $ref: '#/components/schemas/SLORawErrorBudgetRemaining' + $ref: "#/components/schemas/SLORawErrorBudgetRemaining" sli: - description: The current service level indicator (SLI) of the SLO, also - known as 'status'. This is a percentage value from 0-100 (inclusive). + description: |- + The current service level indicator (SLI) of the SLO, also known as 'status'. This is a percentage value from 0-100 (inclusive). example: 100 format: double nullable: true @@ -13394,230 +12375,220 @@ components: nullable: true type: integer state: - $ref: '#/components/schemas/SLOState' + $ref: "#/components/schemas/SLOState" type: object SLOThreshold: - description: SLO thresholds (target and optionally warning) for a single time - window. + description: SLO thresholds (target and optionally warning) for a single time window. properties: target: - description: 'The target value for the service level indicator within the - corresponding - - timeframe.' + description: |- + The target value for the service level indicator within the corresponding + timeframe. example: 99.9 format: double type: number target_display: - description: 'A string representation of the target that indicates its precision. - - It uses trailing zeros to show significant decimal places (for example - `98.00`). - + description: |- + A string representation of the target that indicates its precision. + It uses trailing zeros to show significant decimal places (for example `98.00`). Always included in service level objective responses. Ignored in - - create/update requests.' - example: '99.9' + create/update requests. + example: "99.9" type: string timeframe: - $ref: '#/components/schemas/SLOTimeframe' + $ref: "#/components/schemas/SLOTimeframe" warning: - description: The warning value for the service level objective. + description: |- + The warning value for the service level objective. example: 90.0 format: double type: number warning_display: - description: 'A string representation of the warning target (see the description - of - + description: |- + A string representation of the warning target (see the description of the `target_display` field for details). - Included in service level objective responses if a warning target exists. - - Ignored in create/update requests.' - example: '90.0' + Ignored in create/update requests. + example: "90.0" type: string required: - - timeframe - - target + - timeframe + - target type: object SLOTimeSliceComparator: - description: The comparator used to compare the SLI value to the threshold. + description: |- + The comparator used to compare the SLI value to the threshold. enum: - - '>' - - '>=' - - < - - <= - example: '>' + - ">" + - ">=" + - "<" + - "<=" + example: ">" type: string x-enum-varnames: - - GREATER - - GREATER_EQUAL - - LESS - - LESS_EQUAL + - GREATER + - GREATER_EQUAL + - LESS + - LESS_EQUAL SLOTimeSliceCondition: - description: 'The time-slice condition, composed of 3 parts: 1. the metric timeseries - query, 2. the comparator, - - and 3. the threshold. Optionally, a fourth part, the query interval, can be - provided.' + description: |- + The time-slice condition, composed of 3 parts: 1. the metric timeseries query, 2. the comparator, + and 3. the threshold. Optionally, a fourth part, the query interval, can be provided. example: - comparator: < + comparator: "<" query: formulas: - - formula: query2/query1 + - formula: "query2/query1" queries: - - data_source: metrics - name: query1 - query: sum:trace.servlet.request.hits{*} by {env}.as_count() - - data_source: metrics - name: query1 - query: sum:trace.servlet.request.errors{*} by {env}.as_count() + - data_source: metrics + name: "query1" + query: "sum:trace.servlet.request.hits{*} by {env}.as_count()" + - data_source: metrics + name: "query1" + query: "sum:trace.servlet.request.errors{*} by {env}.as_count()" threshold: 5 properties: comparator: - $ref: '#/components/schemas/SLOTimeSliceComparator' + $ref: "#/components/schemas/SLOTimeSliceComparator" query: - $ref: '#/components/schemas/SLOTimeSliceQuery' + $ref: "#/components/schemas/SLOTimeSliceQuery" query_interval_seconds: - $ref: '#/components/schemas/SLOTimeSliceInterval' + $ref: "#/components/schemas/SLOTimeSliceInterval" threshold: - description: The threshold value to which each SLI value will be compared. + description: |- + The threshold value to which each SLI value will be compared. example: 5 format: double type: number required: - - comparator - - threshold - - query + - comparator + - threshold + - query type: object SLOTimeSliceInterval: - description: 'The interval used when querying data, which defines the size of - a time slice. - + description: |- + The interval used when querying data, which defines the size of a time slice. Two values are allowed: 60 (1 minute) and 300 (5 minutes). - - If not provided, the value defaults to 300 (5 minutes).' + If not provided, the value defaults to 300 (5 minutes). enum: - - 60 - - 300 + - 60 + - 300 example: 300 format: int32 type: integer x-enum-varnames: - - ONE_MINUTE - - FIVE_MINUTES + - ONE_MINUTE + - FIVE_MINUTES SLOTimeSliceQuery: - description: The queries and formula used to calculate the SLI value. + description: |- + The queries and formula used to calculate the SLI value. example: formulas: - - formula: query2/query1 + - formula: "query2/query1" queries: - - data_source: metrics - name: query1 - query: sum:trace.servlet.request.hits{*} by {env}.as_count() - - data_source: metrics - name: query1 - query: sum:trace.servlet.request.errors{*} by {env}.as_count() + - data_source: metrics + name: "query1" + query: "sum:trace.servlet.request.hits{*} by {env}.as_count()" + - data_source: metrics + name: "query1" + query: "sum:trace.servlet.request.errors{*} by {env}.as_count()" properties: formulas: - description: A list that contains exactly one formula, as only a single - formula may be used in a time-slice SLO. + description: |- + A list that contains exactly one formula, as only a single formula may be used in a time-slice SLO. example: - - formula: query1 - default_zero(query2) + - formula: "query1 - default_zero(query2)" items: - $ref: '#/components/schemas/SLOFormula' + $ref: "#/components/schemas/SLOFormula" maxItems: 1 minItems: 1 type: array queries: - description: A list of queries that are used to calculate the SLI value. + description: |- + A list of queries that are used to calculate the SLI value. example: - - data_source: metrics - name: query1 - query: sum:trace.servlet.request.hits{*} by {env}.as_count() + - data_source: metrics + name: "query1" + query: "sum:trace.servlet.request.hits{*} by {env}.as_count()" items: - $ref: '#/components/schemas/SLODataSourceQueryDefinition' + $ref: "#/components/schemas/SLODataSourceQueryDefinition" type: array required: - - formulas - - queries + - formulas + - queries type: object SLOTimeSliceSpec: additionalProperties: false - description: A time-slice SLI specification. + description: |- + A time-slice SLI specification. example: time_slice: - comparator: < + comparator: "<" query: formulas: - - formula: query2/query1 + - formula: "query2/query1" queries: - - data_source: metrics - name: query1 - query: sum:trace.servlet.request.hits{*} by {env}.as_count() - - data_source: metrics - name: query2 - query: sum:trace.servlet.request.errors{*} by {env}.as_count() + - data_source: metrics + name: "query1" + query: "sum:trace.servlet.request.hits{*} by {env}.as_count()" + - data_source: metrics + name: "query2" + query: "sum:trace.servlet.request.errors{*} by {env}.as_count()" threshold: 5 properties: time_slice: - $ref: '#/components/schemas/SLOTimeSliceCondition' + $ref: "#/components/schemas/SLOTimeSliceCondition" required: - - time_slice + - time_slice type: object SLOTimeframe: - description: 'The SLO time window options. Note that "custom" is not a valid - option for creating - - or updating SLOs. It is only used when querying SLO history over custom timeframes.' + description: |- + The SLO time window options. Note that "custom" is not a valid option for creating + or updating SLOs. It is only used when querying SLO history over custom timeframes. enum: - - 7d - - 30d - - 90d - - custom + - 7d + - 30d + - 90d + - custom example: 30d type: string x-enum-varnames: - - SEVEN_DAYS - - THIRTY_DAYS - - NINETY_DAYS - - CUSTOM + - SEVEN_DAYS + - THIRTY_DAYS + - NINETY_DAYS + - CUSTOM SLOType: description: The type of the service level objective. enum: - - metric - - monitor - - time_slice - example: metric + - metric + - monitor + - time_slice + example: "metric" type: string x-enum-varnames: - - METRIC - - MONITOR - - TIME_SLICE + - METRIC + - MONITOR + - TIME_SLICE SLOTypeNumeric: - description: 'A numeric representation of the type of the service level objective - (`0` for - + description: |- + A numeric representation of the type of the service level objective (`0` for monitor, `1` for metric). Always included in service level objective responses. - - Ignored in create/update requests.' + Ignored in create/update requests. enum: - - 0 - - 1 - - 2 + - 0 + - 1 + - 2 example: 0 format: int32 type: integer x-enum-varnames: - - MONITOR - - METRIC - - TIME_SLICE + - MONITOR + - METRIC + - TIME_SLICE SLOWidgetDefinition: - description: Use the SLO and uptime widget to track your SLOs (Service Level - Objectives) and uptime on screenboards and timeboards. + description: Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards. properties: additional_query_filters: description: Additional filters applied to the SLO query. @@ -13634,82 +12605,81 @@ components: time_windows: description: Times being monitored. items: - $ref: '#/components/schemas/WidgetTimeWindows' + $ref: "#/components/schemas/WidgetTimeWindows" type: array title: description: Title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/SLOWidgetDefinitionType' + $ref: "#/components/schemas/SLOWidgetDefinitionType" view_mode: - $ref: '#/components/schemas/WidgetViewMode' + $ref: "#/components/schemas/WidgetViewMode" view_type: default: detail description: Type of view displayed by the widget. example: detail type: string required: - - type - - view_type + - type + - view_type type: object SLOWidgetDefinitionType: default: slo description: Type of the SLO widget. enum: - - slo + - slo example: slo type: string x-enum-varnames: - - SLO + - SLO ScatterPlotRequest: description: Updated scatter plot. properties: aggregator: - $ref: '#/components/schemas/ScatterplotWidgetAggregator' + $ref: "#/components/schemas/ScatterplotWidgetAggregator" apm_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. event_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. log_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. process_query: - $ref: '#/components/schemas/ProcessQueryDefinition' + $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: description: Query definition. type: string rum_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. type: object ScatterPlotWidgetDefinition: - description: The scatter plot visualization allows you to graph a chosen scope - over two different metrics with their respective aggregation. + description: The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. properties: color_by_groups: description: List of groups used for colors. @@ -13720,138 +12690,128 @@ components: custom_links: description: List of custom links. items: - $ref: '#/components/schemas/WidgetCustomLink' + $ref: "#/components/schemas/WidgetCustomLink" type: array requests: - $ref: '#/components/schemas/ScatterPlotWidgetDefinitionRequests' + $ref: "#/components/schemas/ScatterPlotWidgetDefinitionRequests" time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/ScatterPlotWidgetDefinitionType' + $ref: "#/components/schemas/ScatterPlotWidgetDefinitionType" xaxis: - $ref: '#/components/schemas/WidgetAxis' + $ref: "#/components/schemas/WidgetAxis" yaxis: - $ref: '#/components/schemas/WidgetAxis' + $ref: "#/components/schemas/WidgetAxis" required: - - type - - requests + - type + - requests type: object ScatterPlotWidgetDefinitionRequests: description: Widget definition. - example: - x: - q: system.cpu.user - y: - q: system.mem.used + example: {"x": {"q": "system.cpu.user"}, "y": {"q": "system.mem.used"}} properties: table: - $ref: '#/components/schemas/ScatterplotTableRequest' + $ref: "#/components/schemas/ScatterplotTableRequest" x: - $ref: '#/components/schemas/ScatterPlotRequest' + $ref: "#/components/schemas/ScatterPlotRequest" y: - $ref: '#/components/schemas/ScatterPlotRequest' + $ref: "#/components/schemas/ScatterPlotRequest" type: object ScatterPlotWidgetDefinitionType: default: scatterplot description: Type of the scatter plot widget. enum: - - scatterplot + - scatterplot example: scatterplot type: string x-enum-varnames: - - SCATTERPLOT + - SCATTERPLOT ScatterplotDimension: description: Dimension of the Scatterplot. enum: - - x - - y - - radius - - color + - x + - y + - radius + - color example: radius type: string x-enum-varnames: - - X - - Y - - RADIUS - - COLOR + - X + - Y + - RADIUS + - COLOR ScatterplotTableRequest: description: Scatterplot request containing formulas and functions. properties: formulas: description: List of Scatterplot formulas that operate on queries. items: - $ref: '#/components/schemas/ScatterplotWidgetFormula' + $ref: "#/components/schemas/ScatterplotWidgetFormula" type: array queries: description: List of queries that can be returned directly or used in formulas. items: - $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition' + $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: - $ref: '#/components/schemas/FormulaAndFunctionResponseFormat' + $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" type: object ScatterplotWidgetAggregator: description: Aggregator used for the request. enum: - - avg - - last - - max - - min - - sum + - avg + - last + - max + - min + - sum type: string x-enum-varnames: - - AVERAGE - - LAST - - MAXIMUM - - MINIMUM - - SUM + - AVERAGE + - LAST + - MAXIMUM + - MINIMUM + - SUM ScatterplotWidgetFormula: description: Formula to be used in a Scatterplot widget query. properties: alias: description: Expression alias. - example: my-query + example: "my-query" type: string dimension: - $ref: '#/components/schemas/ScatterplotDimension' + $ref: "#/components/schemas/ScatterplotDimension" formula: description: String expression built from queries, formulas, and functions. - example: func(a) + b + example: "func(a) + b" type: string required: - - formula - - dimension + - formula + - dimension type: object SearchSLOQuery: - description: 'A metric-based SLO. **Required if type is `metric`**. Note that - Datadog only allows the sum by aggregator - - to be used because this will sum up all request counts instead of averaging - them, or taking the max or - - min of all of those requests.' + description: |- + A metric-based SLO. **Required if type is `metric`**. Note that Datadog only allows the sum by aggregator + to be used because this will sum up all request counts instead of averaging them, or taking the max or + min of all of those requests. nullable: true properties: denominator: description: A Datadog metric query for total (valid) events. - example: sum:my.custom.metric{*}.as_count() + example: "sum:my.custom.metric{*}.as_count()" type: string metrics: - description: 'Metric names used in the query''s numerator and denominator. - - This field will return null and will be implemented in the next version - of this endpoint.' - example: - - my.custom.metric - - my.other.custom.metric + description: |- + Metric names used in the query's numerator and denominator. + This field will return null and will be implemented in the next version of this endpoint. + example: ["my.custom.metric", "my.other.custom.metric"] items: description: Metric name. type: string @@ -13859,38 +12819,38 @@ components: type: array numerator: description: A Datadog metric query for good events. - example: sum:my.custom.metric{type:good}.as_count() + example: "sum:my.custom.metric{type:good}.as_count()" type: string type: object SearchSLOResponse: description: A search SLO response containing results from the search query. properties: data: - $ref: '#/components/schemas/SearchSLOResponseData' + $ref: "#/components/schemas/SearchSLOResponseData" links: - $ref: '#/components/schemas/SearchSLOResponseLinks' + $ref: "#/components/schemas/SearchSLOResponseLinks" meta: - $ref: '#/components/schemas/SearchSLOResponseMeta' + $ref: "#/components/schemas/SearchSLOResponseMeta" type: object SearchSLOResponseData: description: Data from search SLO response. properties: attributes: - $ref: '#/components/schemas/SearchSLOResponseDataAttributes' + $ref: "#/components/schemas/SearchSLOResponseDataAttributes" type: description: Type of service level objective result. - example: '' + example: "" type: string type: object SearchSLOResponseDataAttributes: description: Attributes properties: facets: - $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacets' + $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacets" slos: description: SLOs items: - $ref: '#/components/schemas/SearchServiceLevelObjective' + $ref: "#/components/schemas/SearchServiceLevelObjective" type: array type: object SearchSLOResponseDataAttributesFacets: @@ -13899,42 +12859,42 @@ components: all_tags: description: All tags associated with an SLO. items: - $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString' + $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString" type: array creator_name: description: Creator of an SLO. items: - $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString' + $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString" type: array env_tags: description: Tags with the `env` tag key. items: - $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString' + $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString" type: array service_tags: description: Tags with the `service` tag key. items: - $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString' + $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString" type: array slo_type: description: Type of SLO. items: - $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectInt' + $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectInt" type: array target: description: SLO Target items: - $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectInt' + $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectInt" type: array team_tags: description: Tags with the `team` tag key. items: - $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString' + $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString" type: array timeframe: description: Timeframes of SLOs. items: - $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString' + $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString" type: array type: object SearchSLOResponseDataAttributesFacetsObjectInt: @@ -13985,7 +12945,7 @@ components: description: Searches metadata returned by the API. properties: pagination: - $ref: '#/components/schemas/SearchSLOResponseMetaPage' + $ref: "#/components/schemas/SearchSLOResponseMetaPage" type: object SearchSLOResponseMetaPage: description: Pagination metadata returned by the API. @@ -14023,105 +12983,94 @@ components: type: string type: object SearchSLOThreshold: - description: SLO thresholds (target and optionally warning) for a single time - window. + description: SLO thresholds (target and optionally warning) for a single time window. properties: target: - description: 'The target value for the service level indicator within the - corresponding - - timeframe.' + description: |- + The target value for the service level indicator within the corresponding + timeframe. example: 99.9 format: double type: number target_display: - description: 'A string representation of the target that indicates its precision. - - It uses trailing zeros to show significant decimal places (for example - `98.00`). - + description: |- + A string representation of the target that indicates its precision. + It uses trailing zeros to show significant decimal places (for example `98.00`). Always included in service level objective responses. Ignored in - - create/update requests.' - example: '99.9' + create/update requests. + example: "99.9" type: string timeframe: - $ref: '#/components/schemas/SearchSLOTimeframe' + $ref: "#/components/schemas/SearchSLOTimeframe" warning: - description: The warning value for the service level objective. + description: |- + The warning value for the service level objective. example: 90.0 format: double nullable: true type: number warning_display: - description: 'A string representation of the warning target (see the description - of - + description: |- + A string representation of the warning target (see the description of the `target_display` field for details). - Included in service level objective responses if a warning target exists. - - Ignored in create/update requests.' - example: '90.0' + Ignored in create/update requests. + example: "90.0" nullable: true type: string required: - - timeframe - - target + - timeframe + - target type: object SearchSLOTimeframe: description: The SLO time window options. enum: - - 7d - - 30d - - 90d + - 7d + - 30d + - 90d example: 30d type: string x-enum-varnames: - - SEVEN_DAYS - - THIRTY_DAYS - - NINETY_DAYS + - SEVEN_DAYS + - THIRTY_DAYS + - NINETY_DAYS SearchServiceLevelObjective: description: A service level objective data container. properties: data: - $ref: '#/components/schemas/SearchServiceLevelObjectiveData' + $ref: "#/components/schemas/SearchServiceLevelObjectiveData" type: object SearchServiceLevelObjectiveAttributes: - description: 'A service level objective object includes a service level indicator, - thresholds - - for one or more timeframes, and metadata (`name`, `description`, and `tags`).' + description: |- + A service level objective object includes a service level indicator, thresholds + for one or more timeframes, and metadata (`name`, `description`, and `tags`). properties: all_tags: - description: 'A list of tags associated with this service level objective. - - Always included in service level objective responses (but may be empty).' - example: - - env:prod - - app:core + description: |- + A list of tags associated with this service level objective. + Always included in service level objective responses (but may be empty). + example: ["env:prod", "app:core"] items: type: string type: array created_at: - description: 'Creation timestamp (UNIX time in seconds) + description: |- + Creation timestamp (UNIX time in seconds) - - Always included in service level objective responses.' + Always included in service level objective responses. format: int64 readOnly: true type: integer creator: - $ref: '#/components/schemas/SLOCreator' + $ref: "#/components/schemas/SLOCreator" description: - description: 'A user-defined description of the service level objective. - + description: |- + A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). - - Optional in create/update requests.' + Optional in create/update requests. nullable: true type: string env_tags: @@ -14130,31 +13079,27 @@ components: type: string type: array groups: - description: 'A list of (up to 100) monitor groups that narrow the scope - of a monitor service level objective. - - Included in service level objective responses if it is not empty.' - example: - - env:prod - - role:mysql + description: |- + A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective. + Included in service level objective responses if it is not empty. + example: ["env:prod", "role:mysql"] items: description: A group name, for instance `env:prod`. type: string nullable: true type: array modified_at: - description: 'Modification timestamp (UNIX time in seconds) - + description: |- + Modification timestamp (UNIX time in seconds) - Always included in service level objective responses.' + Always included in service level objective responses. format: int64 readOnly: true type: integer monitor_ids: - description: 'A list of monitor ids that defines the scope of a monitor - service level - - objective.' + description: |- + A list of monitor ids that defines the scope of a monitor service level + objective. items: description: A monitor ID. format: int64 @@ -14163,57 +13108,48 @@ components: type: array name: description: The name of the service level objective object. - example: Custom Metric SLO + example: "Custom Metric SLO" type: string overall_status: description: calculated status and error budget remaining. items: - $ref: '#/components/schemas/SLOOverallStatuses' + $ref: "#/components/schemas/SLOOverallStatuses" type: array query: - $ref: '#/components/schemas/SearchSLOQuery' + $ref: "#/components/schemas/SearchSLOQuery" service_tags: description: Tags with the `service` tag key. items: type: string type: array slo_type: - $ref: '#/components/schemas/SLOType' + $ref: "#/components/schemas/SLOType" status: - $ref: '#/components/schemas/SLOStatus' + $ref: "#/components/schemas/SLOStatus" team_tags: description: Tags with the `team` tag key. items: type: string type: array thresholds: - description: 'The thresholds (timeframes and associated targets) for this - service level - - objective object.' - example: - - target: 95 - target_display: '95' - timeframe: 7d - - target: 95 - target_display: '95' - timeframe: 30d - warning: 97 - warning_display: '97' + description: |- + The thresholds (timeframes and associated targets) for this service level + objective object. + example: [{"target": 95, "target_display": "95", "timeframe": "7d"}, {"target": 95, "target_display": "95", "timeframe": "30d", "warning": 97, "warning_display": "97"}] items: - $ref: '#/components/schemas/SearchSLOThreshold' + $ref: "#/components/schemas/SearchSLOThreshold" type: array type: object SearchServiceLevelObjectiveData: description: A service level objective ID and attributes. properties: attributes: - $ref: '#/components/schemas/SearchServiceLevelObjectiveAttributes' + $ref: "#/components/schemas/SearchServiceLevelObjectiveAttributes" id: - description: 'A unique identifier for the service level objective object. - + description: |- + A unique identifier for the service level objective object. - Always included in service level objective responses.' + Always included in service level objective responses. readOnly: true type: string type: @@ -14221,8 +13157,7 @@ components: type: string type: object SelectableTemplateVariableItems: - description: Object containing the template variable's name, associated tag/attribute, - default value and selectable values. + description: Object containing the template variable's name, associated tag/attribute, default value and selectable values. properties: default_value: description: The default value of the template variable. @@ -14234,33 +13169,29 @@ components: description: The tag/attribute key associated with the template variable. type: string type: - description: The type of variable. This is to differentiate between filter - variables (interpolated in query) and group by variables (interpolated - into group by). + description: The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by). nullable: true type: string visible_tags: description: List of visible tag values on the shared dashboard. items: - description: Other values for this tag that can be selected on the shared - dashboard. + description: Other values for this tag that can be selected on the shared dashboard. type: string nullable: true type: array type: object Series: - description: 'A metric to submit to Datadog. - - See [Datadog metrics](https://docs.datadoghq.com/developers/metrics/#custom-metrics-properties).' + description: |- + A metric to submit to Datadog. + See [Datadog metrics](https://docs.datadoghq.com/developers/metrics/#custom-metrics-properties). properties: host: description: The name of the host that produced the metric. example: test.example.com type: string interval: - default: null - description: If the type of the metric is rate or count, define the corresponding - interval in seconds. + default: + description: If the type of the metric is rate or count, define the corresponding interval in seconds. example: 20 format: int64 nullable: true @@ -14270,33 +13201,27 @@ components: example: system.load.1 type: string points: - description: Points relating to a metric. All points must be tuples with - timestamp and a scalar value (cannot be a string). Timestamps should be - in POSIX time in seconds, and cannot be more than ten minutes in the future - or more than one hour in the past. + description: Points relating to a metric. All points must be tuples with timestamp and a scalar value (cannot be a string). Timestamps should be in POSIX time in seconds, and cannot be more than ten minutes in the future or more than one hour in the past. example: - - - 1575317847.0 - - 0.5 + - [1575317847.0, 0.5] items: - $ref: '#/components/schemas/Point' + $ref: "#/components/schemas/Point" type: array tags: description: A list of tags associated with the metric. - example: - - environment:test + example: ["environment:test"] items: description: Individual tags. type: string type: array type: - default: '' - description: The type of the metric. Valid types are "",`count`, `gauge`, - and `rate`. + default: "" + description: The type of the metric. Valid types are "",`count`, `gauge`, and `rate`. example: rate type: string required: - - metric - - points + - metric + - points type: object ServiceCheck: description: An object containing service check and status. @@ -14314,11 +13239,10 @@ components: example: app is running type: string status: - $ref: '#/components/schemas/ServiceCheckStatus' + $ref: "#/components/schemas/ServiceCheckStatus" tags: description: Tags related to a check. - example: - - environment:test + example: ["environment:test"] items: description: Items related to a check. type: string @@ -14328,248 +13252,200 @@ components: format: int64 type: integer required: - - check - - status - - tags - - host_name + - check + - status + - tags + - host_name type: object ServiceCheckStatus: - description: The status of a service check. Set to `0` for OK, `1` for warning, - `2` for critical, and `3` for unknown. + description: The status of a service check. Set to `0` for OK, `1` for warning, `2` for critical, and `3` for unknown. enum: - - 0 - - 1 - - 2 - - 3 + - 0 + - 1 + - 2 + - 3 example: 0 format: int32 type: integer x-enum-varnames: - - OK - - WARNING - - CRITICAL - - UNKNOWN + - OK + - WARNING + - CRITICAL + - UNKNOWN ServiceChecks: description: The service checks. items: - $ref: '#/components/schemas/ServiceCheck' + $ref: "#/components/schemas/ServiceCheck" type: array ServiceLevelObjective: - description: 'A service level objective object includes a service level indicator, - thresholds - - for one or more timeframes, and metadata (`name`, `description`, `tags`, etc.).' + description: |- + A service level objective object includes a service level indicator, thresholds + for one or more timeframes, and metadata (`name`, `description`, `tags`, etc.). properties: created_at: - description: 'Creation timestamp (UNIX time in seconds) - + description: |- + Creation timestamp (UNIX time in seconds) - Always included in service level objective responses.' + Always included in service level objective responses. format: int64 readOnly: true type: integer creator: - $ref: '#/components/schemas/Creator' + $ref: "#/components/schemas/Creator" description: - description: 'A user-defined description of the service level objective. - + description: |- + A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). - - Optional in create/update requests.' + Optional in create/update requests. nullable: true type: string groups: - description: 'A list of (up to 100) monitor groups that narrow the scope - of a monitor service level objective. - - - Included in service level objective responses if it is not empty. Optional - in + description: |- + A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective. - create/update requests for monitor service level objectives, but may only - be - - used when then length of the `monitor_ids` field is one.' - example: - - env:prod - - role:mysql + Included in service level objective responses if it is not empty. Optional in + create/update requests for monitor service level objectives, but may only be + used when then length of the `monitor_ids` field is one. + example: ["env:prod", "role:mysql"] items: description: A group name, for instance `env:prod`. type: string type: array id: - description: 'A unique identifier for the service level objective object. + description: |- + A unique identifier for the service level objective object. - - Always included in service level objective responses.' + Always included in service level objective responses. readOnly: true type: string modified_at: - description: 'Modification timestamp (UNIX time in seconds) - + description: |- + Modification timestamp (UNIX time in seconds) - Always included in service level objective responses.' + Always included in service level objective responses. format: int64 readOnly: true type: integer monitor_ids: - description: 'A list of monitor ids that defines the scope of a monitor - service level - - objective. **Required if type is `monitor`**.' + description: |- + A list of monitor ids that defines the scope of a monitor service level + objective. **Required if type is `monitor`**. items: description: A monitor ID. format: int64 type: integer type: array monitor_tags: - description: 'The union of monitor tags for all monitors referenced by the - `monitor_ids` - + description: |- + The union of monitor tags for all monitors referenced by the `monitor_ids` field. - - Always included in service level objective responses for monitor-based - service level - - objectives (but may be empty). Ignored in create/update requests. Does - not - - affect which monitors are included in the service level objective (that - is - - determined entirely by the `monitor_ids` field).' + Always included in service level objective responses for monitor-based service level + objectives (but may be empty). Ignored in create/update requests. Does not + affect which monitors are included in the service level objective (that is + determined entirely by the `monitor_ids` field). items: description: A monitor tag. type: string type: array name: description: The name of the service level objective object. - example: Custom Metric SLO + example: "Custom Metric SLO" type: string query: - $ref: '#/components/schemas/ServiceLevelObjectiveQuery' + $ref: "#/components/schemas/ServiceLevelObjectiveQuery" sli_specification: - $ref: '#/components/schemas/SLOSliSpec' + $ref: "#/components/schemas/SLOSliSpec" tags: - description: 'A list of tags associated with this service level objective. - + description: |- + A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). - - Optional in create/update requests.' - example: - - env:prod - - app:core + Optional in create/update requests. + example: ["env:prod", "app:core"] items: description: A tag to apply to your SLO. type: string type: array target_threshold: - description: 'The target threshold such that when the service level indicator - is above this - - threshold over the given timeframe, the objective is being met.' + description: |- + The target threshold such that when the service level indicator is above this + threshold over the given timeframe, the objective is being met. example: 99.9 format: double type: number thresholds: - description: 'The thresholds (timeframes and associated targets) for this - service level - - objective object.' - example: - - target: 95 - timeframe: 7d - - target: 95 - timeframe: 30d - warning: 97 + description: |- + The thresholds (timeframes and associated targets) for this service level + objective object. + example: [{"target": 95, "timeframe": "7d"}, {"target": 95, "timeframe": "30d", "warning": 97}] items: - $ref: '#/components/schemas/SLOThreshold' + $ref: "#/components/schemas/SLOThreshold" type: array timeframe: - $ref: '#/components/schemas/SLOTimeframe' + $ref: "#/components/schemas/SLOTimeframe" type: - $ref: '#/components/schemas/SLOType' + $ref: "#/components/schemas/SLOType" warning_threshold: - description: 'The optional warning threshold such that when the service - level indicator is - - below this value for the given threshold, but above the target threshold, - the - - objective appears in a "warning" state. This value must be greater than - the target - - threshold.' + description: |- + The optional warning threshold such that when the service level indicator is + below this value for the given threshold, but above the target threshold, the + objective appears in a "warning" state. This value must be greater than the target + threshold. example: 99.95 format: double type: number required: - - name - - thresholds - - type + - name + - thresholds + - type type: object ServiceLevelObjectiveQuery: - description: 'A count-based (metric) SLO query. This field is superseded by - `sli_specification` but is retained for backwards compatibility. Note that - Datadog only allows the sum by aggregator - - to be used because this will sum up all request counts instead of averaging - them, or taking the max or - - min of all of those requests.' + description: |- + A count-based (metric) SLO query. This field is superseded by `sli_specification` but is retained for backwards compatibility. Note that Datadog only allows the sum by aggregator + to be used because this will sum up all request counts instead of averaging them, or taking the max or + min of all of those requests. properties: denominator: description: A Datadog metric query for total (valid) events. - example: sum:my.custom.metric{*}.as_count() + example: "sum:my.custom.metric{*}.as_count()" type: string numerator: description: A Datadog metric query for good events. - example: sum:my.custom.metric{type:good}.as_count() + example: "sum:my.custom.metric{type:good}.as_count()" type: string required: - - numerator - - denominator + - numerator + - denominator type: object ServiceLevelObjectiveRequest: - description: 'A service level objective object includes a service level indicator, - thresholds - - for one or more timeframes, and metadata (`name`, `description`, `tags`, etc.).' + description: |- + A service level objective object includes a service level indicator, thresholds + for one or more timeframes, and metadata (`name`, `description`, `tags`, etc.). properties: description: - description: 'A user-defined description of the service level objective. - + description: |- + A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). - - Optional in create/update requests.' + Optional in create/update requests. nullable: true type: string groups: - description: 'A list of (up to 100) monitor groups that narrow the scope - of a monitor service level objective. + description: |- + A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective. - - Included in service level objective responses if it is not empty. Optional - in - - create/update requests for monitor service level objectives, but may only - be - - used when then length of the `monitor_ids` field is one.' - example: - - env:prod - - role:mysql + Included in service level objective responses if it is not empty. Optional in + create/update requests for monitor service level objectives, but may only be + used when then length of the `monitor_ids` field is one. + example: ["env:prod", "role:mysql"] items: description: A group name, for instance `env:prod`. type: string type: array monitor_ids: - description: 'A list of monitor IDs that defines the scope of a monitor - service level - - objective. **Required if type is `monitor`**.' + description: |- + A list of monitor IDs that defines the scope of a monitor service level + objective. **Required if type is `monitor`**. items: description: A monitor ID. format: int64 @@ -14577,84 +13453,66 @@ components: type: array name: description: The name of the service level objective object. - example: Custom Metric SLO + example: "Custom Metric SLO" type: string query: - $ref: '#/components/schemas/ServiceLevelObjectiveQuery' + $ref: "#/components/schemas/ServiceLevelObjectiveQuery" sli_specification: - $ref: '#/components/schemas/SLOSliSpec' + $ref: "#/components/schemas/SLOSliSpec" tags: - description: 'A list of tags associated with this service level objective. - + description: |- + A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). - - Optional in create/update requests.' - example: - - env:prod - - app:core + Optional in create/update requests. + example: ["env:prod", "app:core"] items: description: A tag to apply to your SLO. type: string type: array target_threshold: - description: 'The target threshold such that when the service level indicator - is above this - - threshold over the given timeframe, the objective is being met.' + description: |- + The target threshold such that when the service level indicator is above this + threshold over the given timeframe, the objective is being met. example: 99.9 format: double type: number thresholds: - description: 'The thresholds (timeframes and associated targets) for this - service level - - objective object.' - example: - - target: 95 - timeframe: 7d - - target: 95 - timeframe: 30d - warning: 97 + description: |- + The thresholds (timeframes and associated targets) for this service level + objective object. + example: [{"target": 95, "timeframe": "7d"}, {"target": 95, "timeframe": "30d", "warning": 97}] items: - $ref: '#/components/schemas/SLOThreshold' + $ref: "#/components/schemas/SLOThreshold" type: array timeframe: - $ref: '#/components/schemas/SLOTimeframe' + $ref: "#/components/schemas/SLOTimeframe" type: - $ref: '#/components/schemas/SLOType' + $ref: "#/components/schemas/SLOType" warning_threshold: - description: 'The optional warning threshold such that when the service - level indicator is - - below this value for the given threshold, but above the target threshold, - the - - objective appears in a "warning" state. This value must be greater than - the target - - threshold.' + description: |- + The optional warning threshold such that when the service level indicator is + below this value for the given threshold, but above the target threshold, the + objective appears in a "warning" state. This value must be greater than the target + threshold. example: 99.95 format: double type: number required: - - name - - thresholds - - type + - name + - thresholds + - type type: object ServiceMapWidgetDefinition: - description: This widget displays a map of a service to all of the services - that call it, and all of the services that it calls. + description: This widget displays a map of a service to all of the services that call it, and all of the services that it calls. properties: custom_links: description: List of custom links. items: - $ref: '#/components/schemas/WidgetCustomLink' + $ref: "#/components/schemas/WidgetCustomLink" type: array filters: - description: Your environment and primary tag (or * if enabled for your - account). - example: - - '*' + description: Your environment and primary tag (or * if enabled for your account). + example: ["*"] items: description: Filter name. type: string @@ -14662,45 +13520,44 @@ components: type: array service: description: The ID of the service you want to map. - example: '' + example: "" type: string title: description: The title of your widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/ServiceMapWidgetDefinitionType' + $ref: "#/components/schemas/ServiceMapWidgetDefinitionType" required: - - type - - filters - - service + - type + - filters + - service type: object ServiceMapWidgetDefinitionType: default: servicemap description: Type of the service map widget. enum: - - servicemap + - servicemap example: servicemap type: string x-enum-varnames: - - SERVICEMAP + - SERVICEMAP ServiceSummaryWidgetDefinition: - description: The service summary displays the graphs of a chosen service in - your screenboard. Only available on FREE layout dashboards. + description: The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards. properties: display_format: - $ref: '#/components/schemas/WidgetServiceSummaryDisplayFormat' + $ref: "#/components/schemas/WidgetServiceSummaryDisplayFormat" env: description: APM environment. - example: '' + example: "" type: string service: description: APM service. - example: '' + example: "" type: string show_breakdown: description: Whether to show the latency breakdown or not. @@ -14721,44 +13578,44 @@ components: description: Whether to show the resource list or not. type: boolean size_format: - $ref: '#/components/schemas/WidgetSizeFormat' + $ref: "#/components/schemas/WidgetSizeFormat" span_name: description: APM span name. - example: '' + example: "" type: string time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of the widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/ServiceSummaryWidgetDefinitionType' + $ref: "#/components/schemas/ServiceSummaryWidgetDefinitionType" required: - - type - - env - - service - - span_name + - type + - env + - service + - span_name type: object ServiceSummaryWidgetDefinitionType: default: trace_service description: Type of the service summary widget. enum: - - trace_service + - trace_service example: trace_service type: string x-enum-varnames: - - TRACE_SERVICE + - TRACE_SERVICE SharedDashboard: - description: The metadata object associated with how a dashboard has been/will - be shared. + description: |- + The metadata object associated with how a dashboard has been/will be shared. properties: author: - $ref: '#/components/schemas/SharedDashboardAuthor' + $ref: "#/components/schemas/SharedDashboardAuthor" created: description: Date the dashboard was shared. format: date-time @@ -14766,15 +13623,13 @@ components: type: string dashboard_id: description: ID of the dashboard to share. - example: 123-abc-456 + example: "123-abc-456" type: string dashboard_type: - $ref: '#/components/schemas/DashboardType' + $ref: "#/components/schemas/DashboardType" embeddable_domains: description: The `SharedDashboard` `embeddable_domains`. - example: - - https://domain.atlassian.net/ - - http://myserver.com/ + example: ["https://domain.atlassian.net/", "http://myserver.com/"] items: description: The allowlisted referrers for an EMBED shared dashboard. type: string @@ -14785,25 +13640,19 @@ components: nullable: true type: string global_time: - $ref: '#/components/schemas/DashboardGlobalTime' + $ref: "#/components/schemas/DashboardGlobalTime" global_time_selectable_enabled: - description: Whether to allow viewers to select a different global time - setting for the shared dashboard. + description: Whether to allow viewers to select a different global time setting for the shared dashboard. nullable: true type: boolean invitees: description: The `SharedDashboard` `invitees`. - example: - - access_expiration: '2030-01-01T12:00:00.00Z' - email: test@datadoghq.com - - access_expiration: null - email: test2@datadoghq.com + example: [{"access_expiration": "2030-01-01T12:00:00.00Z", "email": "test@datadoghq.com"}, {"access_expiration": null, "email": "test2@datadoghq.com"}] items: - $ref: '#/components/schemas/SharedDashboardInviteesItems' + $ref: "#/components/schemas/SharedDashboardInviteesItems" type: array last_accessed: - description: The last time the shared dashboard was accessed. Null if never - accessed. + description: The last time the shared dashboard was accessed. Null if never accessed. format: date-time nullable: true readOnly: true @@ -14813,36 +13662,25 @@ components: readOnly: true type: string selectable_template_vars: - description: List of objects representing template variables on the shared - dashboard which can have selectable values. - example: - - default_value: '*' - name: exampleVar - prefix: test - visible_tags: - - selectableValue1 - - selectableValue2 - items: - $ref: '#/components/schemas/SelectableTemplateVariableItems' + description: List of objects representing template variables on the shared dashboard which can have selectable values. + example: [{"default_value": "*", "name": "exampleVar", "prefix": "test", "visible_tags": ["selectableValue1", "selectableValue2"]}] + items: + $ref: "#/components/schemas/SelectableTemplateVariableItems" nullable: true type: array share_list: deprecated: true - description: List of email addresses that can receive an invitation to access - to the shared dashboard. - example: - - test@datadoghq.com - - test2@email.com + description: List of email addresses that can receive an invitation to access to the shared dashboard. + example: ["test@datadoghq.com", "test2@email.com"] items: - description: Email address that can receive an invitation to access the - shared dashboard. + description: Email address that can receive an invitation to access the shared dashboard. type: string nullable: true type: array share_type: - $ref: '#/components/schemas/DashboardShareType' + $ref: "#/components/schemas/DashboardShareType" status: - $ref: '#/components/schemas/SharedDashboardStatus' + $ref: "#/components/schemas/SharedDashboardStatus" title: description: Title of the shared dashboard. type: string @@ -14851,10 +13689,10 @@ components: readOnly: true type: string viewing_preferences: - $ref: '#/components/schemas/ViewingPreferences' + $ref: "#/components/schemas/ViewingPreferences" required: - - dashboard_id - - dashboard_type + - dashboard_id + - dashboard_type type: object SharedDashboardAuthor: description: User who shared the dashboard. @@ -14875,8 +13713,7 @@ components: description: The allowlisted invitees for an INVITE-only shared dashboard. properties: access_expiration: - description: Time of the invitee expiration. Null means the invite will - not expire. + description: Time of the invitee expiration. Null means the invite will not expire. format: date-time nullable: true type: string @@ -14887,77 +13724,49 @@ components: type: string email: description: Email of the invitee. - example: test@datadoghq.com + example: "test@datadoghq.com" type: string required: - - email + - email type: object SharedDashboardInvites: - description: Invitations data and metadata that exists for a shared dashboard - returned by the API. - example: - data: - - attributes: - email: test@datadoghq.com - type: public_dashboard_invitation + description: Invitations data and metadata that exists for a shared dashboard returned by the API. + example: {"data": [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}]} properties: data: - $ref: '#/components/schemas/SharedDashboardInvitesData' + $ref: "#/components/schemas/SharedDashboardInvitesData" meta: - $ref: '#/components/schemas/SharedDashboardInvitesMeta' + $ref: "#/components/schemas/SharedDashboardInvitesMeta" required: - - data + - data type: object SharedDashboardInvitesData: - description: An object or list of objects containing the information for an - invitation to a shared dashboard. - example: - - attributes: - email: test@datadoghq.com - type: public_dashboard_invitation + description: An object or list of objects containing the information for an invitation to a shared dashboard. + example: [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}] oneOf: - - $ref: '#/components/schemas/SharedDashboardInvitesDataObject' - - $ref: '#/components/schemas/SharedDashboardInvitesDataList' + - $ref: "#/components/schemas/SharedDashboardInvitesDataObject" + - $ref: "#/components/schemas/SharedDashboardInvitesDataList" SharedDashboardInvitesDataList: - description: A list of objects containing the information for an invitation(s) - to a shared dashboard. - example: - - attributes: - email: test@datadoghq.com - type: public_dashboard_invitation + description: A list of objects containing the information for an invitation(s) to a shared dashboard. + example: [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}] items: - $ref: '#/components/schemas/SharedDashboardInvitesDataObject' + $ref: "#/components/schemas/SharedDashboardInvitesDataObject" type: array SharedDashboardInvitesDataObject: - description: Object containing the information for an invitation to a shared - dashboard. - example: - attributes: - created_at: '2020-12-07T20:16:27.846985+00:00' - email: test@datadoghq.com - has_session: false - invitation_expiry: '2020-12-07T21:16:27.840542+00:00' - session_expiry: null - share_token: XXXXXX-123456abcedfg7890hijklmnopqrstuv - type: public_dashboard_invitation + description: Object containing the information for an invitation to a shared dashboard. + example: {"attributes": {"created_at": "2020-12-07T20:16:27.846985+00:00", "email": "test@datadoghq.com", "has_session": false, "invitation_expiry": "2020-12-07T21:16:27.840542+00:00", "session_expiry": null, "share_token": "XXXXXX-123456abcedfg7890hijklmnopqrstuv"}, "type": "public_dashboard_invitation"} properties: attributes: - $ref: '#/components/schemas/SharedDashboardInvitesDataObjectAttributes' + $ref: "#/components/schemas/SharedDashboardInvitesDataObjectAttributes" type: - $ref: '#/components/schemas/DashboardInviteType' + $ref: "#/components/schemas/DashboardInviteType" required: - - type - - attributes + - type + - attributes type: object SharedDashboardInvitesDataObjectAttributes: description: Attributes of the shared dashboard invitation - example: - created_at: '2020-12-07T20:16:27.846985+00:00' - email: test@datadoghq.com - has_session: false - invitation_expiry: '2020-12-07T21:16:27.840542+00:00' - session_expiry: null - share_token: XXXXXX-123456abcedfg7890hijklmnopqrstuv + example: {"created_at": "2020-12-07T20:16:27.846985+00:00", "email": "test@datadoghq.com", "has_session": false, "invitation_expiry": "2020-12-07T21:16:27.840542+00:00", "session_expiry": null, "share_token": "XXXXXX-123456abcedfg7890hijklmnopqrstuv"} properties: created_at: description: When the invitation was sent. @@ -14965,13 +13774,11 @@ components: readOnly: true type: string email: - description: An email address that an invitation has been (or if used in - invitation request, will be) sent to. + description: An email address that an invitation has been (or if used in invitation request, will be) sent to. nullable: false type: string has_session: - description: Indicates whether an active session exists for the invitation - (produced when a user clicks the link in the email). + description: Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email). readOnly: true type: boolean invitation_expiry: @@ -14980,15 +13787,13 @@ components: readOnly: true type: string session_expiry: - description: When the invited user's session expires. null if the invitation - has no associated session. + description: When the invited user's session expires. null if the invitation has no associated session. format: date-time nullable: true readOnly: true type: string share_token: - description: The unique token of the shared dashboard that was (or is to - be) shared. + description: The unique token of the shared dashboard that was (or is to be) shared. readOnly: true type: string type: object @@ -14996,44 +13801,35 @@ components: description: Pagination metadata returned by the API. properties: page: - $ref: '#/components/schemas/SharedDashboardInvitesMetaPage' + $ref: "#/components/schemas/SharedDashboardInvitesMetaPage" readOnly: true type: object SharedDashboardInvitesMetaPage: description: Object containing the total count of invitations across all pages properties: total_count: - description: The total number of invitations on this shared board, across - all pages. + description: The total number of invitations on this shared board, across all pages. format: int64 type: integer type: object SharedDashboardStatus: - description: Active means the dashboard is publicly available. Paused means - the dashboard is not publicly available. + description: Active means the dashboard is publicly available. Paused means the dashboard is not publicly available. enum: - - active - - paused - example: active + - active + - paused + example: "active" type: string x-enum-varnames: - - ACTIVE - - PAUSED + - ACTIVE + - PAUSED SharedDashboardUpdateRequest: - description: Update a shared dashboard's settings. - example: - global_time: - live_span: 1h - share_list: - - test@datadoghq.com - - test2@datadoghq.com - share_type: invite + description: |- + Update a shared dashboard's settings. + example: {"global_time": {"live_span": "1h"}, "share_list": ["test@datadoghq.com", "test2@datadoghq.com"], "share_type": "invite"} properties: embeddable_domains: description: The `SharedDashboard` `embeddable_domains`. - example: - - https://domain.atlassian.net/ - - http://myserver.com/ + example: ["https://domain.atlassian.net/", "http://myserver.com/"] items: description: The allowlisted referrers for an EMBED shared dashboard. type: string @@ -15044,100 +13840,81 @@ components: nullable: true type: string global_time: - $ref: '#/components/schemas/SharedDashboardUpdateRequestGlobalTime' + $ref: "#/components/schemas/SharedDashboardUpdateRequestGlobalTime" global_time_selectable_enabled: - description: Whether to allow viewers to select a different global time - setting for the shared dashboard. + description: Whether to allow viewers to select a different global time setting for the shared dashboard. nullable: true type: boolean invitees: description: The `SharedDashboard` `invitees`. - example: - - access_expiration: '2030-01-01T12:00:00.00Z' - email: test@datadoghq.com - - access_expiration: null - email: test2@datadoghq.com + example: [{"access_expiration": "2030-01-01T12:00:00.00Z", "email": "test@datadoghq.com"}, {"access_expiration": null, "email": "test2@datadoghq.com"}] items: - $ref: '#/components/schemas/SharedDashboardInviteesItems' + $ref: "#/components/schemas/SharedDashboardInviteesItems" type: array selectable_template_vars: - description: List of objects representing template variables on the shared - dashboard which can have selectable values. - example: - - default_value: '*' - name: exampleVar - prefix: test - visible_tags: - - selectableValue1 - - selectableValue2 - items: - $ref: '#/components/schemas/SelectableTemplateVariableItems' + description: List of objects representing template variables on the shared dashboard which can have selectable values. + example: [{"default_value": "*", "name": "exampleVar", "prefix": "test", "visible_tags": ["selectableValue1", "selectableValue2"]}] + items: + $ref: "#/components/schemas/SelectableTemplateVariableItems" nullable: true type: array share_list: deprecated: true - description: List of email addresses that can be given access to the shared - dashboard. - example: - - test@datadoghq.com - - test2@email.com + description: List of email addresses that can be given access to the shared dashboard. + example: ["test@datadoghq.com", "test2@email.com"] items: - description: Email address that can receive an invitation to access the - shared dashboard. + description: Email address that can receive an invitation to access the shared dashboard. type: string nullable: true type: array share_type: - $ref: '#/components/schemas/DashboardShareType' + $ref: "#/components/schemas/DashboardShareType" status: - $ref: '#/components/schemas/SharedDashboardStatus' + $ref: "#/components/schemas/SharedDashboardStatus" title: description: Title of the shared dashboard. type: string viewing_preferences: - $ref: '#/components/schemas/ViewingPreferences' + $ref: "#/components/schemas/ViewingPreferences" type: object SharedDashboardUpdateRequestGlobalTime: description: Timeframe setting for the shared dashboard. - example: - live_span: 1h + example: {"live_span": "1h"} nullable: true properties: live_span: - $ref: '#/components/schemas/DashboardGlobalTimeLiveSpan' + $ref: "#/components/schemas/DashboardGlobalTimeLiveSpan" type: object SignalArchiveReason: description: Reason why a signal has been archived. enum: - - none - - false_positive - - testing_or_maintenance - - investigated_case_opened - - true_positive_benign - - true_positive_malicious - - other - type: string - x-enum-varnames: - - NONE - - FALSE_POSITIVE - - TESTING_OR_MAINTENANCE - - INVESTIGATED_CASE_OPENED - - TRUE_POSITIVE_BENIGN - - TRUE_POSITIVE_MALICIOUS - - OTHER + - none + - false_positive + - testing_or_maintenance + - investigated_case_opened + - true_positive_benign + - true_positive_malicious + - other + type: string + x-enum-varnames: + - NONE + - FALSE_POSITIVE + - TESTING_OR_MAINTENANCE + - INVESTIGATED_CASE_OPENED + - TRUE_POSITIVE_BENIGN + - TRUE_POSITIVE_MALICIOUS + - OTHER SignalAssigneeUpdateRequest: - description: Attributes describing an assignee update operation over a security - signal. + description: Attributes describing an assignee update operation over a security signal. properties: assignee: - description: The UUID of the user being assigned. Use empty string to return - signal to unassigned. + description: The UUID of the user being assigned. Use empty string to return signal to unassigned. example: 773b045d-ccf8-4808-bd3b-955ef6a8c940 type: string version: - $ref: '#/components/schemas/Version' + $ref: "#/components/schemas/Version" required: - - assignee + - assignee type: object SignalStateUpdateRequest: description: Attributes describing the change of state for a given state. @@ -15146,34 +13923,34 @@ components: description: Optional comment to explain why a signal is being archived. type: string archiveReason: - $ref: '#/components/schemas/SignalArchiveReason' + $ref: "#/components/schemas/SignalArchiveReason" state: - $ref: '#/components/schemas/SignalTriageState' + $ref: "#/components/schemas/SignalTriageState" version: - $ref: '#/components/schemas/Version' + $ref: "#/components/schemas/Version" required: - - state + - state type: object SignalTriageState: description: The new triage state of the signal. enum: - - open - - archived - - under_review - example: open + - open + - archived + - under_review + example: "open" type: string x-enum-varnames: - - OPEN - - ARCHIVED - - UNDER_REVIEW + - OPEN + - ARCHIVED + - UNDER_REVIEW SlackIntegrationChannel: description: The Slack channel configuration. properties: display: - $ref: '#/components/schemas/SlackIntegrationChannelDisplay' + $ref: "#/components/schemas/SlackIntegrationChannelDisplay" name: description: Your channel name. - example: '#general' + example: "#general" type: string type: object SlackIntegrationChannelDisplay: @@ -15202,23 +13979,9 @@ components: type: object SlackIntegrationChannels: description: A list of configured Slack channels. - example: - - display: - message: true - mute_buttons: true - notified: true - snapshot: true - tags: true - name: '#channel_name_main_account' - - display: - message: true - mute_buttons: true - notified: true - snapshot: false - tags: true - name: '#channel_name_doghouse' + example: [{"display": {"message": true, "mute_buttons": true, "notified": true, "snapshot": true, "tags": true}, "name": "#channel_name_main_account"}, {"display": {"message": true, "mute_buttons": true, "notified": true, "snapshot": false, "tags": true}, "name": "#channel_name_doghouse"}] items: - $ref: '#/components/schemas/SlackIntegrationChannel' + $ref: "#/components/schemas/SlackIntegrationChannel" type: array SplitConfig: description: Encapsulates all user choices about how to split a graph. @@ -15231,159 +13994,151 @@ components: minimum: 1 type: integer sort: - $ref: '#/components/schemas/SplitSort' + $ref: "#/components/schemas/SplitSort" split_dimensions: description: The dimension(s) on which to split the graph example: - - one_graph_per: service + - {"one_graph_per": "service"} items: - $ref: '#/components/schemas/SplitDimension' + $ref: "#/components/schemas/SplitDimension" maxItems: 1 minItems: 1 type: array static_splits: description: Manual selection of tags making split graph widget static items: - $ref: '#/components/schemas/SplitVectorEntry' + $ref: "#/components/schemas/SplitVectorEntry" maxItems: 500 type: array required: - - split_dimensions - - limit - - sort + - split_dimensions + - limit + - sort type: object SplitConfigSortCompute: description: Defines the metric and aggregation used as the sort value. properties: aggregation: description: How to aggregate the sort metric for the purposes of ordering. - example: sum + example: "sum" type: string metric: description: The metric to use for sorting graphs. - example: system.cpu.user + example: "system.cpu.user" type: string required: - - aggregation - - metric + - aggregation + - metric type: object SplitDimension: description: The property by which the graph splits - example: - one_graph_per: service + example: {"one_graph_per": "service"} properties: one_graph_per: - description: The system interprets this attribute differently depending - on the data source of the query being split. For metrics, it's a tag. - For the events platform, it's an attribute or tag. - example: service + description: The system interprets this attribute differently depending on the data source of the query being split. For metrics, it's a tag. For the events platform, it's an attribute or tag. + example: "service" type: string required: - - one_graph_per + - one_graph_per type: object SplitGraphSourceWidgetDefinition: description: The original widget we are splitting on. oneOf: - - $ref: '#/components/schemas/BarChartWidgetDefinition' - - $ref: '#/components/schemas/ChangeWidgetDefinition' - - $ref: '#/components/schemas/GeomapWidgetDefinition' - - $ref: '#/components/schemas/QueryValueWidgetDefinition' - - $ref: '#/components/schemas/ScatterPlotWidgetDefinition' - - $ref: '#/components/schemas/SunburstWidgetDefinition' - - $ref: '#/components/schemas/TableWidgetDefinition' - - $ref: '#/components/schemas/TimeseriesWidgetDefinition' - - $ref: '#/components/schemas/ToplistWidgetDefinition' - - $ref: '#/components/schemas/TreeMapWidgetDefinition' + - $ref: "#/components/schemas/BarChartWidgetDefinition" + - $ref: "#/components/schemas/ChangeWidgetDefinition" + - $ref: "#/components/schemas/GeomapWidgetDefinition" + - $ref: "#/components/schemas/QueryValueWidgetDefinition" + - $ref: "#/components/schemas/ScatterPlotWidgetDefinition" + - $ref: "#/components/schemas/SunburstWidgetDefinition" + - $ref: "#/components/schemas/TableWidgetDefinition" + - $ref: "#/components/schemas/TimeseriesWidgetDefinition" + - $ref: "#/components/schemas/ToplistWidgetDefinition" + - $ref: "#/components/schemas/TreeMapWidgetDefinition" SplitGraphVizSize: description: Size of the individual graphs in the split. enum: - - xs - - sm - - md - - lg + - xs + - sm + - md + - lg example: sm type: string x-enum-varnames: - - XS - - SM - - MD - - LG + - XS + - SM + - MD + - LG SplitGraphWidgetDefinition: - description: 'The split graph widget allows you to create repeating units of - a graph - one for each value in a group (for example: one per service)' + description: |- + The split graph widget allows you to create repeating units of a graph - one for each value in a group (for example: one per service) properties: has_uniform_y_axes: description: Normalize y axes across graphs type: boolean size: - $ref: '#/components/schemas/SplitGraphVizSize' + $ref: "#/components/schemas/SplitGraphVizSize" source_widget_definition: - $ref: '#/components/schemas/SplitGraphSourceWidgetDefinition' + $ref: "#/components/schemas/SplitGraphSourceWidgetDefinition" split_config: - $ref: '#/components/schemas/SplitConfig' + $ref: "#/components/schemas/SplitConfig" time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string type: - $ref: '#/components/schemas/SplitGraphWidgetDefinitionType' + $ref: "#/components/schemas/SplitGraphWidgetDefinitionType" required: - - size - - type - - source_widget_definition - - split_config + - size + - type + - source_widget_definition + - split_config type: object SplitGraphWidgetDefinitionType: default: split_group description: Type of the split graph widget enum: - - split_group + - split_group example: split_group type: string x-enum-varnames: - - SPLIT_GROUP + - SPLIT_GROUP SplitSort: description: Controls the order in which graphs appear in the split. properties: compute: - $ref: '#/components/schemas/SplitConfigSortCompute' + $ref: "#/components/schemas/SplitConfigSortCompute" order: - $ref: '#/components/schemas/WidgetSort' + $ref: "#/components/schemas/WidgetSort" required: - - order + - order type: object SplitVectorEntry: description: The widget displays one graph for each entry in this parameter. - example: - - tag_key: demo - tag_values: - - env + example: [{"tag_key": "demo", "tag_values": ["env"]}] items: - $ref: '#/components/schemas/SplitVectorEntryItem' + $ref: "#/components/schemas/SplitVectorEntryItem" minItems: 1 type: array SplitVectorEntryItem: - description: The split graph list contains a graph for each value of the split - dimension. + description: The split graph list contains a graph for each value of the split dimension. minLength: 1 properties: tag_key: description: The tag key. - example: demo + example: "demo" minLength: 1 type: string tag_values: description: The tag values. - example: - - env + example: ["env"] items: minLength: 1 type: string type: array required: - - tag_key - - tag_values + - tag_key + - tag_values type: object SuccessfulSignalUpdateResponse: description: Updated signal data following a successfully performed update. @@ -15393,57 +14148,55 @@ components: type: string type: object SunburstWidgetDefinition: - description: Sunbursts are spot on to highlight how groups contribute to the - total of a query. + description: Sunbursts are spot on to highlight how groups contribute to the total of a query. properties: custom_links: description: List of custom links. items: - $ref: '#/components/schemas/WidgetCustomLink' + $ref: "#/components/schemas/WidgetCustomLink" type: array hide_total: description: Show the total value in this widget. type: boolean legend: - $ref: '#/components/schemas/SunburstWidgetLegend' + $ref: "#/components/schemas/SunburstWidgetLegend" requests: description: List of sunburst widget requests. - example: - - q/apm_query/log_query: {} + example: ["q/apm_query/log_query": "{}"] items: - $ref: '#/components/schemas/SunburstWidgetRequest' + $ref: "#/components/schemas/SunburstWidgetRequest" minItems: 1 type: array time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/SunburstWidgetDefinitionType' + $ref: "#/components/schemas/SunburstWidgetDefinitionType" required: - - type - - requests + - type + - requests type: object SunburstWidgetDefinitionType: default: sunburst description: Type of the Sunburst widget. enum: - - sunburst + - sunburst example: sunburst type: string x-enum-varnames: - - SUNBURST + - SUNBURST SunburstWidgetLegend: description: Configuration of the legend. oneOf: - - $ref: '#/components/schemas/SunburstWidgetLegendTable' - - $ref: '#/components/schemas/SunburstWidgetLegendInlineAutomatic' + - $ref: "#/components/schemas/SunburstWidgetLegendTable" + - $ref: "#/components/schemas/SunburstWidgetLegendInlineAutomatic" SunburstWidgetLegendInlineAutomatic: description: Configuration of inline or automatic legends. properties: @@ -15454,72 +14207,72 @@ components: description: Whether to hide the values of the groups. type: boolean type: - $ref: '#/components/schemas/SunburstWidgetLegendInlineAutomaticType' + $ref: "#/components/schemas/SunburstWidgetLegendInlineAutomaticType" required: - - type + - type type: object SunburstWidgetLegendInlineAutomaticType: description: Whether to show the legend inline or let it be automatically generated. enum: - - inline - - automatic - example: automatic + - inline + - automatic + example: "automatic" type: string x-enum-varnames: - - INLINE - - AUTOMATIC + - INLINE + - AUTOMATIC SunburstWidgetLegendTable: description: Configuration of table-based legend. properties: type: - $ref: '#/components/schemas/SunburstWidgetLegendTableType' + $ref: "#/components/schemas/SunburstWidgetLegendTableType" required: - - type + - type type: object SunburstWidgetLegendTableType: description: Whether or not to show a table legend. enum: - - table - - none - example: table + - table + - none + example: "table" type: string x-enum-varnames: - - TABLE - - NONE + - TABLE + - NONE SunburstWidgetRequest: description: Request definition of sunburst widget. properties: apm_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. audit_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. event_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: - $ref: '#/components/schemas/WidgetFormula' + $ref: "#/components/schemas/WidgetFormula" type: array log_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. process_query: - $ref: '#/components/schemas/ProcessQueryDefinition' + $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: @@ -15529,37 +14282,35 @@ components: queries: description: List of queries that can be returned directly or used in formulas. items: - $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition' + $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: - $ref: '#/components/schemas/FormulaAndFunctionResponseFormat' + $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" rum_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. style: - $ref: '#/components/schemas/WidgetStyle' + $ref: "#/components/schemas/WidgetStyle" type: object SyntheticsAPIStep: description: The steps used in a Synthetic multi-step API test. oneOf: - - $ref: '#/components/schemas/SyntheticsAPITestStep' - - $ref: '#/components/schemas/SyntheticsAPIWaitStep' - - $ref: '#/components/schemas/SyntheticsAPISubtestStep' + - $ref: "#/components/schemas/SyntheticsAPITestStep" + - $ref: "#/components/schemas/SyntheticsAPIWaitStep" + - $ref: "#/components/schemas/SyntheticsAPISubtestStep" SyntheticsAPISubtestStep: description: The subtest step used in a Synthetics multi-step API test. properties: allowFailure: - description: Determines whether or not to continue with test if this step - fails. + description: Determines whether or not to continue with test if this step fails. type: boolean alwaysExecute: - description: A boolean set to always execute this step even if the previous - step failed or was skipped. + description: A boolean set to always execute this step even if the previous step failed or was skipped. type: boolean exitIfSucceed: description: Determines whether or not to exit the test if the step succeeds. @@ -15569,50 +14320,47 @@ components: type: string id: description: ID of the step. - example: abc-def-123 + example: "abc-def-123" readOnly: true type: string isCritical: - description: 'Determines whether or not to consider the entire test as failed - if this step fails. - - Can be used only if `allowFailure` is `true`.' + description: |- + Determines whether or not to consider the entire test as failed if this step fails. + Can be used only if `allowFailure` is `true`. type: boolean name: description: The name of the step. - example: Example step name + example: "Example step name" type: string retry: - $ref: '#/components/schemas/SyntheticsTestOptionsRetry' + $ref: "#/components/schemas/SyntheticsTestOptionsRetry" subtestPublicId: - description: Public ID of the test to be played as part of a `playSubTest` - step type. - example: '' + description: Public ID of the test to be played as part of a `playSubTest` step type. + example: "" type: string subtype: - $ref: '#/components/schemas/SyntheticsAPISubtestStepSubtype' + $ref: "#/components/schemas/SyntheticsAPISubtestStepSubtype" required: - - name - - subtype - - subtestPublicId + - name + - subtype + - subtestPublicId type: object SyntheticsAPISubtestStepSubtype: description: The subtype of the Synthetic multi-step API subtest step. enum: - - playSubTest + - playSubTest example: playSubTest type: string x-enum-varnames: - - PLAY_SUB_TEST + - PLAY_SUB_TEST SyntheticsAPITest: description: Object containing details about a Synthetic API test. properties: config: - $ref: '#/components/schemas/SyntheticsAPITestConfig' + $ref: "#/components/schemas/SyntheticsAPITestConfig" locations: description: Array of locations used to run the test. - example: - - aws:eu-west-3 + example: ["aws:eu-west-3"] items: description: A location from which the test was run. type: string @@ -15629,85 +14377,73 @@ components: type: integer name: description: Name of the test. - example: Example test name + example: "Example test name" type: string options: - $ref: '#/components/schemas/SyntheticsTestOptions' + $ref: "#/components/schemas/SyntheticsTestOptions" public_id: description: The public ID for the test. example: 123-abc-456 readOnly: true type: string status: - $ref: '#/components/schemas/SyntheticsTestPauseStatus' + $ref: "#/components/schemas/SyntheticsTestPauseStatus" subtype: - $ref: '#/components/schemas/SyntheticsTestDetailsSubType' + $ref: "#/components/schemas/SyntheticsTestDetailsSubType" tags: description: Array of tags attached to the test. - example: - - env:production + example: ["env:production"] items: description: A tag attached to the test. type: string type: array type: - $ref: '#/components/schemas/SyntheticsAPITestType' + $ref: "#/components/schemas/SyntheticsAPITestType" required: - - name - - config - - locations - - options - - type - - message + - name + - config + - locations + - options + - type + - message type: object SyntheticsAPITestConfig: description: Configuration object for a Synthetic API test. - example: - assertions: - - operator: lessThan - target: 1000 - type: responseTime - request: - method: GET - url: https://example.com + example: {"assertions": [{"operator": "lessThan", "target": 1000, "type": "responseTime"}], "request": {"method": "GET", "url": "https://example.com"}} properties: assertions: default: [] - description: Array of assertions used for the test. Required for single - API tests. - example: - - operator: lessThan - target: 1000 - type: responseTime + description: Array of assertions used for the test. Required for single API tests. + example: [{"operator": "lessThan", "target": 1000, "type": "responseTime"}] items: - $ref: '#/components/schemas/SyntheticsAssertion' + $ref: "#/components/schemas/SyntheticsAssertion" type: array configVariables: description: Array of variables used for the test. items: - $ref: '#/components/schemas/SyntheticsConfigVariable' + $ref: "#/components/schemas/SyntheticsConfigVariable" type: array request: - $ref: '#/components/schemas/SyntheticsTestRequest' + $ref: "#/components/schemas/SyntheticsTestRequest" steps: description: When the test subtype is `multi`, the steps of the test. items: - $ref: '#/components/schemas/SyntheticsAPIStep' + $ref: "#/components/schemas/SyntheticsAPIStep" type: array variablesFromScript: description: Variables defined from JavaScript code. - example: dd.variable.set("FOO", "foo") + example: 'dd.variable.set("FOO", "foo")' type: string type: object SyntheticsAPITestResultData: description: Object containing results for your Synthetic API test. properties: cert: - $ref: '#/components/schemas/SyntheticsSSLCertificate' + $ref: "#/components/schemas/SyntheticsSSLCertificate" eventType: - $ref: '#/components/schemas/SyntheticsTestProcessStatus' + $ref: "#/components/schemas/SyntheticsTestProcessStatus" failure: - $ref: '#/components/schemas/SyntheticsApiTestResultFailure' + $ref: "#/components/schemas/SyntheticsApiTestResultFailure" httpStatusCode: description: The API test HTTP status code. format: int64 @@ -15731,13 +14467,13 @@ components: format: int64 type: integer timings: - $ref: '#/components/schemas/SyntheticsTiming' + $ref: "#/components/schemas/SyntheticsTiming" type: object SyntheticsAPITestResultFull: description: Object returned describing a API test result. properties: check: - $ref: '#/components/schemas/SyntheticsAPITestResultFullCheck' + $ref: "#/components/schemas/SyntheticsAPITestResultFullCheck" check_time: description: When the API test was conducted. format: double @@ -15750,20 +14486,20 @@ components: description: Locations for which to query the API test results. type: string result: - $ref: '#/components/schemas/SyntheticsAPITestResultData' + $ref: "#/components/schemas/SyntheticsAPITestResultData" result_id: description: ID of the API test result. type: string status: - $ref: '#/components/schemas/SyntheticsTestMonitorStatus' + $ref: "#/components/schemas/SyntheticsTestMonitorStatus" type: object SyntheticsAPITestResultFullCheck: description: Object describing the API test configuration. properties: config: - $ref: '#/components/schemas/SyntheticsTestConfig' + $ref: "#/components/schemas/SyntheticsTestConfig" required: - - config + - config type: object SyntheticsAPITestResultShort: description: Object with the results of a single Synthetic API test. @@ -15776,12 +14512,12 @@ components: description: Location from which the API test was performed. type: string result: - $ref: '#/components/schemas/SyntheticsAPITestResultShortResult' + $ref: "#/components/schemas/SyntheticsAPITestResultShortResult" result_id: description: ID of the API test result. type: string status: - $ref: '#/components/schemas/SyntheticsTestMonitorStatus' + $ref: "#/components/schemas/SyntheticsTestMonitorStatus" type: object SyntheticsAPITestResultShortResult: description: Result of the last API test run. @@ -15790,24 +14526,20 @@ components: description: Describes if the test run has passed or failed. type: boolean timings: - $ref: '#/components/schemas/SyntheticsTiming' + $ref: "#/components/schemas/SyntheticsTiming" type: object SyntheticsAPITestStep: description: The Test step used in a Synthetic multi-step API test. properties: allowFailure: - description: Determines whether or not to continue with test if this step - fails. + description: Determines whether or not to continue with test if this step fails. type: boolean assertions: default: [] description: Array of assertions used for the test. - example: - - operator: lessThan - target: 1000 - type: responseTime + example: [{"operator": "lessThan", "target": 1000, "type": "responseTime"}] items: - $ref: '#/components/schemas/SyntheticsAssertion' + $ref: "#/components/schemas/SyntheticsAssertion" type: array exitIfSucceed: description: Determines whether or not to exit the test if the step succeeds. @@ -15815,249 +14547,246 @@ components: extractedValues: description: Array of values to parse and save as variables from the response. items: - $ref: '#/components/schemas/SyntheticsParsingOptions' + $ref: "#/components/schemas/SyntheticsParsingOptions" type: array extractedValuesFromScript: description: Generate variables using JavaScript. type: string id: description: ID of the step. - example: abc-def-123 + example: "abc-def-123" readOnly: true type: string isCritical: - description: 'Determines whether or not to consider the entire test as failed - if this step fails. - - Can be used only if `allowFailure` is `true`.' + description: |- + Determines whether or not to consider the entire test as failed if this step fails. + Can be used only if `allowFailure` is `true`. type: boolean name: description: The name of the step. - example: Example step name + example: "Example step name" type: string request: - $ref: '#/components/schemas/SyntheticsTestRequest' + $ref: "#/components/schemas/SyntheticsTestRequest" retry: - $ref: '#/components/schemas/SyntheticsTestOptionsRetry' + $ref: "#/components/schemas/SyntheticsTestOptionsRetry" subtype: - $ref: '#/components/schemas/SyntheticsAPITestStepSubtype' + $ref: "#/components/schemas/SyntheticsAPITestStepSubtype" required: - - assertions - - request - - name - - subtype + - assertions + - request + - name + - subtype type: object SyntheticsAPITestStepSubtype: - description: The subtype of the Synthetic multi-step API test step. - enum: - - http - - grpc - - ssl - - dns - - tcp - - udp - - icmp - - websocket + description: |- + The subtype of the Synthetic multi-step API test step. + enum: + - http + - grpc + - ssl + - dns + - tcp + - udp + - icmp + - websocket example: http type: string x-enum-varnames: - - HTTP - - GRPC - - SSL - - DNS - - TCP - - UDP - - ICMP - - WEBSOCKET + - HTTP + - GRPC + - SSL + - DNS + - TCP + - UDP + - ICMP + - WEBSOCKET SyntheticsAPITestType: - default: api + default: "api" description: Type of the Synthetic test, `api`. enum: - - api + - api example: api type: string x-enum-varnames: - - API + - API SyntheticsAPIWaitStep: description: The Wait step used in a Synthetic multi-step API test. properties: id: description: ID of the step. - example: abc-def-123 + example: "abc-def-123" readOnly: true type: string name: description: The name of the step. - example: Example step name + example: "Example step name" type: string subtype: - $ref: '#/components/schemas/SyntheticsAPIWaitStepSubtype' + $ref: "#/components/schemas/SyntheticsAPIWaitStepSubtype" value: - description: 'The time to wait in seconds. Minimum value: 0. Maximum value: - 180.' + description: "The time to wait in seconds. Minimum value: 0. Maximum value: 180." example: 5 format: int32 maximum: 180 minimum: 0 type: integer required: - - name - - subtype - - value + - name + - subtype + - value type: object SyntheticsAPIWaitStepSubtype: - description: The subtype of the Synthetic multi-step API wait step. + description: |- + The subtype of the Synthetic multi-step API wait step. enum: - - wait + - wait example: wait type: string x-enum-varnames: - - WAIT + - WAIT SyntheticsApiTestFailureCode: description: Error code that can be returned by a Synthetic test. enum: - - BODY_TOO_LARGE - - DENIED - - TOO_MANY_REDIRECTS - - AUTHENTICATION_ERROR - - DECRYPTION - - INVALID_CHAR_IN_HEADER - - HEADER_TOO_LARGE - - HEADERS_INCOMPATIBLE_CONTENT_LENGTH - - INVALID_REQUEST - - REQUIRES_UPDATE - - UNESCAPED_CHARACTERS_IN_REQUEST_PATH - - MALFORMED_RESPONSE - - INCORRECT_ASSERTION - - CONNREFUSED - - CONNRESET - - DNS - - HOSTUNREACH - - NETUNREACH - - TIMEOUT - - SSL - - OCSP - - INVALID_TEST - - TUNNEL - - WEBSOCKET - - UNKNOWN - - INTERNAL_ERROR - type: string - x-enum-varnames: - - BODY_TOO_LARGE - - DENIED - - TOO_MANY_REDIRECTS - - AUTHENTICATION_ERROR - - DECRYPTION - - INVALID_CHAR_IN_HEADER - - HEADER_TOO_LARGE - - HEADERS_INCOMPATIBLE_CONTENT_LENGTH - - INVALID_REQUEST - - REQUIRES_UPDATE - - UNESCAPED_CHARACTERS_IN_REQUEST_PATH - - MALFORMED_RESPONSE - - INCORRECT_ASSERTION - - CONNREFUSED - - CONNRESET - - DNS - - HOSTUNREACH - - NETUNREACH - - TIMEOUT - - SSL - - OCSP - - INVALID_TEST - - TUNNEL - - WEBSOCKET - - UNKNOWN - - INTERNAL_ERROR + - BODY_TOO_LARGE + - DENIED + - TOO_MANY_REDIRECTS + - AUTHENTICATION_ERROR + - DECRYPTION + - INVALID_CHAR_IN_HEADER + - HEADER_TOO_LARGE + - HEADERS_INCOMPATIBLE_CONTENT_LENGTH + - INVALID_REQUEST + - REQUIRES_UPDATE + - UNESCAPED_CHARACTERS_IN_REQUEST_PATH + - MALFORMED_RESPONSE + - INCORRECT_ASSERTION + - CONNREFUSED + - CONNRESET + - DNS + - HOSTUNREACH + - NETUNREACH + - TIMEOUT + - SSL + - OCSP + - INVALID_TEST + - TUNNEL + - WEBSOCKET + - UNKNOWN + - INTERNAL_ERROR + type: string + x-enum-varnames: + - BODY_TOO_LARGE + - DENIED + - TOO_MANY_REDIRECTS + - AUTHENTICATION_ERROR + - DECRYPTION + - INVALID_CHAR_IN_HEADER + - HEADER_TOO_LARGE + - HEADERS_INCOMPATIBLE_CONTENT_LENGTH + - INVALID_REQUEST + - REQUIRES_UPDATE + - UNESCAPED_CHARACTERS_IN_REQUEST_PATH + - MALFORMED_RESPONSE + - INCORRECT_ASSERTION + - CONNREFUSED + - CONNRESET + - DNS + - HOSTUNREACH + - NETUNREACH + - TIMEOUT + - SSL + - OCSP + - INVALID_TEST + - TUNNEL + - WEBSOCKET + - UNKNOWN + - INTERNAL_ERROR SyntheticsApiTestResultFailure: description: The API test failure details. properties: code: - $ref: '#/components/schemas/SyntheticsApiTestFailureCode' + $ref: "#/components/schemas/SyntheticsApiTestFailureCode" message: description: The API test error message. - example: Error during DNS resolution (ENOTFOUND). + example: "Error during DNS resolution (ENOTFOUND)." type: string type: object SyntheticsAssertion: - description: 'Object describing the assertions type, their associated operator, - - which property they apply, and upon which target.' + description: |- + Object describing the assertions type, their associated operator, + which property they apply, and upon which target. oneOf: - - $ref: '#/components/schemas/SyntheticsAssertionTarget' - - $ref: '#/components/schemas/SyntheticsAssertionBodyHashTarget' - - $ref: '#/components/schemas/SyntheticsAssertionJSONPathTarget' - - $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaTarget' - - $ref: '#/components/schemas/SyntheticsAssertionXPathTarget' - - $ref: '#/components/schemas/SyntheticsAssertionJavascript' + - $ref: "#/components/schemas/SyntheticsAssertionTarget" + - $ref: "#/components/schemas/SyntheticsAssertionBodyHashTarget" + - $ref: "#/components/schemas/SyntheticsAssertionJSONPathTarget" + - $ref: "#/components/schemas/SyntheticsAssertionJSONSchemaTarget" + - $ref: "#/components/schemas/SyntheticsAssertionXPathTarget" + - $ref: "#/components/schemas/SyntheticsAssertionJavascript" SyntheticsAssertionBodyHashOperator: description: Assertion operator to apply. enum: - - md5 - - sha1 - - sha256 + - md5 + - sha1 + - sha256 example: md5 type: string x-enum-varnames: - - MD5 - - SHA1 - - SHA256 + - MD5 + - SHA1 + - SHA256 SyntheticsAssertionBodyHashTarget: description: An assertion which targets body hash. properties: operator: - $ref: '#/components/schemas/SyntheticsAssertionBodyHashOperator' + $ref: "#/components/schemas/SyntheticsAssertionBodyHashOperator" target: - $ref: '#/components/schemas/SyntheticsAssertionTargetValue' + $ref: "#/components/schemas/SyntheticsAssertionTargetValue" description: Value used by the operator. type: - $ref: '#/components/schemas/SyntheticsAssertionBodyHashType' + $ref: "#/components/schemas/SyntheticsAssertionBodyHashType" required: - - type - - operator - - target + - type + - operator + - target type: object SyntheticsAssertionBodyHashType: description: Type of the assertion. enum: - - bodyHash + - bodyHash example: bodyHash type: string x-enum-varnames: - - BODY_HASH + - BODY_HASH SyntheticsAssertionJSONPathOperator: description: Assertion operator to apply. enum: - - validatesJSONPath + - validatesJSONPath example: validatesJSONPath type: string x-enum-varnames: - - VALIDATES_JSON_PATH + - VALIDATES_JSON_PATH SyntheticsAssertionJSONPathTarget: description: An assertion for the `validatesJSONPath` operator. properties: operator: - $ref: '#/components/schemas/SyntheticsAssertionJSONPathOperator' + $ref: "#/components/schemas/SyntheticsAssertionJSONPathOperator" property: description: The associated assertion property. type: string target: - $ref: '#/components/schemas/SyntheticsAssertionJSONPathTargetTarget' + $ref: "#/components/schemas/SyntheticsAssertionJSONPathTargetTarget" type: - $ref: '#/components/schemas/SyntheticsAssertionType' + $ref: "#/components/schemas/SyntheticsAssertionType" required: - - type - - operator + - type + - operator type: object SyntheticsAssertionJSONPathTargetTarget: description: Composed target for `validatesJSONPath` operator. properties: elementsOperator: - description: The element from the list of results to assert on. To choose - from the first element in the list `firstElementMatches`, every element - in the list `everyElementMatches`, at least one element in the list `atLeastOneElementMatches` - or the serialized value of the list `serializationMatches`. + description: The element from the list of results to assert on. To choose from the first element in the list `firstElementMatches`, every element in the list `everyElementMatches`, at least one element in the list `atLeastOneElementMatches` or the serialized value of the list `serializationMatches`. type: string jsonPath: description: The JSON path to assert. @@ -16066,38 +14795,38 @@ components: description: The specific operator to use on the path. type: string targetValue: - $ref: '#/components/schemas/SyntheticsAssertionTargetValue' + $ref: "#/components/schemas/SyntheticsAssertionTargetValue" description: The path target value to compare to. type: object SyntheticsAssertionJSONSchemaMetaSchema: description: The JSON Schema meta-schema version used in the assertion. enum: - - draft-07 - - draft-06 + - draft-07 + - draft-06 type: string x-enum-varnames: - - DRAFT_07 - - DRAFT_06 + - DRAFT_07 + - DRAFT_06 SyntheticsAssertionJSONSchemaOperator: description: Assertion operator to apply. enum: - - validatesJSONSchema + - validatesJSONSchema example: validatesJSONSchema type: string x-enum-varnames: - - VALIDATES_JSON_SCHEMA + - VALIDATES_JSON_SCHEMA SyntheticsAssertionJSONSchemaTarget: description: An assertion for the `validatesJSONSchema` operator. properties: operator: - $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaOperator' + $ref: "#/components/schemas/SyntheticsAssertionJSONSchemaOperator" target: - $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaTargetTarget' + $ref: "#/components/schemas/SyntheticsAssertionJSONSchemaTargetTarget" type: - $ref: '#/components/schemas/SyntheticsAssertionType' + $ref: "#/components/schemas/SyntheticsAssertionType" required: - - type - - operator + - type + - operator type: object SyntheticsAssertionJSONSchemaTargetTarget: description: Composed target for `validatesJSONSchema` operator. @@ -16106,7 +14835,7 @@ components: description: The JSON Schema to assert. type: string metaSchema: - $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaMetaSchema' + $ref: "#/components/schemas/SyntheticsAssertionJSONSchemaMetaSchema" type: object SyntheticsAssertionJavascript: description: A JavaScript assertion. @@ -16116,170 +14845,168 @@ components: example: dd.expect(dd.response.statusCode).to.equal(200); type: string type: - $ref: '#/components/schemas/SyntheticsAssertionJavascriptType' + $ref: "#/components/schemas/SyntheticsAssertionJavascriptType" required: - - type - - code + - type + - code type: object SyntheticsAssertionJavascriptType: description: Type of the assertion. enum: - - javascript + - javascript example: javascript type: string x-enum-varnames: - - JAVASCRIPT + - JAVASCRIPT SyntheticsAssertionOperator: description: Assertion operator to apply. enum: - - contains - - doesNotContain - - is - - isNot - - lessThan - - lessThanOrEqual - - moreThan - - moreThanOrEqual - - matches - - doesNotMatch - - validates - - isInMoreThan - - isInLessThan - - doesNotExist - - isUndefined + - contains + - doesNotContain + - is + - isNot + - lessThan + - lessThanOrEqual + - moreThan + - moreThanOrEqual + - matches + - doesNotMatch + - validates + - isInMoreThan + - isInLessThan + - doesNotExist + - isUndefined example: contains type: string x-enum-varnames: - - CONTAINS - - DOES_NOT_CONTAIN - - IS - - IS_NOT - - LESS_THAN - - LESS_THAN_OR_EQUAL - - MORE_THAN - - MORE_THAN_OR_EQUAL - - MATCHES - - DOES_NOT_MATCH - - VALIDATES - - IS_IN_MORE_DAYS_THAN - - IS_IN_LESS_DAYS_THAN - - DOES_NOT_EXIST - - IS_UNDEFINED + - CONTAINS + - DOES_NOT_CONTAIN + - IS + - IS_NOT + - LESS_THAN + - LESS_THAN_OR_EQUAL + - MORE_THAN + - MORE_THAN_OR_EQUAL + - MATCHES + - DOES_NOT_MATCH + - VALIDATES + - IS_IN_MORE_DAYS_THAN + - IS_IN_LESS_DAYS_THAN + - DOES_NOT_EXIST + - IS_UNDEFINED SyntheticsAssertionTarget: description: An assertion which uses a simple target. properties: operator: - $ref: '#/components/schemas/SyntheticsAssertionOperator' + $ref: "#/components/schemas/SyntheticsAssertionOperator" property: description: The associated assertion property. type: string target: - $ref: '#/components/schemas/SyntheticsAssertionTargetValue' + $ref: "#/components/schemas/SyntheticsAssertionTargetValue" description: Value used by the operator. timingsScope: - $ref: '#/components/schemas/SyntheticsAssertionTimingsScope' + $ref: "#/components/schemas/SyntheticsAssertionTimingsScope" type: - $ref: '#/components/schemas/SyntheticsAssertionType' + $ref: "#/components/schemas/SyntheticsAssertionType" required: - - type - - operator - - target + - type + - operator + - target type: object SyntheticsAssertionTargetValue: - description: Value used by the operator in assertions. Can be either a number - or string. + description: Value used by the operator in assertions. Can be either a number or string. example: 0.0 oneOf: - - $ref: '#/components/schemas/SyntheticsAssertionTargetValueNumber' - - $ref: '#/components/schemas/SyntheticsAssertionTargetValueString' + - $ref: "#/components/schemas/SyntheticsAssertionTargetValueNumber" + - $ref: "#/components/schemas/SyntheticsAssertionTargetValueString" SyntheticsAssertionTargetValueNumber: description: Numeric value used by the operator in assertions. format: double type: number SyntheticsAssertionTargetValueString: - description: String value used by the operator in assertions. Supports templated - variables. + description: String value used by the operator in assertions. Supports templated variables. type: string SyntheticsAssertionTimingsScope: description: Timings scope for response time assertions. enum: - - all - - withoutDNS + - all + - withoutDNS type: string x-enum-varnames: - - ALL - - WITHOUT_DNS + - ALL + - WITHOUT_DNS SyntheticsAssertionType: description: Type of the assertion. enum: - - body - - header - - statusCode - - certificate - - responseTime - - property - - recordEvery - - recordSome - - tlsVersion - - minTlsVersion - - latency - - packetLossPercentage - - packetsReceived - - networkHop - - receivedMessage - - grpcHealthcheckStatus - - grpcMetadata - - grpcProto - - connection - - multiNetworkHop - - jitter + - body + - header + - statusCode + - certificate + - responseTime + - property + - recordEvery + - recordSome + - tlsVersion + - minTlsVersion + - latency + - packetLossPercentage + - packetsReceived + - networkHop + - receivedMessage + - grpcHealthcheckStatus + - grpcMetadata + - grpcProto + - connection + - multiNetworkHop + - jitter example: statusCode type: string x-enum-varnames: - - BODY - - HEADER - - STATUS_CODE - - CERTIFICATE - - RESPONSE_TIME - - PROPERTY - - RECORD_EVERY - - RECORD_SOME - - TLS_VERSION - - MIN_TLS_VERSION - - LATENCY - - PACKET_LOSS_PERCENTAGE - - PACKETS_RECEIVED - - NETWORK_HOP - - RECEIVED_MESSAGE - - GRPC_HEALTHCHECK_STATUS - - GRPC_METADATA - - GRPC_PROTO - - CONNECTION - - MULTI_NETWORK_HOP - - JITTER + - BODY + - HEADER + - STATUS_CODE + - CERTIFICATE + - RESPONSE_TIME + - PROPERTY + - RECORD_EVERY + - RECORD_SOME + - TLS_VERSION + - MIN_TLS_VERSION + - LATENCY + - PACKET_LOSS_PERCENTAGE + - PACKETS_RECEIVED + - NETWORK_HOP + - RECEIVED_MESSAGE + - GRPC_HEALTHCHECK_STATUS + - GRPC_METADATA + - GRPC_PROTO + - CONNECTION + - MULTI_NETWORK_HOP + - JITTER SyntheticsAssertionXPathOperator: description: Assertion operator to apply. enum: - - validatesXPath + - validatesXPath example: validatesXPath type: string x-enum-varnames: - - VALIDATES_X_PATH + - VALIDATES_X_PATH SyntheticsAssertionXPathTarget: description: An assertion for the `validatesXPath` operator. properties: operator: - $ref: '#/components/schemas/SyntheticsAssertionXPathOperator' + $ref: "#/components/schemas/SyntheticsAssertionXPathOperator" property: description: The associated assertion property. type: string target: - $ref: '#/components/schemas/SyntheticsAssertionXPathTargetTarget' + $ref: "#/components/schemas/SyntheticsAssertionXPathTargetTarget" type: - $ref: '#/components/schemas/SyntheticsAssertionType' + $ref: "#/components/schemas/SyntheticsAssertionType" required: - - type - - operator + - type + - operator type: object SyntheticsAssertionXPathTargetTarget: description: Composed target for `validatesXPath` operator. @@ -16288,7 +15015,7 @@ components: description: The specific operator to use on the path. type: string targetValue: - $ref: '#/components/schemas/SyntheticsAssertionTargetValue' + $ref: "#/components/schemas/SyntheticsAssertionTargetValue" description: The path target value to compare to. xPath: description: The X path to assert. @@ -16297,287 +15024,280 @@ components: SyntheticsBasicAuth: description: Object to handle basic authentication when performing the test. oneOf: - - $ref: '#/components/schemas/SyntheticsBasicAuthWeb' - - $ref: '#/components/schemas/SyntheticsBasicAuthSigv4' - - $ref: '#/components/schemas/SyntheticsBasicAuthNTLM' - - $ref: '#/components/schemas/SyntheticsBasicAuthDigest' - - $ref: '#/components/schemas/SyntheticsBasicAuthOauthClient' - - $ref: '#/components/schemas/SyntheticsBasicAuthOauthROP' + - $ref: "#/components/schemas/SyntheticsBasicAuthWeb" + - $ref: "#/components/schemas/SyntheticsBasicAuthSigv4" + - $ref: "#/components/schemas/SyntheticsBasicAuthNTLM" + - $ref: "#/components/schemas/SyntheticsBasicAuthDigest" + - $ref: "#/components/schemas/SyntheticsBasicAuthOauthClient" + - $ref: "#/components/schemas/SyntheticsBasicAuthOauthROP" SyntheticsBasicAuthDigest: description: Object to handle digest authentication when performing the test. properties: password: description: Password to use for the digest authentication. - example: PaSSw0RD! + example: "PaSSw0RD!" type: string type: - $ref: '#/components/schemas/SyntheticsBasicAuthDigestType' + $ref: "#/components/schemas/SyntheticsBasicAuthDigestType" username: description: Username to use for the digest authentication. - example: my_username + example: "my_username" type: string required: - - password - - username - - type + - password + - username + - type type: object SyntheticsBasicAuthDigestType: - default: digest + default: "digest" description: The type of basic authentication to use when performing the test. enum: - - digest - example: digest + - digest + example: "digest" type: string x-enum-varnames: - - DIGEST + - DIGEST SyntheticsBasicAuthNTLM: description: Object to handle `NTLM` authentication when performing the test. properties: domain: description: Domain for the authentication to use when performing the test. - example: DOMAINNAME + example: "DOMAINNAME" type: string password: - description: Password for the authentication to use when performing the - test. - example: examplepassword + description: Password for the authentication to use when performing the test. + example: "examplepassword" type: string type: - $ref: '#/components/schemas/SyntheticsBasicAuthNTLMType' + $ref: "#/components/schemas/SyntheticsBasicAuthNTLMType" username: - description: Username for the authentication to use when performing the - test. - example: joedoe + description: Username for the authentication to use when performing the test. + example: "joedoe" type: string workstation: - description: Workstation for the authentication to use when performing the - test. - example: '' + description: Workstation for the authentication to use when performing the test. + example: "" type: string required: - - type + - type type: object SyntheticsBasicAuthNTLMType: - default: ntlm + default: "ntlm" description: The type of authentication to use when performing the test. enum: - - ntlm - example: ntlm + - ntlm + example: "ntlm" type: string x-enum-varnames: - - NTLM + - NTLM SyntheticsBasicAuthOauthClient: - description: Object to handle `oauth client` authentication when performing - the test. + description: Object to handle `oauth client` authentication when performing the test. properties: accessTokenUrl: description: Access token URL to use when performing the authentication. - example: https://example.com + example: "https://example.com" type: string audience: description: Audience to use when performing the authentication. - example: audience + example: "audience" type: string clientId: description: Client ID to use when performing the authentication. - example: oauth-username + example: "oauth-username" type: string clientSecret: description: Client secret to use when performing the authentication. - example: oauth-password + example: "oauth-password" type: string resource: description: Resource to use when performing the authentication. - example: resource + example: "resource" type: string scope: description: Scope to use when performing the authentication. - example: scope + example: "scope" type: string tokenApiAuthentication: - $ref: '#/components/schemas/SyntheticsBasicAuthOauthTokenApiAuthentication' + $ref: "#/components/schemas/SyntheticsBasicAuthOauthTokenApiAuthentication" type: - $ref: '#/components/schemas/SyntheticsBasicAuthOauthClientType' + $ref: "#/components/schemas/SyntheticsBasicAuthOauthClientType" required: - - accessTokenUrl - - tokenApiAuthentication - - clientId - - clientSecret - - type + - accessTokenUrl + - tokenApiAuthentication + - clientId + - clientSecret + - type type: object SyntheticsBasicAuthOauthClientType: - default: oauth-client + default: "oauth-client" description: The type of basic authentication to use when performing the test. enum: - - oauth-client - example: oauth-client + - oauth-client + example: "oauth-client" type: string x-enum-varnames: - - OAUTH_CLIENT + - OAUTH_CLIENT SyntheticsBasicAuthOauthROP: - description: Object to handle `oauth rop` authentication when performing the - test. + description: Object to handle `oauth rop` authentication when performing the test. properties: accessTokenUrl: description: Access token URL to use when performing the authentication. - example: https://example.com + example: "https://example.com" type: string audience: description: Audience to use when performing the authentication. - example: audience + example: "audience" type: string clientId: description: Client ID to use when performing the authentication. - example: client-id + example: "client-id" type: string clientSecret: description: Client secret to use when performing the authentication. - example: client-secret + example: "client-secret" type: string password: description: Password to use when performing the authentication. - example: password + example: "password" type: string resource: description: Resource to use when performing the authentication. - example: resource + example: "resource" type: string scope: description: Scope to use when performing the authentication. - example: scope + example: "scope" type: string tokenApiAuthentication: - $ref: '#/components/schemas/SyntheticsBasicAuthOauthTokenApiAuthentication' + $ref: "#/components/schemas/SyntheticsBasicAuthOauthTokenApiAuthentication" type: - $ref: '#/components/schemas/SyntheticsBasicAuthOauthROPType' + $ref: "#/components/schemas/SyntheticsBasicAuthOauthROPType" username: description: Username to use when performing the authentication. - example: username + example: "username" type: string required: - - accessTokenUrl - - password - - tokenApiAuthentication - - username - - type + - accessTokenUrl + - password + - tokenApiAuthentication + - username + - type type: object SyntheticsBasicAuthOauthROPType: - default: oauth-rop + default: "oauth-rop" description: The type of basic authentication to use when performing the test. enum: - - oauth-rop - example: oauth-rop + - oauth-rop + example: "oauth-rop" type: string x-enum-varnames: - - OAUTH_ROP + - OAUTH_ROP SyntheticsBasicAuthOauthTokenApiAuthentication: description: Type of token to use when performing the authentication. enum: - - header - - body - example: header + - header + - body + example: "header" type: string x-enum-varnames: - - HEADER - - BODY + - HEADER + - BODY SyntheticsBasicAuthSigv4: description: Object to handle `SIGV4` authentication when performing the test. properties: accessKey: description: Access key for the `SIGV4` authentication. - example: AKIAIOSFODNN7EXAMPLE + example: "AKIAIOSFODNN7EXAMPLE" type: string region: description: Region for the `SIGV4` authentication. - example: us-east-1 + example: "us-east-1" type: string secretKey: description: Secret key for the `SIGV4` authentication. - example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY + example: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY" type: string serviceName: description: Service name for the `SIGV4` authentication. - example: execute-api + example: "execute-api" type: string sessionToken: description: Session token for the `SIGV4` authentication. - example: 'AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/L - + example: |- + AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/L To6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3z - rkuWJOgQs8IZZaIv2BXIa2R4OlgkBN9bkUDNCJiBeb/AXlzBBko7b15fjrBs2+cTQtp - - Z3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE' + Z3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE type: string type: - $ref: '#/components/schemas/SyntheticsBasicAuthSigv4Type' + $ref: "#/components/schemas/SyntheticsBasicAuthSigv4Type" required: - - accessKey - - secretKey - - type + - accessKey + - secretKey + - type type: object SyntheticsBasicAuthSigv4Type: - default: sigv4 + default: "sigv4" description: The type of authentication to use when performing the test. enum: - - sigv4 - example: sigv4 + - sigv4 + example: "sigv4" type: string x-enum-varnames: - - SIGV4 + - SIGV4 SyntheticsBasicAuthWeb: description: Object to handle basic authentication when performing the test. properties: password: description: Password to use for the basic authentication. - example: PaSSw0RD! + example: "PaSSw0RD!" type: string type: - $ref: '#/components/schemas/SyntheticsBasicAuthWebType' + $ref: "#/components/schemas/SyntheticsBasicAuthWebType" username: description: Username to use for the basic authentication. - example: my_username + example: "my_username" type: string type: object SyntheticsBasicAuthWebType: - default: web + default: "web" description: The type of basic authentication to use when performing the test. enum: - - web - example: web + - web + example: "web" type: string x-enum-varnames: - - WEB + - WEB SyntheticsBatchDetails: description: Details about a batch response. properties: data: - $ref: '#/components/schemas/SyntheticsBatchDetailsData' + $ref: "#/components/schemas/SyntheticsBatchDetailsData" type: object SyntheticsBatchDetailsData: description: Wrapper object that contains the details of a batch. properties: metadata: - $ref: '#/components/schemas/SyntheticsCIBatchMetadata' + $ref: "#/components/schemas/SyntheticsCIBatchMetadata" results: description: List of results for the batch. items: - $ref: '#/components/schemas/SyntheticsBatchResult' + $ref: "#/components/schemas/SyntheticsBatchResult" type: array status: - $ref: '#/components/schemas/SyntheticsBatchStatus' + $ref: "#/components/schemas/SyntheticsBatchStatus" type: object SyntheticsBatchResult: description: Object with the results of a Synthetic batch. properties: device: - $ref: '#/components/schemas/SyntheticsDeviceID' + $ref: "#/components/schemas/SyntheticsDeviceID" duration: description: Total duration in millisecond of the test. format: double type: number execution_rule: - $ref: '#/components/schemas/SyntheticsTestExecutionRule' + $ref: "#/components/schemas/SyntheticsTestExecutionRule" location: description: Name of the location. type: string @@ -16589,7 +15309,7 @@ components: format: double type: number status: - $ref: '#/components/schemas/SyntheticsBatchStatus' + $ref: "#/components/schemas/SyntheticsBatchStatus" test_name: description: Name of the test. type: string @@ -16597,29 +15317,29 @@ components: description: The public ID of the Synthetic test. type: string test_type: - $ref: '#/components/schemas/SyntheticsTestDetailsType' + $ref: "#/components/schemas/SyntheticsTestDetailsType" type: object SyntheticsBatchStatus: description: Determines whether the batch has passed, failed, or is in progress. enum: - - passed - - skipped - - failed + - passed + - skipped + - failed type: string x-enum-varnames: - - PASSED - - SKIPPED - - FAILED + - PASSED + - SKIPPED + - FAILED SyntheticsBrowserError: description: Error response object for a browser test. properties: description: description: Description of the error. - example: Example error message + example: "Example error message" type: string name: description: Name of the error. - example: Failed test + example: "Failed test" type: string status: description: Status Code of the error. @@ -16627,39 +15347,37 @@ components: format: int64 type: integer type: - $ref: '#/components/schemas/SyntheticsBrowserErrorType' + $ref: "#/components/schemas/SyntheticsBrowserErrorType" required: - - description - - name - - type + - description + - name + - type type: object SyntheticsBrowserErrorType: description: Error type returned by a browser test. enum: - - network - - js + - network + - js example: network type: string x-enum-varnames: - - NETWORK - - JS + - NETWORK + - JS SyntheticsBrowserTest: description: Object containing details about a Synthetic browser test. properties: config: - $ref: '#/components/schemas/SyntheticsBrowserTestConfig' + $ref: "#/components/schemas/SyntheticsBrowserTestConfig" locations: description: Array of locations used to run the test. - example: - - aws:eu-west-3 + example: ["aws:eu-west-3"] items: description: A location from which the test was run. type: string type: array message: - description: Notification message associated with the test. Message can - either be text or an empty string. - example: '' + description: Notification message associated with the test. Message can either be text or an empty string. + example: "" type: string monitor_id: description: The associated monitor ID. @@ -16668,38 +15386,37 @@ components: type: integer name: description: Name of the test. - example: Example test name + example: "Example test name" type: string options: - $ref: '#/components/schemas/SyntheticsTestOptions' + $ref: "#/components/schemas/SyntheticsTestOptions" public_id: description: The public ID of the test. readOnly: true type: string status: - $ref: '#/components/schemas/SyntheticsTestPauseStatus' + $ref: "#/components/schemas/SyntheticsTestPauseStatus" steps: description: Array of steps for the test. items: - $ref: '#/components/schemas/SyntheticsStep' + $ref: "#/components/schemas/SyntheticsStep" type: array tags: description: Array of tags attached to the test. - example: - - env:prod + example: ["env:prod"] items: description: A tag attached to the test. type: string type: array type: - $ref: '#/components/schemas/SyntheticsBrowserTestType' + $ref: "#/components/schemas/SyntheticsBrowserTestType" required: - - config - - locations - - name - - options - - type - - message + - config + - locations + - name + - options + - type + - message type: object SyntheticsBrowserTestConfig: description: Configuration object for a Synthetic browser test. @@ -16709,99 +15426,98 @@ components: description: Array of assertions used for the test. example: [] items: - $ref: '#/components/schemas/SyntheticsAssertion' + $ref: "#/components/schemas/SyntheticsAssertion" type: array configVariables: description: Array of variables used for the test. items: - $ref: '#/components/schemas/SyntheticsConfigVariable' + $ref: "#/components/schemas/SyntheticsConfigVariable" type: array request: - $ref: '#/components/schemas/SyntheticsTestRequest' + $ref: "#/components/schemas/SyntheticsTestRequest" setCookie: - description: Cookies to be used for the request, using the [Set-Cookie](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie) - syntax. + description: Cookies to be used for the request, using the [Set-Cookie](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie) syntax. type: string variables: description: Array of variables used for the test steps. items: - $ref: '#/components/schemas/SyntheticsBrowserVariable' + $ref: "#/components/schemas/SyntheticsBrowserVariable" type: array required: - - request - - assertions + - request + - assertions type: object SyntheticsBrowserTestFailureCode: description: Error code that can be returned by a Synthetic test. enum: - - API_REQUEST_FAILURE - - ASSERTION_FAILURE - - DOWNLOAD_FILE_TOO_LARGE - - ELEMENT_NOT_INTERACTABLE - - EMAIL_VARIABLE_NOT_DEFINED - - EVALUATE_JAVASCRIPT - - EVALUATE_JAVASCRIPT_CONTEXT - - EXTRACT_VARIABLE - - FORBIDDEN_URL - - FRAME_DETACHED - - INCONSISTENCIES - - INTERNAL_ERROR - - INVALID_TYPE_TEXT_DELAY - - INVALID_URL - - INVALID_VARIABLE_PATTERN - - INVISIBLE_ELEMENT - - LOCATE_ELEMENT - - NAVIGATE_TO_LINK - - OPEN_URL - - PRESS_KEY - - SERVER_CERTIFICATE - - SELECT_OPTION - - STEP_TIMEOUT - - SUB_TEST_NOT_PASSED - - TEST_TIMEOUT - - TOO_MANY_HTTP_REQUESTS - - UNAVAILABLE_BROWSER - - UNKNOWN - - UNSUPPORTED_AUTH_SCHEMA - - UPLOAD_FILES_ELEMENT_TYPE - - UPLOAD_FILES_DIALOG - - UPLOAD_FILES_DYNAMIC_ELEMENT - - UPLOAD_FILES_NAME - type: string - x-enum-varnames: - - API_REQUEST_FAILURE - - ASSERTION_FAILURE - - DOWNLOAD_FILE_TOO_LARGE - - ELEMENT_NOT_INTERACTABLE - - EMAIL_VARIABLE_NOT_DEFINED - - EVALUATE_JAVASCRIPT - - EVALUATE_JAVASCRIPT_CONTEXT - - EXTRACT_VARIABLE - - FORBIDDEN_URL - - FRAME_DETACHED - - INCONSISTENCIES - - INTERNAL_ERROR - - INVALID_TYPE_TEXT_DELAY - - INVALID_URL - - INVALID_VARIABLE_PATTERN - - INVISIBLE_ELEMENT - - LOCATE_ELEMENT - - NAVIGATE_TO_LINK - - OPEN_URL - - PRESS_KEY - - SERVER_CERTIFICATE - - SELECT_OPTION - - STEP_TIMEOUT - - SUB_TEST_NOT_PASSED - - TEST_TIMEOUT - - TOO_MANY_HTTP_REQUESTS - - UNAVAILABLE_BROWSER - - UNKNOWN - - UNSUPPORTED_AUTH_SCHEMA - - UPLOAD_FILES_ELEMENT_TYPE - - UPLOAD_FILES_DIALOG - - UPLOAD_FILES_DYNAMIC_ELEMENT - - UPLOAD_FILES_NAME + - API_REQUEST_FAILURE + - ASSERTION_FAILURE + - DOWNLOAD_FILE_TOO_LARGE + - ELEMENT_NOT_INTERACTABLE + - EMAIL_VARIABLE_NOT_DEFINED + - EVALUATE_JAVASCRIPT + - EVALUATE_JAVASCRIPT_CONTEXT + - EXTRACT_VARIABLE + - FORBIDDEN_URL + - FRAME_DETACHED + - INCONSISTENCIES + - INTERNAL_ERROR + - INVALID_TYPE_TEXT_DELAY + - INVALID_URL + - INVALID_VARIABLE_PATTERN + - INVISIBLE_ELEMENT + - LOCATE_ELEMENT + - NAVIGATE_TO_LINK + - OPEN_URL + - PRESS_KEY + - SERVER_CERTIFICATE + - SELECT_OPTION + - STEP_TIMEOUT + - SUB_TEST_NOT_PASSED + - TEST_TIMEOUT + - TOO_MANY_HTTP_REQUESTS + - UNAVAILABLE_BROWSER + - UNKNOWN + - UNSUPPORTED_AUTH_SCHEMA + - UPLOAD_FILES_ELEMENT_TYPE + - UPLOAD_FILES_DIALOG + - UPLOAD_FILES_DYNAMIC_ELEMENT + - UPLOAD_FILES_NAME + type: string + x-enum-varnames: + - API_REQUEST_FAILURE + - ASSERTION_FAILURE + - DOWNLOAD_FILE_TOO_LARGE + - ELEMENT_NOT_INTERACTABLE + - EMAIL_VARIABLE_NOT_DEFINED + - EVALUATE_JAVASCRIPT + - EVALUATE_JAVASCRIPT_CONTEXT + - EXTRACT_VARIABLE + - FORBIDDEN_URL + - FRAME_DETACHED + - INCONSISTENCIES + - INTERNAL_ERROR + - INVALID_TYPE_TEXT_DELAY + - INVALID_URL + - INVALID_VARIABLE_PATTERN + - INVISIBLE_ELEMENT + - LOCATE_ELEMENT + - NAVIGATE_TO_LINK + - OPEN_URL + - PRESS_KEY + - SERVER_CERTIFICATE + - SELECT_OPTION + - STEP_TIMEOUT + - SUB_TEST_NOT_PASSED + - TEST_TIMEOUT + - TOO_MANY_HTTP_REQUESTS + - UNAVAILABLE_BROWSER + - UNKNOWN + - UNSUPPORTED_AUTH_SCHEMA + - UPLOAD_FILES_ELEMENT_TYPE + - UPLOAD_FILES_DIALOG + - UPLOAD_FILES_DYNAMIC_ELEMENT + - UPLOAD_FILES_NAME SyntheticsBrowserTestResultData: description: Object containing results for your Synthetic browser test. properties: @@ -16812,7 +15528,7 @@ components: description: Browser version used for the browser test. type: string device: - $ref: '#/components/schemas/SyntheticsDevice' + $ref: "#/components/schemas/SyntheticsDevice" duration: description: Global duration in second of the browser test. format: double @@ -16821,7 +15537,7 @@ components: description: Error returned for the browser test. type: string failure: - $ref: '#/components/schemas/SyntheticsBrowserTestResultFailure' + $ref: "#/components/schemas/SyntheticsBrowserTestResultFailure" passed: description: Whether or not the browser test was conducted. type: boolean @@ -16835,15 +15551,15 @@ components: stepDetails: description: Array containing the different browser test steps. items: - $ref: '#/components/schemas/SyntheticsStepDetail' + $ref: "#/components/schemas/SyntheticsStepDetail" type: array thumbnailsBucketKey: description: Whether or not a thumbnail is associated with the browser test. type: boolean timeToInteractive: - description: 'Time in second to wait before the browser test starts after - - reaching the start URL.' + description: |- + Time in second to wait before the browser test starts after + reaching the start URL. format: double type: number type: object @@ -16851,17 +15567,17 @@ components: description: The browser test failure details. properties: code: - $ref: '#/components/schemas/SyntheticsBrowserTestFailureCode' + $ref: "#/components/schemas/SyntheticsBrowserTestFailureCode" message: description: The browser test error message. - example: Error during DNS resolution (ENOTFOUND). + example: "Error during DNS resolution (ENOTFOUND)." type: string type: object SyntheticsBrowserTestResultFull: description: Object returned describing a browser test result. properties: check: - $ref: '#/components/schemas/SyntheticsBrowserTestResultFullCheck' + $ref: "#/components/schemas/SyntheticsBrowserTestResultFullCheck" check_time: description: When the browser test was conducted. format: double @@ -16874,20 +15590,20 @@ components: description: Location from which the browser test was performed. type: string result: - $ref: '#/components/schemas/SyntheticsBrowserTestResultData' + $ref: "#/components/schemas/SyntheticsBrowserTestResultData" result_id: description: ID of the browser test result. type: string status: - $ref: '#/components/schemas/SyntheticsTestMonitorStatus' + $ref: "#/components/schemas/SyntheticsTestMonitorStatus" type: object SyntheticsBrowserTestResultFullCheck: description: Object describing the browser test configuration. properties: config: - $ref: '#/components/schemas/SyntheticsTestConfig' + $ref: "#/components/schemas/SyntheticsTestConfig" required: - - config + - config type: object SyntheticsBrowserTestResultShort: description: Object with the results of a single Synthetic browser test. @@ -16900,18 +15616,18 @@ components: description: Location from which the Browser test was performed. type: string result: - $ref: '#/components/schemas/SyntheticsBrowserTestResultShortResult' + $ref: "#/components/schemas/SyntheticsBrowserTestResultShortResult" result_id: description: ID of the browser test result. type: string status: - $ref: '#/components/schemas/SyntheticsTestMonitorStatus' + $ref: "#/components/schemas/SyntheticsTestMonitorStatus" type: object SyntheticsBrowserTestResultShortResult: description: Object with the result of the last browser test run. properties: device: - $ref: '#/components/schemas/SyntheticsDevice' + $ref: "#/components/schemas/SyntheticsDevice" duration: description: Length in milliseconds of the browser test run. format: double @@ -16930,38 +15646,26 @@ components: type: integer type: object SyntheticsBrowserTestRumSettings: - description: 'The RUM data collection settings for the Synthetic browser test. - + description: |- + The RUM data collection settings for the Synthetic browser test. **Note:** There are 3 ways to format RUM settings: - `{ isEnabled: false }` - RUM data is not collected. - `{ isEnabled: true }` + RUM data is collected from the Synthetic test's default application. - RUM data is collected from the Synthetic test''s default application. - - - `{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", - clientTokenId: 12345 }` - - RUM data is collected using the specified application.' - example: - applicationId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - clientTokenId: 12345 - isEnabled: true + `{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }` + RUM data is collected using the specified application. + example: {"applicationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "clientTokenId": 12345, "isEnabled": true} properties: applicationId: - description: RUM application ID used to collect RUM data for the browser - test. + description: RUM application ID used to collect RUM data for the browser test. example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx type: string clientTokenId: - description: RUM application API key ID used to collect RUM data for the - browser test. + description: RUM application API key ID used to collect RUM data for the browser test. example: 12345 format: int64 type: integer @@ -16970,21 +15674,21 @@ components: example: true type: boolean required: - - isEnabled + - isEnabled type: object SyntheticsBrowserTestType: - default: browser + default: "browser" description: Type of the Synthetic test, `browser`. enum: - - browser - example: browser + - browser + example: "browser" type: string x-enum-varnames: - - BROWSER + - BROWSER SyntheticsBrowserVariable: - description: 'Object defining a variable that can be used in your browser test. - - See the [Recording Steps documentation](https://docs.datadoghq.com/synthetics/browser_tests/actions/?tab=testanelementontheactivepage#variables).' + description: |- + Object defining a variable that can be used in your browser test. + See the [Recording Steps documentation](https://docs.datadoghq.com/synthetics/browser_tests/actions/?tab=testanelementontheactivepage#variables). properties: example: description: Example for the variable. @@ -16994,50 +15698,49 @@ components: type: string name: description: Name of the variable. - example: VARIABLE_NAME + example: "VARIABLE_NAME" type: string pattern: description: Pattern of the variable. type: string secure: - description: Determines whether or not the browser test variable is obfuscated. - Can only be used with browser variables of type `text`. + description: Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type `text`. type: boolean type: - $ref: '#/components/schemas/SyntheticsBrowserVariableType' + $ref: "#/components/schemas/SyntheticsBrowserVariableType" required: - - type - - name + - type + - name type: object SyntheticsBrowserVariableType: description: Type of browser test variable. enum: - - element - - email - - global - - text + - element + - email + - global + - text example: text type: string x-enum-varnames: - - ELEMENT - - EMAIL - - GLOBAL - - TEXT + - ELEMENT + - EMAIL + - GLOBAL + - TEXT SyntheticsCIBatchMetadata: description: Metadata for the Synthetic tests run. properties: ci: - $ref: '#/components/schemas/SyntheticsCIBatchMetadataCI' + $ref: "#/components/schemas/SyntheticsCIBatchMetadataCI" git: - $ref: '#/components/schemas/SyntheticsCIBatchMetadataGit' + $ref: "#/components/schemas/SyntheticsCIBatchMetadataGit" type: object SyntheticsCIBatchMetadataCI: description: Description of the CI provider. properties: pipeline: - $ref: '#/components/schemas/SyntheticsCIBatchMetadataPipeline' + $ref: "#/components/schemas/SyntheticsCIBatchMetadataPipeline" provider: - $ref: '#/components/schemas/SyntheticsCIBatchMetadataProvider' + $ref: "#/components/schemas/SyntheticsCIBatchMetadataProvider" type: object SyntheticsCIBatchMetadataGit: description: Git information. @@ -17070,7 +15773,7 @@ components: description: Disable certificate checks in API tests. type: boolean basicAuth: - $ref: '#/components/schemas/SyntheticsBasicAuth' + $ref: "#/components/schemas/SyntheticsBasicAuth" body: description: Body to include in the test. type: string @@ -17081,32 +15784,30 @@ components: description: Cookies for the request. type: string deviceIds: - description: For browser test, array with the different device IDs used - to run the test. + description: For browser test, array with the different device IDs used to run the test. items: - $ref: '#/components/schemas/SyntheticsDeviceID' + $ref: "#/components/schemas/SyntheticsDeviceID" type: array followRedirects: description: For API HTTP test, whether or not the test should follow redirects. type: boolean headers: - $ref: '#/components/schemas/SyntheticsTestHeaders' + $ref: "#/components/schemas/SyntheticsTestHeaders" locations: description: Array of locations used to run the test. - example: - - aws:eu-west-3 + example: ["aws:eu-west-3"] items: description: A location from which the test was run. type: string type: array metadata: - $ref: '#/components/schemas/SyntheticsCIBatchMetadata' + $ref: "#/components/schemas/SyntheticsCIBatchMetadata" public_id: description: The public ID of the Synthetic test to trigger. example: aaa-aaa-aaa type: string retry: - $ref: '#/components/schemas/SyntheticsTestOptionsRetry' + $ref: "#/components/schemas/SyntheticsTestOptionsRetry" startUrl: description: Starting URL for the browser test. type: string @@ -17121,7 +15822,7 @@ components: format: int64 type: integer required: - - public_id + - public_id type: object SyntheticsCITestBody: description: Object describing the synthetics tests to trigger. @@ -17129,44 +15830,45 @@ components: tests: description: List of Synthetic tests with overrides. items: - $ref: '#/components/schemas/SyntheticsCITest' + $ref: "#/components/schemas/SyntheticsCITest" type: array type: object SyntheticsCheckType: description: Type of assertion to apply in an API test. enum: - - equals - - notEquals - - contains - - notContains - - startsWith - - notStartsWith - - greater - - lower - - greaterEquals - - lowerEquals - - matchRegex - - between - - isEmpty - - notIsEmpty - type: string - x-enum-varnames: - - EQUALS - - NOT_EQUALS - - CONTAINS - - NOT_CONTAINS - - STARTS_WITH - - NOT_STARTS_WITH - - GREATER - - LOWER - - GREATER_EQUALS - - LOWER_EQUALS - - MATCH_REGEX - - BETWEEN - - IS_EMPTY - - NOT_IS_EMPTY + - equals + - notEquals + - contains + - notContains + - startsWith + - notStartsWith + - greater + - lower + - greaterEquals + - lowerEquals + - matchRegex + - between + - isEmpty + - notIsEmpty + type: string + x-enum-varnames: + - EQUALS + - NOT_EQUALS + - CONTAINS + - NOT_CONTAINS + - STARTS_WITH + - NOT_STARTS_WITH + - GREATER + - LOWER + - GREATER_EQUALS + - LOWER_EQUALS + - MATCH_REGEX + - BETWEEN + - IS_EMPTY + - NOT_IS_EMPTY SyntheticsConfigVariable: - description: Object defining a variable that can be used in your test configuration. + description: |- + Object defining a variable that can be used in your test configuration. properties: example: description: Example for the variable. @@ -17176,34 +15878,33 @@ components: type: string name: description: Name of the variable. - example: VARIABLE_NAME + example: "VARIABLE_NAME" type: string pattern: description: Pattern of the variable. type: string secure: - description: Whether the value of this variable will be obfuscated in test - results. Only for config variables of type `text`. + description: Whether the value of this variable will be obfuscated in test results. Only for config variables of type `text`. example: false type: boolean type: - $ref: '#/components/schemas/SyntheticsConfigVariableType' + $ref: "#/components/schemas/SyntheticsConfigVariableType" required: - - type - - name + - type + - name type: object SyntheticsConfigVariableType: description: Type of the configuration variable. enum: - - global - - text - - email + - global + - text + - email example: text type: string x-enum-varnames: - - GLOBAL - - TEXT - - EMAIL + - GLOBAL + - TEXT + - EMAIL SyntheticsCoreWebVitals: description: Core Web Vitals attached to a browser test step. properties: @@ -17221,22 +15922,20 @@ components: type: object SyntheticsDefaultLocations: description: List of Synthetics default locations settings. - example: - - aws:eu-west-3 + example: ["aws:eu-west-3"] items: description: Name of the location. type: string type: array SyntheticsDeleteTestsPayload: - description: 'A JSON list of the ID or IDs of the Synthetic tests that you want - - to delete.' + description: |- + A JSON list of the ID or IDs of the Synthetic tests that you want + to delete. properties: force_delete_dependencies: - description: 'Delete the Synthetic test even if it''s referenced by other - resources - - (for example, SLOs and composite monitors).' + description: |- + Delete the Synthetic test even if it's referenced by other resources + (for example, SLOs and composite monitors). example: false type: boolean public_ids: @@ -17244,7 +15943,7 @@ components: example: [] items: description: A Synthetic test ID to delete. - example: abc-def-123 + example: "abc-def-123" type: string type: array type: object @@ -17252,17 +15951,17 @@ components: description: Response object for deleting Synthetic tests. properties: deleted_tests: - description: 'Array of objects containing a deleted Synthetic test ID with - - the associated deletion timestamp.' + description: |- + Array of objects containing a deleted Synthetic test ID with + the associated deletion timestamp. items: - $ref: '#/components/schemas/SyntheticsDeletedTest' + $ref: "#/components/schemas/SyntheticsDeletedTest" type: array type: object SyntheticsDeletedTest: - description: 'Object containing a deleted Synthetic test ID with the associated - - deletion timestamp.' + description: |- + Object containing a deleted Synthetic test ID with the associated + deletion timestamp. properties: deleted_at: description: Deletion timestamp of the Synthetic test ID. @@ -17281,13 +15980,13 @@ components: format: int64 type: integer id: - $ref: '#/components/schemas/SyntheticsDeviceID' + $ref: "#/components/schemas/SyntheticsDeviceID" isMobile: description: Whether or not the device is a mobile. type: boolean name: description: The device name. - example: '' + example: "" type: string width: description: Screen width of the device. @@ -17295,17 +15994,18 @@ components: format: int64 type: integer required: - - id - - name - - height - - width + - id + - name + - height + - width type: object SyntheticsDeviceID: description: The device ID. example: chrome.laptop_large type: string SyntheticsFetchUptimesPayload: - description: Object containing IDs of Synthetic tests and a timeframe. + description: |- + Object containing IDs of Synthetic tests and a timeframe. properties: from_ts: description: Timestamp in seconds (Unix epoch) for the start of uptime. @@ -17317,7 +16017,7 @@ components: example: [] items: description: A Synthetic test ID. - example: abc-def-123 + example: "abc-def-123" type: string type: array to_ts: @@ -17326,9 +16026,9 @@ components: format: int64 type: integer required: - - from_ts - - to_ts - - public_ids + - from_ts + - to_ts + - public_ids type: object SyntheticsGetAPITestLatestResultsResponse: description: Object with the latest Synthetic API test run. @@ -17340,7 +16040,7 @@ components: results: description: Result of the latest API test run. items: - $ref: '#/components/schemas/SyntheticsAPITestResultShort' + $ref: "#/components/schemas/SyntheticsAPITestResultShort" type: array type: object SyntheticsGetBrowserTestLatestResultsResponse: @@ -17353,17 +16053,17 @@ components: results: description: Result of the latest browser test run. items: - $ref: '#/components/schemas/SyntheticsBrowserTestResultShort' + $ref: "#/components/schemas/SyntheticsBrowserTestResultShort" type: array type: object SyntheticsGlobalVariable: description: Synthetic global variable. properties: attributes: - $ref: '#/components/schemas/SyntheticsGlobalVariableAttributes' + $ref: "#/components/schemas/SyntheticsGlobalVariableAttributes" description: description: Description of the global variable. - example: Example description + example: "Example description" type: string id: description: Unique identifier of the global variable. @@ -17376,104 +16076,96 @@ components: description: Determines if the global variable is a TOTP/MFA variable. type: boolean name: - description: Name of the global variable. Unique across Synthetic global - variables. - example: MY_VARIABLE + description: Name of the global variable. Unique across Synthetic global variables. + example: "MY_VARIABLE" type: string parse_test_options: - $ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptions' + $ref: "#/components/schemas/SyntheticsGlobalVariableParseTestOptions" parse_test_public_id: - description: A Synthetic test ID to use as a test to generate the variable - value. - example: abc-def-123 + description: A Synthetic test ID to use as a test to generate the variable value. + example: "abc-def-123" type: string tags: description: Tags of the global variable. - example: - - team:front - - test:workflow-1 + example: ["team:front", "test:workflow-1"] items: description: Tag name. type: string type: array value: - $ref: '#/components/schemas/SyntheticsGlobalVariableValue' + $ref: "#/components/schemas/SyntheticsGlobalVariableValue" required: - - description - - name - - tags - - value + - description + - name + - tags + - value type: object SyntheticsGlobalVariableAttributes: description: Attributes of the global variable. properties: restricted_roles: - $ref: '#/components/schemas/SyntheticsRestrictedRoles' + $ref: "#/components/schemas/SyntheticsRestrictedRoles" type: object SyntheticsGlobalVariableOptions: description: Options for the Global Variable for MFA. properties: totp_parameters: - $ref: '#/components/schemas/SyntheticsGlobalVariableTOTPParameters' + $ref: "#/components/schemas/SyntheticsGlobalVariableTOTPParameters" type: object SyntheticsGlobalVariableParseTestOptions: - description: Parser options to use for retrieving a Synthetic global variable - from a Synthetic test. Used in conjunction with `parse_test_public_id`. + description: Parser options to use for retrieving a Synthetic global variable from a Synthetic test. Used in conjunction with `parse_test_public_id`. properties: field: - description: When type is `http_header`, name of the header to use to extract - the value. - example: content-type + description: When type is `http_header`, name of the header to use to extract the value. + example: "content-type" type: string localVariableName: - description: When type is `local_variable`, name of the local variable to - use to extract the value. - example: LOCAL_VARIABLE + description: When type is `local_variable`, name of the local variable to use to extract the value. + example: "LOCAL_VARIABLE" type: string parser: - $ref: '#/components/schemas/SyntheticsVariableParser' + $ref: "#/components/schemas/SyntheticsVariableParser" type: - $ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptionsType' + $ref: "#/components/schemas/SyntheticsGlobalVariableParseTestOptionsType" required: - - type + - type type: object SyntheticsGlobalVariableParseTestOptionsType: description: Type of value to extract from a test for a Synthetic global variable. enum: - - http_body - - http_header - - http_status_code - - local_variable + - http_body + - http_header + - http_status_code + - local_variable example: http_body type: string x-enum-varnames: - - HTTP_BODY - - HTTP_HEADER - - HTTP_STATUS_CODE - - LOCAL_VARIABLE + - HTTP_BODY + - HTTP_HEADER + - HTTP_STATUS_CODE + - LOCAL_VARIABLE SyntheticsGlobalVariableParserType: - description: Type of parser for a Synthetic global variable from a synthetics - test. + description: Type of parser for a Synthetic global variable from a synthetics test. enum: - - raw - - json_path - - regex - - x_path + - raw + - json_path + - regex + - x_path example: raw type: string x-enum-varnames: - - RAW - - JSON_PATH - - REGEX - - X_PATH + - RAW + - JSON_PATH + - REGEX + - X_PATH SyntheticsGlobalVariableRequest: description: Details of the global variable to create. properties: attributes: - $ref: '#/components/schemas/SyntheticsGlobalVariableAttributes' + $ref: "#/components/schemas/SyntheticsGlobalVariableAttributes" description: description: Description of the global variable. - example: Example description + example: "Example description" type: string id: description: Unique identifier of the global variable. @@ -17486,35 +16178,31 @@ components: description: Determines if the global variable is a TOTP/MFA variable. type: boolean name: - description: Name of the global variable. Unique across Synthetic global - variables. - example: MY_VARIABLE + description: Name of the global variable. Unique across Synthetic global variables. + example: "MY_VARIABLE" type: string parse_test_options: - $ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptions' + $ref: "#/components/schemas/SyntheticsGlobalVariableParseTestOptions" parse_test_public_id: - description: A Synthetic test ID to use as a test to generate the variable - value. - example: abc-def-123 + description: A Synthetic test ID to use as a test to generate the variable value. + example: "abc-def-123" type: string tags: description: Tags of the global variable. - example: - - team:front - - test:workflow-1 + example: ["team:front", "test:workflow-1"] items: description: Tag name. type: string type: array value: - $ref: '#/components/schemas/SyntheticsGlobalVariableValue' + $ref: "#/components/schemas/SyntheticsGlobalVariableValue" required: - - description - - name - - tags + - description + - name + - tags type: object SyntheticsGlobalVariableTOTPParameters: - description: Parameters for the TOTP/MFA variable + description: "Parameters for the TOTP/MFA variable" properties: digits: description: Number of digits for the OTP code. @@ -17538,16 +16226,15 @@ components: value: value properties: options: - $ref: '#/components/schemas/SyntheticsGlobalVariableOptions' + $ref: "#/components/schemas/SyntheticsGlobalVariableOptions" secure: description: Determines if the value of the variable is hidden. type: boolean value: - description: 'Value of the global variable. When reading a global variable, - - the value will not be present if the variable is hidden with the `secure` - property.' - example: example-value + description: |- + Value of the global variable. When reading a global variable, + the value will not be present if the variable is hidden with the `secure` property. + example: "example-value" type: string type: object SyntheticsListGlobalVariablesResponse: @@ -17556,7 +16243,7 @@ components: variables: description: Array of Synthetic global variables. items: - $ref: '#/components/schemas/SyntheticsGlobalVariable' + $ref: "#/components/schemas/SyntheticsGlobalVariable" type: array type: object SyntheticsListTestsResponse: @@ -17565,30 +16252,29 @@ components: tests: description: Array of Synthetic tests configuration. items: - $ref: '#/components/schemas/SyntheticsTestDetailsWithoutSteps' + $ref: "#/components/schemas/SyntheticsTestDetailsWithoutSteps" type: array type: object SyntheticsLocalVariableParsingOptionsType: - description: Property of the Synthetic Test Response to extract into a local - variable. - enum: - - grpc_message - - grpc_metadata - - http_body - - http_header - - http_status_code + description: Property of the Synthetic Test Response to extract into a local variable. + enum: + - grpc_message + - grpc_metadata + - http_body + - http_header + - http_status_code example: http_body type: string x-enum-varnames: - - GRPC_MESSAGE - - GRPC_METADATA - - HTTP_BODY - - HTTP_HEADER - - HTTP_STATUS_CODE + - GRPC_MESSAGE + - GRPC_METADATA + - HTTP_BODY + - HTTP_HEADER + - HTTP_STATUS_CODE SyntheticsLocation: - description: 'Synthetic location that can be used when creating or editing a - - test.' + description: |- + Synthetic location that can be used when creating or editing a + test. properties: id: description: Unique identifier of the location. @@ -17603,7 +16289,7 @@ components: locations: description: List of Synthetic locations. items: - $ref: '#/components/schemas/SyntheticsLocation' + $ref: "#/components/schemas/SyntheticsLocation" type: array type: object SyntheticsMobileStep: @@ -17616,72 +16302,66 @@ components: description: A boolean set to determine if the step has a new step element. type: boolean isCritical: - description: A boolean to use in addition to `allowFailure` to determine - if the test should be marked as failed when the step fails. + description: A boolean to use in addition to `allowFailure` to determine if the test should be marked as failed when the step fails. type: boolean name: description: The name of the step. - example: '' + example: "" maxLength: 1500 type: string noScreenshot: description: A boolean set to not take a screenshot for the step. type: boolean params: - $ref: '#/components/schemas/SyntheticsMobileStepParams' + $ref: "#/components/schemas/SyntheticsMobileStepParams" publicId: description: The public ID of the step. - example: pub-lic-id0 + example: "pub-lic-id0" type: string timeout: description: The time before declaring a step failed. format: int64 type: integer type: - $ref: '#/components/schemas/SyntheticsMobileStepType' + $ref: "#/components/schemas/SyntheticsMobileStepType" required: - - name - - params - - type + - name + - params + - type type: object SyntheticsMobileStepParams: description: The parameters of a mobile step. properties: check: - $ref: '#/components/schemas/SyntheticsCheckType' + $ref: "#/components/schemas/SyntheticsCheckType" delay: - description: Number of milliseconds to wait between inputs in a `typeText` - step type. + description: Number of milliseconds to wait between inputs in a `typeText` step type. format: int64 maximum: 5000 minimum: 0 type: integer direction: - $ref: '#/components/schemas/SyntheticsMobileStepParamsDirection' + $ref: "#/components/schemas/SyntheticsMobileStepParamsDirection" element: - $ref: '#/components/schemas/SyntheticsMobileStepParamsElement' + $ref: "#/components/schemas/SyntheticsMobileStepParamsElement" enabled: - description: Boolean to change the state of the wifi for a `toggleWiFi` - step type. + description: Boolean to change the state of the wifi for a `toggleWiFi` step type. type: boolean maxScrolls: - description: Maximum number of scrolls to do for a `scrollToElement` step - type. + description: Maximum number of scrolls to do for a `scrollToElement` step type. format: int64 type: integer positions: - $ref: '#/components/schemas/SyntheticsMobileStepParamsPositions' + $ref: "#/components/schemas/SyntheticsMobileStepParamsPositions" subtestPublicId: - description: Public ID of the test to be played as part of a `playSubTest` - step type. + description: Public ID of the test to be played as part of a `playSubTest` step type. type: string value: - $ref: '#/components/schemas/SyntheticsMobileStepParamsValue' + $ref: "#/components/schemas/SyntheticsMobileStepParamsValue" variable: - $ref: '#/components/schemas/SyntheticsMobileStepParamsVariable' + $ref: "#/components/schemas/SyntheticsMobileStepParamsVariable" withEnter: - description: Boolean to indicate if `Enter` should be pressed at the end - of the `typeText` step type. + description: Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type. type: boolean x: description: Amount to scroll by on the `x` axis for a `scroll` step type. @@ -17695,16 +16375,16 @@ components: SyntheticsMobileStepParamsDirection: description: The direction of the scroll for a `scrollToElement` step type. enum: - - up - - down - - left - - right + - up + - down + - left + - right type: string x-enum-varnames: - - UP - - DOWN - - LEFT - - RIGHT + - UP + - DOWN + - LEFT + - RIGHT SyntheticsMobileStepParamsElement: description: Information about the element used for a step. properties: @@ -17712,7 +16392,7 @@ components: description: Context of the element. type: string contextType: - $ref: '#/components/schemas/SyntheticsMobileStepParamsElementContextType' + $ref: "#/components/schemas/SyntheticsMobileStepParamsElementContextType" elementDescription: description: Description of the element. type: string @@ -17720,12 +16400,12 @@ components: description: Multi-locator to find the element. type: object relativePosition: - $ref: '#/components/schemas/SyntheticsMobileStepParamsElementRelativePosition' + $ref: "#/components/schemas/SyntheticsMobileStepParamsElementRelativePosition" textContent: description: Text content of the element. type: string userLocator: - $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocator' + $ref: "#/components/schemas/SyntheticsMobileStepParamsElementUserLocator" viewName: description: Name of the view of the element. type: string @@ -17733,12 +16413,12 @@ components: SyntheticsMobileStepParamsElementContextType: description: Type of the context that the element is in. enum: - - native - - web + - native + - web type: string x-enum-varnames: - - NATIVE - - WEB + - NATIVE + - WEB SyntheticsMobileStepParamsElementRelativePosition: description: Position of the action relative to the element. properties: @@ -17760,14 +16440,14 @@ components: values: description: Values of the user locator. items: - $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItems' + $ref: "#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItems" type: array type: object SyntheticsMobileStepParamsElementUserLocatorValuesItems: description: A single user locator object. properties: type: - $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItemsType' + $ref: "#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItemsType" value: description: Value of a user locator. type: string @@ -17775,23 +16455,22 @@ components: SyntheticsMobileStepParamsElementUserLocatorValuesItemsType: description: Type of a user locator. enum: - - accessibility-id - - id - - ios-predicate-string - - ios-class-chain - - xpath + - accessibility-id + - id + - ios-predicate-string + - ios-class-chain + - xpath type: string x-enum-varnames: - - ACCESSIBILITY_ID - - ID - - IOS_PREDICATE_STRING - - IOS_CLASS_CHAIN - - XPATH + - ACCESSIBILITY_ID + - ID + - IOS_PREDICATE_STRING + - IOS_CLASS_CHAIN + - XPATH SyntheticsMobileStepParamsPositions: - description: List of positions for the `flick` step type. The maximum is 10 - flicks per step + description: List of positions for the `flick` step type. The maximum is 10 flicks per step items: - $ref: '#/components/schemas/SyntheticsMobileStepParamsPositionsItems' + $ref: "#/components/schemas/SyntheticsMobileStepParamsPositionsItems" type: array SyntheticsMobileStepParamsPositionsItems: description: A description of a single position for a `flick` step type. @@ -17808,8 +16487,8 @@ components: SyntheticsMobileStepParamsValue: description: Values used in the step for in multiple step types. oneOf: - - $ref: '#/components/schemas/SyntheticsMobileStepParamsValueString' - - $ref: '#/components/schemas/SyntheticsMobileStepParamsValueNumber' + - $ref: "#/components/schemas/SyntheticsMobileStepParamsValueString" + - $ref: "#/components/schemas/SyntheticsMobileStepParamsValueNumber" SyntheticsMobileStepParamsValueNumber: description: Value used in the step for in multiple step types. format: int64 @@ -17822,65 +16501,65 @@ components: properties: example: description: An example for the variable. - example: '' + example: "" type: string name: description: The variable name. - example: VAR_NAME + example: "VAR_NAME" type: string required: - - name - - example + - name + - example type: object SyntheticsMobileStepType: description: Step type used in your mobile Synthetic test. enum: - - assertElementContent - - assertScreenContains - - assertScreenLacks - - doubleTap - - extractVariable - - flick - - openDeeplink - - playSubTest - - pressBack - - restartApplication - - rotate - - scroll - - scrollToElement - - tap - - toggleWiFi - - typeText - - wait + - assertElementContent + - assertScreenContains + - assertScreenLacks + - doubleTap + - extractVariable + - flick + - openDeeplink + - playSubTest + - pressBack + - restartApplication + - rotate + - scroll + - scrollToElement + - tap + - toggleWiFi + - typeText + - wait example: assertElementContent type: string x-enum-varnames: - - ASSERTELEMENTCONTENT - - ASSERTSCREENCONTAINS - - ASSERTSCREENLACKS - - DOUBLETAP - - EXTRACTVARIABLE - - FLICK - - OPENDEEPLINK - - PLAYSUBTEST - - PRESSBACK - - RESTARTAPPLICATION - - ROTATE - - SCROLL - - SCROLLTOELEMENT - - TAP - - TOGGLEWIFI - - TYPETEXT - - WAIT + - ASSERTELEMENTCONTENT + - ASSERTSCREENCONTAINS + - ASSERTSCREENLACKS + - DOUBLETAP + - EXTRACTVARIABLE + - FLICK + - OPENDEEPLINK + - PLAYSUBTEST + - PRESSBACK + - RESTARTAPPLICATION + - ROTATE + - SCROLL + - SCROLLTOELEMENT + - TAP + - TOGGLEWIFI + - TYPETEXT + - WAIT SyntheticsMobileTest: description: Object containing details about a Synthetic mobile test. properties: config: - $ref: '#/components/schemas/SyntheticsMobileTestConfig' + $ref: "#/components/schemas/SyntheticsMobileTestConfig" device_ids: description: Array with the different device IDs used to run the test. items: - $ref: '#/components/schemas/SyntheticsDeviceID' + $ref: "#/components/schemas/SyntheticsDeviceID" type: array message: description: Notification message associated with the test. @@ -17894,53 +16573,52 @@ components: type: integer name: description: Name of the test. - example: Example test name + example: "Example test name" type: string options: - $ref: '#/components/schemas/SyntheticsMobileTestOptions' + $ref: "#/components/schemas/SyntheticsMobileTestOptions" public_id: description: The public ID of the test. example: 123-abc-456 readOnly: true type: string status: - $ref: '#/components/schemas/SyntheticsTestPauseStatus' + $ref: "#/components/schemas/SyntheticsTestPauseStatus" steps: description: Array of steps for the test. items: - $ref: '#/components/schemas/SyntheticsMobileStep' + $ref: "#/components/schemas/SyntheticsMobileStep" type: array tags: description: Array of tags attached to the test. - example: - - env:production + example: ["env:production"] items: description: A tag attached to the test. type: string type: array type: - $ref: '#/components/schemas/SyntheticsMobileTestType' + $ref: "#/components/schemas/SyntheticsMobileTestType" required: - - config - - name - - options - - type - - message + - config + - name + - options + - type + - message type: object SyntheticsMobileTestConfig: description: Configuration object for a Synthetic mobile test. properties: initialApplicationArguments: - $ref: '#/components/schemas/SyntheticsMobileTestInitialApplicationArguments' + $ref: "#/components/schemas/SyntheticsMobileTestInitialApplicationArguments" variables: description: Array of variables used for the test steps. items: - $ref: '#/components/schemas/SyntheticsConfigVariable' + $ref: "#/components/schemas/SyntheticsConfigVariable" type: array type: object SyntheticsMobileTestInitialApplicationArguments: additionalProperties: - description: A single application argument. + description: "A single application argument." type: string description: Initial application arguments for a mobile test. type: object @@ -17948,16 +16626,15 @@ components: description: Object describing the extra options for a Synthetic test. properties: allowApplicationCrash: - description: A boolean to set if an application crash would mark the test - as failed. + description: A boolean to set if an application crash would mark the test as failed. type: boolean bindings: description: Array of bindings used for the mobile test. items: - $ref: '#/components/schemas/SyntheticsTestRestrictionPolicyBinding' + $ref: "#/components/schemas/SyntheticsTestRestrictionPolicyBinding" type: array ci: - $ref: '#/components/schemas/SyntheticsTestCiOptions' + $ref: "#/components/schemas/SyntheticsTestCiOptions" defaultStepTimeout: description: The default timeout for steps in the test (in seconds). format: int32 @@ -17965,12 +16642,11 @@ components: minimum: 1 type: integer device_ids: - description: For mobile test, array with the different device IDs used to - run the test. + description: For mobile test, array with the different device IDs used to run the test. example: - - synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16 + - synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16 items: - $ref: '#/components/schemas/SyntheticsDeviceID' + $ref: "#/components/schemas/SyntheticsDeviceID" type: array disableAutoAcceptAlert: description: A boolean to disable auto accepting alerts. @@ -17982,13 +16658,12 @@ components: minimum: 0 type: integer mobileApplication: - $ref: '#/components/schemas/SyntheticsMobileTestsMobileApplication' + $ref: "#/components/schemas/SyntheticsMobileTestsMobileApplication" monitor_name: - description: The monitor name is used for the alert title as well as for - all monitor dashboard widgets and SLOs. + description: The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs. type: string monitor_options: - $ref: '#/components/schemas/SyntheticsTestOptionsMonitorOptions' + $ref: "#/components/schemas/SyntheticsTestOptionsMonitorOptions" monitor_priority: description: Integer from 1 (high) to 5 (low) indicating alert severity. format: int32 @@ -17999,11 +16674,11 @@ components: description: A boolean set to not take a screenshot for the step. type: boolean restricted_roles: - $ref: '#/components/schemas/SyntheticsRestrictedRoles' + $ref: "#/components/schemas/SyntheticsRestrictedRoles" retry: - $ref: '#/components/schemas/SyntheticsTestOptionsRetry' + $ref: "#/components/schemas/SyntheticsTestOptionsRetry" scheduling: - $ref: '#/components/schemas/SyntheticsTestOptionsScheduling' + $ref: "#/components/schemas/SyntheticsTestOptionsScheduling" tick_every: description: The frequency at which to run the Synthetic test (in seconds). example: 300 @@ -18012,142 +16687,131 @@ components: minimum: 300 type: integer verbosity: - description: The level of verbosity for the mobile test. This field can - not be set by a user. + description: The level of verbosity for the mobile test. This field can not be set by a user. format: int32 maximum: 5 minimum: 0 type: integer required: - - device_ids - - tick_every - - mobileApplication + - device_ids + - tick_every + - mobileApplication type: object SyntheticsMobileTestType: - default: mobile + default: "mobile" description: Type of the Synthetic test, `mobile`. enum: - - mobile - example: mobile + - mobile + example: "mobile" type: string x-enum-varnames: - - MOBILE + - MOBILE SyntheticsMobileTestsMobileApplication: description: Mobile application for mobile synthetics test. properties: applicationId: description: Application ID of the mobile application. - example: 00000000-0000-0000-0000-aaaaaaaaaaaa + example: "00000000-0000-0000-0000-aaaaaaaaaaaa" maxLength: 1500 type: string referenceId: description: Reference ID of the mobile application. - example: 00000000-0000-0000-0000-aaaaaaaaaaab + example: "00000000-0000-0000-0000-aaaaaaaaaaab" maxLength: 1500 type: string referenceType: - $ref: '#/components/schemas/SyntheticsMobileTestsMobileApplicationReferenceType' + $ref: "#/components/schemas/SyntheticsMobileTestsMobileApplicationReferenceType" required: - - applicationId - - referenceId - - referenceType + - applicationId + - referenceId + - referenceType type: object SyntheticsMobileTestsMobileApplicationReferenceType: - description: Reference type for the mobile application for a mobile synthetics - test. + description: Reference type for the mobile application for a mobile synthetics test. enum: - - latest - - version + - latest + - version example: latest type: string x-enum-varnames: - - LATEST - - VERSION + - LATEST + - VERSION SyntheticsParsingOptions: description: Parsing options for variables to extract. example: {} properties: field: - description: When type is `http_header` or `grpc_metadata`, name of the - header or metadatum to extract. - example: content-type + description: When type is `http_header` or `grpc_metadata`, name of the header or metadatum to extract. + example: "content-type" type: string name: description: Name of the variable to extract. type: string parser: - $ref: '#/components/schemas/SyntheticsVariableParser' + $ref: "#/components/schemas/SyntheticsVariableParser" secure: description: Determines whether or not the extracted value will be obfuscated. type: boolean type: - $ref: '#/components/schemas/SyntheticsLocalVariableParsingOptionsType' + $ref: "#/components/schemas/SyntheticsLocalVariableParsingOptionsType" type: object SyntheticsPatchTestBody: - description: Wrapper around an array of [JSON Patch](https://jsonpatch.com) - operations to perform on the test + description: Wrapper around an array of [JSON Patch](https://jsonpatch.com) operations to perform on the test properties: data: - description: Array of [JSON Patch](https://jsonpatch.com) operations to - perform on the test - example: - - op: replace - path: /name - value: New test name - - op: remove - path: /config/assertions/0 + description: Array of [JSON Patch](https://jsonpatch.com) operations to perform on the test + example: [{"op": "replace", "path": "/name", "value": "New test name"}, {"op": "remove", "path": "/config/assertions/0"}] items: - $ref: '#/components/schemas/SyntheticsPatchTestOperation' + $ref: "#/components/schemas/SyntheticsPatchTestOperation" type: array type: object SyntheticsPatchTestOperation: - description: A single [JSON Patch](https://jsonpatch.com) operation to perform - on the test + description: A single [JSON Patch](https://jsonpatch.com) operation to perform on the test properties: op: - $ref: '#/components/schemas/SyntheticsPatchTestOperationName' + $ref: "#/components/schemas/SyntheticsPatchTestOperationName" path: description: The path to the value to modify example: /name type: string value: description: A value to use in a [JSON Patch](https://jsonpatch.com) operation - example: New Test Name + example: "New Test Name" type: object SyntheticsPatchTestOperationName: description: The operation to perform enum: - - add - - remove - - replace - - move - - copy - - test + - add + - remove + - replace + - move + - copy + - test example: replace type: string x-enum-varnames: - - ADD - - REMOVE - - REPLACE - - MOVE - - COPY - - TEST + - ADD + - REMOVE + - REPLACE + - MOVE + - COPY + - TEST SyntheticsPlayingTab: description: Navigate between different tabs for your browser test. enum: - - -1 - - 0 - - 1 - - 2 - - 3 + - -1 + - 0 + - 1 + - 2 + - 3 format: int64 type: integer x-enum-varnames: - - MAIN_TAB - - NEW_TAB - - TAB_1 - - TAB_2 - - TAB_3 + - MAIN_TAB + - NEW_TAB + - TAB_1 + - TAB_2 + - TAB_3 SyntheticsPrivateLocation: description: Object containing information about the private location to create. properties: @@ -18160,39 +16824,36 @@ components: readOnly: true type: string metadata: - $ref: '#/components/schemas/SyntheticsPrivateLocationMetadata' + $ref: "#/components/schemas/SyntheticsPrivateLocationMetadata" name: description: Name of the private location. example: New private location type: string secrets: - $ref: '#/components/schemas/SyntheticsPrivateLocationSecrets' + $ref: "#/components/schemas/SyntheticsPrivateLocationSecrets" tags: description: Array of tags attached to the private location. - example: - - team:front + example: ["team:front"] items: description: A tag attached to the private location. - example: team:front + example: "team:front" type: string type: array required: - - name - - description - - tags + - name + - description + - tags type: object SyntheticsPrivateLocationCreationResponse: - description: Object that contains the new private location, the public key for - result encryption, and the configuration skeleton. + description: Object that contains the new private location, the public key for result encryption, and the configuration skeleton. properties: config: - description: Configuration skeleton for the private location. See installation - instructions of the private location on how to use this configuration. + description: Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration. type: object private_location: - $ref: '#/components/schemas/SyntheticsPrivateLocation' + $ref: "#/components/schemas/SyntheticsPrivateLocation" result_encryption: - $ref: '#/components/schemas/SyntheticsPrivateLocationCreationResponseResultEncryption' + $ref: "#/components/schemas/SyntheticsPrivateLocationCreationResponseResultEncryption" type: object SyntheticsPrivateLocationCreationResponseResultEncryption: description: Public key for the result encryption. @@ -18208,16 +16869,15 @@ components: description: Object containing metadata about the private location. properties: restricted_roles: - $ref: '#/components/schemas/SyntheticsRestrictedRoles' + $ref: "#/components/schemas/SyntheticsRestrictedRoles" type: object SyntheticsPrivateLocationSecrets: - description: Secrets for the private location. Only present in the response - when creating the private location. + description: Secrets for the private location. Only present in the response when creating the private location. properties: authentication: - $ref: '#/components/schemas/SyntheticsPrivateLocationSecretsAuthentication' + $ref: "#/components/schemas/SyntheticsPrivateLocationSecretsAuthentication" config_decryption: - $ref: '#/components/schemas/SyntheticsPrivateLocationSecretsConfigDecryption' + $ref: "#/components/schemas/SyntheticsPrivateLocationSecretsConfigDecryption" readOnly: true type: object SyntheticsPrivateLocationSecretsAuthentication: @@ -18242,11 +16902,8 @@ components: type: object SyntheticsRestrictedRoles: deprecated: true - description: A list of role identifiers that can be pulled from the Roles API, - for restricting read and write access. This field is deprecated. Use the restriction - policies API to manage permissions. - example: - - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + description: A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions. + example: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] items: description: UUID for a role. example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx @@ -18275,7 +16932,7 @@ components: description: SHA-1 digest of the DER-encoded Certificate information. type: string issuer: - $ref: '#/components/schemas/SyntheticsSSLCertificateIssuer' + $ref: "#/components/schemas/SyntheticsSSLCertificateIssuer" modulus: description: Modulus associated to the SSL certificate private key. type: string @@ -18286,7 +16943,7 @@ components: description: Serial Number assigned by Symantec to the SSL certificate. type: string subject: - $ref: '#/components/schemas/SyntheticsSSLCertificateSubject' + $ref: "#/components/schemas/SyntheticsSSLCertificateSubject" validFrom: description: Date from which the SSL certificate is valid. format: date-time @@ -18350,15 +17007,13 @@ components: description: A boolean set to allow this step to fail. type: boolean alwaysExecute: - description: A boolean set to always execute this step even if the previous - step failed or was skipped. + description: A boolean set to always execute this step even if the previous step failed or was skipped. type: boolean exitIfSucceed: description: A boolean set to exit the test if the step succeeds. type: boolean isCritical: - description: A boolean to use in addition to `allowFailure` to determine - if the test should be marked as failed when the step fails. + description: A boolean to use in addition to `allowFailure` to determine if the test should be marked as failed when the step fails. type: boolean name: description: The name of the step. @@ -18377,7 +17032,7 @@ components: format: int64 type: integer type: - $ref: '#/components/schemas/SyntheticsStepType' + $ref: "#/components/schemas/SyntheticsStepType" type: object SyntheticsStepDetail: description: Object describing a step for a Synthetic test. @@ -18388,10 +17043,10 @@ components: browserErrors: description: Array of errors collected for a browser test. items: - $ref: '#/components/schemas/SyntheticsBrowserError' + $ref: "#/components/schemas/SyntheticsBrowserError" type: array checkType: - $ref: '#/components/schemas/SyntheticsCheckType' + $ref: "#/components/schemas/SyntheticsCheckType" description: description: Description of the test. type: string @@ -18403,9 +17058,9 @@ components: description: Error returned by the test. type: string failure: - $ref: '#/components/schemas/SyntheticsBrowserTestResultFailure' + $ref: "#/components/schemas/SyntheticsBrowserTestResultFailure" playingTab: - $ref: '#/components/schemas/SyntheticsPlayingTab' + $ref: "#/components/schemas/SyntheticsPlayingTab" screenshotBucketKey: description: Whether or not screenshots where collected by the test. type: boolean @@ -18420,18 +17075,18 @@ components: format: int64 type: integer subTestStepDetails: - description: 'If this step includes a sub-test. - - [Subtests documentation](https://docs.datadoghq.com/synthetics/browser_tests/advanced_options/#subtests).' + description: |- + If this step includes a sub-test. + [Subtests documentation](https://docs.datadoghq.com/synthetics/browser_tests/advanced_options/#subtests). items: - $ref: '#/components/schemas/SyntheticsStepDetail' + $ref: "#/components/schemas/SyntheticsStepDetail" type: array timeToInteractive: description: Time before starting the step. format: double type: number type: - $ref: '#/components/schemas/SyntheticsStepType' + $ref: "#/components/schemas/SyntheticsStepType" url: description: URL to perform the step against. type: string @@ -18440,12 +17095,12 @@ components: vitalsMetrics: description: Array of Core Web Vitals metrics for the step. items: - $ref: '#/components/schemas/SyntheticsCoreWebVitals' + $ref: "#/components/schemas/SyntheticsCoreWebVitals" type: array warnings: description: Warning collected that didn't failed the step. items: - $ref: '#/components/schemas/SyntheticsStepDetailWarning' + $ref: "#/components/schemas/SyntheticsStepDetailWarning" type: array type: object SyntheticsStepDetailWarning: @@ -18453,127 +17108,125 @@ components: properties: message: description: Message for the warning. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/SyntheticsWarningType' + $ref: "#/components/schemas/SyntheticsWarningType" required: - - message - - type + - message + - type type: object SyntheticsStepType: description: Step type used in your Synthetic test. enum: - - assertCurrentUrl - - assertElementAttribute - - assertElementContent - - assertElementPresent - - assertEmail - - assertFileDownload - - assertFromJavascript - - assertPageContains - - assertPageLacks - - assertRequests - - click - - extractFromJavascript - - extractFromEmailBody - - extractVariable - - goToEmailLink - - goToUrl - - goToUrlAndMeasureTti - - hover - - playSubTest - - pressKey - - refresh - - runApiTest - - scroll - - selectOption - - typeText - - uploadFiles - - wait + - assertCurrentUrl + - assertElementAttribute + - assertElementContent + - assertElementPresent + - assertEmail + - assertFileDownload + - assertFromJavascript + - assertPageContains + - assertPageLacks + - assertRequests + - click + - extractFromJavascript + - extractFromEmailBody + - extractVariable + - goToEmailLink + - goToUrl + - goToUrlAndMeasureTti + - hover + - playSubTest + - pressKey + - refresh + - runApiTest + - scroll + - selectOption + - typeText + - uploadFiles + - wait example: assertElementContent type: string x-enum-varnames: - - ASSERT_CURRENT_URL - - ASSERT_ELEMENT_ATTRIBUTE - - ASSERT_ELEMENT_CONTENT - - ASSERT_ELEMENT_PRESENT - - ASSERT_EMAIL - - ASSERT_FILE_DOWNLOAD - - ASSERT_FROM_JAVASCRIPT - - ASSERT_PAGE_CONTAINS - - ASSERT_PAGE_LACKS - - ASSERT_REQUESTS - - CLICK - - EXTRACT_FROM_JAVASCRIPT - - EXTRACT_FROM_EMAIL_BODY - - EXTRACT_VARIABLE - - GO_TO_EMAIL_LINK - - GO_TO_URL - - GO_TO_URL_AND_MEASURE_TTI - - HOVER - - PLAY_SUB_TEST - - PRESS_KEY - - REFRESH - - RUN_API_TEST - - SCROLL - - SELECT_OPTION - - TYPE_TEXT - - UPLOAD_FILES - - WAIT + - ASSERT_CURRENT_URL + - ASSERT_ELEMENT_ATTRIBUTE + - ASSERT_ELEMENT_CONTENT + - ASSERT_ELEMENT_PRESENT + - ASSERT_EMAIL + - ASSERT_FILE_DOWNLOAD + - ASSERT_FROM_JAVASCRIPT + - ASSERT_PAGE_CONTAINS + - ASSERT_PAGE_LACKS + - ASSERT_REQUESTS + - CLICK + - EXTRACT_FROM_JAVASCRIPT + - EXTRACT_FROM_EMAIL_BODY + - EXTRACT_VARIABLE + - GO_TO_EMAIL_LINK + - GO_TO_URL + - GO_TO_URL_AND_MEASURE_TTI + - HOVER + - PLAY_SUB_TEST + - PRESS_KEY + - REFRESH + - RUN_API_TEST + - SCROLL + - SELECT_OPTION + - TYPE_TEXT + - UPLOAD_FILES + - WAIT SyntheticsTestCallType: description: The type of gRPC call to perform. enum: - - healthcheck - - unary + - healthcheck + - unary example: unary type: string x-enum-varnames: - - HEALTHCHECK - - UNARY + - HEALTHCHECK + - UNARY SyntheticsTestCiOptions: description: CI/CD options for a Synthetic test. properties: executionRule: - $ref: '#/components/schemas/SyntheticsTestExecutionRule' + $ref: "#/components/schemas/SyntheticsTestExecutionRule" required: - - executionRule + - executionRule type: object SyntheticsTestConfig: description: Configuration object for a Synthetic test. properties: assertions: default: [] - description: Array of assertions used for the test. Required for single - API tests. + description: Array of assertions used for the test. Required for single API tests. example: [] items: - $ref: '#/components/schemas/SyntheticsAssertion' + $ref: "#/components/schemas/SyntheticsAssertion" type: array configVariables: description: Array of variables used for the test. items: - $ref: '#/components/schemas/SyntheticsConfigVariable' + $ref: "#/components/schemas/SyntheticsConfigVariable" type: array request: - $ref: '#/components/schemas/SyntheticsTestRequest' + $ref: "#/components/schemas/SyntheticsTestRequest" variables: description: Browser tests only - array of variables used for the test steps. items: - $ref: '#/components/schemas/SyntheticsBrowserVariable' + $ref: "#/components/schemas/SyntheticsBrowserVariable" type: array type: object SyntheticsTestDetails: description: Object containing details about your Synthetic test. properties: config: - $ref: '#/components/schemas/SyntheticsTestConfig' + $ref: "#/components/schemas/SyntheticsTestConfig" creator: - $ref: '#/components/schemas/Creator' + $ref: "#/components/schemas/Creator" locations: description: Array of locations used to run the test. - example: - - aws:eu-west-3 + example: ["aws:eu-west-3"] items: description: A location from which the test was run. type: string @@ -18590,20 +17243,20 @@ components: description: Name of the test. type: string options: - $ref: '#/components/schemas/SyntheticsTestOptions' + $ref: "#/components/schemas/SyntheticsTestOptions" public_id: description: The test public ID. readOnly: true type: string status: - $ref: '#/components/schemas/SyntheticsTestPauseStatus' + $ref: "#/components/schemas/SyntheticsTestPauseStatus" steps: description: The steps of the test if they exist. items: - $ref: '#/components/schemas/SyntheticsStep' + $ref: "#/components/schemas/SyntheticsStep" type: array subtype: - $ref: '#/components/schemas/SyntheticsTestDetailsSubType' + $ref: "#/components/schemas/SyntheticsTestDetailsSubType" tags: description: Array of tags attached to the test. items: @@ -18611,59 +17264,57 @@ components: type: string type: array type: - $ref: '#/components/schemas/SyntheticsTestDetailsType' + $ref: "#/components/schemas/SyntheticsTestDetailsType" type: object SyntheticsTestDetailsSubType: - description: 'The subtype of the Synthetic API test, `http`, `ssl`, `tcp`, - - `dns`, `icmp`, `udp`, `websocket`, `grpc` or `multi`.' - enum: - - http - - ssl - - tcp - - dns - - multi - - icmp - - udp - - websocket - - grpc + description: |- + The subtype of the Synthetic API test, `http`, `ssl`, `tcp`, + `dns`, `icmp`, `udp`, `websocket`, `grpc` or `multi`. + enum: + - http + - ssl + - tcp + - dns + - multi + - icmp + - udp + - websocket + - grpc example: http type: string x-enum-varnames: - - HTTP - - SSL - - TCP - - DNS - - MULTI - - ICMP - - UDP - - WEBSOCKET - - GRPC + - HTTP + - SSL + - TCP + - DNS + - MULTI + - ICMP + - UDP + - WEBSOCKET + - GRPC SyntheticsTestDetailsType: description: Type of the Synthetic test. enum: - - api - - browser - - mobile - - network + - api + - browser + - mobile + - network type: string x-enum-varnames: - - API - - BROWSER - - MOBILE - - NETWORK + - API + - BROWSER + - MOBILE + - NETWORK SyntheticsTestDetailsWithoutSteps: - description: Object containing details about your Synthetic test, without test - steps. + description: Object containing details about your Synthetic test, without test steps. properties: config: - $ref: '#/components/schemas/SyntheticsTestConfig' + $ref: "#/components/schemas/SyntheticsTestConfig" creator: - $ref: '#/components/schemas/Creator' + $ref: "#/components/schemas/Creator" locations: description: Array of locations used to run the test. - example: - - aws:eu-west-3 + example: ["aws:eu-west-3"] items: description: A location from which the test was run. type: string @@ -18680,15 +17331,15 @@ components: description: Name of the test. type: string options: - $ref: '#/components/schemas/SyntheticsTestOptions' + $ref: "#/components/schemas/SyntheticsTestOptions" public_id: description: The test public ID. readOnly: true type: string status: - $ref: '#/components/schemas/SyntheticsTestPauseStatus' + $ref: "#/components/schemas/SyntheticsTestPauseStatus" subtype: - $ref: '#/components/schemas/SyntheticsTestDetailsSubType' + $ref: "#/components/schemas/SyntheticsTestDetailsSubType" tags: description: Array of tags attached to the test. items: @@ -18696,20 +17347,20 @@ components: type: string type: array type: - $ref: '#/components/schemas/SyntheticsTestDetailsType' + $ref: "#/components/schemas/SyntheticsTestDetailsType" type: object SyntheticsTestExecutionRule: description: Execution rule for a Synthetic test. enum: - - blocking - - non_blocking - - skipped + - blocking + - non_blocking + - skipped example: blocking type: string x-enum-varnames: - - BLOCKING - - NON_BLOCKING - - SKIPPED + - BLOCKING + - NON_BLOCKING + - SKIPPED SyntheticsTestHeaders: additionalProperties: description: A single Header. @@ -18723,34 +17374,31 @@ components: description: Metadata to include when performing the gRPC test. type: object SyntheticsTestMonitorStatus: - description: 'The status of your Synthetic monitor. - + description: |- + The status of your Synthetic monitor. * `O` for not triggered - * `1` for triggered - - * `2` for no data' + * `2` for no data enum: - - 0 - - 1 - - 2 + - 0 + - 1 + - 2 format: int64 type: integer x-enum-varnames: - - UNTRIGGERED - - TRIGGERED - - NO_DATA + - UNTRIGGERED + - TRIGGERED + - NO_DATA SyntheticsTestOptions: description: Object describing the extra options for a Synthetic test. properties: accept_self_signed: - description: 'For SSL tests, whether or not the test should allow self signed - - certificates.' + description: |- + For SSL tests, whether or not the test should allow self signed + certificates. type: boolean allow_insecure: - description: Allows loading insecure content for an HTTP request in an API - test. + description: Allows loading insecure content for an HTTP request in an API test. type: boolean blockedRequestPatterns: description: Array of URL patterns to block. @@ -18758,20 +17406,19 @@ components: type: string type: array checkCertificateRevocation: - description: For SSL tests, whether or not the test should fail on revoked - certificate in stapled OCSP. + description: |- + For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP. type: boolean ci: - $ref: '#/components/schemas/SyntheticsTestCiOptions' + $ref: "#/components/schemas/SyntheticsTestCiOptions" device_ids: - description: For browser test, array with the different device IDs used - to run the test. + description: For browser test, array with the different device IDs used to run the test. items: - $ref: '#/components/schemas/SyntheticsDeviceID' + $ref: "#/components/schemas/SyntheticsDeviceID" type: array disableAiaIntermediateFetching: - description: For SSL tests, whether or not the test should disable fetching - intermediate certificates from AIA. + description: |- + For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA. type: boolean disableCors: description: Whether or not to disable CORS mechanism. @@ -18784,20 +17431,18 @@ components: type: boolean enableSecurityTesting: deprecated: true - description: Enable security testing for browser tests. Security testing - is not available anymore. This field is deprecated and won't be used. + description: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used. type: boolean follow_redirects: description: For API HTTP test, whether or not the test should follow redirects. type: boolean httpVersion: - $ref: '#/components/schemas/SyntheticsTestOptionsHTTPVersion' + $ref: "#/components/schemas/SyntheticsTestOptionsHTTPVersion" ignoreServerCertificateError: description: Ignore server certificate error for browser tests. type: boolean initialNavigationTimeout: - description: Timeout before declaring the initial step as failed (in seconds) - for browser tests. + description: Timeout before declaring the initial step as failed (in seconds) for browser tests. format: int64 type: integer min_failure_duration: @@ -18805,17 +17450,16 @@ components: format: int64 type: integer min_location_failed: - description: 'Minimum number of locations in failure required to trigger - - an alert.' + description: |- + Minimum number of locations in failure required to trigger + an alert. format: int64 type: integer monitor_name: - description: The monitor name is used for the alert title as well as for - all monitor dashboard widgets and SLOs. + description: The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs. type: string monitor_options: - $ref: '#/components/schemas/SyntheticsTestOptionsMonitorOptions' + $ref: "#/components/schemas/SyntheticsTestOptionsMonitorOptions" monitor_priority: description: Integer from 1 (high) to 5 (low) indicating alert severity. format: int32 @@ -18826,13 +17470,13 @@ components: description: Prevents saving screenshots of the steps. type: boolean restricted_roles: - $ref: '#/components/schemas/SyntheticsRestrictedRoles' + $ref: "#/components/schemas/SyntheticsRestrictedRoles" retry: - $ref: '#/components/schemas/SyntheticsTestOptionsRetry' + $ref: "#/components/schemas/SyntheticsTestOptionsRetry" rumSettings: - $ref: '#/components/schemas/SyntheticsBrowserTestRumSettings' + $ref: "#/components/schemas/SyntheticsBrowserTestRumSettings" scheduling: - $ref: '#/components/schemas/SyntheticsTestOptionsScheduling' + $ref: "#/components/schemas/SyntheticsTestOptionsScheduling" tick_every: description: The frequency at which to run the Synthetic test (in seconds). format: int64 @@ -18843,28 +17487,28 @@ components: SyntheticsTestOptionsHTTPVersion: description: HTTP version to use for a Synthetic test. enum: - - http1 - - http2 - - any + - http1 + - http2 + - any type: string x-enum-varnames: - - HTTP1 - - HTTP2 - - ANY + - HTTP1 + - HTTP2 + - ANY SyntheticsTestOptionsMonitorOptions: - description: 'Object containing the options for a Synthetic test as a monitor - - (for example, renotification).' + description: |- + Object containing the options for a Synthetic test as a monitor + (for example, renotification). properties: escalation_message: description: Message to include in the escalation notification. type: string notification_preset_name: - $ref: '#/components/schemas/SyntheticsTestOptionsMonitorOptionsNotificationPresetName' + $ref: "#/components/schemas/SyntheticsTestOptionsMonitorOptionsNotificationPresetName" renotify_interval: - description: 'Time interval before renotifying if the test is still failing - - (in minutes).' + description: |- + Time interval before renotifying if the test is still failing + (in minutes). format: int64 minimum: 0 type: integer @@ -18876,37 +17520,35 @@ components: SyntheticsTestOptionsMonitorOptionsNotificationPresetName: description: The name of the preset for the notification for the monitor. enum: - - show_all - - hide_all - - hide_query - - hide_handles - - hide_query_and_handles - - show_only_snapshot - - hide_handles_and_footer - type: string - x-enum-varnames: - - SHOW_ALL - - HIDE_ALL - - HIDE_QUERY - - HIDE_HANDLES - - HIDE_QUERY_AND_HANDLES - - SHOW_ONLY_SNAPSHOT - - HIDE_HANDLES_AND_FOOTER + - show_all + - hide_all + - hide_query + - hide_handles + - hide_query_and_handles + - show_only_snapshot + - hide_handles_and_footer + type: string + x-enum-varnames: + - SHOW_ALL + - HIDE_ALL + - HIDE_QUERY + - HIDE_HANDLES + - HIDE_QUERY_AND_HANDLES + - SHOW_ONLY_SNAPSHOT + - HIDE_HANDLES_AND_FOOTER SyntheticsTestOptionsRetry: description: Object describing the retry strategy to apply to a Synthetic test. properties: count: - description: 'Number of times a test needs to be retried before marking - a - - location as failed. Defaults to 0.' + description: |- + Number of times a test needs to be retried before marking a + location as failed. Defaults to 0. format: int64 type: integer interval: - description: 'Time interval between retries (in milliseconds). Defaults - to - - 300ms.' + description: |- + Time interval between retries (in milliseconds). Defaults to + 300ms. format: double type: number type: object @@ -18914,25 +17556,18 @@ components: description: Object containing timeframes and timezone used for advanced scheduling. properties: timeframes: - description: Array containing objects describing the scheduling pattern - to apply to each day. - example: - - day: 1 - from: 07:00 - to: '16:00' - - day: 3 - from: 07:00 - to: '16:00' + description: Array containing objects describing the scheduling pattern to apply to each day. + example: [{"day": 1, "from": "07:00", "to": "16:00"}, {"day": 3, "from": "07:00", "to": "16:00"}] items: - $ref: '#/components/schemas/SyntheticsTestOptionsSchedulingTimeframe' + $ref: "#/components/schemas/SyntheticsTestOptionsSchedulingTimeframe" type: array timezone: description: Timezone in which the timeframe is based. - example: America/New_York + example: "America/New_York" type: string required: - - timeframes - - timezone + - timeframes + - timezone type: object SyntheticsTestOptionsSchedulingTimeframe: description: Object describing a timeframe. @@ -18946,96 +17581,90 @@ components: type: integer from: description: The hour of the day on which scheduling starts. - example: 07:00 + example: "07:00" type: string to: description: The hour of the day on which scheduling ends. - example: '16:00' + example: "16:00" type: string required: - - day - - from - - to + - day + - from + - to type: object SyntheticsTestPauseStatus: - description: 'Define whether you want to start (`live`) or pause (`paused`) - a - - Synthetic test.' + description: |- + Define whether you want to start (`live`) or pause (`paused`) a + Synthetic test. enum: - - live - - paused + - live + - paused example: live type: string x-enum-varnames: - - LIVE - - PAUSED + - LIVE + - PAUSED SyntheticsTestProcessStatus: description: Status of a Synthetic test. enum: - - not_scheduled - - scheduled - - finished - - finished_with_error + - not_scheduled + - scheduled + - finished + - finished_with_error type: string x-enum-varnames: - - NOT_SCHEDULED - - SCHEDULED - - FINISHED - - FINISHED_WITH_ERROR + - NOT_SCHEDULED + - SCHEDULED + - FINISHED + - FINISHED_WITH_ERROR SyntheticsTestRequest: description: Object describing the Synthetic test request. properties: allow_insecure: - description: Allows loading insecure content for an HTTP request in a multistep - test step. + description: Allows loading insecure content for an HTTP request in a multistep test step. type: boolean basicAuth: - $ref: '#/components/schemas/SyntheticsBasicAuth' + $ref: "#/components/schemas/SyntheticsBasicAuth" body: description: Body to include in the test. type: string bodyType: - $ref: '#/components/schemas/SyntheticsTestRequestBodyType' + $ref: "#/components/schemas/SyntheticsTestRequestBodyType" callType: - $ref: '#/components/schemas/SyntheticsTestCallType' + $ref: "#/components/schemas/SyntheticsTestCallType" certificate: - $ref: '#/components/schemas/SyntheticsTestRequestCertificate' + $ref: "#/components/schemas/SyntheticsTestRequestCertificate" certificateDomains: default: [] - description: By default, the client certificate is applied on the domain - of the starting URL for browser tests. If you want your client certificate - to be applied on other domains instead, add them in `certificateDomains`. + description: By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in `certificateDomains`. items: description: Domain to apply the client certificate. - example: '' + example: "" type: string type: array checkCertificateRevocation: description: Check for certificate revocation. type: boolean compressedJsonDescriptor: - description: A protobuf JSON descriptor that needs to be gzipped first then - base64 encoded. + description: A protobuf JSON descriptor that needs to be gzipped first then base64 encoded. type: string compressedProtoFile: - description: A protobuf file that needs to be gzipped first then base64 - encoded. + description: A protobuf file that needs to be gzipped first then base64 encoded. type: string disableAiaIntermediateFetching: - description: Disable fetching intermediate certificates from AIA. + description: |- + Disable fetching intermediate certificates from AIA. type: boolean dnsServer: description: DNS server to use for DNS tests. type: string dnsServerPort: - $ref: '#/components/schemas/SyntheticsTestRequestDNSServerPort' + $ref: "#/components/schemas/SyntheticsTestRequestDNSServerPort" description: DNS server port to use for DNS tests. files: - description: Files to be used as part of the request in the test. Only valid - if `bodyType` is `multipart/form-data`. + description: Files to be used as part of the request in the test. Only valid if `bodyType` is `multipart/form-data`. items: - $ref: '#/components/schemas/SyntheticsTestRequestBodyFile' + $ref: "#/components/schemas/SyntheticsTestRequestBodyFile" type: array follow_redirects: description: Specifies whether or not the request follows redirects. @@ -19044,16 +17673,15 @@ components: additionalProperties: description: A single form entry. type: string - description: Form to be used as part of the request in the test. Only valid - if `bodyType` is `multipart/form-data`. + description: Form to be used as part of the request in the test. Only valid if `bodyType` is `multipart/form-data`. type: object headers: - $ref: '#/components/schemas/SyntheticsTestHeaders' + $ref: "#/components/schemas/SyntheticsTestHeaders" host: description: Host name to perform the test with. type: string httpVersion: - $ref: '#/components/schemas/SyntheticsTestOptionsHTTPVersion' + $ref: "#/components/schemas/SyntheticsTestOptionsHTTPVersion" isMessageBase64Encoded: description: Whether the message is base64 encoded. type: boolean @@ -19061,11 +17689,9 @@ components: description: Message to send for UDP or WebSocket tests. type: string metadata: - $ref: '#/components/schemas/SyntheticsTestMetadata' + $ref: "#/components/schemas/SyntheticsTestMetadata" method: - description: Either the HTTP method/verb to use or a gRPC method available - on the service set in the `service` field. Required if `subtype` is `HTTP` - or if `subtype` is `grpc` and `callType` is `unary`. + description: Either the HTTP method/verb to use or a gRPC method available on the service set in the `service` field. Required if `subtype` is `HTTP` or if `subtype` is `grpc` and `callType` is `unary`. type: string noSavingResponseBody: description: Determines whether or not to save the response body. @@ -19080,27 +17706,24 @@ components: description: Persist cookies across redirects. type: boolean port: - $ref: '#/components/schemas/SyntheticsTestRequestPort' + $ref: "#/components/schemas/SyntheticsTestRequestPort" proxy: - $ref: '#/components/schemas/SyntheticsTestRequestProxy' + $ref: "#/components/schemas/SyntheticsTestRequestProxy" query: description: Query to use for the test. type: object servername: - description: 'For SSL tests, it specifies on which server you want to initiate - the TLS handshake, - + description: |- + For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on - - the same IP address and TCP port number.' + the same IP address and TCP port number. type: string service: description: The gRPC service on which you want to perform the gRPC call. example: Greeter type: string shouldTrackHops: - description: Turns on a traceroute probe to discover all gateways along - the path to the host destination. + description: Turns on a traceroute probe to discover all gateways along the path to the host destination. type: boolean timeout: description: Timeout in seconds for the test. @@ -19108,12 +17731,11 @@ components: type: number url: description: URL to perform the test with. - example: https://example.com + example: "https://example.com" type: string type: object SyntheticsTestRequestBodyFile: - description: Object describing a file to be used as part of the request in the - test. + description: Object describing a file to be used as part of the request in the test. properties: bucketKey: description: Bucket key of the file. @@ -19123,8 +17745,7 @@ components: maxLength: 3145728 type: string encoding: - description: Encoding of the file content. The only supported value is `base64`, - indicating the `content` field contains base64-encoded data. + description: Encoding of the file content. The only supported value is `base64`, indicating the `content` field contains base64-encoded data. type: string name: description: Name of the file. @@ -19148,32 +17769,32 @@ components: SyntheticsTestRequestBodyType: description: Type of the request body. enum: - - text/plain - - application/json - - text/xml - - text/html - - application/x-www-form-urlencoded - - graphql - - application/octet-stream - - multipart/form-data - example: text/plain - type: string - x-enum-varnames: - - TEXT_PLAIN - - APPLICATION_JSON - - TEXT_XML - - TEXT_HTML - - APPLICATION_X_WWW_FORM_URLENCODED - - GRAPHQL - - APPLICATION_OCTET_STREAM - - MULTIPART_FORM_DATA + - text/plain + - application/json + - text/xml + - text/html + - application/x-www-form-urlencoded + - graphql + - application/octet-stream + - multipart/form-data + example: "text/plain" + type: string + x-enum-varnames: + - TEXT_PLAIN + - APPLICATION_JSON + - TEXT_XML + - TEXT_HTML + - APPLICATION_X_WWW_FORM_URLENCODED + - GRAPHQL + - APPLICATION_OCTET_STREAM + - MULTIPART_FORM_DATA SyntheticsTestRequestCertificate: description: Client certificate to use when performing the test request. properties: cert: - $ref: '#/components/schemas/SyntheticsTestRequestCertificateItem' + $ref: "#/components/schemas/SyntheticsTestRequestCertificateItem" key: - $ref: '#/components/schemas/SyntheticsTestRequestCertificateItem' + $ref: "#/components/schemas/SyntheticsTestRequestCertificateItem" type: object SyntheticsTestRequestCertificateItem: description: Define a request certificate. @@ -19191,8 +17812,8 @@ components: SyntheticsTestRequestDNSServerPort: description: DNS server port to use for DNS tests. oneOf: - - $ref: '#/components/schemas/SyntheticsTestRequestNumericalDNSServerPort' - - $ref: '#/components/schemas/SyntheticsTestRequestVariableDNSServerPort' + - $ref: "#/components/schemas/SyntheticsTestRequestNumericalDNSServerPort" + - $ref: "#/components/schemas/SyntheticsTestRequestVariableDNSServerPort" SyntheticsTestRequestNumericalDNSServerPort: description: Integer DNS server port number to use when performing the test. format: int64 @@ -19204,35 +17825,33 @@ components: SyntheticsTestRequestPort: description: Port to use when performing the test. oneOf: - - $ref: '#/components/schemas/SyntheticsTestRequestNumericalPort' - - $ref: '#/components/schemas/SyntheticsTestRequestVariablePort' + - $ref: "#/components/schemas/SyntheticsTestRequestNumericalPort" + - $ref: "#/components/schemas/SyntheticsTestRequestVariablePort" SyntheticsTestRequestProxy: description: The proxy to perform the test. properties: headers: - $ref: '#/components/schemas/SyntheticsTestHeaders' + $ref: "#/components/schemas/SyntheticsTestHeaders" url: description: URL of the proxy to perform the test. - example: https://example.com + example: "https://example.com" type: string required: - - url + - url type: object SyntheticsTestRequestVariableDNSServerPort: - description: String DNS server port number to use when performing the test. - Supports templated variables. + description: String DNS server port number to use when performing the test. Supports templated variables. type: string SyntheticsTestRequestVariablePort: - description: String Port number to use when performing the test. Supports templated - variables. + description: String Port number to use when performing the test. Supports templated variables. type: string SyntheticsTestRestrictionPolicyBinding: description: Objects describing the binding used for a mobile test. properties: principals: - $ref: '#/components/schemas/SyntheticsTestRestrictionPolicyBindingPrincipals' + $ref: "#/components/schemas/SyntheticsTestRestrictionPolicyBindingPrincipals" relation: - $ref: '#/components/schemas/SyntheticsTestRestrictionPolicyBindingRelation' + $ref: "#/components/schemas/SyntheticsTestRestrictionPolicyBindingRelation" type: object SyntheticsTestRestrictionPolicyBindingPrincipals: description: List of principals for a mobile test binding. @@ -19244,24 +17863,25 @@ components: SyntheticsTestRestrictionPolicyBindingRelation: description: The type of relation for the binding. enum: - - editor - - viewer + - editor + - viewer type: string x-enum-varnames: - - EDITOR - - VIEWER + - EDITOR + - VIEWER SyntheticsTestUptime: - description: Object containing the uptime for a Synthetic test ID. + description: |- + Object containing the uptime for a Synthetic test ID. properties: from_ts: description: Timestamp in seconds for the start of uptime. format: int64 type: integer overall: - $ref: '#/components/schemas/SyntheticsUptime' + $ref: "#/components/schemas/SyntheticsUptime" public_id: description: A Synthetic test ID. - example: abc-def-123 + example: "abc-def-123" type: string to_ts: description: Timestamp in seconds for the end of uptime. @@ -19269,10 +17889,9 @@ components: type: integer type: object SyntheticsTiming: - description: 'Object containing all metrics and their values collected for a - Synthetic API test. - - See the [Synthetic Monitoring Metrics documentation](https://docs.datadoghq.com/synthetics/metrics/).' + description: |- + Object containing all metrics and their values collected for a Synthetic API test. + See the [Synthetic Monitoring Metrics documentation](https://docs.datadoghq.com/synthetics/metrics/). properties: dns: description: The duration in millisecond of the DNS lookup. @@ -19317,10 +17936,10 @@ components: tests: description: List of Synthetic tests. items: - $ref: '#/components/schemas/SyntheticsTriggerTest' + $ref: "#/components/schemas/SyntheticsTriggerTest" type: array required: - - tests + - tests type: object SyntheticsTriggerCITestLocation: description: Synthetic location. @@ -19337,7 +17956,7 @@ components: description: Information about a single test run. properties: device: - $ref: '#/components/schemas/SyntheticsDeviceID' + $ref: "#/components/schemas/SyntheticsDeviceID" location: description: The location ID of the test run. format: int64 @@ -19359,12 +17978,12 @@ components: locations: description: List of Synthetic locations. items: - $ref: '#/components/schemas/SyntheticsTriggerCITestLocation' + $ref: "#/components/schemas/SyntheticsTriggerCITestLocation" type: array results: description: Information about the tests runs. items: - $ref: '#/components/schemas/SyntheticsTriggerCITestRunResult' + $ref: "#/components/schemas/SyntheticsTriggerCITestRunResult" type: array triggered_check_ids: description: The public IDs of the Synthetic test triggered. @@ -19377,58 +17996,48 @@ components: description: Test configuration for Synthetics properties: metadata: - $ref: '#/components/schemas/SyntheticsCIBatchMetadata' + $ref: "#/components/schemas/SyntheticsCIBatchMetadata" public_id: description: The public ID of the Synthetic test to trigger. example: aaa-aaa-aaa type: string required: - - public_id + - public_id type: object SyntheticsUpdateTestPauseStatusPayload: description: Object to start or pause an existing Synthetic test. properties: new_status: - $ref: '#/components/schemas/SyntheticsTestPauseStatus' + $ref: "#/components/schemas/SyntheticsTestPauseStatus" type: object SyntheticsUptime: - description: Object containing the uptime information. + description: |- + Object containing the uptime information. properties: errors: - description: An array of error objects returned while querying the history - data for the service level objective. + description: An array of error objects returned while querying the history data for the service level objective. items: - $ref: '#/components/schemas/SLOHistoryResponseErrorWithType' + $ref: "#/components/schemas/SLOHistoryResponseErrorWithType" nullable: true type: array group: description: The location name - example: name + example: "name" type: string history: - description: 'The state transition history for the monitor, represented - as an array of - - pairs. Each pair is an array where the first element is the transition - timestamp - + description: |- + The state transition history for the monitor, represented as an array of + pairs. Each pair is an array where the first element is the transition timestamp in Unix epoch format (integer) and the second element is the state (integer). - - For the state, an integer value of `0` indicates uptime, `1` indicates - downtime, - - and `2` indicates no data.' - example: - - - 1579212382 - - 0 + For the state, an integer value of `0` indicates uptime, `1` indicates downtime, + and `2` indicates no data. + example: [[1579212382, 0]] items: - description: An array of transitions - example: - - 1579212382 - - 0 + description: |- + An array of transitions + example: [1579212382, 0] items: - description: A timeseries data point which is a tuple of (timestamp, - value). + description: A timeseries data point which is a tuple of (timestamp, value). format: double type: number maxItems: 2 @@ -19436,8 +18045,7 @@ components: type: array type: array span_precision: - description: The number of decimal places to which the SLI value is accurate - for the given from-to timestamps. + description: The number of decimal places to which the SLI value is accurate for the given from-to timestamps. example: 2.0 format: double type: number @@ -19454,485 +18062,445 @@ components: value: .* properties: type: - $ref: '#/components/schemas/SyntheticsGlobalVariableParserType' + $ref: "#/components/schemas/SyntheticsGlobalVariableParserType" value: - description: Regex or JSON path used for the parser. Not used with type - `raw`. + description: Regex or JSON path used for the parser. Not used with type `raw`. type: string required: - - type + - type type: object SyntheticsWarningType: description: User locator used. enum: - - user_locator + - user_locator example: user_locator type: string x-enum-varnames: - - USER_LOCATOR + - USER_LOCATOR TableWidgetCellDisplayMode: description: Define a display mode for the table cell. enum: - - number - - bar - - trend + - number + - bar + - trend example: number type: string x-enum-varnames: - - NUMBER - - BAR - - TREND + - NUMBER + - BAR + - TREND TableWidgetDefinition: - description: The table visualization is available on timeboards and screenboards. - It displays columns of metrics grouped by tag key. + description: The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key. properties: custom_links: description: List of custom links. items: - $ref: '#/components/schemas/WidgetCustomLink' + $ref: "#/components/schemas/WidgetCustomLink" type: array has_search_bar: - $ref: '#/components/schemas/TableWidgetHasSearchBar' + $ref: "#/components/schemas/TableWidgetHasSearchBar" requests: description: Widget definition. - example: - - q/apm_query/log_query: {} + example: ["q/apm_query/log_query": "{}"] items: - $ref: '#/components/schemas/TableWidgetRequest' + $ref: "#/components/schemas/TableWidgetRequest" type: array time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/TableWidgetDefinitionType' + $ref: "#/components/schemas/TableWidgetDefinitionType" required: - - type - - requests + - type + - requests type: object TableWidgetDefinitionType: default: query_table description: Type of the table widget. enum: - - query_table + - query_table example: query_table type: string x-enum-varnames: - - QUERY_TABLE + - QUERY_TABLE TableWidgetHasSearchBar: description: Controls the display of the search bar. enum: - - always - - never - - auto + - always + - never + - auto example: auto type: string x-enum-varnames: - - ALWAYS - - NEVER - - AUTO + - ALWAYS + - NEVER + - AUTO TableWidgetRequest: description: Updated table widget. properties: aggregator: - $ref: '#/components/schemas/WidgetAggregator' + $ref: "#/components/schemas/WidgetAggregator" alias: description: The column name (defaults to the metric name). type: string apm_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. apm_stats_query: - $ref: '#/components/schemas/ApmStatsQueryDefinition' + $ref: "#/components/schemas/ApmStatsQueryDefinition" cell_display_mode: description: A list of display modes for each table cell. items: - $ref: '#/components/schemas/TableWidgetCellDisplayMode' + $ref: "#/components/schemas/TableWidgetCellDisplayMode" type: array conditional_formats: description: List of conditional formats. items: - $ref: '#/components/schemas/WidgetConditionalFormat' + $ref: "#/components/schemas/WidgetConditionalFormat" type: array event_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: - $ref: '#/components/schemas/WidgetFormula' + $ref: "#/components/schemas/WidgetFormula" type: array limit: - description: For metric queries, the number of lines to show in the table. - Only one request should have this property. + description: For metric queries, the number of lines to show in the table. Only one request should have this property. format: int64 type: integer log_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. order: - $ref: '#/components/schemas/WidgetSort' + $ref: "#/components/schemas/WidgetSort" process_query: - $ref: '#/components/schemas/ProcessQueryDefinition' + $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: deprecated: true - description: Query definition. Deprecated - Use `queries` and `formulas` - instead. + description: Query definition. Deprecated - Use `queries` and `formulas` instead. type: string queries: description: List of queries that can be returned directly or used in formulas. items: - $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition' + $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: - $ref: '#/components/schemas/FormulaAndFunctionResponseFormat' + $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" rum_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. sort: - $ref: '#/components/schemas/WidgetSortBy' + $ref: "#/components/schemas/WidgetSortBy" text_formats: description: List of text formats for columns produced by tags. items: - $ref: '#/components/schemas/TableWidgetTextFormat' + $ref: "#/components/schemas/TableWidgetTextFormat" type: array type: object TableWidgetTextFormat: description: Text format rules for a tag-based column within a table widget. - example: - - match: - type: is - value: fruit - replace: - type: all - with: vegetable - - match: - type: is - value: cake - palette: white_on_green + example: [{"match": {"type": "is", "value": "fruit"}, "replace": {"type": "all", "with": "vegetable"}}, {"match": {"type": "is", "value": "cake"}, "palette": "white_on_green"}] items: - $ref: '#/components/schemas/TableWidgetTextFormatRule' + $ref: "#/components/schemas/TableWidgetTextFormatRule" minItems: 1 type: array TableWidgetTextFormatMatch: description: Match rule for the table widget text format. - example: - type: is - value: fruit + example: {"type": "is", "value": "fruit"} properties: type: - $ref: '#/components/schemas/TableWidgetTextFormatMatchType' + $ref: "#/components/schemas/TableWidgetTextFormatMatchType" value: description: Table Widget Match String. - example: Match Value + example: "Match Value" type: string required: - - type - - value + - type + - value type: object TableWidgetTextFormatMatchType: description: Match or compare option. enum: - - is - - is_not - - contains - - does_not_contain - - starts_with - - ends_with + - is + - is_not + - contains + - does_not_contain + - starts_with + - ends_with example: is type: string x-enum-varnames: - - IS - - IS_NOT - - CONTAINS - - DOES_NOT_CONTAIN - - STARTS_WITH - - ENDS_WITH + - IS + - IS_NOT + - CONTAINS + - DOES_NOT_CONTAIN + - STARTS_WITH + - ENDS_WITH TableWidgetTextFormatPalette: default: white_on_green description: Color-on-color palette to highlight replaced text. enum: - - white_on_red - - white_on_yellow - - white_on_green - - black_on_light_red - - black_on_light_yellow - - black_on_light_green - - red_on_white - - yellow_on_white - - green_on_white - - custom_bg - - custom_text - type: string - x-enum-varnames: - - WHITE_ON_RED - - WHITE_ON_YELLOW - - WHITE_ON_GREEN - - BLACK_ON_LIGHT_RED - - BLACK_ON_LIGHT_YELLOW - - BLACK_ON_LIGHT_GREEN - - RED_ON_WHITE - - YELLOW_ON_WHITE - - GREEN_ON_WHITE - - CUSTOM_BG - - CUSTOM_TEXT + - white_on_red + - white_on_yellow + - white_on_green + - black_on_light_red + - black_on_light_yellow + - black_on_light_green + - red_on_white + - yellow_on_white + - green_on_white + - custom_bg + - custom_text + type: string + x-enum-varnames: + - WHITE_ON_RED + - WHITE_ON_YELLOW + - WHITE_ON_GREEN + - BLACK_ON_LIGHT_RED + - BLACK_ON_LIGHT_YELLOW + - BLACK_ON_LIGHT_GREEN + - RED_ON_WHITE + - YELLOW_ON_WHITE + - GREEN_ON_WHITE + - CUSTOM_BG + - CUSTOM_TEXT TableWidgetTextFormatReplace: description: Replace rule for the table widget text format. - example: - type: all - with: vegetable + example: {"type": "all", "with": "vegetable"} oneOf: - - $ref: '#/components/schemas/TableWidgetTextFormatReplaceAll' - - $ref: '#/components/schemas/TableWidgetTextFormatReplaceSubstring' + - $ref: "#/components/schemas/TableWidgetTextFormatReplaceAll" + - $ref: "#/components/schemas/TableWidgetTextFormatReplaceSubstring" TableWidgetTextFormatReplaceAll: description: Match All definition. - example: - type: all - with: vegetable + example: {"type": "all", "with": "vegetable"} properties: type: - $ref: '#/components/schemas/TableWidgetTextFormatReplaceAllType' + $ref: "#/components/schemas/TableWidgetTextFormatReplaceAllType" with: description: Replace All type. example: all type: string required: - - type - - with + - type + - with type: object TableWidgetTextFormatReplaceAllType: description: Table widget text format replace all type. enum: - - all + - all example: all type: string x-enum-varnames: - - ALL + - ALL TableWidgetTextFormatReplaceSubstring: description: Match Sub-string definition. - example: - substring: fruit - type: substring - with: vegetable + example: {"substring": "fruit", "type": "substring", "with": "vegetable"} properties: substring: description: Text that will be replaced. - example: string to replace + example: "string to replace" type: string type: - $ref: '#/components/schemas/TableWidgetTextFormatReplaceSubstringType' + $ref: "#/components/schemas/TableWidgetTextFormatReplaceSubstringType" with: description: Text that will replace original sub-string. - example: replacement + example: "replacement" type: string required: - - type - - with - - substring + - type + - with + - substring type: object TableWidgetTextFormatReplaceSubstringType: description: Table widget text format replace sub-string type. enum: - - substring + - substring example: substring type: string x-enum-varnames: - - SUBSTRING + - SUBSTRING TableWidgetTextFormatRule: description: Text format rules. - example: - match: - type: is - value: apple - replace: - type: all - with: vegetable + example: {"match": {"type": "is", "value": "apple"}, "replace": {"type": "all", "with": "vegetable"}} properties: custom_bg_color: - description: Hex representation of the custom background color. Used with - custom background palette option. - example: '#632ca6' + description: Hex representation of the custom background color. Used with custom background palette option. + example: "#632ca6" type: string custom_fg_color: - description: Hex representation of the custom text color. Used with custom - text palette option. - example: '#632ca6' + description: Hex representation of the custom text color. Used with custom text palette option. + example: "#632ca6" type: string match: - $ref: '#/components/schemas/TableWidgetTextFormatMatch' + $ref: "#/components/schemas/TableWidgetTextFormatMatch" palette: - $ref: '#/components/schemas/TableWidgetTextFormatPalette' + $ref: "#/components/schemas/TableWidgetTextFormatPalette" replace: - $ref: '#/components/schemas/TableWidgetTextFormatReplace' + $ref: "#/components/schemas/TableWidgetTextFormatReplace" required: - - match + - match type: object TagToHosts: - description: In this object, the key is the tag, and the value is a list of - host names that are reporting that tag. + description: In this object, the key is the tag, and the value is a list of host names that are reporting that tag. properties: tags: additionalProperties: description: A list of host names which contain this tag items: description: A given tag in a list. - example: test.metric.host + example: "test.metric.host" type: string type: array description: A mapping of tags to host names type: object type: object TargetFormatType: - description: 'If the `target_type` of the remapper is `attribute`, try to cast - the value to a new specific type. - - If the cast is not possible, the original type is kept. `string`, `integer`, - or `double` are the possible types. - - If the `target_type` is `tag`, this parameter may not be specified.' + description: |- + If the `target_type` of the remapper is `attribute`, try to cast the value to a new specific type. + If the cast is not possible, the original type is kept. `string`, `integer`, or `double` are the possible types. + If the `target_type` is `tag`, this parameter may not be specified. enum: - - auto - - string - - integer - - double + - auto + - string + - integer + - double type: string x-enum-varnames: - - AUTO - - STRING - - INTEGER - - DOUBLE + - AUTO + - STRING + - INTEGER + - DOUBLE TimeseriesBackground: description: Set a timeseries on the widget background. properties: type: - $ref: '#/components/schemas/TimeseriesBackgroundType' + $ref: "#/components/schemas/TimeseriesBackgroundType" yaxis: - $ref: '#/components/schemas/WidgetAxis' + $ref: "#/components/schemas/WidgetAxis" required: - - type + - type type: object TimeseriesBackgroundType: default: area description: Timeseries is made using an area or bars. enum: - - bars - - area + - bars + - area example: bars type: string x-enum-varnames: - - BARS - - AREA + - BARS + - AREA TimeseriesRequestStyle: description: Define request widget style for timeseries widgets. properties: has_value_labels: - description: If true, the value is displayed as a label relative to the - data point. + description: If true, the value is displayed as a label relative to the data point. type: boolean line_type: - $ref: '#/components/schemas/WidgetLineType' + $ref: "#/components/schemas/WidgetLineType" line_width: - $ref: '#/components/schemas/WidgetLineWidth' + $ref: "#/components/schemas/WidgetLineWidth" order_by: - $ref: '#/components/schemas/WidgetStyleOrderBy' + $ref: "#/components/schemas/WidgetStyleOrderBy" palette: description: Color palette to apply to the widget. type: string type: object TimeseriesWidgetDefinition: - description: The timeseries visualization allows you to display the evolution - of one or more metrics, log events, or Indexed Spans over time. + description: The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. properties: custom_links: description: List of custom links. items: - $ref: '#/components/schemas/WidgetCustomLink' + $ref: "#/components/schemas/WidgetCustomLink" type: array events: deprecated: true - description: List of widget events. Deprecated - Use `overlay` request type - instead. + description: List of widget events. Deprecated - Use `overlay` request type instead. items: - $ref: '#/components/schemas/WidgetEvent' + $ref: "#/components/schemas/WidgetEvent" type: array legend_columns: description: Columns displayed in the legend. items: - $ref: '#/components/schemas/TimeseriesWidgetLegendColumn' + $ref: "#/components/schemas/TimeseriesWidgetLegendColumn" type: array legend_layout: - $ref: '#/components/schemas/TimeseriesWidgetLegendLayout' + $ref: "#/components/schemas/TimeseriesWidgetLegendLayout" legend_size: - $ref: '#/components/schemas/WidgetLegendSize' + $ref: "#/components/schemas/WidgetLegendSize" markers: description: List of markers. items: - $ref: '#/components/schemas/WidgetMarker' + $ref: "#/components/schemas/WidgetMarker" type: array requests: description: List of timeseries widget requests. - example: - - q/apm_query/log_query: {} + example: ["q/apm_query/log_query": "{}"] items: - $ref: '#/components/schemas/TimeseriesWidgetRequest' + $ref: "#/components/schemas/TimeseriesWidgetRequest" minItems: 1 type: array right_yaxis: - $ref: '#/components/schemas/WidgetAxis' + $ref: "#/components/schemas/WidgetAxis" show_legend: description: (screenboard only) Show the legend for this widget. type: boolean time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/TimeseriesWidgetDefinitionType' + $ref: "#/components/schemas/TimeseriesWidgetDefinitionType" yaxis: - $ref: '#/components/schemas/WidgetAxis' + $ref: "#/components/schemas/WidgetAxis" required: - - type - - requests + - type + - requests type: object TimeseriesWidgetDefinitionType: default: timeseries description: Type of the timeseries widget. enum: - - timeseries + - timeseries example: timeseries type: string x-enum-varnames: - - TIMESERIES + - TIMESERIES TimeseriesWidgetExpressionAlias: description: Define an expression alias. properties: @@ -19941,81 +18509,81 @@ components: type: string expression: description: Expression name. - example: '' + example: "" type: string required: - - expression + - expression type: object TimeseriesWidgetLegendColumn: description: Legend column. enum: - - value - - avg - - sum - - min - - max + - value + - avg + - sum + - min + - max type: string x-enum-varnames: - - VALUE - - AVG - - SUM - - MIN - - MAX + - VALUE + - AVG + - SUM + - MIN + - MAX TimeseriesWidgetLegendLayout: description: Layout of the legend. enum: - - auto - - horizontal - - vertical + - auto + - horizontal + - vertical type: string x-enum-varnames: - - AUTO - - HORIZONTAL - - VERTICAL + - AUTO + - HORIZONTAL + - VERTICAL TimeseriesWidgetRequest: description: Updated timeseries widget. properties: apm_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. audit_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. display_type: - $ref: '#/components/schemas/WidgetDisplayType' + $ref: "#/components/schemas/WidgetDisplayType" event_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: - $ref: '#/components/schemas/WidgetFormula' + $ref: "#/components/schemas/WidgetFormula" type: array log_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. metadata: description: Used to define expression aliases. items: - $ref: '#/components/schemas/TimeseriesWidgetExpressionAlias' + $ref: "#/components/schemas/TimeseriesWidgetExpressionAlias" type: array network_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. on_right_yaxis: description: Whether or not to display a second y-axis on the right. type: boolean process_query: - $ref: '#/components/schemas/ProcessQueryDefinition' + $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: @@ -20025,143 +18593,137 @@ components: queries: description: List of queries that can be returned directly or used in formulas. items: - $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition' + $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: - $ref: '#/components/schemas/FormulaAndFunctionResponseFormat' + $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" rum_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. style: - $ref: '#/components/schemas/TimeseriesRequestStyle' + $ref: "#/components/schemas/TimeseriesRequestStyle" type: object ToplistWidgetDefinition: - description: The top list visualization enables you to display a list of Tag - value like hostname or service with the most or least of any metric value, - such as highest consumers of CPU, hosts with the least disk space, etc. + description: The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc. properties: custom_links: description: List of custom links. items: - $ref: '#/components/schemas/WidgetCustomLink' + $ref: "#/components/schemas/WidgetCustomLink" type: array requests: description: List of top list widget requests. - example: - - q: system.load.1 + example: ["q": "system.load.1"] items: - $ref: '#/components/schemas/ToplistWidgetRequest' + $ref: "#/components/schemas/ToplistWidgetRequest" type: array style: - $ref: '#/components/schemas/ToplistWidgetStyle' + $ref: "#/components/schemas/ToplistWidgetStyle" time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/ToplistWidgetDefinitionType' + $ref: "#/components/schemas/ToplistWidgetDefinitionType" required: - - type - - requests + - type + - requests type: object ToplistWidgetDefinitionType: default: toplist description: Type of the top list widget. enum: - - toplist + - toplist example: toplist type: string x-enum-varnames: - - TOPLIST + - TOPLIST ToplistWidgetDisplay: description: Top list widget display options. oneOf: - - $ref: '#/components/schemas/ToplistWidgetStacked' - - $ref: '#/components/schemas/ToplistWidgetFlat' + - $ref: "#/components/schemas/ToplistWidgetStacked" + - $ref: "#/components/schemas/ToplistWidgetFlat" ToplistWidgetFlat: description: Top list widget flat display. properties: type: - $ref: '#/components/schemas/ToplistWidgetFlatType' + $ref: "#/components/schemas/ToplistWidgetFlatType" required: - - type + - type type: object ToplistWidgetFlatType: default: flat description: Top list widget flat display type. enum: - - flat + - flat example: flat type: string x-enum-varnames: - - FLAT + - FLAT ToplistWidgetLegend: description: Top list widget stacked legend behavior. enum: - - automatic - - inline - - none + - automatic + - inline + - none example: automatic type: string x-enum-varnames: - - AUTOMATIC - - INLINE - - NONE + - AUTOMATIC + - INLINE + - NONE ToplistWidgetRequest: description: Updated top list widget. properties: apm_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. audit_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. conditional_formats: description: List of conditional formats. - example: - - comparator: '>=' - palette: blue - value: 1.0 + example: [{"comparator": ">=", "palette": "blue", "value": 1.0}] items: - $ref: '#/components/schemas/WidgetConditionalFormat' + $ref: "#/components/schemas/WidgetConditionalFormat" minItems: 1 type: array event_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. formulas: description: List of formulas that operate on queries. items: - $ref: '#/components/schemas/WidgetFormula' + $ref: "#/components/schemas/WidgetFormula" type: array log_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. network_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. process_query: - $ref: '#/components/schemas/ProcessQueryDefinition' + $ref: "#/components/schemas/ProcessQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. profile_metrics_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. q: @@ -20171,112 +18733,107 @@ components: queries: description: List of queries that can be returned directly or used in formulas. items: - $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition' + $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: - $ref: '#/components/schemas/FormulaAndFunctionResponseFormat' + $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" rum_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. security_query: - $ref: '#/components/schemas/LogQueryDefinition' + $ref: "#/components/schemas/LogQueryDefinition" deprecated: true description: Deprecated - Use `queries` and `formulas` instead. sort: - $ref: '#/components/schemas/WidgetSortBy' + $ref: "#/components/schemas/WidgetSortBy" style: - $ref: '#/components/schemas/WidgetRequestStyle' + $ref: "#/components/schemas/WidgetRequestStyle" type: object ToplistWidgetScaling: description: Top list widget scaling definition. enum: - - absolute - - relative + - absolute + - relative type: string x-enum-varnames: - - ABSOLUTE - - RELATIVE + - ABSOLUTE + - RELATIVE ToplistWidgetStacked: description: Top list widget stacked display options. properties: legend: - $ref: '#/components/schemas/ToplistWidgetLegend' + $ref: "#/components/schemas/ToplistWidgetLegend" type: - $ref: '#/components/schemas/ToplistWidgetStackedType' + $ref: "#/components/schemas/ToplistWidgetStackedType" required: - - type + - type type: object ToplistWidgetStackedType: default: stacked description: Top list widget stacked display type. enum: - - stacked + - stacked example: stacked type: string x-enum-varnames: - - STACKED + - STACKED ToplistWidgetStyle: description: Style customization for a top list widget. properties: display: - $ref: '#/components/schemas/ToplistWidgetDisplay' + $ref: "#/components/schemas/ToplistWidgetDisplay" palette: description: Color palette to apply to the widget. type: string scaling: - $ref: '#/components/schemas/ToplistWidgetScaling' + $ref: "#/components/schemas/ToplistWidgetScaling" type: object TopologyMapWidgetDefinition: - description: This widget displays a topology of nodes and edges for different - data sources. It replaces the service map widget. + description: This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget. properties: custom_links: description: List of custom links. items: - $ref: '#/components/schemas/WidgetCustomLink' + $ref: "#/components/schemas/WidgetCustomLink" type: array requests: description: One or more Topology requests. items: - $ref: '#/components/schemas/TopologyRequest' + $ref: "#/components/schemas/TopologyRequest" minItems: 1 type: array title: description: Title of your widget. type: string title_align: - $ref: '#/components/schemas/WidgetTextAlign' + $ref: "#/components/schemas/WidgetTextAlign" title_size: description: Size of the title. type: string type: - $ref: '#/components/schemas/TopologyMapWidgetDefinitionType' + $ref: "#/components/schemas/TopologyMapWidgetDefinitionType" required: - - type - - requests + - type + - requests type: object TopologyMapWidgetDefinitionType: default: topology_map description: Type of the topology map widget. enum: - - topology_map + - topology_map example: topology_map type: string x-enum-varnames: - - TOPOLOGY_MAP + - TOPOLOGY_MAP TopologyQuery: - description: Query to service-based topology data sources like the service map - or data streams. + description: Query to service-based topology data sources like the service map or data streams. properties: data_source: - $ref: '#/components/schemas/TopologyQueryDataSource' + $ref: "#/components/schemas/TopologyQueryDataSource" filters: - description: Your environment and primary tag (or * if enabled for your - account). - example: - - env:prod - - az:us-east + description: Your environment and primary tag (or * if enabled for your account). + example: ["env:prod", "az:us-east"] items: description: Environment or primary tag, generally in a key:value format type: string @@ -20290,133 +18847,122 @@ components: TopologyQueryDataSource: description: Name of the data source enum: - - data_streams - - service_map + - data_streams + - service_map type: string x-enum-varnames: - - DATA_STREAMS - - SERVICE_MAP + - DATA_STREAMS + - SERVICE_MAP TopologyRequest: - description: Request that will return nodes and edges to be used by topology - map. + description: Request that will return nodes and edges to be used by topology map. properties: query: - $ref: '#/components/schemas/TopologyQuery' + $ref: "#/components/schemas/TopologyQuery" request_type: - $ref: '#/components/schemas/TopologyRequestType' + $ref: "#/components/schemas/TopologyRequestType" type: object TopologyRequestType: description: Widget request type. enum: - - topology + - topology type: string x-enum-varnames: - - TOPOLOGY + - TOPOLOGY TreeMapColorBy: - default: user + default: "user" deprecated: true - description: (deprecated) The attribute formerly used to determine color in - the widget. + description: (deprecated) The attribute formerly used to determine color in the widget. enum: - - user - example: user + - user + example: "user" type: string x-enum-varnames: - - USER + - USER TreeMapGroupBy: deprecated: true - description: (deprecated) The attribute formerly used to group elements in the - widget. + description: (deprecated) The attribute formerly used to group elements in the widget. enum: - - user - - family - - process - example: user + - user + - family + - process + example: "user" type: string x-enum-varnames: - - USER - - FAMILY - - PROCESS + - USER + - FAMILY + - PROCESS TreeMapSizeBy: deprecated: true - description: (deprecated) The attribute formerly used to determine size in the - widget. + description: (deprecated) The attribute formerly used to determine size in the widget. enum: - - pct_cpu - - pct_mem - example: pct_cpu + - pct_cpu + - pct_mem + example: "pct_cpu" type: string x-enum-varnames: - - PCT_CPU - - PCT_MEM + - PCT_CPU + - PCT_MEM TreeMapWidgetDefinition: - description: The treemap visualization enables you to display hierarchical and - nested data. It is well suited for queries that describe part-whole relationships, - such as resource usage by availability zone, data center, or team. + description: The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team. properties: color_by: - $ref: '#/components/schemas/TreeMapColorBy' + $ref: "#/components/schemas/TreeMapColorBy" custom_links: description: List of custom links. items: - $ref: '#/components/schemas/WidgetCustomLink' + $ref: "#/components/schemas/WidgetCustomLink" type: array group_by: - $ref: '#/components/schemas/TreeMapGroupBy' + $ref: "#/components/schemas/TreeMapGroupBy" requests: description: List of treemap widget requests. - example: - - aggregator: sum - data_source: metrics - name: query1 - query: sum:system.mem.total{*} by {service} + example: [{"aggregator": "sum", "data_source": "metrics", "name": "query1", "query": "sum:system.mem.total{*} by {service}"}] items: - $ref: '#/components/schemas/TreeMapWidgetRequest' + $ref: "#/components/schemas/TreeMapWidgetRequest" maxItems: 1 minItems: 1 type: array size_by: - $ref: '#/components/schemas/TreeMapSizeBy' + $ref: "#/components/schemas/TreeMapSizeBy" time: - $ref: '#/components/schemas/WidgetTime' + $ref: "#/components/schemas/WidgetTime" title: description: Title of your widget. type: string type: - $ref: '#/components/schemas/TreeMapWidgetDefinitionType' + $ref: "#/components/schemas/TreeMapWidgetDefinitionType" required: - - type - - requests + - type + - requests type: object TreeMapWidgetDefinitionType: default: treemap description: Type of the treemap widget. enum: - - treemap + - treemap example: treemap type: string x-enum-varnames: - - TREEMAP + - TREEMAP TreeMapWidgetRequest: description: An updated treemap widget. properties: formulas: description: List of formulas that operate on queries. items: - $ref: '#/components/schemas/WidgetFormula' + $ref: "#/components/schemas/WidgetFormula" type: array q: deprecated: true - description: The widget metrics query. Deprecated - Use `queries` and `formulas` - instead. + description: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. type: string queries: description: List of queries that can be returned directly or used in formulas. items: - $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition' + $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition" type: array response_format: - $ref: '#/components/schemas/FormulaAndFunctionResponseFormat' + $ref: "#/components/schemas/FormulaAndFunctionResponseFormat" type: object UsageAnalyzedLogsHour: description: The number of analyzed logs for each hour for a given organization. @@ -20438,30 +18984,29 @@ components: type: string type: object UsageAnalyzedLogsResponse: - description: A response containing the number of analyzed logs for each hour - for a given organization. + description: A response containing the number of analyzed logs for each hour for a given organization. properties: usage: description: Get hourly usage for analyzed logs. items: - $ref: '#/components/schemas/UsageAnalyzedLogsHour' + $ref: "#/components/schemas/UsageAnalyzedLogsHour" type: array type: object UsageAttributionAggregates: description: An array of available aggregates. items: - $ref: '#/components/schemas/UsageAttributionAggregatesBody' + $ref: "#/components/schemas/UsageAttributionAggregatesBody" type: array UsageAttributionAggregatesBody: description: The object containing the aggregates. properties: agg_type: description: The aggregate type. - example: sum + example: "sum" type: string field: description: The field. - example: custom_timeseries_usage + example: "custom_timeseries_usage" type: string value: description: The value for a given field. @@ -20470,31 +19015,23 @@ components: type: object UsageAttributionTagNames: additionalProperties: - description: 'A list of values that are associated with each tag key. - + description: |- + A list of values that are associated with each tag key. - - An empty list means the resource use wasn''t tagged with the respective - tag. - - - Multiple values means the respective tag was applied multiple times on - the resource. - - - An `` value means the resource was tagged with the respective tag - but did not have a value.' + - An empty list means the resource use wasn't tagged with the respective tag. + - Multiple values means the respective tag was applied multiple times on the resource. + - An `` value means the resource was tagged with the respective tag but did not have a value. items: description: A given tag in a list. - example: datadog-integrations-lab + example: "datadog-integrations-lab" type: string type: array - description: 'Tag keys and values. - - - A `null` value here means that the requested tag breakdown cannot be applied - because it does not match the [tags + description: |- + Tag keys and values. + A `null` value here means that the requested tag breakdown cannot be applied because it does not match the [tags configured for usage attribution](https://docs.datadoghq.com/account_management/billing/usage_attribution/#getting-started). - - In this scenario the API returns the total usage, not broken down by tags.' + In this scenario the API returns the total usage, not broken down by tags. nullable: true type: object UsageAuditLogsHour: @@ -20505,8 +19042,7 @@ components: format: date-time type: string lines_indexed: - description: The total number of audit logs lines indexed during a given - hour. + description: The total number of audit logs lines indexed during a given hour. format: int64 nullable: true type: integer @@ -20518,13 +19054,12 @@ components: type: string type: object UsageAuditLogsResponse: - description: Response containing the audit logs usage for each hour for a given - organization. + description: Response containing the audit logs usage for each hour for a given organization. properties: usage: description: Get hourly usage for audit logs. items: - $ref: '#/components/schemas/UsageAuditLogsHour' + $ref: "#/components/schemas/UsageAuditLogsHour" type: array type: object UsageBillableSummaryBody: @@ -20605,189 +19140,189 @@ components: format: date-time type: string usage: - $ref: '#/components/schemas/UsageBillableSummaryKeys' + $ref: "#/components/schemas/UsageBillableSummaryKeys" type: object UsageBillableSummaryKeys: description: Response with aggregated usage types. properties: apm_fargate_average: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" apm_fargate_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" apm_host_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" apm_host_top99p: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" apm_profiler_host_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" apm_profiler_host_top99p: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" apm_trace_search_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" application_security_fargate_average: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" application_security_host_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" application_security_host_top99p: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" ci_pipeline_indexed_spans_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" ci_pipeline_maximum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" ci_pipeline_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" ci_test_indexed_spans_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" ci_testing_maximum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" ci_testing_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" cloud_cost_management_average: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" cloud_cost_management_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" cspm_container_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" cspm_host_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" cspm_host_top99p: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" custom_event_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" cws_container_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" cws_host_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" cws_host_top99p: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" dbm_host_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" dbm_host_top99p: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" dbm_normalized_queries_average: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" dbm_normalized_queries_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" fargate_container_apm_and_profiler_average: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" fargate_container_apm_and_profiler_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" fargate_container_average: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" fargate_container_profiler_average: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" fargate_container_profiler_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" fargate_container_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" incident_management_maximum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" incident_management_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" infra_and_apm_host_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" infra_and_apm_host_top99p: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" infra_container_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" infra_host_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" infra_host_top99p: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" ingested_spans_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" ingested_timeseries_average: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" ingested_timeseries_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" iot_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" iot_top99p: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" lambda_function_average: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" lambda_function_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" logs_forwarding_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_15day_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_180day_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_1day_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_30day_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_360day_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_3day_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_45day_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_60day_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_7day_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_90day_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_custom_retention_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" logs_indexed_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" logs_ingested_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" network_device_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" network_device_top99p: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" npm_flow_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" npm_host_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" npm_host_top99p: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" observability_pipeline_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" online_archive_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" prof_container_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" prof_host_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" prof_host_top99p: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" rum_lite_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" rum_replay_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" rum_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" rum_units_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" sensitive_data_scanner_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" serverless_apm_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" serverless_infra_average: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" serverless_infra_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" serverless_invocation_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" siem_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" standard_timeseries_average: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" synthetics_api_tests_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" synthetics_app_testing_maximum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" synthetics_browser_checks_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" timeseries_average: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" timeseries_sum: - $ref: '#/components/schemas/UsageBillableSummaryBody' + $ref: "#/components/schemas/UsageBillableSummaryBody" type: object UsageBillableSummaryResponse: description: Response with monthly summary of data billed by Datadog. @@ -20795,7 +19330,7 @@ components: usage: description: An array of objects regarding usage of billable summary. items: - $ref: '#/components/schemas/UsageBillableSummaryHour' + $ref: "#/components/schemas/UsageBillableSummaryHour" type: array type: object UsageCIVisibilityHour: @@ -20812,23 +19347,17 @@ components: nullable: true type: integer ci_visibility_itr_committers: - description: Shows the total count of all active Git committers for Intelligent - Test Runner in the current month. A committer is active if they commit - at least 3 times in a given month. + description: Shows the total count of all active Git committers for Intelligent Test Runner in the current month. A committer is active if they commit at least 3 times in a given month. format: int64 nullable: true type: integer ci_visibility_pipeline_committers: - description: Shows the total count of all active Git committers for Pipelines - in the current month. A committer is active if they commit at least 3 - times in a given month. + description: Shows the total count of all active Git committers for Pipelines in the current month. A committer is active if they commit at least 3 times in a given month. format: int64 nullable: true type: integer ci_visibility_test_committers: - description: The total count of all active Git committers for tests in the - current month. A committer is active if they commit at least 3 times in - a given month. + description: The total count of all active Git committers for tests in the current month. A committer is active if they commit at least 3 times in a given month. format: int64 nullable: true type: integer @@ -20845,22 +19374,19 @@ components: usage: description: Response containing CI visibility usage. items: - $ref: '#/components/schemas/UsageCIVisibilityHour' + $ref: "#/components/schemas/UsageCIVisibilityHour" type: array type: object UsageCWSHour: - description: Cloud Workload Security usage for a given organization for a given - hour. + description: Cloud Workload Security usage for a given organization for a given hour. properties: cws_container_count: - description: "The total number of Cloud Workload Security container hours - from the start of the given hour\u2019s month until the given hour." + description: The total number of Cloud Workload Security container hours from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer cws_host_count: - description: "The total number of Cloud Workload Security host hours from - the start of the given hour\u2019s month until the given hour." + description: The total number of Cloud Workload Security host hours from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer @@ -20876,58 +19402,49 @@ components: type: string type: object UsageCWSResponse: - description: Response containing the Cloud Workload Security usage for each - hour for a given organization. + description: Response containing the Cloud Workload Security usage for each hour for a given organization. properties: usage: description: Get hourly usage for Cloud Workload Security. items: - $ref: '#/components/schemas/UsageCWSHour' + $ref: "#/components/schemas/UsageCWSHour" type: array type: object UsageCloudSecurityPostureManagementHour: - description: Cloud Security Management Pro usage for a given organization for - a given hour. + description: Cloud Security Management Pro usage for a given organization for a given hour. properties: aas_host_count: - description: The number of Cloud Security Management Pro Azure app services - hosts during a given hour. + description: The number of Cloud Security Management Pro Azure app services hosts during a given hour. format: double nullable: true type: number aws_host_count: - description: The number of Cloud Security Management Pro AWS hosts during - a given hour. + description: The number of Cloud Security Management Pro AWS hosts during a given hour. format: double nullable: true type: number azure_host_count: - description: The number of Cloud Security Management Pro Azure hosts during - a given hour. + description: The number of Cloud Security Management Pro Azure hosts during a given hour. format: double nullable: true type: number compliance_host_count: - description: The number of Cloud Security Management Pro hosts during a - given hour. + description: The number of Cloud Security Management Pro hosts during a given hour. format: double nullable: true type: number container_count: - description: The total number of Cloud Security Management Pro containers - during a given hour. + description: The total number of Cloud Security Management Pro containers during a given hour. format: double nullable: true type: number gcp_host_count: - description: The number of Cloud Security Management Pro GCP hosts during - a given hour. + description: The number of Cloud Security Management Pro GCP hosts during a given hour. format: double nullable: true type: number host_count: - description: The total number of Cloud Security Management Pro hosts during - a given hour. + description: The total number of Cloud Security Management Pro hosts during a given hour. format: double nullable: true type: number @@ -20943,13 +19460,12 @@ components: type: string type: object UsageCloudSecurityPostureManagementResponse: - description: The response containing the Cloud Security Management Pro usage - for each hour for a given organization. + description: The response containing the Cloud Security Management Pro usage for each hour for a given organization. properties: usage: description: Get hourly usage for Cloud Security Management Pro. items: - $ref: '#/components/schemas/UsageCloudSecurityPostureManagementHour' + $ref: "#/components/schemas/UsageCloudSecurityPostureManagementHour" type: array type: object UsageCustomReportsAttributes: @@ -20972,7 +19488,7 @@ components: description: A list of tags to apply to custom reports. items: description: A given tag in a list. - example: env + example: "env" type: string type: array type: object @@ -20980,18 +19496,18 @@ components: description: The response containing the date and type for custom reports. properties: attributes: - $ref: '#/components/schemas/UsageCustomReportsAttributes' + $ref: "#/components/schemas/UsageCustomReportsAttributes" id: description: The date for specified custom reports. type: string type: - $ref: '#/components/schemas/UsageReportsType' + $ref: "#/components/schemas/UsageReportsType" type: object UsageCustomReportsMeta: description: The object containing document metadata. properties: page: - $ref: '#/components/schemas/UsageCustomReportsPage' + $ref: "#/components/schemas/UsageCustomReportsPage" type: object UsageCustomReportsPage: description: The object containing page total count. @@ -21007,24 +19523,21 @@ components: data: description: An array of available custom reports. items: - $ref: '#/components/schemas/UsageCustomReportsData' + $ref: "#/components/schemas/UsageCustomReportsData" type: array meta: - $ref: '#/components/schemas/UsageCustomReportsMeta' + $ref: "#/components/schemas/UsageCustomReportsMeta" type: object UsageDBMHour: - description: Database Monitoring usage for a given organization for a given - hour. + description: Database Monitoring usage for a given organization for a given hour. properties: dbm_host_count: - description: "The total number of Database Monitoring host hours from the - start of the given hour\u2019s month until the given hour." + description: The total number of Database Monitoring host hours from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer dbm_queries_count: - description: "The total number of normalized Database Monitoring queries - from the start of the given hour\u2019s month until the given hour." + description: The total number of normalized Database Monitoring queries from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer @@ -21040,27 +19553,24 @@ components: type: string type: object UsageDBMResponse: - description: Response containing the Database Monitoring usage for each hour - for a given organization. + description: Response containing the Database Monitoring usage for each hour for a given organization. properties: usage: description: Get hourly usage for Database Monitoring items: - $ref: '#/components/schemas/UsageDBMHour' + $ref: "#/components/schemas/UsageDBMHour" type: array type: object UsageFargateHour: description: Number of Fargate tasks run and hourly usage. properties: apm_fargate_count: - description: The high-water mark of APM ECS Fargate tasks during the given - hour. + description: The high-water mark of APM ECS Fargate tasks during the given hour. format: int64 nullable: true type: integer appsec_fargate_count: - description: The Application Security Monitoring ECS Fargate tasks during - the given hour. + description: The Application Security Monitoring ECS Fargate tasks during the given hour. format: int64 nullable: true type: integer @@ -21086,88 +19596,78 @@ components: type: integer type: object UsageFargateResponse: - description: Response containing the number of Fargate tasks run and hourly - usage. + description: Response containing the number of Fargate tasks run and hourly usage. properties: usage: - description: Array with the number of hourly Fargate tasks recorded for - a given organization. + description: Array with the number of hourly Fargate tasks recorded for a given organization. items: - $ref: '#/components/schemas/UsageFargateHour' + $ref: "#/components/schemas/UsageFargateHour" type: array type: object UsageHostHour: description: Number of hosts/containers recorded for each hour for a given organization. properties: agent_host_count: - description: 'Contains the total number of infrastructure hosts reporting - - during a given hour that were running the Datadog Agent.' + description: |- + Contains the total number of infrastructure hosts reporting + during a given hour that were running the Datadog Agent. format: int64 nullable: true type: integer alibaba_host_count: - description: 'Contains the total number of hosts that reported through Alibaba - integration - - (and were NOT running the Datadog Agent).' + description: |- + Contains the total number of hosts that reported through Alibaba integration + (and were NOT running the Datadog Agent). format: int64 nullable: true type: integer apm_azure_app_service_host_count: - description: Contains the total number of Azure App Services hosts using - APM. + description: Contains the total number of Azure App Services hosts using APM. format: int64 nullable: true type: integer apm_host_count: - description: 'Shows the total number of hosts using APM during the hour, - - these are counted as billable (except during trial periods).' + description: |- + Shows the total number of hosts using APM during the hour, + these are counted as billable (except during trial periods). format: int64 nullable: true type: integer aws_host_count: - description: 'Contains the total number of hosts that reported through the - AWS integration - - (and were NOT running the Datadog Agent).' + description: |- + Contains the total number of hosts that reported through the AWS integration + (and were NOT running the Datadog Agent). format: int64 nullable: true type: integer azure_host_count: - description: 'Contains the total number of hosts that reported through Azure - integration - - (and were NOT running the Datadog Agent).' + description: |- + Contains the total number of hosts that reported through Azure integration + (and were NOT running the Datadog Agent). format: int64 nullable: true type: integer container_count: - description: Shows the total number of containers reported by the Docker - integration during the hour. + description: Shows the total number of containers reported by the Docker integration during the hour. format: int64 nullable: true type: integer gcp_host_count: - description: 'Contains the total number of hosts that reported through the - Google Cloud integration - - (and were NOT running the Datadog Agent).' + description: |- + Contains the total number of hosts that reported through the Google Cloud integration + (and were NOT running the Datadog Agent). format: int64 nullable: true type: integer heroku_host_count: - description: Contains the total number of Heroku dynos reported by the Datadog - Agent. + description: Contains the total number of Heroku dynos reported by the Datadog Agent. format: int64 nullable: true type: integer host_count: - description: 'Contains the total number of billable infrastructure hosts - reporting during a given hour. - - This is the sum of `agent_host_count`, `aws_host_count`, and `gcp_host_count`.' + description: |- + Contains the total number of billable infrastructure hosts reporting during a given hour. + This is the sum of `agent_host_count`, `aws_host_count`, and `gcp_host_count`. format: int64 nullable: true type: integer @@ -21177,22 +19677,19 @@ components: nullable: true type: string infra_azure_app_service: - description: 'Contains the total number of hosts that reported through the - Azure App Services integration - - (and were NOT running the Datadog Agent).' + description: |- + Contains the total number of hosts that reported through the Azure App Services integration + (and were NOT running the Datadog Agent). format: int64 nullable: true type: integer opentelemetry_apm_host_count: - description: Contains the total number of hosts using APM reported by Datadog - exporter for the OpenTelemetry Collector. + description: Contains the total number of hosts using APM reported by Datadog exporter for the OpenTelemetry Collector. format: int64 nullable: true type: integer opentelemetry_host_count: - description: Contains the total number of hosts reported by Datadog exporter - for the OpenTelemetry Collector. + description: Contains the total number of hosts reported by Datadog exporter for the OpenTelemetry Collector. format: int64 nullable: true type: integer @@ -21203,10 +19700,9 @@ components: description: The organization public ID. type: string vsphere_host_count: - description: 'Contains the total number of hosts that reported through vSphere - integration - - (and were NOT running the Datadog Agent).' + description: |- + Contains the total number of hosts that reported through vSphere integration + (and were NOT running the Datadog Agent). format: int64 nullable: true type: integer @@ -21217,20 +19713,18 @@ components: usage: description: An array of objects related to host usage. items: - $ref: '#/components/schemas/UsageHostHour' + $ref: "#/components/schemas/UsageHostHour" type: array type: object UsageIncidentManagementHour: - description: Incident management usage for a given organization for a given - hour. + description: Incident management usage for a given organization for a given hour. properties: hour: description: The hour for the usage. format: date-time type: string monthly_active_users: - description: Contains the total number monthly active users from the start - of the given hour's month until the given hour. + description: Contains the total number monthly active users from the start of the given hour's month until the given hour. format: int64 nullable: true type: integer @@ -21242,13 +19736,12 @@ components: type: string type: object UsageIncidentManagementResponse: - description: Response containing the incident management usage for each hour - for a given organization. + description: Response containing the incident management usage for each hour for a given organization. properties: usage: description: Get hourly usage for incident management. items: - $ref: '#/components/schemas/UsageIncidentManagementHour' + $ref: "#/components/schemas/UsageIncidentManagementHour" type: array type: object UsageIndexedSpansHour: @@ -21274,10 +19767,9 @@ components: description: A response containing indexed spans usage. properties: usage: - description: Array with the number of hourly traces indexed for a given - organization. + description: Array with the number of hourly traces indexed for a given organization. items: - $ref: '#/components/schemas/UsageIndexedSpansHour' + $ref: "#/components/schemas/UsageIndexedSpansHour" type: array type: object UsageIngestedSpansHour: @@ -21288,8 +19780,7 @@ components: format: date-time type: string ingested_events_bytes: - description: Contains the total number of bytes ingested for APM spans during - a given hour. + description: Contains the total number of bytes ingested for APM spans during a given hour. format: int64 nullable: true type: integer @@ -21301,13 +19792,12 @@ components: type: string type: object UsageIngestedSpansResponse: - description: Response containing the ingested spans usage for each hour for - a given organization. + description: Response containing the ingested spans usage for each hour for a given organization. properties: usage: description: Get hourly usage for ingested spans. items: - $ref: '#/components/schemas/UsageIngestedSpansHour' + $ref: "#/components/schemas/UsageIngestedSpansHour" type: array type: object UsageIoTHour: @@ -21335,18 +19825,16 @@ components: usage: description: Get hourly usage for IoT. items: - $ref: '#/components/schemas/UsageIoTHour' + $ref: "#/components/schemas/UsageIoTHour" type: array type: object UsageLambdaHour: - description: 'Number of Lambda functions and sum of the invocations of all Lambda - functions - - for each hour for a given organization.' + description: |- + Number of Lambda functions and sum of the invocations of all Lambda functions + for each hour for a given organization. properties: func_count: - description: Contains the number of different functions for each region - and AWS account. + description: Contains the number of different functions for each region and AWS account. format: int64 nullable: true type: integer @@ -21367,15 +19855,14 @@ components: type: string type: object UsageLambdaResponse: - description: 'Response containing the number of Lambda functions and sum of - the invocations of all Lambda functions - - for each hour for a given organization.' + description: |- + Response containing the number of Lambda functions and sum of the invocations of all Lambda functions + for each hour for a given organization. properties: usage: description: Get hourly usage for Lambda. items: - $ref: '#/components/schemas/UsageLambdaHour' + $ref: "#/components/schemas/UsageLambdaHour" type: array type: object UsageLogsByIndexHour: @@ -21407,29 +19894,24 @@ components: type: integer type: object UsageLogsByIndexResponse: - description: Response containing the number of indexed logs for each hour and - index for a given organization. + description: Response containing the number of indexed logs for each hour and index for a given organization. properties: usage: - description: An array of objects regarding hourly usage of logs by index - response. + description: An array of objects regarding hourly usage of logs by index response. items: - $ref: '#/components/schemas/UsageLogsByIndexHour' + $ref: "#/components/schemas/UsageLogsByIndexHour" type: array type: object UsageLogsByRetentionHour: - description: The number of indexed logs for each hour for a given organization - broken down by retention period. + description: The number of indexed logs for each hour for a given organization broken down by retention period. properties: indexed_events_count: - description: Total logs indexed with this retention period during a given - hour. + description: Total logs indexed with this retention period during a given hour. format: int64 nullable: true type: integer live_indexed_events_count: - description: Live logs indexed with this retention period during a given - hour. + description: Live logs indexed with this retention period during a given hour. format: int64 nullable: true type: integer @@ -21440,25 +19922,22 @@ components: description: The organization public ID. type: string rehydrated_indexed_events_count: - description: Rehydrated logs indexed with this retention period during a - given hour. + description: Rehydrated logs indexed with this retention period during a given hour. format: int64 nullable: true type: integer retention: - description: The retention period in days or "custom" for all custom retention - usage. + description: The retention period in days or "custom" for all custom retention usage. nullable: true type: string type: object UsageLogsByRetentionResponse: - description: Response containing the indexed logs usage broken down by retention - period for an organization during a given hour. + description: Response containing the indexed logs usage broken down by retention period for an organization during a given hour. properties: usage: description: Get hourly usage for indexed logs by retention period. items: - $ref: '#/components/schemas/UsageLogsByRetentionHour' + $ref: "#/components/schemas/UsageLogsByRetentionHour" type: array type: object UsageLogsHour: @@ -21484,32 +19963,27 @@ components: nullable: true type: integer logs_forwarding_events_bytes: - description: Contains the number of logs forwarded bytes (data available - as of April 1st 2023) + description: Contains the number of logs forwarded bytes (data available as of April 1st 2023) format: int64 nullable: true type: integer logs_live_indexed_count: - description: Contains the number of live log events indexed (data available - as of December 1, 2020). + description: Contains the number of live log events indexed (data available as of December 1, 2020). format: int64 nullable: true type: integer logs_live_ingested_bytes: - description: Contains the number of live log bytes ingested (data available - as of December 1, 2020). + description: Contains the number of live log bytes ingested (data available as of December 1, 2020). format: int64 nullable: true type: integer logs_rehydrated_indexed_count: - description: Contains the number of rehydrated log events indexed (data - available as of December 1, 2020). + description: Contains the number of rehydrated log events indexed (data available as of December 1, 2020). format: int64 nullable: true type: integer logs_rehydrated_ingested_bytes: - description: Contains the number of rehydrated log bytes ingested (data - available as of December 1, 2020). + description: Contains the number of rehydrated log bytes ingested (data available as of December 1, 2020). format: int64 nullable: true type: integer @@ -21526,18 +20000,18 @@ components: usage: description: An array of objects regarding hourly usage of logs. items: - $ref: '#/components/schemas/UsageLogsHour' + $ref: "#/components/schemas/UsageLogsHour" type: array type: object UsageMetricCategory: description: Contains the metric category. enum: - - standard - - custom + - standard + - custom type: string x-enum-varnames: - - STANDARD - - CUSTOM + - STANDARD + - CUSTOM UsageNetworkFlowsHour: description: Number of netflow events indexed for each hour for a given organization. properties: @@ -21558,13 +20032,12 @@ components: type: string type: object UsageNetworkFlowsResponse: - description: Response containing the number of netflow events indexed for each - hour for a given organization. + description: Response containing the number of netflow events indexed for each hour for a given organization. properties: usage: description: Get hourly usage for Network Flows. items: - $ref: '#/components/schemas/UsageNetworkFlowsHour' + $ref: "#/components/schemas/UsageNetworkFlowsHour" type: array type: object UsageNetworkHostsHour: @@ -21587,13 +20060,12 @@ components: type: string type: object UsageNetworkHostsResponse: - description: Response containing the number of active NPM hosts for each hour - for a given organization. + description: Response containing the number of active NPM hosts for each hour for a given organization. properties: usage: description: Get hourly usage for NPM hosts. items: - $ref: '#/components/schemas/UsageNetworkHostsHour' + $ref: "#/components/schemas/UsageNetworkHostsHour" type: array type: object UsageOnlineArchiveHour: @@ -21621,15 +20093,14 @@ components: usage: description: Response containing Online Archive usage. items: - $ref: '#/components/schemas/UsageOnlineArchiveHour' + $ref: "#/components/schemas/UsageOnlineArchiveHour" type: array type: object UsageProfilingHour: description: The number of profiled hosts for each hour for a given organization. properties: aas_count: - description: Contains the total number of profiled Azure app services reporting - during a given hour. + description: Contains the total number of profiled Azure app services reporting during a given hour. format: int64 nullable: true type: integer @@ -21639,8 +20110,7 @@ components: nullable: true type: integer host_count: - description: Contains the total number of profiled hosts reporting during - a given hour. + description: Contains the total number of profiled hosts reporting during a given hour. format: int64 nullable: true type: integer @@ -21656,24 +20126,23 @@ components: type: string type: object UsageProfilingResponse: - description: Response containing the number of profiled hosts for each hour - for a given organization. + description: Response containing the number of profiled hosts for each hour for a given organization. properties: usage: description: Get hourly usage for profiled hosts. items: - $ref: '#/components/schemas/UsageProfilingHour' + $ref: "#/components/schemas/UsageProfilingHour" type: array type: object UsageReportsType: default: reports description: The type of reports. enum: - - reports - example: reports + - reports + example: "reports" type: string x-enum-varnames: - - REPORTS + - REPORTS UsageRumSessionsHour: description: Number of RUM sessions recorded for each hour for a given organization. properties: @@ -21688,8 +20157,7 @@ components: description: The organization public ID. type: string replay_session_count: - description: Contains the number of RUM Session Replay counts (data available - beginning November 1, 2021). + description: Contains the number of RUM Session Replay counts (data available beginning November 1, 2021). format: int64 type: integer session_count: @@ -21698,43 +20166,37 @@ components: nullable: true type: integer session_count_android: - description: Contains the number of mobile RUM sessions on Android (data - available beginning December 1, 2020). + description: Contains the number of mobile RUM sessions on Android (data available beginning December 1, 2020). format: int64 nullable: true type: integer session_count_flutter: - description: Contains the number of mobile RUM sessions on Flutter (data - available beginning March 1, 2023). + description: Contains the number of mobile RUM sessions on Flutter (data available beginning March 1, 2023). format: int64 nullable: true type: integer session_count_ios: - description: Contains the number of mobile RUM sessions on iOS (data available - beginning December 1, 2020). + description: Contains the number of mobile RUM sessions on iOS (data available beginning December 1, 2020). format: int64 nullable: true type: integer session_count_reactnative: - description: Contains the number of mobile RUM sessions on React Native - (data available beginning May 1, 2022). + description: Contains the number of mobile RUM sessions on React Native (data available beginning May 1, 2022). format: int64 nullable: true type: integer type: object UsageRumSessionsResponse: - description: Response containing the number of RUM sessions for each hour for - a given organization. + description: Response containing the number of RUM sessions for each hour for a given organization. properties: usage: description: Get hourly usage for RUM sessions. items: - $ref: '#/components/schemas/UsageRumSessionsHour' + $ref: "#/components/schemas/UsageRumSessionsHour" type: array type: object UsageRumUnitsHour: - description: Number of RUM Units used for each hour for a given organization - (data available as of November 1, 2021). + description: Number of RUM Units used for each hour for a given organization (data available as of November 1, 2021). properties: browser_rum_units: description: The number of browser RUM units. @@ -21759,30 +20221,24 @@ components: type: integer type: object UsageRumUnitsResponse: - description: Response containing the number of RUM Units for each hour for a - given organization. + description: Response containing the number of RUM Units for each hour for a given organization. properties: usage: description: Get hourly usage for RUM Units. items: - $ref: '#/components/schemas/UsageRumUnitsHour' + $ref: "#/components/schemas/UsageRumUnitsHour" type: array type: object UsageSDSHour: - description: Sensitive Data Scanner usage for a given organization for a given - hour. + description: Sensitive Data Scanner usage for a given organization for a given hour. properties: apm_scanned_bytes: - description: "The total number of bytes scanned of APM usage across all - usage types by the Sensitive Data Scanner from the start of the given - hour\u2019s month until the given hour." + description: The total number of bytes scanned of APM usage across all usage types by the Sensitive Data Scanner from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer events_scanned_bytes: - description: "The total number of bytes scanned of Events usage across all - usage types by the Sensitive Data Scanner from the start of the given - hour\u2019s month until the given hour." + description: The total number of bytes scanned of Events usage across all usage types by the Sensitive Data Scanner from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer @@ -21791,9 +20247,7 @@ components: format: date-time type: string logs_scanned_bytes: - description: "The total number of bytes scanned of logs usage by the Sensitive - Data Scanner from the start of the given hour\u2019s month until the given - hour." + description: The total number of bytes scanned of logs usage by the Sensitive Data Scanner from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer @@ -21804,28 +20258,23 @@ components: description: The organization public ID. type: string rum_scanned_bytes: - description: "The total number of bytes scanned of RUM usage across all - usage types by the Sensitive Data Scanner from the start of the given - hour\u2019s month until the given hour." + description: The total number of bytes scanned of RUM usage across all usage types by the Sensitive Data Scanner from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer total_scanned_bytes: - description: "The total number of bytes scanned across all usage types by - the Sensitive Data Scanner from the start of the given hour\u2019s month - until the given hour." + description: The total number of bytes scanned across all usage types by the Sensitive Data Scanner from the start of the given hour’s month until the given hour. format: int64 nullable: true type: integer type: object UsageSDSResponse: - description: Response containing the Sensitive Data Scanner usage for each hour - for a given organization. + description: Response containing the Sensitive Data Scanner usage for each hour for a given organization. properties: usage: description: Get hourly usage for Sensitive Data Scanner. items: - $ref: '#/components/schemas/UsageSDSHour' + $ref: "#/components/schemas/UsageSDSHour" type: array type: object UsageSNMPHour: @@ -21848,39 +20297,38 @@ components: type: integer type: object UsageSNMPResponse: - description: Response containing the number of SNMP devices for each hour for - a given organization. + description: Response containing the number of SNMP devices for each hour for a given organization. properties: usage: description: Get hourly usage for SNMP devices. items: - $ref: '#/components/schemas/UsageSNMPHour' + $ref: "#/components/schemas/UsageSNMPHour" type: array type: object UsageSort: default: start_date description: The field to sort by. enum: - - computed_on - - size - - start_date - - end_date + - computed_on + - size + - start_date + - end_date type: string x-enum-varnames: - - COMPUTED_ON - - SIZE - - START_DATE - - END_DATE + - COMPUTED_ON + - SIZE + - START_DATE + - END_DATE UsageSortDirection: default: desc description: The direction to sort by. enum: - - desc - - asc + - desc + - asc type: string x-enum-varnames: - - DESC - - ASC + - DESC + - ASC UsageSpecifiedCustomReportsAttributes: description: The response containing attributes for specified custom reports. properties: @@ -21892,7 +20340,7 @@ components: type: string location: description: A downloadable file for the specified custom reporting file. - example: https://an-s3-or-gs-bucket.s3.amazonaws.com + example: "https://an-s3-or-gs-bucket.s3.amazonaws.com" type: string size: description: size @@ -21905,7 +20353,7 @@ components: description: A list of tags to apply to specified custom reports. items: description: A given tag in a list. - example: env + example: "env" type: string type: array type: object @@ -21913,18 +20361,18 @@ components: description: Response containing date and type for specified custom reports. properties: attributes: - $ref: '#/components/schemas/UsageSpecifiedCustomReportsAttributes' + $ref: "#/components/schemas/UsageSpecifiedCustomReportsAttributes" id: description: The date for specified custom reports. type: string type: - $ref: '#/components/schemas/UsageReportsType' + $ref: "#/components/schemas/UsageReportsType" type: object UsageSpecifiedCustomReportsMeta: description: The object containing document metadata. properties: page: - $ref: '#/components/schemas/UsageSpecifiedCustomReportsPage' + $ref: "#/components/schemas/UsageSpecifiedCustomReportsPage" type: object UsageSpecifiedCustomReportsPage: description: The object containing page total count for specified ID. @@ -21938,346 +20386,270 @@ components: description: Returns available specified custom reports. properties: data: - $ref: '#/components/schemas/UsageSpecifiedCustomReportsData' + $ref: "#/components/schemas/UsageSpecifiedCustomReportsData" meta: - $ref: '#/components/schemas/UsageSpecifiedCustomReportsMeta' + $ref: "#/components/schemas/UsageSpecifiedCustomReportsMeta" type: object UsageSummaryDate: description: Response with hourly report of all data billed by Datadog all organizations. properties: agent_host_top99p: - description: Shows the 99th percentile of all agent hosts over all hours - in the current date for all organizations. + description: Shows the 99th percentile of all agent hosts over all hours in the current date for all organizations. format: int64 type: integer apm_azure_app_service_host_top99p: - description: Shows the 99th percentile of all Azure app services using APM - over all hours in the current date all organizations. + description: Shows the 99th percentile of all Azure app services using APM over all hours in the current date all organizations. format: int64 type: integer apm_devsecops_host_top99p: - description: Shows the 99th percentile of all APM DevSecOps hosts over all - hours in the current date for the given org. + description: Shows the 99th percentile of all APM DevSecOps hosts over all hours in the current date for the given org. format: int64 type: integer apm_enterprise_standalone_hosts_top99p: - description: Shows the 99th percentile of all distinct standalone Enterprise - hosts over all hours in the current date for all organizations. + description: Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for all organizations. format: int64 type: integer apm_fargate_count_avg: - description: Shows the average of all APM ECS Fargate tasks over all hours - in the current date for all organizations. + description: Shows the average of all APM ECS Fargate tasks over all hours in the current date for all organizations. format: int64 type: integer apm_host_top99p: - description: Shows the 99th percentile of all distinct APM hosts over all - hours in the current date for all organizations. + description: Shows the 99th percentile of all distinct APM hosts over all hours in the current date for all organizations. format: int64 type: integer apm_pro_standalone_hosts_top99p: - description: Shows the 99th percentile of all distinct standalone Pro hosts - over all hours in the current date for all organizations. + description: Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for all organizations. format: int64 type: integer appsec_fargate_count_avg: - description: Shows the average of all Application Security Monitoring ECS - Fargate tasks over all hours in the current date for all organizations. + description: Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current date for all organizations. format: int64 type: integer asm_serverless_sum: - description: Shows the sum of all Application Security Monitoring Serverless - invocations over all hours in the current date for all organizations. + description: Shows the sum of all Application Security Monitoring Serverless invocations over all hours in the current date for all organizations. format: int64 type: integer audit_logs_lines_indexed_sum: deprecated: true - description: Shows the sum of audit logs lines indexed over all hours in - the current date for all organizations (To be deprecated on October 1st, - 2024). + description: Shows the sum of audit logs lines indexed over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer audit_trail_enabled_hwm: - description: Shows the number of organizations that had Audit Trail enabled - in the current date. + description: Shows the number of organizations that had Audit Trail enabled in the current date. format: int64 type: integer avg_profiled_fargate_tasks: - description: The average total count for Fargate Container Profiler over - all hours in the current date for all organizations. + description: The average total count for Fargate Container Profiler over all hours in the current date for all organizations. format: int64 type: integer aws_host_top99p: - description: Shows the 99th percentile of all AWS hosts over all hours in - the current date for all organizations. + description: Shows the 99th percentile of all AWS hosts over all hours in the current date for all organizations. format: int64 type: integer aws_lambda_func_count: - description: Shows the average of the number of functions that executed - 1 or more times each hour in the current date for all organizations. + description: Shows the average of the number of functions that executed 1 or more times each hour in the current date for all organizations. format: int64 type: integer aws_lambda_invocations_sum: - description: Shows the sum of all AWS Lambda invocations over all hours - in the current date for all organizations. + description: Shows the sum of all AWS Lambda invocations over all hours in the current date for all organizations. format: int64 type: integer azure_app_service_top99p: - description: Shows the 99th percentile of all Azure app services over all - hours in the current date for all organizations. + description: Shows the 99th percentile of all Azure app services over all hours in the current date for all organizations. format: int64 type: integer billable_ingested_bytes_sum: - description: Shows the sum of all log bytes ingested over all hours in the - current date for all organizations. + description: Shows the sum of all log bytes ingested over all hours in the current date for all organizations. format: int64 type: integer bits_ai_investigations_sum: - description: Shows the sum of all Bits AI Investigations over all hours - in the current date for all organizations. + description: Shows the sum of all Bits AI Investigations over all hours in the current date for all organizations. format: int64 type: integer browser_rum_lite_session_count_sum: deprecated: true - description: Shows the sum of all browser lite sessions over all hours in - the current date for all organizations (To be deprecated on October 1st, - 2024). + description: Shows the sum of all browser lite sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer browser_rum_replay_session_count_sum: - description: Shows the sum of all browser replay sessions over all hours - in the current date for all organizations (To be deprecated on October - 1st, 2024). + description: Shows the sum of all browser replay sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer browser_rum_units_sum: deprecated: true - description: Shows the sum of all browser RUM units over all hours in the - current date for all organizations (To be deprecated on October 1st, 2024). + description: Shows the sum of all browser RUM units over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer ccm_spend_monitored_ent_last: - description: Shows the last value of the amount of cloud spend monitored - for Enterprise over all hours in the current date for all organizations. + description: Shows the last value of the amount of cloud spend monitored for Enterprise over all hours in the current date for all organizations. format: int64 type: integer ccm_spend_monitored_pro_last: - description: Shows the last value of the amount of cloud spend monitored - for Pro over all hours in the current date for all organizations. + description: Shows the last value of the amount of cloud spend monitored for Pro over all hours in the current date for all organizations. format: int64 type: integer ci_pipeline_indexed_spans_sum: - description: Shows the sum of all CI pipeline indexed spans over all hours - in the current month for all organizations. + description: Shows the sum of all CI pipeline indexed spans over all hours in the current month for all organizations. format: int64 type: integer ci_test_indexed_spans_sum: - description: Shows the sum of all CI test indexed spans over all hours in - the current month for all organizations. + description: Shows the sum of all CI test indexed spans over all hours in the current month for all organizations. format: int64 type: integer ci_visibility_itr_committers_hwm: - description: Shows the high-water mark of all CI visibility intelligent - test runner committers over all hours in the current month for all organizations. + description: Shows the high-water mark of all CI visibility intelligent test runner committers over all hours in the current month for all organizations. format: int64 type: integer ci_visibility_pipeline_committers_hwm: - description: Shows the high-water mark of all CI visibility pipeline committers - over all hours in the current month for all organizations. + description: Shows the high-water mark of all CI visibility pipeline committers over all hours in the current month for all organizations. format: int64 type: integer ci_visibility_test_committers_hwm: - description: Shows the high-water mark of all CI visibility test committers - over all hours in the current month for all organizations. + description: Shows the high-water mark of all CI visibility test committers over all hours in the current month for all organizations. format: int64 type: integer cloud_cost_management_aws_host_count_avg: - description: Host count average of Cloud Cost Management for AWS for the - given date and given organization. + description: Host count average of Cloud Cost Management for AWS for the given date and given organization. format: int64 type: integer cloud_cost_management_azure_host_count_avg: - description: Host count average of Cloud Cost Management for Azure for the - given date and given organization. + description: Host count average of Cloud Cost Management for Azure for the given date and given organization. format: int64 type: integer cloud_cost_management_gcp_host_count_avg: - description: Host count average of Cloud Cost Management for GCP for the - given date and given organization. + description: Host count average of Cloud Cost Management for GCP for the given date and given organization. format: int64 type: integer cloud_cost_management_host_count_avg: - description: Host count average of Cloud Cost Management for all cloud providers - for the given date and given organization. + description: Host count average of Cloud Cost Management for all cloud providers for the given date and given organization. format: int64 type: integer cloud_cost_management_oci_host_count_avg: - description: Average host count for Cloud Cost Management on OCI for the - given date and organization. + description: Average host count for Cloud Cost Management on OCI for the given date and organization. format: int64 type: integer cloud_siem_events_sum: - description: Shows the sum of all Cloud Security Information and Event Management - events over all hours in the current date for the given org. + description: Shows the sum of all Cloud Security Information and Event Management events over all hours in the current date for the given org. format: int64 type: integer code_analysis_sa_committers_hwm: - description: Shows the high-water mark of all Static Analysis committers - over all hours in the current date for the given org. + description: Shows the high-water mark of all Static Analysis committers over all hours in the current date for the given org. format: int64 type: integer code_analysis_sca_committers_hwm: - description: Shows the high-water mark of all static Software Composition - Analysis committers over all hours in the current date for the given org. + description: Shows the high-water mark of all static Software Composition Analysis committers over all hours in the current date for the given org. format: int64 type: integer code_security_host_top99p: - description: Shows the 99th percentile of all Code Security hosts over all - hours in the current date for the given org. + description: Shows the 99th percentile of all Code Security hosts over all hours in the current date for the given org. format: int64 type: integer container_avg: - description: Shows the average of all distinct containers over all hours - in the current date for all organizations. + description: Shows the average of all distinct containers over all hours in the current date for all organizations. format: int64 type: integer container_excl_agent_avg: - description: Shows the average of containers without the Datadog Agent over - all hours in the current date for all organizations. + description: Shows the average of containers without the Datadog Agent over all hours in the current date for all organizations. format: int64 type: integer container_hwm: - description: Shows the high-water mark of all distinct containers over all - hours in the current date for all organizations. + description: Shows the high-water mark of all distinct containers over all hours in the current date for all organizations. format: int64 type: integer csm_container_enterprise_compliance_count_sum: - description: Shows the sum of all Cloud Security Management Enterprise compliance - containers over all hours in the current date for the given org. + description: Shows the sum of all Cloud Security Management Enterprise compliance containers over all hours in the current date for the given org. format: int64 type: integer csm_container_enterprise_cws_count_sum: - description: Shows the sum of all Cloud Security Management Enterprise Cloud - Workload Security containers over all hours in the current date for the - given org. + description: Shows the sum of all Cloud Security Management Enterprise Cloud Workload Security containers over all hours in the current date for the given org. format: int64 type: integer csm_container_enterprise_total_count_sum: - description: Shows the sum of all Cloud Security Management Enterprise containers - over all hours in the current date for the given org. + description: Shows the sum of all Cloud Security Management Enterprise containers over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_aas_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise Azure app services hosts over all hours in the current date - for the given org. + description: Shows the 99th percentile of all Cloud Security Management Enterprise Azure app services hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_aws_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise AWS hosts over all hours in the current date for the given - org. + description: Shows the 99th percentile of all Cloud Security Management Enterprise AWS hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_azure_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise Azure hosts over all hours in the current date for the given - org. + description: Shows the 99th percentile of all Cloud Security Management Enterprise Azure hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_compliance_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise compliance hosts over all hours in the current date for the - given org. + description: Shows the 99th percentile of all Cloud Security Management Enterprise compliance hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_cws_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise Cloud Workload Security hosts over all hours in the current - date for the given org. + description: Shows the 99th percentile of all Cloud Security Management Enterprise Cloud Workload Security hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_gcp_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise GCP hosts over all hours in the current date for the given - org. + description: Shows the 99th percentile of all Cloud Security Management Enterprise GCP hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_oci_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise OCI hosts over all hours in the current date for the given - org. + description: Shows the 99th percentile of all Cloud Security Management Enterprise OCI hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_total_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise hosts over all hours in the current date for the given org. + description: Shows the 99th percentile of all Cloud Security Management Enterprise hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_pro_oci_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Pro OCI hosts over all hours in the current date for the given org. + description: Shows the 99th percentile of all Cloud Security Management Pro OCI hosts over all hours in the current date for the given org. format: int64 type: integer cspm_aas_host_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Pro Azure app services hosts over all hours in the current date for all - organizations. + description: Shows the 99th percentile of all Cloud Security Management Pro Azure app services hosts over all hours in the current date for all organizations. format: int64 type: integer cspm_aws_host_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Pro AWS hosts over all hours in the current date for all organizations. + description: Shows the 99th percentile of all Cloud Security Management Pro AWS hosts over all hours in the current date for all organizations. format: int64 type: integer cspm_azure_host_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Pro Azure hosts over all hours in the current date for all organizations. + description: Shows the 99th percentile of all Cloud Security Management Pro Azure hosts over all hours in the current date for all organizations. format: int64 type: integer cspm_container_avg: - description: Shows the average number of Cloud Security Management Pro containers - over all hours in the current date for all organizations. + description: Shows the average number of Cloud Security Management Pro containers over all hours in the current date for all organizations. format: int64 type: integer cspm_container_hwm: - description: Shows the high-water mark of Cloud Security Management Pro - containers over all hours in the current date for all organizations. + description: Shows the high-water mark of Cloud Security Management Pro containers over all hours in the current date for all organizations. format: int64 type: integer cspm_gcp_host_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Pro GCP hosts over all hours in the current date for all organizations. + description: Shows the 99th percentile of all Cloud Security Management Pro GCP hosts over all hours in the current date for all organizations. format: int64 type: integer cspm_host_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Pro hosts over all hours in the current date for all organizations. + description: Shows the 99th percentile of all Cloud Security Management Pro hosts over all hours in the current date for all organizations. format: int64 type: integer custom_ts_avg: - description: Shows the average number of distinct custom metrics over all - hours in the current date for all organizations. + description: Shows the average number of distinct custom metrics over all hours in the current date for all organizations. format: int64 type: integer cws_container_count_avg: - description: Shows the average of all distinct Cloud Workload Security containers - over all hours in the current date for all organizations. + description: Shows the average of all distinct Cloud Workload Security containers over all hours in the current date for all organizations. format: int64 type: integer cws_fargate_task_avg: - description: Shows the average of all distinct Cloud Workload Security Fargate - tasks over all hours in the current date for all organizations. + description: Shows the average of all distinct Cloud Workload Security Fargate tasks over all hours in the current date for all organizations. format: int64 type: integer cws_host_top99p: - description: Shows the 99th percentile of all Cloud Workload Security hosts - over all hours in the current date for all organizations. + description: Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current date for all organizations. format: int64 type: integer data_jobs_monitoring_host_hr_sum: - description: Shows the sum of all Data Jobs Monitoring hosts over all hours - in the current date for the given org. + description: Shows the sum of all Data Jobs Monitoring hosts over all hours in the current date for the given org. format: int64 type: integer date: @@ -22285,823 +20657,624 @@ components: format: date-time type: string dbm_host_top99p: - description: Shows the 99th percentile of all Database Monitoring hosts - over all hours in the current date for all organizations. + description: Shows the 99th percentile of all Database Monitoring hosts over all hours in the current date for all organizations. format: int64 type: integer dbm_queries_count_avg: - description: Shows the average of all normalized Database Monitoring queries - over all hours in the current date for all organizations. + description: Shows the average of all normalized Database Monitoring queries over all hours in the current date for all organizations. format: int64 type: integer eph_infra_host_agent_sum: - description: Shows the sum of all ephemeral infrastructure hosts with the - Datadog Agent over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts with the Datadog Agent over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_alibaba_sum: - description: Shows the sum of all ephemeral infrastructure hosts on Alibaba - over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts on Alibaba over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_aws_sum: - description: Shows the sum of all ephemeral infrastructure hosts on AWS - over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts on AWS over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_azure_sum: - description: Shows the sum of all ephemeral infrastructure hosts on Azure - over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts on Azure over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_ent_sum: - description: Shows the sum of all ephemeral infrastructure hosts for Enterprise - over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts for Enterprise over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_gcp_sum: - description: Shows the sum of all ephemeral infrastructure hosts on GCP - over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts on GCP over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_heroku_sum: - description: Shows the sum of all ephemeral infrastructure hosts on Heroku - over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts on Heroku over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_only_aas_sum: - description: Shows the sum of all ephemeral infrastructure hosts with only - Azure App Services over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts with only Azure App Services over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_only_vsphere_sum: - description: Shows the sum of all ephemeral infrastructure hosts with only - vSphere over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts with only vSphere over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_opentelemetry_apm_sum: - description: Shows the sum of all ephemeral APM hosts reported by the Datadog - exporter for the OpenTelemetry Collector over all hours in the current - date for the given org. + description: Shows the sum of all ephemeral APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_opentelemetry_sum: - description: Shows the sum of all ephemeral hosts reported by the Datadog - exporter for the OpenTelemetry Collector over all hours in the current - date for the given org. + description: Shows the sum of all ephemeral hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_pro_sum: - description: Shows the sum of all ephemeral infrastructure hosts for Pro - over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts for Pro over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_proplus_sum: - description: Shows the sum of all ephemeral infrastructure hosts for Pro - Plus over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts for Pro Plus over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_proxmox_sum: - description: Sum of all ephemeral infrastructure hosts for Proxmox over - all hours in the current date for all organizations. + description: Sum of all ephemeral infrastructure hosts for Proxmox over all hours in the current date for all organizations. format: int64 type: integer error_tracking_apm_error_events_sum: - description: Shows the sum of all Error Tracking APM error events over all - hours in the current date for the given org. + description: Shows the sum of all Error Tracking APM error events over all hours in the current date for the given org. format: int64 type: integer error_tracking_error_events_sum: - description: Shows the sum of all Error Tracking error events over all hours - in the current date for the given org. + description: Shows the sum of all Error Tracking error events over all hours in the current date for the given org. format: int64 type: integer error_tracking_events_sum: - description: Shows the sum of all Error Tracking events over all hours in - the current date for the given org. + description: Shows the sum of all Error Tracking events over all hours in the current date for the given org. format: int64 type: integer error_tracking_rum_error_events_sum: - description: Shows the sum of all Error Tracking RUM error events over all - hours in the current date for the given org. + description: Shows the sum of all Error Tracking RUM error events over all hours in the current date for the given org. format: int64 type: integer event_management_correlation_correlated_events_sum: - description: Shows the sum of all Event Management correlated events over - all hours in the current date for all organizations. + description: Shows the sum of all Event Management correlated events over all hours in the current date for all organizations. format: int64 type: integer event_management_correlation_correlated_related_events_sum: - description: Shows the sum of all Event Management correlated related events - over all hours in the current date for all organizations. + description: Shows the sum of all Event Management correlated related events over all hours in the current date for all organizations. format: int64 type: integer event_management_correlation_sum: - description: Shows the sum of all Event Management correlations over all - hours in the current date for all organizations. + description: Shows the sum of all Event Management correlations over all hours in the current date for all organizations. format: int64 type: integer fargate_container_profiler_profiling_fargate_avg: - description: The average number of Profiling Fargate tasks over all hours - in the current date for all organizations. + description: The average number of Profiling Fargate tasks over all hours in the current date for all organizations. format: int64 type: integer fargate_container_profiler_profiling_fargate_eks_avg: - description: The average number of Profiling Fargate Elastic Kubernetes - Service tasks over all hours in the current date for all organizations. + description: The average number of Profiling Fargate Elastic Kubernetes Service tasks over all hours in the current date for all organizations. format: int64 type: integer fargate_tasks_count_avg: - description: Shows the high-watermark of all Fargate tasks over all hours - in the current date for all organizations. + description: Shows the high-watermark of all Fargate tasks over all hours in the current date for all organizations. format: int64 type: integer fargate_tasks_count_hwm: - description: Shows the average of all Fargate tasks over all hours in the - current date for all organizations. + description: Shows the average of all Fargate tasks over all hours in the current date for all organizations. format: int64 type: integer flex_logs_compute_large_avg: - description: Shows the average number of Flex Logs Compute Large Instances - over all hours in the current date for the given org. + description: Shows the average number of Flex Logs Compute Large Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_medium_avg: - description: Shows the average number of Flex Logs Compute Medium Instances - over all hours in the current date for the given org. + description: Shows the average number of Flex Logs Compute Medium Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_small_avg: - description: Shows the average number of Flex Logs Compute Small Instances - over all hours in the current date for the given org. + description: Shows the average number of Flex Logs Compute Small Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_xlarge_avg: - description: Shows the average number of Flex Logs Compute Extra Large Instances - over all hours in the current date for the given org. + description: Shows the average number of Flex Logs Compute Extra Large Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_xsmall_avg: - description: Shows the average number of Flex Logs Compute Extra Small Instances - over all hours in the current date for the given org. + description: Shows the average number of Flex Logs Compute Extra Small Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_starter_avg: - description: Shows the average number of Flex Logs Starter Instances over - all hours in the current date for the given org. + description: Shows the average number of Flex Logs Starter Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_starter_storage_index_avg: - description: Shows the average number of Flex Logs Starter Storage Index - Instances over all hours in the current date for the given org. + description: Shows the average number of Flex Logs Starter Storage Index Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_starter_storage_retention_adjustment_avg: - description: Shows the average number of Flex Logs Starter Storage Retention - Adjustment Instances over all hours in the current date for the given - org. + description: Shows the average number of Flex Logs Starter Storage Retention Adjustment Instances over all hours in the current date for the given org. format: int64 type: integer flex_stored_logs_avg: - description: Shows the average of all Flex Stored Logs over all hours in - the current date for the given org. + description: Shows the average of all Flex Stored Logs over all hours in the current date for the given org. format: int64 type: integer forwarding_events_bytes_sum: - description: Shows the sum of all log bytes forwarded over all hours in - the current date for all organizations. + description: Shows the sum of all log bytes forwarded over all hours in the current date for all organizations. format: int64 type: integer gcp_host_top99p: - description: Shows the 99th percentile of all GCP hosts over all hours in - the current date for all organizations. + description: Shows the 99th percentile of all GCP hosts over all hours in the current date for all organizations. format: int64 type: integer heroku_host_top99p: - description: Shows the 99th percentile of all Heroku dynos over all hours - in the current date for all organizations. + description: Shows the 99th percentile of all Heroku dynos over all hours in the current date for all organizations. format: int64 type: integer incident_management_monthly_active_users_hwm: - description: Shows the high-water mark of incident management monthly active - users over all hours in the current date for all organizations. + description: Shows the high-water mark of incident management monthly active users over all hours in the current date for all organizations. format: int64 type: integer incident_management_seats_hwm: - description: Shows the high-water mark of Incident Management seats over - all hours on the current date for all organizations. + description: Shows the high-water mark of Incident Management seats over all hours on the current date for all organizations. format: int64 type: integer indexed_events_count_sum: - description: Shows the sum of all log events indexed over all hours in the - current date for all organizations. + description: Shows the sum of all log events indexed over all hours in the current date for all organizations. format: int64 type: integer infra_edge_monitoring_devices_top99p: - description: Shows the 99th percentile of all Edge Devices Monitoring devices - over all hours in the current date for all organizations. + description: Shows the 99th percentile of all Edge Devices Monitoring devices over all hours in the current date for all organizations. format: int64 type: integer infra_host_top99p: - description: Shows the 99th percentile of all distinct infrastructure hosts - over all hours in the current date for all organizations. + description: Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for all organizations. format: int64 type: integer ingested_events_bytes_sum: - description: Shows the sum of all log bytes ingested over all hours in the - current date for all organizations. + description: Shows the sum of all log bytes ingested over all hours in the current date for all organizations. format: int64 type: integer iot_device_sum: - description: Shows the sum of all IoT devices over all hours in the current - date for all organizations. + description: Shows the sum of all IoT devices over all hours in the current date for all organizations. format: int64 type: integer iot_device_top99p: - description: Shows the 99th percentile of all IoT devices over all hours - in the current date all organizations. + description: Shows the 99th percentile of all IoT devices over all hours in the current date all organizations. format: int64 type: integer llm_observability_min_spend_sum: - description: Sum of all LLM observability minimum spend over all hours in - the current date for all organizations. + description: Sum of all LLM observability minimum spend over all hours in the current date for all organizations. format: int64 type: integer llm_observability_sum: - description: Sum of all LLM observability sessions over all hours in the - current date for all organizations. + description: Sum of all LLM observability sessions over all hours in the current date for all organizations. format: int64 type: integer mobile_rum_lite_session_count_sum: deprecated: true - description: Shows the sum of all mobile lite sessions over all hours in - the current date for all organizations (To be deprecated on October 1st, - 2024). + description: Shows the sum of all mobile lite sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_android_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions on Android over all - hours in the current date for all organizations (To be deprecated on October - 1st, 2024). + description: Shows the sum of all mobile RUM sessions on Android over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_flutter_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions on Flutter over all - hours in the current date for all organizations (To be deprecated on October - 1st, 2024). + description: Shows the sum of all mobile RUM sessions on Flutter over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_ios_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions on iOS over all hours - in the current date for all organizations (To be deprecated on October - 1st, 2024). + description: Shows the sum of all mobile RUM sessions on iOS over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_reactnative_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions on React Native over - all hours in the current date for all organizations (To be deprecated - on October 1st, 2024). + description: Shows the sum of all mobile RUM sessions on React Native over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_roku_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions on Roku over all hours - in the current date for all organizations (To be deprecated on October - 1st, 2024). + description: Shows the sum of all mobile RUM sessions on Roku over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions over all hours in - the current date for all organizations (To be deprecated on October 1st, - 2024). + description: Shows the sum of all mobile RUM sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_units_sum: deprecated: true - description: Shows the sum of all mobile RUM units over all hours in the - current date for all organizations (To be deprecated on October 1st, 2024). + description: Shows the sum of all mobile RUM units over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer ndm_netflow_events_sum: - description: Shows the sum of all Network Device Monitoring NetFlow events - over all hours in the current date for the given org. + description: Shows the sum of all Network Device Monitoring NetFlow events over all hours in the current date for the given org. format: int64 type: integer netflow_indexed_events_count_sum: deprecated: true - description: Shows the sum of all Network flows indexed over all hours in - the current date for all organizations (To be deprecated on October 1st, - 2024). + description: Shows the sum of all Network flows indexed over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer network_device_wireless_top99p: - description: Shows the 99th percentile of all Network Device Monitoring - wireless devices over all hours in the current date for all organizations. + description: Shows the 99th percentile of all Network Device Monitoring wireless devices over all hours in the current date for all organizations. format: int64 type: integer network_path_sum: - description: Shows the sum of all Network Path scheduled tests over all - hours in the current date for all organizations. + description: Shows the sum of all Network Path scheduled tests over all hours in the current date for all organizations. format: int64 type: integer npm_host_top99p: - description: Shows the 99th percentile of all distinct Cloud Network Monitoring - hosts (formerly known as Network hosts) over all hours in the current - date for all organizations. + description: Shows the 99th percentile of all distinct Cloud Network Monitoring hosts (formerly known as Network hosts) over all hours in the current date for all organizations. format: int64 type: integer observability_pipelines_bytes_processed_sum: - description: Sum of all observability pipelines bytes processed over all - hours in the current date for the given org. + description: Sum of all observability pipelines bytes processed over all hours in the current date for the given org. format: int64 type: integer oci_host_sum: - description: Shows the sum of all Oracle Cloud Infrastructure hosts over - all hours in the current date for the given org. + description: Shows the sum of all Oracle Cloud Infrastructure hosts over all hours in the current date for the given org. format: int64 type: integer oci_host_top99p: - description: Shows the 99th percentile of all Oracle Cloud Infrastructure - hosts over all hours in the current date for the given org. + description: Shows the 99th percentile of all Oracle Cloud Infrastructure hosts over all hours in the current date for the given org. format: int64 type: integer on_call_seat_hwm: - description: Shows the high-water mark of On-Call seats over all hours in - the current date for all organizations. + description: Shows the high-water mark of On-Call seats over all hours in the current date for all organizations. format: int64 type: integer online_archive_events_count_sum: - description: Sum of all online archived events over all hours in the current - date for all organizations. + description: Sum of all online archived events over all hours in the current date for all organizations. format: int64 type: integer opentelemetry_apm_host_top99p: - description: Shows the 99th percentile of APM hosts reported by the Datadog - exporter for the OpenTelemetry Collector over all hours in the current - date for all organizations. + description: Shows the 99th percentile of APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for all organizations. format: int64 type: integer opentelemetry_host_top99p: - description: Shows the 99th percentile of all hosts reported by the Datadog - exporter for the OpenTelemetry Collector over all hours in the current - date for all organizations. + description: Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for all organizations. format: int64 type: integer orgs: description: Organizations associated with a user. items: - $ref: '#/components/schemas/UsageSummaryDateOrg' + $ref: "#/components/schemas/UsageSummaryDateOrg" type: array product_analytics_sum: - description: Sum of all product analytics sessions over all hours in the - current date for all organizations. + description: Sum of all product analytics sessions over all hours in the current date for all organizations. format: int64 type: integer profiling_aas_count_top99p: - description: Shows the 99th percentile of all profiled Azure app services - over all hours in the current date for all organizations. + description: Shows the 99th percentile of all profiled Azure app services over all hours in the current date for all organizations. format: int64 type: integer profiling_host_top99p: - description: Shows the 99th percentile of all profiled hosts over all hours - within the current date for all organizations. + description: Shows the 99th percentile of all profiled hosts over all hours within the current date for all organizations. format: int64 type: integer proxmox_host_sum: - description: Sum of all Proxmox hosts over all hours in the current date - for all organizations. + description: Sum of all Proxmox hosts over all hours in the current date for all organizations. format: int64 type: integer proxmox_host_top99p: - description: 99th percentile of all Proxmox hosts over all hours in the - current date for all organizations. + description: 99th percentile of all Proxmox hosts over all hours in the current date for all organizations. format: int64 type: integer published_app_hwm: - description: Shows the high-water mark of all published applications over - all hours in the current date for all organizations. + description: Shows the high-water mark of all published applications over all hours in the current date for all organizations. format: int64 type: integer rum_browser_and_mobile_session_count: - description: Shows the sum of all mobile sessions and all browser lite and - legacy sessions over all hours in the current month for all organizations - (To be deprecated on October 1st, 2024). + description: Shows the sum of all mobile sessions and all browser lite and legacy sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer rum_browser_legacy_session_count_sum: - description: Shows the sum of all browser RUM legacy sessions over all hours - in the current date for all organizations (To be introduced on October - 1st, 2024). + description: Shows the sum of all browser RUM legacy sessions over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_browser_lite_session_count_sum: - description: Shows the sum of all browser RUM lite sessions over all hours - in the current date for all organizations (To be introduced on October - 1st, 2024). + description: Shows the sum of all browser RUM lite sessions over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_browser_replay_session_count_sum: - description: Shows the sum of all browser RUM Session Replay counts over - all hours in the current date for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all browser RUM Session Replay counts over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_indexed_sessions_sum: - description: Sum of all RUM indexed sessions over all hours in the current - date for all organizations. + description: Sum of all RUM indexed sessions over all hours in the current date for all organizations. format: int64 type: integer rum_ingested_sessions_sum: - description: Sum of all RUM ingested sessions over all hours in the current - date for all organizations. + description: Sum of all RUM ingested sessions over all hours in the current date for all organizations. format: int64 type: integer rum_lite_session_count_sum: - description: Shows the sum of all RUM lite sessions (browser and mobile) - over all hours in the current date for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all RUM lite sessions (browser and mobile) over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_android_sum: - description: Shows the sum of all mobile RUM legacy sessions on Android - over all hours in the current date for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM legacy sessions on Android over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_flutter_sum: - description: Shows the sum of all mobile RUM legacy Sessions on Flutter - over all hours in the current date for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM legacy Sessions on Flutter over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_ios_sum: - description: Shows the sum of all mobile RUM legacy sessions on iOS over - all hours in the current date for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM legacy sessions on iOS over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_reactnative_sum: - description: Shows the sum of all mobile RUM legacy sessions on React Native - over all hours in the current date for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM legacy sessions on React Native over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_roku_sum: - description: Shows the sum of all mobile RUM legacy sessions on Roku over - all hours in the current date for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM legacy sessions on Roku over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_android_sum: - description: Shows the sum of all mobile RUM lite sessions on Android over - all hours in the current date for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM lite sessions on Android over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_flutter_sum: - description: Shows the sum of all mobile RUM lite sessions on Flutter over - all hours in the current date for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM lite sessions on Flutter over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_ios_sum: - description: Shows the sum of all mobile RUM lite sessions on iOS over all - hours in the current date for all organizations (To be introduced on October - 1st, 2024). + description: Shows the sum of all mobile RUM lite sessions on iOS over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_kotlinmultiplatform_sum: - description: Shows the sum of all mobile RUM lite sessions on Kotlin Multiplatform - over all hours within the current date for all organizations. + description: Shows the sum of all mobile RUM lite sessions on Kotlin Multiplatform over all hours within the current date for all organizations. format: int64 type: integer rum_mobile_lite_session_count_reactnative_sum: - description: Shows the sum of all mobile RUM lite sessions on React Native - over all hours in the current date for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM lite sessions on React Native over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_roku_sum: - description: Shows the sum of all mobile RUM lite sessions on Roku over - all hours within the current date for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM lite sessions on Roku over all hours within the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_unity_sum: - description: Shows the sum of all mobile RUM lite sessions on Unity over - all hours within the current date for all organizations. + description: Shows the sum of all mobile RUM lite sessions on Unity over all hours within the current date for all organizations. format: int64 type: integer rum_mobile_replay_session_count_android_sum: - description: Shows the sum of all mobile RUM replay sessions on Android - over all hours within the current date for the given org. + description: Shows the sum of all mobile RUM replay sessions on Android over all hours within the current date for the given org. format: int64 type: integer rum_mobile_replay_session_count_ios_sum: - description: Shows the sum of all mobile RUM replay sessions on iOS over - all hours within the current date for the given org. + description: Shows the sum of all mobile RUM replay sessions on iOS over all hours within the current date for the given org. format: int64 type: integer rum_mobile_replay_session_count_kotlinmultiplatform_sum: - description: Shows the sum of all mobile RUM replay sessions on Kotlin Multiplatform - over all hours within the current date for all organizations. + description: Shows the sum of all mobile RUM replay sessions on Kotlin Multiplatform over all hours within the current date for all organizations. format: int64 type: integer rum_mobile_replay_session_count_reactnative_sum: - description: Shows the sum of all mobile RUM replay sessions on React Native - over all hours within the current date for the given org. + description: Shows the sum of all mobile RUM replay sessions on React Native over all hours within the current date for the given org. format: int64 type: integer rum_replay_session_count_sum: - description: Shows the sum of all RUM Session Replay counts over all hours - in the current date for all organizations (To be introduced on October - 1st, 2024). + description: Shows the sum of all RUM Session Replay counts over all hours in the current date for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_session_count_sum: deprecated: true - description: Shows the sum of all browser RUM lite sessions over all hours - in the current date for all organizations (To be deprecated on October - 1st, 2024). + description: Shows the sum of all browser RUM lite sessions over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer rum_session_replay_add_on_sum: - description: Sum of all RUM session replay add-on sessions over all hours - in the current date for all organizations. + description: Sum of all RUM session replay add-on sessions over all hours in the current date for all organizations. format: int64 type: integer rum_total_session_count_sum: - description: Shows the sum of RUM sessions (browser and mobile) over all - hours in the current date for all organizations. + description: Shows the sum of RUM sessions (browser and mobile) over all hours in the current date for all organizations. format: int64 type: integer rum_units_sum: deprecated: true - description: Shows the sum of all browser and mobile RUM units over all - hours in the current date for all organizations (To be deprecated on October - 1st, 2024). + description: Shows the sum of all browser and mobile RUM units over all hours in the current date for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer sca_fargate_count_avg: - description: Shows the average of all Software Composition Analysis Fargate - tasks over all hours in the current date for the given org. + description: Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org. format: int64 type: integer sca_fargate_count_hwm: - description: Shows the sum of the high-water marks of all Software Composition - Analysis Fargate tasks over all hours in the current date for the given - org. + description: Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org. format: int64 type: integer sds_apm_scanned_bytes_sum: - description: Sum of all APM bytes scanned with sensitive data scanner over - all hours in the current date for all organizations. + description: Sum of all APM bytes scanned with sensitive data scanner over all hours in the current date for all organizations. format: int64 type: integer sds_events_scanned_bytes_sum: - description: Sum of all event stream events bytes scanned with sensitive - data scanner over all hours in the current date for all organizations. + description: Sum of all event stream events bytes scanned with sensitive data scanner over all hours in the current date for all organizations. format: int64 type: integer sds_logs_scanned_bytes_sum: - description: Shows the sum of all bytes scanned of logs usage by the Sensitive - Data Scanner over all hours in the current month for all organizations. + description: Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for all organizations. format: int64 type: integer sds_rum_scanned_bytes_sum: - description: Sum of all RUM bytes scanned with sensitive data scanner over - all hours in the current date for all organizations. + description: Sum of all RUM bytes scanned with sensitive data scanner over all hours in the current date for all organizations. format: int64 type: integer sds_total_scanned_bytes_sum: - description: Shows the sum of all bytes scanned across all usage types by - the Sensitive Data Scanner over all hours in the current month for all - organizations. + description: Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for all organizations. format: int64 type: integer serverless_apps_apm_apm_azure_appservice_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring for Azure App Service instances for the current - date for all organizations. + description: Shows the average number of Serverless Apps with Application Performance Monitoring for Azure App Service instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_apm_azure_azurefunction_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring for Azure Function instances for the current date - for all organizations. + description: Shows the average number of Serverless Apps with Application Performance Monitoring for Azure Function instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_apm_azure_containerapp_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring for Azure Container App instances for the current - date for all organizations. + description: Shows the average number of Serverless Apps with Application Performance Monitoring for Azure Container App instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_apm_fargate_ecs_tasks_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring for Fargate Elastic Container Service tasks for - the current date for all organizations. + description: Shows the average number of Serverless Apps with Application Performance Monitoring for Fargate Elastic Container Service tasks for the current date for all organizations. format: int64 type: integer serverless_apps_apm_apm_gcp_cloudfunction_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring for Google Cloud Platform Cloud Function instances - for the current date for all organizations. + description: Shows the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Function instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_apm_gcp_cloudrun_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring for Google Cloud Platform Cloud Run instances for - the current date for all organizations. + description: Shows the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Run instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring for the current date for all organizations. + description: Shows the average number of Serverless Apps with Application Performance Monitoring for the current date for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_appservice_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for Azure App Service instances - for the current date for all organizations. + description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure App Service instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_azurefunction_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for Azure Function instances - for the current date for all organizations. + description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Function instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_containerapp_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for Azure Container App instances - for the current date for all organizations. + description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Container App instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_gcp_cloudfunction_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for Google Cloud Platform Cloud - Function instances for the current date for all organizations. + description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Function instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_gcp_cloudrun_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for Google Cloud Platform Cloud - Run instances for the current date for all organizations. + description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Run instances for the current date for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for the current date for all - organizations. + description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for the current date for all organizations. format: int64 type: integer serverless_apps_azure_container_app_instances_avg: - description: Shows the average number of Serverless Apps for Azure Container - App instances for the current date for all organizations. + description: Shows the average number of Serverless Apps for Azure Container App instances for the current date for all organizations. format: int64 type: integer serverless_apps_azure_count_avg: - description: Shows the average number of Serverless Apps for Azure for the - given date and given org. + description: Shows the average number of Serverless Apps for Azure for the given date and given org. format: int64 type: integer serverless_apps_azure_function_app_instances_avg: - description: Shows the average number of Serverless Apps for Azure Function - App instances for the current date for all organizations. + description: Shows the average number of Serverless Apps for Azure Function App instances for the current date for all organizations. format: int64 type: integer serverless_apps_azure_web_app_instances_avg: - description: Shows the average number of Serverless Apps for Azure Web App - instances for the current date for all organizations. + description: Shows the average number of Serverless Apps for Azure Web App instances for the current date for all organizations. format: int64 type: integer serverless_apps_ecs_avg: - description: Shows the average number of Serverless Apps for Elastic Container - Service for the current date for all organizations. + description: Shows the average number of Serverless Apps for Elastic Container Service for the current date for all organizations. format: int64 type: integer serverless_apps_eks_avg: - description: Shows the average number of Serverless Apps for Elastic Kubernetes - Service for the current date for all organizations. + description: Shows the average number of Serverless Apps for Elastic Kubernetes Service for the current date for all organizations. format: int64 type: integer serverless_apps_excl_fargate_avg: - description: Shows the average number of Serverless Apps excluding Fargate - for the current date for all organizations. + description: Shows the average number of Serverless Apps excluding Fargate for the current date for all organizations. format: int64 type: integer serverless_apps_excl_fargate_azure_container_app_instances_avg: - description: Shows the average number of Serverless Apps excluding Fargate - for Azure Container App instances for the current date for all organizations. + description: Shows the average number of Serverless Apps excluding Fargate for Azure Container App instances for the current date for all organizations. format: int64 type: integer serverless_apps_excl_fargate_azure_function_app_instances_avg: - description: Shows the average number of Serverless Apps excluding Fargate - for Azure Function App instances for the current date for all organizations. + description: Shows the average number of Serverless Apps excluding Fargate for Azure Function App instances for the current date for all organizations. format: int64 type: integer serverless_apps_excl_fargate_azure_web_app_instances_avg: - description: Shows the average number of Serverless Apps excluding Fargate - for Azure Web App instances for the current date for all organizations. + description: Shows the average number of Serverless Apps excluding Fargate for Azure Web App instances for the current date for all organizations. format: int64 type: integer serverless_apps_excl_fargate_google_cloud_functions_instances_avg: - description: Shows the average number of Serverless Apps excluding Fargate - for Google Cloud Platform Cloud Functions instances for the current date - for all organizations. + description: Shows the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Functions instances for the current date for all organizations. format: int64 type: integer serverless_apps_excl_fargate_google_cloud_run_instances_avg: - description: Shows the average number of Serverless Apps excluding Fargate - for Google Cloud Platform Cloud Run instances for the current date for - all organizations. + description: Shows the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Run instances for the current date for all organizations. format: int64 type: integer serverless_apps_google_cloud_functions_instances_avg: - description: Shows the average number of Serverless Apps for Google Cloud - Platform Cloud Functions instances for the current date for all organizations. + description: Shows the average number of Serverless Apps for Google Cloud Platform Cloud Functions instances for the current date for all organizations. format: int64 type: integer serverless_apps_google_cloud_run_instances_avg: - description: Shows the average number of Serverless Apps for Google Cloud - Platform Cloud Run instances for the current date for all organizations. + description: Shows the average number of Serverless Apps for Google Cloud Platform Cloud Run instances for the current date for all organizations. format: int64 type: integer serverless_apps_google_count_avg: - description: Shows the average number of Serverless Apps for Google Cloud - for the given date and given org. + description: Shows the average number of Serverless Apps for Google Cloud for the given date and given org. format: int64 type: integer serverless_apps_total_count_avg: - description: Shows the average number of Serverless Apps for Azure and Google - Cloud for the given date and given org. + description: Shows the average number of Serverless Apps for Azure and Google Cloud for the given date and given org. format: int64 type: integer siem_analyzed_logs_add_on_count_sum: - description: Shows the sum of all log events analyzed by Cloud SIEM over - all hours in the current date for the given org. + description: Shows the sum of all log events analyzed by Cloud SIEM over all hours in the current date for the given org. format: int64 type: integer synthetics_browser_check_calls_count_sum: - description: Shows the sum of all Synthetic browser tests over all hours - in the current date for all organizations. + description: Shows the sum of all Synthetic browser tests over all hours in the current date for all organizations. format: int64 type: integer synthetics_check_calls_count_sum: - description: Shows the sum of all Synthetic API tests over all hours in - the current date for all organizations. + description: Shows the sum of all Synthetic API tests over all hours in the current date for all organizations. format: int64 type: integer synthetics_mobile_test_runs_sum: - description: Shows the sum of all Synthetic mobile application tests over - all hours in the current date for all organizations. + description: Shows the sum of all Synthetic mobile application tests over all hours in the current date for all organizations. format: int64 type: integer synthetics_parallel_testing_max_slots_hwm: - description: Shows the high-water mark of used synthetics parallel testing - slots over all hours in the current date for all organizations. + description: Shows the high-water mark of used synthetics parallel testing slots over all hours in the current date for all organizations. format: int64 type: integer trace_search_indexed_events_count_sum: - description: Shows the sum of all Indexed Spans indexed over all hours in - the current date for all organizations. + description: Shows the sum of all Indexed Spans indexed over all hours in the current date for all organizations. format: int64 type: integer twol_ingested_events_bytes_sum: - description: Shows the sum of all ingested APM span bytes over all hours - in the current date for all organizations. + description: Shows the sum of all ingested APM span bytes over all hours in the current date for all organizations. format: int64 type: integer universal_service_monitoring_host_top99p: - description: Shows the 99th percentile of all universal service management - hosts over all hours in the current date for the given org. + description: Shows the 99th percentile of all universal service management hosts over all hours in the current date for the given org. format: int64 type: integer vsphere_host_top99p: - description: Shows the 99th percentile of all vSphere hosts over all hours - in the current date for all organizations. + description: Shows the 99th percentile of all vSphere hosts over all hours in the current date for all organizations. format: int64 type: integer vuln_management_host_count_top99p: - description: Shows the 99th percentile of all Application Vulnerability - Management hosts over all hours in the current date for the given org. + description: Shows the 99th percentile of all Application Vulnerability Management hosts over all hours in the current date for the given org. format: int64 type: integer workflow_executions_usage_sum: - description: Sum of all workflows executed over all hours in the current - date for all organizations. + description: Sum of all workflows executed over all hours in the current date for all organizations. format: int64 type: integer type: object UsageSummaryDateOrg: - description: Global hourly report of all data billed by Datadog for a given - organization. + description: Global hourly report of all data billed by Datadog for a given organization. properties: account_name: description: The account name. @@ -23110,475 +21283,370 @@ components: description: The account public id. type: string agent_host_top99p: - description: Shows the 99th percentile of all agent hosts over all hours - in the current date for the given org. + description: Shows the 99th percentile of all agent hosts over all hours in the current date for the given org. format: int64 type: integer apm_azure_app_service_host_top99p: - description: Shows the 99th percentile of all Azure app services using APM - over all hours in the current date for the given org. + description: Shows the 99th percentile of all Azure app services using APM over all hours in the current date for the given org. format: int64 type: integer apm_devsecops_host_top99p: - description: Shows the 99th percentile of all APM DevSecOps hosts over all - hours in the current date for the given org. + description: Shows the 99th percentile of all APM DevSecOps hosts over all hours in the current date for the given org. format: int64 type: integer apm_enterprise_standalone_hosts_top99p: - description: Shows the 99th percentile of all distinct standalone Enterprise - hosts over all hours in the current date for the given org. + description: Shows the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current date for the given org. format: int64 type: integer apm_fargate_count_avg: - description: Shows the average of all APM ECS Fargate tasks over all hours - in the current month for the given org. + description: Shows the average of all APM ECS Fargate tasks over all hours in the current month for the given org. format: int64 type: integer apm_host_top99p: - description: Shows the 99th percentile of all distinct APM hosts over all - hours in the current date for the given org. + description: Shows the 99th percentile of all distinct APM hosts over all hours in the current date for the given org. format: int64 type: integer apm_pro_standalone_hosts_top99p: - description: Shows the 99th percentile of all distinct standalone Pro hosts - over all hours in the current date for the given org. + description: Shows the 99th percentile of all distinct standalone Pro hosts over all hours in the current date for the given org. format: int64 type: integer appsec_fargate_count_avg: - description: Shows the average of all Application Security Monitoring ECS - Fargate tasks over all hours in the current month for the given org. + description: Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for the given org. format: int64 type: integer asm_serverless_sum: - description: Shows the sum of all Application Security Monitoring Serverless - invocations over all hours in the current month for the given org. + description: Shows the sum of all Application Security Monitoring Serverless invocations over all hours in the current month for the given org. format: int64 type: integer audit_logs_lines_indexed_sum: deprecated: true - description: Shows the sum of all audit logs lines indexed over all hours - in the current date for the given org (To be deprecated on October 1st, - 2024). + description: Shows the sum of all audit logs lines indexed over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer audit_trail_enabled_hwm: - description: Shows whether Audit Trail is enabled for the current date for - the given org. + description: Shows whether Audit Trail is enabled for the current date for the given org. format: int64 type: integer avg_profiled_fargate_tasks: - description: The average total count for Fargate Container Profiler over - all hours in the current month for the given org. + description: The average total count for Fargate Container Profiler over all hours in the current month for the given org. format: int64 type: integer aws_host_top99p: - description: Shows the 99th percentile of all AWS hosts over all hours in - the current date for the given org. + description: Shows the 99th percentile of all AWS hosts over all hours in the current date for the given org. format: int64 type: integer aws_lambda_func_count: - description: Shows the sum of all AWS Lambda invocations over all hours - in the current date for the given org. + description: Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. format: int64 type: integer aws_lambda_invocations_sum: - description: Shows the sum of all AWS Lambda invocations over all hours - in the current date for the given org. + description: Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. format: int64 type: integer azure_app_service_top99p: - description: Shows the 99th percentile of all Azure app services over all - hours in the current date for the given org. + description: Shows the 99th percentile of all Azure app services over all hours in the current date for the given org. format: int64 type: integer billable_ingested_bytes_sum: - description: Shows the sum of all log bytes ingested over all hours in the - current date for the given org. + description: Shows the sum of all log bytes ingested over all hours in the current date for the given org. format: int64 type: integer bits_ai_investigations_sum: - description: Shows the sum of all Bits AI Investigations over all hours - in the current date for the given org. + description: Shows the sum of all Bits AI Investigations over all hours in the current date for the given org. format: int64 type: integer browser_rum_lite_session_count_sum: deprecated: true - description: Shows the sum of all browser lite sessions over all hours in - the current date for the given org (To be deprecated on October 1st, 2024). + description: Shows the sum of all browser lite sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer browser_rum_replay_session_count_sum: - description: Shows the sum of all browser replay sessions over all hours - in the current date for the given org (To be deprecated on October 1st, - 2024). + description: Shows the sum of all browser replay sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer browser_rum_units_sum: deprecated: true - description: Shows the sum of all browser RUM units over all hours in the - current date for the given org (To be deprecated on October 1st, 2024). + description: Shows the sum of all browser RUM units over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer ccm_spend_monitored_ent_last: - description: Shows the last value of the amount of cloud spend monitored - for Enterprise over all hours in the current date for the given org. + description: Shows the last value of the amount of cloud spend monitored for Enterprise over all hours in the current date for the given org. format: int64 type: integer ccm_spend_monitored_pro_last: - description: Shows the last value of the amount of cloud spend monitored - for Pro over all hours in the current date for the given org. + description: Shows the last value of the amount of cloud spend monitored for Pro over all hours in the current date for the given org. format: int64 type: integer ci_pipeline_indexed_spans_sum: - description: Shows the sum of all CI pipeline indexed spans over all hours - in the current date for the given org. + description: Shows the sum of all CI pipeline indexed spans over all hours in the current date for the given org. format: int64 type: integer ci_test_indexed_spans_sum: - description: Shows the sum of all CI test indexed spans over all hours in - the current date for the given org. + description: Shows the sum of all CI test indexed spans over all hours in the current date for the given org. format: int64 type: integer ci_visibility_itr_committers_hwm: - description: Shows the high-water mark of all CI visibility intelligent - test runner committers over all hours in the current date for the given - org. + description: Shows the high-water mark of all CI visibility intelligent test runner committers over all hours in the current date for the given org. format: int64 type: integer ci_visibility_pipeline_committers_hwm: - description: Shows the high-water mark of all CI visibility pipeline committers - over all hours in the current date for the given org. + description: Shows the high-water mark of all CI visibility pipeline committers over all hours in the current date for the given org. format: int64 type: integer ci_visibility_test_committers_hwm: - description: Shows the high-water mark of all CI visibility test committers - over all hours in the current date for the given org. + description: Shows the high-water mark of all CI visibility test committers over all hours in the current date for the given org. format: int64 type: integer cloud_cost_management_aws_host_count_avg: - description: Host count average of Cloud Cost Management for AWS for the - given date and given org. + description: Host count average of Cloud Cost Management for AWS for the given date and given org. format: int64 type: integer cloud_cost_management_azure_host_count_avg: - description: Host count average of Cloud Cost Management for Azure for the - given date and given org. + description: Host count average of Cloud Cost Management for Azure for the given date and given org. format: int64 type: integer cloud_cost_management_gcp_host_count_avg: - description: Host count average of Cloud Cost Management for GCP for the - given date and given org. + description: Host count average of Cloud Cost Management for GCP for the given date and given org. format: int64 type: integer cloud_cost_management_host_count_avg: - description: Host count average of Cloud Cost Management for all cloud providers - for the given date and given org. + description: Host count average of Cloud Cost Management for all cloud providers for the given date and given org. format: int64 type: integer cloud_cost_management_oci_host_count_avg: - description: Average host count for Cloud Cost Management on OCI for the - given date and organization. + description: Average host count for Cloud Cost Management on OCI for the given date and organization. format: int64 type: integer cloud_siem_events_sum: - description: Shows the sum of all Cloud Security Information and Event Management - events over all hours in the current date for the given org. + description: Shows the sum of all Cloud Security Information and Event Management events over all hours in the current date for the given org. format: int64 type: integer code_analysis_sa_committers_hwm: - description: Shows the high-water mark of all Static Analysis committers - over all hours in the current date for the given org. + description: Shows the high-water mark of all Static Analysis committers over all hours in the current date for the given org. format: int64 type: integer code_analysis_sca_committers_hwm: - description: Shows the high-water mark of all static Software Composition - Analysis committers over all hours in the current date for the given org. + description: Shows the high-water mark of all static Software Composition Analysis committers over all hours in the current date for the given org. format: int64 type: integer code_security_host_top99p: - description: Shows the 99th percentile of all Code Security hosts over all - hours in the current date for the given org. + description: Shows the 99th percentile of all Code Security hosts over all hours in the current date for the given org. format: int64 type: integer container_avg: - description: Shows the average of all distinct containers over all hours - in the current date for the given org. + description: Shows the average of all distinct containers over all hours in the current date for the given org. format: int64 type: integer container_excl_agent_avg: - description: Shows the average of containers without the Datadog Agent over - all hours in the current date for the given organization. + description: Shows the average of containers without the Datadog Agent over all hours in the current date for the given organization. format: int64 type: integer container_hwm: - description: Shows the high-water mark of all distinct containers over all - hours in the current date for the given org. + description: Shows the high-water mark of all distinct containers over all hours in the current date for the given org. format: int64 type: integer csm_container_enterprise_compliance_count_sum: - description: Shows the sum of all Cloud Security Management Enterprise compliance - containers over all hours in the current date for the given org. + description: Shows the sum of all Cloud Security Management Enterprise compliance containers over all hours in the current date for the given org. format: int64 type: integer csm_container_enterprise_cws_count_sum: - description: Shows the sum of all Cloud Security Management Enterprise Cloud - Workload Security containers over all hours in the current date for the - given org. + description: Shows the sum of all Cloud Security Management Enterprise Cloud Workload Security containers over all hours in the current date for the given org. format: int64 type: integer csm_container_enterprise_total_count_sum: - description: Shows the sum of all Cloud Security Management Enterprise containers - over all hours in the current date for the given org. + description: Shows the sum of all Cloud Security Management Enterprise containers over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_aas_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise Azure app services hosts over all hours in the current date - for the given org. + description: Shows the 99th percentile of all Cloud Security Management Enterprise Azure app services hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_aws_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise AWS hosts over all hours in the current date for the given - org. + description: Shows the 99th percentile of all Cloud Security Management Enterprise AWS hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_azure_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise Azure hosts over all hours in the current date for the given - org. + description: Shows the 99th percentile of all Cloud Security Management Enterprise Azure hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_compliance_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise compliance hosts over all hours in the current date for the - given org. + description: Shows the 99th percentile of all Cloud Security Management Enterprise compliance hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_cws_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise Cloud Workload Security hosts over all hours in the current - date for the given org. + description: Shows the 99th percentile of all Cloud Security Management Enterprise Cloud Workload Security hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_gcp_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise GCP hosts over all hours in the current date for the given - org. + description: Shows the 99th percentile of all Cloud Security Management Enterprise GCP hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_oci_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise OCI hosts over all hours in the current date for the given - org. + description: Shows the 99th percentile of all Cloud Security Management Enterprise OCI hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_enterprise_total_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise hosts over all hours in the current date for the given org. + description: Shows the 99th percentile of all Cloud Security Management Enterprise hosts over all hours in the current date for the given org. format: int64 type: integer csm_host_pro_oci_host_count_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Pro OCI hosts over all hours in the current date for the given org. + description: Shows the 99th percentile of all Cloud Security Management Pro OCI hosts over all hours in the current date for the given org. format: int64 type: integer cspm_aas_host_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Pro Azure app services hosts over all hours in the current date for the - given org. + description: Shows the 99th percentile of all Cloud Security Management Pro Azure app services hosts over all hours in the current date for the given org. format: int64 type: integer cspm_aws_host_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Pro AWS hosts over all hours in the current date for the given org. + description: Shows the 99th percentile of all Cloud Security Management Pro AWS hosts over all hours in the current date for the given org. format: int64 type: integer cspm_azure_host_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Pro Azure hosts over all hours in the current date for the given org. + description: Shows the 99th percentile of all Cloud Security Management Pro Azure hosts over all hours in the current date for the given org. format: int64 type: integer cspm_container_avg: - description: Shows the average number of Cloud Security Management Pro containers - over all hours in the current date for the given org. + description: Shows the average number of Cloud Security Management Pro containers over all hours in the current date for the given org. format: int64 type: integer cspm_container_hwm: - description: Shows the high-water mark of Cloud Security Management Pro - containers over all hours in the current date for the given org. + description: Shows the high-water mark of Cloud Security Management Pro containers over all hours in the current date for the given org. format: int64 type: integer cspm_gcp_host_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Pro GCP hosts over all hours in the current date for the given org. + description: Shows the 99th percentile of all Cloud Security Management Pro GCP hosts over all hours in the current date for the given org. format: int64 type: integer cspm_host_top99p: - description: Shows the 99th percentile of all Cloud Security Management - Pro hosts over all hours in the current date for the given org. + description: Shows the 99th percentile of all Cloud Security Management Pro hosts over all hours in the current date for the given org. format: int64 type: integer custom_historical_ts_avg: - description: Shows the average number of distinct historical custom metrics - over all hours in the current date for the given org. + description: Shows the average number of distinct historical custom metrics over all hours in the current date for the given org. format: int64 type: integer custom_live_ts_avg: - description: Shows the average number of distinct live custom metrics over - all hours in the current date for the given org. + description: Shows the average number of distinct live custom metrics over all hours in the current date for the given org. format: int64 type: integer custom_ts_avg: - description: Shows the average number of distinct custom metrics over all - hours in the current date for the given org. + description: Shows the average number of distinct custom metrics over all hours in the current date for the given org. format: int64 type: integer cws_container_count_avg: - description: Shows the average of all distinct Cloud Workload Security containers - over all hours in the current date for the given org. + description: Shows the average of all distinct Cloud Workload Security containers over all hours in the current date for the given org. format: int64 type: integer cws_fargate_task_avg: - description: Shows the average of all distinct Cloud Workload Security Fargate - tasks over all hours in the current date for the given org. + description: Shows the average of all distinct Cloud Workload Security Fargate tasks over all hours in the current date for the given org. format: int64 type: integer cws_host_top99p: - description: Shows the 99th percentile of all Cloud Workload Security hosts - over all hours in the current date for the given org. + description: Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current date for the given org. format: int64 type: integer data_jobs_monitoring_host_hr_sum: - description: Shows the sum of all Data Jobs Monitoring hosts over all hours - in the current date for the given org. + description: Shows the sum of all Data Jobs Monitoring hosts over all hours in the current date for the given org. format: int64 type: integer dbm_host_top99p_sum: - description: Shows the 99th percentile of all Database Monitoring hosts - over all hours in the current month for the given org. + description: Shows the 99th percentile of all Database Monitoring hosts over all hours in the current month for the given org. format: int64 type: integer dbm_queries_avg_sum: - description: Shows the average of all distinct Database Monitoring normalized - queries over all hours in the current month for the given org. + description: Shows the average of all distinct Database Monitoring normalized queries over all hours in the current month for the given org. format: int64 type: integer eph_infra_host_agent_sum: - description: Shows the sum of all ephemeral infrastructure hosts with the - Datadog Agent over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts with the Datadog Agent over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_alibaba_sum: - description: Shows the sum of all ephemeral infrastructure hosts on Alibaba - over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts on Alibaba over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_aws_sum: - description: Shows the sum of all ephemeral infrastructure hosts on AWS - over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts on AWS over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_azure_sum: - description: Shows the sum of all ephemeral infrastructure hosts on Azure - over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts on Azure over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_ent_sum: - description: Shows the sum of all ephemeral infrastructure hosts for Enterprise - over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts for Enterprise over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_gcp_sum: - description: Shows the sum of all ephemeral infrastructure hosts on GCP - over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts on GCP over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_heroku_sum: - description: Shows the sum of all ephemeral infrastructure hosts on Heroku - over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts on Heroku over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_only_aas_sum: - description: Shows the sum of all ephemeral infrastructure hosts with only - Azure App Services over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts with only Azure App Services over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_only_vsphere_sum: - description: Shows the sum of all ephemeral infrastructure hosts with only - vSphere over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts with only vSphere over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_opentelemetry_apm_sum: - description: Shows the sum of all ephemeral APM hosts reported by the Datadog - exporter for the OpenTelemetry Collector over all hours in the current - date for the given org. + description: Shows the sum of all ephemeral APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_opentelemetry_sum: - description: Shows the sum of all ephemeral hosts reported by the Datadog - exporter for the OpenTelemetry Collector over all hours in the current - date for the given org. + description: Shows the sum of all ephemeral hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_pro_sum: - description: Shows the sum of all ephemeral infrastructure hosts for Pro - over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts for Pro over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_proplus_sum: - description: Shows the sum of all ephemeral infrastructure hosts for Pro - Plus over all hours in the current date for the given org. + description: Shows the sum of all ephemeral infrastructure hosts for Pro Plus over all hours in the current date for the given org. format: int64 type: integer eph_infra_host_proxmox_sum: - description: Sum of all ephemeral infrastructure hosts for Proxmox over - all hours in the current date for the given organization. + description: Sum of all ephemeral infrastructure hosts for Proxmox over all hours in the current date for the given organization. format: int64 type: integer error_tracking_apm_error_events_sum: - description: Shows the sum of all Error Tracking APM error events over all - hours in the current date for the given org. + description: Shows the sum of all Error Tracking APM error events over all hours in the current date for the given org. format: int64 type: integer error_tracking_error_events_sum: - description: Shows the sum of all Error Tracking error events over all hours - in the current date for the given org. + description: Shows the sum of all Error Tracking error events over all hours in the current date for the given org. format: int64 type: integer error_tracking_events_sum: - description: Shows the sum of all Error Tracking events over all hours in - the current date for the given org. + description: Shows the sum of all Error Tracking events over all hours in the current date for the given org. format: int64 type: integer error_tracking_rum_error_events_sum: - description: Shows the sum of all Error Tracking RUM error events over all - hours in the current date for the given org. + description: Shows the sum of all Error Tracking RUM error events over all hours in the current date for the given org. format: int64 type: integer event_management_correlation_correlated_events_sum: - description: Shows the sum of all Event Management correlated events over - all hours in the current date for the given org. + description: Shows the sum of all Event Management correlated events over all hours in the current date for the given org. format: int64 type: integer event_management_correlation_correlated_related_events_sum: - description: Shows the sum of all Event Management correlated related events - over all hours in the current date for the given org. + description: Shows the sum of all Event Management correlated related events over all hours in the current date for the given org. format: int64 type: integer event_management_correlation_sum: - description: Shows the sum of all Event Management correlations over all - hours in the current date for the given org. + description: Shows the sum of all Event Management correlations over all hours in the current date for the given org. format: int64 type: integer fargate_container_profiler_profiling_fargate_avg: - description: The average number of Profiling Fargate tasks over all hours - in the current month for the given org. + description: The average number of Profiling Fargate tasks over all hours in the current month for the given org. format: int64 type: integer fargate_container_profiler_profiling_fargate_eks_avg: - description: The average number of Profiling Fargate Elastic Kubernetes - Service tasks over all hours in the current month for the given org. + description: The average number of Profiling Fargate Elastic Kubernetes Service tasks over all hours in the current month for the given org. format: int64 type: integer fargate_tasks_count_avg: @@ -23586,1052 +21654,806 @@ components: format: int64 type: integer fargate_tasks_count_hwm: - description: Shows the high-water mark of all Fargate tasks over all hours - in the current date for the given org. + description: Shows the high-water mark of all Fargate tasks over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_large_avg: - description: Shows the average number of Flex Logs Compute Large Instances - over all hours in the current date for the given org. + description: Shows the average number of Flex Logs Compute Large Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_medium_avg: - description: Shows the average number of Flex Logs Compute Medium Instances - over all hours in the current date for the given org. + description: Shows the average number of Flex Logs Compute Medium Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_small_avg: - description: Shows the average number of Flex Logs Compute Small Instances - over all hours in the current date for the given org. + description: Shows the average number of Flex Logs Compute Small Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_xlarge_avg: - description: Shows the average number of Flex Logs Compute Extra Large Instances - over all hours in the current date for the given org. + description: Shows the average number of Flex Logs Compute Extra Large Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_compute_xsmall_avg: - description: Shows the average number of Flex Logs Compute Extra Small Instances - over all hours in the current date for the given org. + description: Shows the average number of Flex Logs Compute Extra Small Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_starter_avg: - description: Shows the average number of Flex Logs Starter Instances over - all hours in the current date for the given org. + description: Shows the average number of Flex Logs Starter Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_starter_storage_index_avg: - description: Shows the average number of Flex Logs Starter Storage Index - Instances over all hours in the current date for the given org. + description: Shows the average number of Flex Logs Starter Storage Index Instances over all hours in the current date for the given org. format: int64 type: integer flex_logs_starter_storage_retention_adjustment_avg: - description: Shows the average number of Flex Logs Starter Storage Retention - Adjustment Instances over all hours in the current date for the given - org. + description: Shows the average number of Flex Logs Starter Storage Retention Adjustment Instances over all hours in the current date for the given org. format: int64 type: integer flex_stored_logs_avg: - description: Shows the average of all Flex Stored Logs over all hours in - the current date for the given org. + description: Shows the average of all Flex Stored Logs over all hours in the current date for the given org. format: int64 type: integer forwarding_events_bytes_sum: - description: Shows the sum of all log bytes forwarded over all hours in - the current date for the given org. + description: Shows the sum of all log bytes forwarded over all hours in the current date for the given org. format: int64 type: integer gcp_host_top99p: - description: Shows the 99th percentile of all GCP hosts over all hours in - the current date for the given org. + description: Shows the 99th percentile of all GCP hosts over all hours in the current date for the given org. format: int64 type: integer heroku_host_top99p: - description: Shows the 99th percentile of all Heroku dynos over all hours - in the current date for the given org. + description: Shows the 99th percentile of all Heroku dynos over all hours in the current date for the given org. format: int64 type: integer id: description: The organization id. type: string incident_management_monthly_active_users_hwm: - description: Shows the high-water mark of incident management monthly active - users over all hours in the current date for the given org. + description: Shows the high-water mark of incident management monthly active users over all hours in the current date for the given org. format: int64 type: integer incident_management_seats_hwm: - description: Shows the high-water mark of Incident Management seats over - all hours on the current date for the given organization. + description: Shows the high-water mark of Incident Management seats over all hours on the current date for the given organization. format: int64 type: integer indexed_events_count_sum: deprecated: true - description: Shows the sum of all log events indexed over all hours in the - current date for the given org (To be deprecated on October 1st, 2024). + description: Shows the sum of all log events indexed over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer infra_edge_monitoring_devices_top99p: - description: Shows the 99th percentile of all Edge Devices Monitoring devices - over all hours in the current date for the given org. + description: Shows the 99th percentile of all Edge Devices Monitoring devices over all hours in the current date for the given org. format: int64 type: integer infra_host_top99p: - description: Shows the 99th percentile of all distinct infrastructure hosts - over all hours in the current date for the given org. + description: Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for the given org. format: int64 type: integer ingested_events_bytes_sum: - description: Shows the sum of all log bytes ingested over all hours in the - current date for the given org. + description: Shows the sum of all log bytes ingested over all hours in the current date for the given org. format: int64 type: integer iot_device_agg_sum: - description: Shows the sum of all IoT devices over all hours in the current - date for the given org. + description: Shows the sum of all IoT devices over all hours in the current date for the given org. format: int64 type: integer iot_device_top99p_sum: - description: Shows the 99th percentile of all IoT devices over all hours - in the current date for the given org. + description: Shows the 99th percentile of all IoT devices over all hours in the current date for the given org. format: int64 type: integer llm_observability_min_spend_sum: - description: Shows the sum of all LLM Observability minimum spend over all - hours in the current date for the given org. + description: Shows the sum of all LLM Observability minimum spend over all hours in the current date for the given org. format: int64 type: integer llm_observability_sum: - description: Shows the sum of all LLM observability sessions over all hours - in the current date for the given org. + description: Shows the sum of all LLM observability sessions over all hours in the current date for the given org. format: int64 type: integer mobile_rum_lite_session_count_sum: deprecated: true - description: Shows the sum of all mobile lite sessions over all hours in - the current date for the given org (To be deprecated on October 1st, 2024). + description: Shows the sum of all mobile lite sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_android_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions on Android over all - hours in the current date for the given org (To be deprecated on October - 1st, 2024). + description: Shows the sum of all mobile RUM sessions on Android over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_flutter_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions on Flutter over all - hours in the current date for the given org (To be deprecated on October - 1st, 2024). + description: Shows the sum of all mobile RUM sessions on Flutter over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_ios_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions on iOS over all hours - in the current date for the given org (To be deprecated on October 1st, - 2024). + description: Shows the sum of all mobile RUM sessions on iOS over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_reactnative_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions on React Native over - all hours in the current date for the given org (To be deprecated on October - 1st, 2024). + description: Shows the sum of all mobile RUM sessions on React Native over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_roku_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions on Roku over all hours - in the current date for the given org (To be deprecated on October 1st, - 2024). + description: Shows the sum of all mobile RUM sessions on Roku over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions over all hours in - the current date for the given org (To be deprecated on October 1st, 2024). + description: Shows the sum of all mobile RUM sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_units_sum: deprecated: true - description: Shows the sum of all mobile RUM units over all hours in the - current date for the given org (To be deprecated on October 1st, 2024). + description: Shows the sum of all mobile RUM units over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer name: description: The organization name. type: string ndm_netflow_events_sum: - description: Shows the sum of all Network Device Monitoring NetFlow events - over all hours in the current date for the given org. + description: Shows the sum of all Network Device Monitoring NetFlow events over all hours in the current date for the given org. format: int64 type: integer netflow_indexed_events_count_sum: deprecated: true - description: Shows the sum of all Network flows indexed over all hours in - the current date for the given org (To be deprecated on October 1st, 2024). + description: Shows the sum of all Network flows indexed over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer network_device_wireless_top99p: - description: Shows the 99th percentile of all Network Device Monitoring - wireless devices over all hours in the current date for the given org. + description: Shows the 99th percentile of all Network Device Monitoring wireless devices over all hours in the current date for the given org. format: int64 type: integer network_path_sum: - description: Shows the sum of all Network Path scheduled tests over all - hours in the current date for the given org. + description: Shows the sum of all Network Path scheduled tests over all hours in the current date for the given org. format: int64 type: integer npm_host_top99p: - description: Shows the 99th percentile of all distinct Cloud Network Monitoring - hosts (formerly known as Network hosts) over all hours in the current - date for the given org. + description: Shows the 99th percentile of all distinct Cloud Network Monitoring hosts (formerly known as Network hosts) over all hours in the current date for the given org. format: int64 type: integer observability_pipelines_bytes_processed_sum: - description: Sum of all observability pipelines bytes processed over all - hours in the current date for the given org. + description: Sum of all observability pipelines bytes processed over all hours in the current date for the given org. format: int64 type: integer oci_host_sum: - description: Shows the sum of all Oracle Cloud Infrastructure hosts over - all hours in the current date for the given org. + description: Shows the sum of all Oracle Cloud Infrastructure hosts over all hours in the current date for the given org. format: int64 type: integer oci_host_top99p: - description: Shows the 99th percentile of all Oracle Cloud Infrastructure - hosts over all hours in the current date for the given org. + description: Shows the 99th percentile of all Oracle Cloud Infrastructure hosts over all hours in the current date for the given org. format: int64 type: integer on_call_seat_hwm: - description: Shows the high-water mark of On-Call seats over all hours in - the current date for the given org. + description: Shows the high-water mark of On-Call seats over all hours in the current date for the given org. format: int64 type: integer online_archive_events_count_sum: - description: Sum of all online archived events over all hours in the current - date for the given org. + description: Sum of all online archived events over all hours in the current date for the given org. format: int64 type: integer opentelemetry_apm_host_top99p: - description: Shows the 99th percentile of APM hosts reported by the Datadog - exporter for the OpenTelemetry Collector over all hours in the current - date for the given org. + description: Shows the 99th percentile of APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org. format: int64 type: integer opentelemetry_host_top99p: - description: Shows the 99th percentile of all hosts reported by the Datadog - exporter for the OpenTelemetry Collector over all hours in the current - date for the given org. + description: Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org. format: int64 type: integer product_analytics_sum: - description: Shows the sum of all product analytics sessions over all hours - in the current date for the given org. + description: Shows the sum of all product analytics sessions over all hours in the current date for the given org. format: int64 type: integer profiling_aas_count_top99p: - description: Shows the 99th percentile of all profiled Azure app services - over all hours in the current date for all organizations. + description: Shows the 99th percentile of all profiled Azure app services over all hours in the current date for all organizations. format: int64 type: integer profiling_host_top99p: - description: Shows the 99th percentile of all profiled hosts over all hours - within the current date for the given org. + description: Shows the 99th percentile of all profiled hosts over all hours within the current date for the given org. format: int64 type: integer proxmox_host_sum: - description: Sum of all Proxmox hosts over all hours in the current date - for the given organization. + description: Sum of all Proxmox hosts over all hours in the current date for the given organization. format: int64 type: integer proxmox_host_top99p: - description: 99th percentile of all Proxmox hosts over all hours in the - current date for the given organization. + description: 99th percentile of all Proxmox hosts over all hours in the current date for the given organization. format: int64 type: integer public_id: description: The organization public id. type: string published_app_hwm: - description: Shows the high-water mark of all published applications over - all hours in the current date for the given org. + description: Shows the high-water mark of all published applications over all hours in the current date for the given org. format: int64 type: integer region: description: The region of the organization. type: string rum_browser_and_mobile_session_count: - description: Shows the sum of all mobile sessions and all browser lite and - legacy sessions over all hours in the current date for the given org (To - be deprecated on October 1st, 2024). + description: Shows the sum of all mobile sessions and all browser lite and legacy sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer rum_browser_legacy_session_count_sum: - description: Shows the sum of all browser RUM legacy sessions over all hours - in the current date for the given org (To be introduced on October 1st, - 2024). + description: Shows the sum of all browser RUM legacy sessions over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_browser_lite_session_count_sum: - description: Shows the sum of all browser RUM lite sessions over all hours - in the current date for the given org (To be introduced on October 1st, - 2024). + description: Shows the sum of all browser RUM lite sessions over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_browser_replay_session_count_sum: - description: Shows the sum of all browser RUM Session Replay counts over - all hours in the current date for the given org (To be introduced on October - 1st, 2024). + description: Shows the sum of all browser RUM Session Replay counts over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_indexed_sessions_sum: - description: Shows the sum of all RUM indexed sessions over all hours in - the current date for the given org. + description: Shows the sum of all RUM indexed sessions over all hours in the current date for the given org. format: int64 type: integer rum_ingested_sessions_sum: - description: Shows the sum of all RUM ingested sessions over all hours in - the current date for the given org. + description: Shows the sum of all RUM ingested sessions over all hours in the current date for the given org. format: int64 type: integer rum_lite_session_count_sum: - description: Shows the sum of all RUM lite sessions (browser and mobile) - over all hours in the current date for the given org (To be introduced - on October 1st, 2024). + description: Shows the sum of all RUM lite sessions (browser and mobile) over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_android_sum: - description: Shows the sum of all mobile RUM legacy sessions on Android - over all hours in the current date for the given org (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM legacy sessions on Android over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_flutter_sum: - description: Shows the sum of all mobile RUM legacy sessions on Flutter - over all hours in the current date for the given org (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM legacy sessions on Flutter over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_ios_sum: - description: Shows the sum of all mobile RUM legacy sessions on iOS over - all hours in the current date for the given org (To be introduced on October - 1st, 2024). + description: Shows the sum of all mobile RUM legacy sessions on iOS over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_reactnative_sum: - description: Shows the sum of all mobile RUM legacy sessions on React Native - over all hours in the current date for the given org (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM legacy sessions on React Native over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_roku_sum: - description: Shows the sum of all mobile RUM legacy sessions on Roku over - all hours in the current date for the given org (To be introduced on October - 1st, 2024). + description: Shows the sum of all mobile RUM legacy sessions on Roku over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_android_sum: - description: Shows the sum of all mobile RUM lite sessions on Android over - all hours in the current date for the given org (To be introduced on October - 1st, 2024). + description: Shows the sum of all mobile RUM lite sessions on Android over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_flutter_sum: - description: Shows the sum of all mobile RUM lite sessions on Flutter over - all hours in the current date for the given org (To be introduced on October - 1st, 2024). + description: Shows the sum of all mobile RUM lite sessions on Flutter over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_ios_sum: - description: Shows the sum of all mobile RUM lite sessions on iOS over all - hours in the current date for the given org (To be introduced on October - 1st, 2024). + description: Shows the sum of all mobile RUM lite sessions on iOS over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_kotlinmultiplatform_sum: - description: Shows the sum of all mobile RUM lite sessions on Kotlin Multiplatform - over all hours within the current date for the given org. + description: Shows the sum of all mobile RUM lite sessions on Kotlin Multiplatform over all hours within the current date for the given org. format: int64 type: integer rum_mobile_lite_session_count_reactnative_sum: - description: Shows the sum of all mobile RUM lite sessions on React Native - over all hours in the current date for the given org (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM lite sessions on React Native over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_roku_sum: - description: Shows the sum of all mobile RUM lite sessions on Roku over - all hours in the current date for the given org (To be introduced on October - 1st, 2024). + description: Shows the sum of all mobile RUM lite sessions on Roku over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_unity_sum: - description: Shows the sum of all mobile RUM lite sessions on Unity over - all hours within the current date for the given org. + description: Shows the sum of all mobile RUM lite sessions on Unity over all hours within the current date for the given org. format: int64 type: integer rum_mobile_replay_session_count_android_sum: - description: Shows the sum of all mobile RUM replay sessions on Android - over all hours within the current date for the given org. + description: Shows the sum of all mobile RUM replay sessions on Android over all hours within the current date for the given org. format: int64 type: integer rum_mobile_replay_session_count_ios_sum: - description: Shows the sum of all mobile RUM replay sessions on iOS over - all hours within the current date for the given org. + description: Shows the sum of all mobile RUM replay sessions on iOS over all hours within the current date for the given org. format: int64 type: integer rum_mobile_replay_session_count_kotlinmultiplatform_sum: - description: Shows the sum of all mobile RUM replay sessions on Kotlin Multiplatform - over all hours within the current date for the given org. + description: Shows the sum of all mobile RUM replay sessions on Kotlin Multiplatform over all hours within the current date for the given org. format: int64 type: integer rum_mobile_replay_session_count_reactnative_sum: - description: Shows the sum of all mobile RUM replay sessions on React Native - over all hours within the current date for the given org. + description: Shows the sum of all mobile RUM replay sessions on React Native over all hours within the current date for the given org. format: int64 type: integer rum_replay_session_count_sum: - description: Shows the sum of all RUM Session Replay counts over all hours - in the current date for the given org (To be introduced on October 1st, - 2024). + description: Shows the sum of all RUM Session Replay counts over all hours in the current date for the given org (To be introduced on October 1st, 2024). format: int64 type: integer rum_session_count_sum: deprecated: true - description: Shows the sum of all browser RUM lite sessions over all hours - in the current date for the given org (To be deprecated on October 1st, - 2024). + description: Shows the sum of all browser RUM lite sessions over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer rum_session_replay_add_on_sum: - description: Shows the sum of all RUM session replay add-on sessions over - all hours in the current date for the given org. + description: Shows the sum of all RUM session replay add-on sessions over all hours in the current date for the given org. format: int64 type: integer rum_total_session_count_sum: - description: Shows the sum of RUM sessions (browser and mobile) over all - hours in the current date for the given org. + description: Shows the sum of RUM sessions (browser and mobile) over all hours in the current date for the given org. format: int64 type: integer rum_units_sum: deprecated: true - description: Shows the sum of all browser and mobile RUM units over all - hours in the current date for the given org (To be deprecated on October - 1st, 2024). + description: Shows the sum of all browser and mobile RUM units over all hours in the current date for the given org (To be deprecated on October 1st, 2024). format: int64 type: integer sca_fargate_count_avg: - description: Shows the average of all Software Composition Analysis Fargate - tasks over all hours in the current date for the given org. + description: Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org. format: int64 type: integer sca_fargate_count_hwm: - description: Shows the sum of the high-water marks of all Software Composition - Analysis Fargate tasks over all hours in the current date for the given - org. + description: Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org. format: int64 type: integer sds_apm_scanned_bytes_sum: - description: Sum of all APM bytes scanned with sensitive data scanner over - all hours in the current date for the given org. + description: Sum of all APM bytes scanned with sensitive data scanner over all hours in the current date for the given org. format: int64 type: integer sds_events_scanned_bytes_sum: - description: Sum of all event stream events bytes scanned with sensitive - data scanner over all hours in the current date for the given org. + description: Sum of all event stream events bytes scanned with sensitive data scanner over all hours in the current date for the given org. format: int64 type: integer sds_logs_scanned_bytes_sum: - description: Shows the sum of all bytes scanned of logs usage by the Sensitive - Data Scanner over all hours in the current month for the given org. + description: Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for the given org. format: int64 type: integer sds_rum_scanned_bytes_sum: - description: Sum of all RUM bytes scanned with sensitive data scanner over - all hours in the current date for the given org. + description: Sum of all RUM bytes scanned with sensitive data scanner over all hours in the current date for the given org. format: int64 type: integer sds_total_scanned_bytes_sum: - description: Shows the sum of all bytes scanned across all usage types by - the Sensitive Data Scanner over all hours in the current month for the - given org. + description: Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for the given org. format: int64 type: integer serverless_apps_apm_apm_azure_appservice_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring for Azure App Service instances for the given date - and given org. + description: Shows the average number of Serverless Apps with Application Performance Monitoring for Azure App Service instances for the given date and given org. format: int64 type: integer serverless_apps_apm_apm_azure_azurefunction_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring for Azure Function instances for the given date - and given org. + description: Shows the average number of Serverless Apps with Application Performance Monitoring for Azure Function instances for the given date and given org. format: int64 type: integer serverless_apps_apm_apm_azure_containerapp_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring for Azure Container App instances for the given - date and given org. + description: Shows the average number of Serverless Apps with Application Performance Monitoring for Azure Container App instances for the given date and given org. format: int64 type: integer serverless_apps_apm_apm_fargate_ecs_tasks_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring for Fargate Elastic Container Service tasks for - the given date and given org. + description: Shows the average number of Serverless Apps with Application Performance Monitoring for Fargate Elastic Container Service tasks for the given date and given org. format: int64 type: integer serverless_apps_apm_apm_gcp_cloudfunction_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring for Google Cloud Platform Cloud Function instances - for the given date and given org. + description: Shows the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Function instances for the given date and given org. format: int64 type: integer serverless_apps_apm_apm_gcp_cloudrun_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring for Google Cloud Platform Cloud Run instances for - the given date and given org. + description: Shows the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Run instances for the given date and given org. format: int64 type: integer serverless_apps_apm_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring for the given date and given org. + description: Shows the average number of Serverless Apps with Application Performance Monitoring for the given date and given org. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_appservice_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for Azure App Service instances - for the given date and given org. + description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure App Service instances for the given date and given org. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_azurefunction_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for Azure Function instances - for the given date and given org. + description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Function instances for the given date and given org. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_containerapp_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for Azure Container App instances - for the given date and given org. + description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Container App instances for the given date and given org. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_gcp_cloudfunction_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for Google Cloud Platform Cloud - Function instances for the given date and given org. + description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Function instances for the given date and given org. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_gcp_cloudrun_instances_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for Google Cloud Platform Cloud - Run instances for the given date and given org. + description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Run instances for the given date and given org. format: int64 type: integer serverless_apps_apm_excl_fargate_avg: - description: Shows the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for the given date and given - org. + description: Shows the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for the given date and given org. format: int64 type: integer serverless_apps_azure_container_app_instances_avg: - description: Shows the average number of Serverless Apps for Azure Container - App instances for the given date and given org. + description: Shows the average number of Serverless Apps for Azure Container App instances for the given date and given org. format: int64 type: integer serverless_apps_azure_count_avg: - description: Shows the average number of Serverless Apps for Azure for the - given date and given org. + description: Shows the average number of Serverless Apps for Azure for the given date and given org. format: int64 type: integer serverless_apps_azure_function_app_instances_avg: - description: Shows the average number of Serverless Apps for Azure Function - App instances for the given date and given org. + description: Shows the average number of Serverless Apps for Azure Function App instances for the given date and given org. format: int64 type: integer serverless_apps_azure_web_app_instances_avg: - description: Shows the average number of Serverless Apps for Azure Web App - instances for the given date and given org. + description: Shows the average number of Serverless Apps for Azure Web App instances for the given date and given org. format: int64 type: integer serverless_apps_ecs_avg: - description: Shows the average number of Serverless Apps for Elastic Container - Service for the given date and given org. + description: Shows the average number of Serverless Apps for Elastic Container Service for the given date and given org. format: int64 type: integer serverless_apps_eks_avg: - description: Shows the average number of Serverless Apps for Elastic Kubernetes - Service for the given date and given org. + description: Shows the average number of Serverless Apps for Elastic Kubernetes Service for the given date and given org. format: int64 type: integer serverless_apps_excl_fargate_avg: - description: Shows the average number of Serverless Apps excluding Fargate - for the given date and given org. + description: Shows the average number of Serverless Apps excluding Fargate for the given date and given org. format: int64 type: integer serverless_apps_excl_fargate_azure_container_app_instances_avg: - description: Shows the average number of Serverless Apps excluding Fargate - for Azure Container App instances for the given date and given org. + description: Shows the average number of Serverless Apps excluding Fargate for Azure Container App instances for the given date and given org. format: int64 type: integer serverless_apps_excl_fargate_azure_function_app_instances_avg: - description: Shows the average number of Serverless Apps excluding Fargate - for Azure Function App instances for the given date and given org. + description: Shows the average number of Serverless Apps excluding Fargate for Azure Function App instances for the given date and given org. format: int64 type: integer serverless_apps_excl_fargate_azure_web_app_instances_avg: - description: Shows the average number of Serverless Apps excluding Fargate - for Azure Web App instances for the given date and given org. + description: Shows the average number of Serverless Apps excluding Fargate for Azure Web App instances for the given date and given org. format: int64 type: integer serverless_apps_excl_fargate_google_cloud_functions_instances_avg: - description: Shows the average number of Serverless Apps excluding Fargate - for Google Cloud Platform Cloud Functions instances for the given date - and given org. + description: Shows the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Functions instances for the given date and given org. format: int64 type: integer serverless_apps_excl_fargate_google_cloud_run_instances_avg: - description: Shows the average number of Serverless Apps excluding Fargate - for Google Cloud Platform Cloud Run instances for the given date and given - org. + description: Shows the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Run instances for the given date and given org. format: int64 type: integer serverless_apps_google_cloud_functions_instances_avg: - description: Shows the average number of Serverless Apps for Google Cloud - Platform Cloud Functions instances for the given date and given org. + description: Shows the average number of Serverless Apps for Google Cloud Platform Cloud Functions instances for the given date and given org. format: int64 type: integer serverless_apps_google_cloud_run_instances_avg: - description: Shows the average number of Serverless Apps for Google Cloud - Platform Cloud Run instances for the given date and given org. + description: Shows the average number of Serverless Apps for Google Cloud Platform Cloud Run instances for the given date and given org. format: int64 type: integer serverless_apps_google_count_avg: - description: Shows the average number of Serverless Apps for Google Cloud - for the given date and given org. + description: Shows the average number of Serverless Apps for Google Cloud for the given date and given org. format: int64 type: integer serverless_apps_total_count_avg: - description: Shows the average number of Serverless Apps for Azure and Google - Cloud for the given date and given org. + description: Shows the average number of Serverless Apps for Azure and Google Cloud for the given date and given org. format: int64 type: integer siem_analyzed_logs_add_on_count_sum: - description: Shows the sum of all log events analyzed by Cloud SIEM over - all hours in the current date for the given org. + description: Shows the sum of all log events analyzed by Cloud SIEM over all hours in the current date for the given org. format: int64 type: integer synthetics_browser_check_calls_count_sum: - description: Shows the sum of all Synthetic browser tests over all hours - in the current date for the given org. + description: Shows the sum of all Synthetic browser tests over all hours in the current date for the given org. format: int64 type: integer synthetics_check_calls_count_sum: - description: Shows the sum of all Synthetic API tests over all hours in - the current date for the given org. + description: Shows the sum of all Synthetic API tests over all hours in the current date for the given org. format: int64 type: integer synthetics_mobile_test_runs_sum: - description: Shows the sum of all Synthetic mobile application tests over - all hours in the current date for the given org. + description: Shows the sum of all Synthetic mobile application tests over all hours in the current date for the given org. format: int64 type: integer synthetics_parallel_testing_max_slots_hwm: - description: Shows the high-water mark of used synthetics parallel testing - slots over all hours in the current date for the given org. + description: Shows the high-water mark of used synthetics parallel testing slots over all hours in the current date for the given org. format: int64 type: integer trace_search_indexed_events_count_sum: - description: Shows the sum of all Indexed Spans indexed over all hours in - the current date for the given org. + description: Shows the sum of all Indexed Spans indexed over all hours in the current date for the given org. format: int64 type: integer twol_ingested_events_bytes_sum: - description: Shows the sum of all ingested APM span bytes over all hours - in the current date for the given org. + description: Shows the sum of all ingested APM span bytes over all hours in the current date for the given org. format: int64 type: integer universal_service_monitoring_host_top99p: - description: Shows the 99th percentile of all Universal Service Monitoring - hosts over all hours in the current date for the given org. + description: Shows the 99th percentile of all Universal Service Monitoring hosts over all hours in the current date for the given org. format: int64 type: integer vsphere_host_top99p: - description: Shows the 99th percentile of all vSphere hosts over all hours - in the current date for the given org. + description: Shows the 99th percentile of all vSphere hosts over all hours in the current date for the given org. format: int64 type: integer vuln_management_host_count_top99p: - description: Shows the 99th percentile of all Application Vulnerability - Management hosts over all hours in the current date for the given org. + description: Shows the 99th percentile of all Application Vulnerability Management hosts over all hours in the current date for the given org. format: int64 type: integer workflow_executions_usage_sum: - description: Sum of all workflows executed over all hours in the current - date for the given org. + description: Sum of all workflows executed over all hours in the current date for the given org. format: int64 type: integer type: object UsageSummaryResponse: - description: Response summarizing all usage aggregated across the months in - the request for all organizations, and broken down by month and by organization. + description: Response summarizing all usage aggregated across the months in the request for all organizations, and broken down by month and by organization. properties: agent_host_top99p_sum: - description: Shows the 99th percentile of all agent hosts over all hours - in the current month for all organizations. + description: Shows the 99th percentile of all agent hosts over all hours in the current month for all organizations. format: int64 type: integer apm_azure_app_service_host_top99p_sum: - description: Shows the 99th percentile of all Azure app services using APM - over all hours in the current month all organizations. + description: Shows the 99th percentile of all Azure app services using APM over all hours in the current month all organizations. format: int64 type: integer apm_devsecops_host_top99p_sum: - description: Shows the 99th percentile of all APM DevSecOps hosts over all - hours in the current month for all organizations. + description: Shows the 99th percentile of all APM DevSecOps hosts over all hours in the current month for all organizations. format: int64 type: integer apm_enterprise_standalone_hosts_top99p_sum: - description: Shows the sum of the 99th percentile of all distinct standalone - Enterprise hosts over all hours in the current month for all organizations. + description: Shows the sum of the 99th percentile of all distinct standalone Enterprise hosts over all hours in the current month for all organizations. format: int64 type: integer apm_fargate_count_avg_sum: - description: Shows the average of all APM ECS Fargate tasks over all hours - in the current month for all organizations. + description: Shows the average of all APM ECS Fargate tasks over all hours in the current month for all organizations. format: int64 type: integer apm_host_top99p_sum: - description: Shows the 99th percentile of all distinct APM hosts over all - hours in the current month for all organizations. + description: Shows the 99th percentile of all distinct APM hosts over all hours in the current month for all organizations. format: int64 type: integer apm_pro_standalone_hosts_top99p_sum: - description: Shows the sum of the 99th percentile of all distinct standalone - Pro hosts over all hours in the current month for all organizations. + description: Shows the sum of the 99th percentile of all distinct standalone Pro hosts over all hours in the current month for all organizations. format: int64 type: integer appsec_fargate_count_avg_sum: - description: Shows the average of all Application Security Monitoring ECS - Fargate tasks over all hours in the current month for all organizations. + description: Shows the average of all Application Security Monitoring ECS Fargate tasks over all hours in the current month for all organizations. format: int64 type: integer asm_serverless_agg_sum: - description: Shows the sum of all Application Security Monitoring Serverless - invocations over all hours in the current months for all organizations. + description: Shows the sum of all Application Security Monitoring Serverless invocations over all hours in the current months for all organizations. format: int64 type: integer audit_logs_lines_indexed_agg_sum: deprecated: true - description: Shows the sum of all audit logs lines indexed over all hours - in the current month for all organizations (To be deprecated on October - 1st, 2024). + description: Shows the sum of all audit logs lines indexed over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer audit_trail_enabled_hwm_sum: - description: Shows the total number of organizations that had Audit Trail - enabled over a specific number of months. + description: Shows the total number of organizations that had Audit Trail enabled over a specific number of months. format: int64 type: integer avg_profiled_fargate_tasks_sum: - description: The average total count for Fargate Container Profiler over - all hours in the current month for all organizations. + description: The average total count for Fargate Container Profiler over all hours in the current month for all organizations. format: int64 type: integer aws_host_top99p_sum: - description: Shows the 99th percentile of all AWS hosts over all hours in - the current month for all organizations. + description: Shows the 99th percentile of all AWS hosts over all hours in the current month for all organizations. format: int64 type: integer aws_lambda_func_count: - description: Shows the average of the number of functions that executed - 1 or more times each hour in the current month for all organizations. + description: Shows the average of the number of functions that executed 1 or more times each hour in the current month for all organizations. format: int64 type: integer aws_lambda_invocations_sum: - description: Shows the sum of all AWS Lambda invocations over all hours - in the current month for all organizations. + description: Shows the sum of all AWS Lambda invocations over all hours in the current month for all organizations. format: int64 type: integer azure_app_service_top99p_sum: - description: Shows the 99th percentile of all Azure app services over all - hours in the current month for all organizations. + description: Shows the 99th percentile of all Azure app services over all hours in the current month for all organizations. format: int64 type: integer azure_host_top99p_sum: - description: Shows the 99th percentile of all Azure hosts over all hours - in the current month for all organizations. + description: Shows the 99th percentile of all Azure hosts over all hours in the current month for all organizations. format: int64 type: integer billable_ingested_bytes_agg_sum: - description: Shows the sum of all log bytes ingested over all hours in the - current month for all organizations. + description: Shows the sum of all log bytes ingested over all hours in the current month for all organizations. format: int64 type: integer bits_ai_investigations_agg_sum: - description: Shows the sum of all Bits AI Investigations over all hours - in the current month for all organizations. + description: Shows the sum of all Bits AI Investigations over all hours in the current month for all organizations. format: int64 type: integer browser_rum_lite_session_count_agg_sum: deprecated: true - description: Shows the sum of all browser lite sessions over all hours in - the current month for all organizations (To be deprecated on October 1st, - 2024). + description: Shows the sum of all browser lite sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer browser_rum_replay_session_count_agg_sum: - description: Shows the sum of all browser replay sessions over all hours - in the current month for all organizations (To be deprecated on October - 1st, 2024). + description: Shows the sum of all browser replay sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer browser_rum_units_agg_sum: deprecated: true - description: Shows the sum of all browser RUM units over all hours in the - current month for all organizations (To be deprecated on October 1st, - 2024). + description: Shows the sum of all browser RUM units over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer ccm_spend_monitored_ent_last_sum: - description: Shows the sum of the last value of the amount of cloud spend - monitored for Enterprise in the current month for all organizations. + description: Shows the sum of the last value of the amount of cloud spend monitored for Enterprise in the current month for all organizations. format: int64 type: integer ccm_spend_monitored_pro_last_sum: - description: Shows the sum of the last value of the amount of cloud spend - monitored for Pro in the current month for all organizations. + description: Shows the sum of the last value of the amount of cloud spend monitored for Pro in the current month for all organizations. format: int64 type: integer ci_pipeline_indexed_spans_agg_sum: - description: Shows the sum of all CI pipeline indexed spans over all hours - in the current month for all organizations. + description: Shows the sum of all CI pipeline indexed spans over all hours in the current month for all organizations. format: int64 type: integer ci_test_indexed_spans_agg_sum: - description: Shows the sum of all CI test indexed spans over all hours in - the current month for all organizations. + description: Shows the sum of all CI test indexed spans over all hours in the current month for all organizations. format: int64 type: integer ci_visibility_itr_committers_hwm_sum: - description: Shows the high-water mark of all CI visibility intelligent - test runner committers over all hours in the current month for all organizations. + description: Shows the high-water mark of all CI visibility intelligent test runner committers over all hours in the current month for all organizations. format: int64 type: integer ci_visibility_pipeline_committers_hwm_sum: - description: Shows the high-water mark of all CI visibility pipeline committers - over all hours in the current month for all organizations. + description: Shows the high-water mark of all CI visibility pipeline committers over all hours in the current month for all organizations. format: int64 type: integer ci_visibility_test_committers_hwm_sum: - description: Shows the high-water mark of all CI visibility test committers - over all hours in the current month for all organizations. + description: Shows the high-water mark of all CI visibility test committers over all hours in the current month for all organizations. format: int64 type: integer cloud_cost_management_aws_host_count_avg_sum: - description: Sum of the host count average for Cloud Cost Management for - AWS. + description: Sum of the host count average for Cloud Cost Management for AWS. format: int64 type: integer cloud_cost_management_azure_host_count_avg_sum: - description: Sum of the host count average for Cloud Cost Management for - Azure. + description: Sum of the host count average for Cloud Cost Management for Azure. format: int64 type: integer cloud_cost_management_gcp_host_count_avg_sum: - description: Sum of the host count average for Cloud Cost Management for - GCP. + description: Sum of the host count average for Cloud Cost Management for GCP. format: int64 type: integer cloud_cost_management_host_count_avg_sum: - description: Sum of the host count average for Cloud Cost Management for - all cloud providers. + description: Sum of the host count average for Cloud Cost Management for all cloud providers. format: int64 type: integer cloud_cost_management_oci_host_count_avg_sum: - description: Sum of the average host counts for Cloud Cost Management on - OCI. + description: Sum of the average host counts for Cloud Cost Management on OCI. format: int64 type: integer cloud_siem_events_agg_sum: - description: Shows the sum of all Cloud Security Information and Event Management - events over all hours in the current month for all organizations. + description: Shows the sum of all Cloud Security Information and Event Management events over all hours in the current month for all organizations. format: int64 type: integer code_analysis_sa_committers_hwm_sum: - description: Shows the high-water mark of all Static Analysis committers - over all hours in the current month for all organizations. + description: Shows the high-water mark of all Static Analysis committers over all hours in the current month for all organizations. format: int64 type: integer code_analysis_sca_committers_hwm_sum: - description: Shows the high-water mark of all static Software Composition - Analysis committers over all hours in the current month for all organizations. + description: Shows the high-water mark of all static Software Composition Analysis committers over all hours in the current month for all organizations. format: int64 type: integer code_security_host_top99p_sum: - description: Shows the 99th percentile of all Code Security hosts over all - hours in the current month for all organizations. + description: Shows the 99th percentile of all Code Security hosts over all hours in the current month for all organizations. format: int64 type: integer container_avg_sum: - description: Shows the average of all distinct containers over all hours - in the current month for all organizations. + description: Shows the average of all distinct containers over all hours in the current month for all organizations. format: int64 type: integer container_excl_agent_avg_sum: - description: Shows the average of the containers without the Datadog Agent - over all hours in the current month for all organizations. + description: Shows the average of the containers without the Datadog Agent over all hours in the current month for all organizations. format: int64 type: integer container_hwm_sum: - description: Shows the sum of the high-water marks of all distinct containers - over all hours in the current month for all organizations. + description: Shows the sum of the high-water marks of all distinct containers over all hours in the current month for all organizations. format: int64 type: integer csm_container_enterprise_compliance_count_agg_sum: - description: Shows the sum of all Cloud Security Management Enterprise compliance - containers over all hours in the current month for all organizations. + description: Shows the sum of all Cloud Security Management Enterprise compliance containers over all hours in the current month for all organizations. format: int64 type: integer csm_container_enterprise_cws_count_agg_sum: - description: Shows the sum of all Cloud Security Management Enterprise Cloud - Workload Security containers over all hours in the current month for all - organizations. + description: Shows the sum of all Cloud Security Management Enterprise Cloud Workload Security containers over all hours in the current month for all organizations. format: int64 type: integer csm_container_enterprise_total_count_agg_sum: - description: Shows the sum of all Cloud Security Management Enterprise containers - over all hours in the current month for all organizations. + description: Shows the sum of all Cloud Security Management Enterprise containers over all hours in the current month for all organizations. format: int64 type: integer csm_host_enterprise_aas_host_count_top99p_sum: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise Azure app services hosts over all hours in the current month - for all organizations. + description: Shows the 99th percentile of all Cloud Security Management Enterprise Azure app services hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_enterprise_aws_host_count_top99p_sum: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise AWS hosts over all hours in the current month for all organizations. + description: Shows the 99th percentile of all Cloud Security Management Enterprise AWS hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_enterprise_azure_host_count_top99p_sum: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise Azure hosts over all hours in the current month for all organizations. + description: Shows the 99th percentile of all Cloud Security Management Enterprise Azure hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_enterprise_compliance_host_count_top99p_sum: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise compliance hosts over all hours in the current month for all - organizations. + description: Shows the 99th percentile of all Cloud Security Management Enterprise compliance hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_enterprise_cws_host_count_top99p_sum: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise Cloud Workload Security hosts over all hours in the current - month for all organizations. + description: Shows the 99th percentile of all Cloud Security Management Enterprise Cloud Workload Security hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_enterprise_gcp_host_count_top99p_sum: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise GCP hosts over all hours in the current month for all organizations. + description: Shows the 99th percentile of all Cloud Security Management Enterprise GCP hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_enterprise_oci_host_count_top99p_sum: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise OCI hosts over all hours in the current month for all organizations. + description: Shows the 99th percentile of all Cloud Security Management Enterprise OCI hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_enterprise_total_host_count_top99p_sum: - description: Shows the 99th percentile of all Cloud Security Management - Enterprise hosts over all hours in the current month for all organizations. + description: Shows the 99th percentile of all Cloud Security Management Enterprise hosts over all hours in the current month for all organizations. format: int64 type: integer csm_host_pro_oci_host_count_top99p_sum: - description: Shows the 99th percentile of all Cloud Security Management - Pro OCI hosts over all hours in the current month for all organizations. + description: Shows the 99th percentile of all Cloud Security Management Pro OCI hosts over all hours in the current month for all organizations. format: int64 type: integer cspm_aas_host_top99p_sum: - description: Shows the 99th percentile of all Cloud Security Management - Pro Azure app services hosts over all hours in the current month for all - organizations. + description: Shows the 99th percentile of all Cloud Security Management Pro Azure app services hosts over all hours in the current month for all organizations. format: int64 type: integer cspm_aws_host_top99p_sum: - description: Shows the 99th percentile of all Cloud Security Management - Pro AWS hosts over all hours in the current month for all organizations. + description: Shows the 99th percentile of all Cloud Security Management Pro AWS hosts over all hours in the current month for all organizations. format: int64 type: integer cspm_azure_host_top99p_sum: - description: Shows the 99th percentile of all Cloud Security Management - Pro Azure hosts over all hours in the current month for all organizations. + description: Shows the 99th percentile of all Cloud Security Management Pro Azure hosts over all hours in the current month for all organizations. format: int64 type: integer cspm_container_avg_sum: - description: Shows the average number of Cloud Security Management Pro containers - over all hours in the current month for all organizations. + description: Shows the average number of Cloud Security Management Pro containers over all hours in the current month for all organizations. format: int64 type: integer cspm_container_hwm_sum: - description: Shows the sum of the high-water marks of Cloud Security Management - Pro containers over all hours in the current month for all organizations. + description: Shows the sum of the high-water marks of Cloud Security Management Pro containers over all hours in the current month for all organizations. format: int64 type: integer cspm_gcp_host_top99p_sum: - description: Shows the 99th percentile of all Cloud Security Management - Pro GCP hosts over all hours in the current month for all organizations. + description: Shows the 99th percentile of all Cloud Security Management Pro GCP hosts over all hours in the current month for all organizations. format: int64 type: integer cspm_host_top99p_sum: - description: Shows the 99th percentile of all Cloud Security Management - Pro hosts over all hours in the current month for all organizations. + description: Shows the 99th percentile of all Cloud Security Management Pro hosts over all hours in the current month for all organizations. format: int64 type: integer custom_historical_ts_sum: - description: Shows the average number of distinct historical custom metrics - over all hours in the current month for all organizations. + description: Shows the average number of distinct historical custom metrics over all hours in the current month for all organizations. format: int64 type: integer custom_live_ts_sum: - description: Shows the average number of distinct live custom metrics over - all hours in the current month for all organizations. + description: Shows the average number of distinct live custom metrics over all hours in the current month for all organizations. format: int64 type: integer custom_ts_sum: - description: Shows the average number of distinct custom metrics over all - hours in the current month for all organizations. + description: Shows the average number of distinct custom metrics over all hours in the current month for all organizations. format: int64 type: integer cws_container_avg_sum: - description: Shows the average of all distinct Cloud Workload Security containers - over all hours in the current month for all organizations. + description: Shows the average of all distinct Cloud Workload Security containers over all hours in the current month for all organizations. format: int64 type: integer cws_fargate_task_avg_sum: - description: Shows the average of all distinct Cloud Workload Security Fargate - tasks over all hours in the current month for all organizations. + description: Shows the average of all distinct Cloud Workload Security Fargate tasks over all hours in the current month for all organizations. format: int64 type: integer cws_host_top99p_sum: - description: Shows the 99th percentile of all Cloud Workload Security hosts - over all hours in the current month for all organizations. + description: Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current month for all organizations. format: int64 type: integer data_jobs_monitoring_host_hr_agg_sum: - description: Shows the sum of Data Jobs Monitoring hosts over all hours - in the current months for all organizations + description: Shows the sum of Data Jobs Monitoring hosts over all hours in the current months for all organizations format: int64 type: integer dbm_host_top99p_sum: - description: Shows the 99th percentile of all Database Monitoring hosts - over all hours in the current month for all organizations. + description: Shows the 99th percentile of all Database Monitoring hosts over all hours in the current month for all organizations. format: int64 type: integer dbm_queries_avg_sum: - description: Shows the average of all distinct Database Monitoring Normalized - Queries over all hours in the current month for all organizations. + description: Shows the average of all distinct Database Monitoring Normalized Queries over all hours in the current month for all organizations. format: int64 type: integer end_date: @@ -24639,851 +22461,644 @@ components: format: date-time type: string eph_infra_host_agent_agg_sum: - description: Shows the sum of all ephemeral infrastructure hosts with the - Datadog Agent over all hours in the current month for all organizations. + description: Shows the sum of all ephemeral infrastructure hosts with the Datadog Agent over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_alibaba_agg_sum: - description: Shows the sum of all ephemeral infrastructure hosts on Alibaba - over all hours in the current month for all organizations. + description: Shows the sum of all ephemeral infrastructure hosts on Alibaba over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_aws_agg_sum: - description: Shows the sum of all ephemeral infrastructure hosts on AWS - over all hours in the current month for all organizations. + description: Shows the sum of all ephemeral infrastructure hosts on AWS over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_azure_agg_sum: - description: Shows the sum of all ephemeral infrastructure hosts on Azure - over all hours in the current month for all organizations. + description: Shows the sum of all ephemeral infrastructure hosts on Azure over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_ent_agg_sum: - description: Shows the sum of all ephemeral infrastructure hosts for Enterprise - over all hours in the current month for all organizations. + description: Shows the sum of all ephemeral infrastructure hosts for Enterprise over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_gcp_agg_sum: - description: Shows the sum of all ephemeral infrastructure hosts on GCP - over all hours in the current month for all organizations. + description: Shows the sum of all ephemeral infrastructure hosts on GCP over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_heroku_agg_sum: - description: Shows the sum of all ephemeral infrastructure hosts on Heroku - over all hours in the current month for all organizations. + description: Shows the sum of all ephemeral infrastructure hosts on Heroku over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_only_aas_agg_sum: - description: Shows the sum of all ephemeral infrastructure hosts with only - Azure App Services over all hours in the current month for all organizations. + description: Shows the sum of all ephemeral infrastructure hosts with only Azure App Services over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_only_vsphere_agg_sum: - description: Shows the sum of all ephemeral infrastructure hosts with only - vSphere over all hours in the current month for all organizations. + description: Shows the sum of all ephemeral infrastructure hosts with only vSphere over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_opentelemetry_agg_sum: - description: Shows the sum of all ephemeral hosts reported by the Datadog - exporter for the OpenTelemetry Collector over all hours in the current - month for all organizations. + description: Shows the sum of all ephemeral hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_opentelemetry_apm_agg_sum: - description: Shows the sum of all ephemeral APM hosts reported by the Datadog - exporter for the OpenTelemetry Collector over all hours in the current - month for all organizations. + description: Shows the sum of all ephemeral APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_pro_agg_sum: - description: Shows the sum of all ephemeral infrastructure hosts for Pro - over all hours in the current month for all organizations. + description: Shows the sum of all ephemeral infrastructure hosts for Pro over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_proplus_agg_sum: - description: Shows the sum of all ephemeral infrastructure hosts for Pro - Plus over all hours in the current month for all organizations. + description: Shows the sum of all ephemeral infrastructure hosts for Pro Plus over all hours in the current month for all organizations. format: int64 type: integer eph_infra_host_proxmox_agg_sum: - description: Sum of all ephemeral infrastructure hosts for Proxmox over - all hours in the current month for all organizations. + description: Sum of all ephemeral infrastructure hosts for Proxmox over all hours in the current month for all organizations. format: int64 type: integer error_tracking_apm_error_events_agg_sum: - description: Shows the sum of all Error Tracking APM error events over all - hours in the current month for all organizations. + description: Shows the sum of all Error Tracking APM error events over all hours in the current month for all organizations. format: int64 type: integer error_tracking_error_events_agg_sum: - description: Shows the sum of all Error Tracking error events over all hours - in the current month for all organizations. + description: Shows the sum of all Error Tracking error events over all hours in the current month for all organizations. format: int64 type: integer error_tracking_events_agg_sum: - description: Shows the sum of all Error Tracking events over all hours in - the current months for all organizations. + description: Shows the sum of all Error Tracking events over all hours in the current months for all organizations. format: int64 type: integer error_tracking_rum_error_events_agg_sum: - description: Shows the sum of all Error Tracking RUM error events over all - hours in the current month for all organizations. + description: Shows the sum of all Error Tracking RUM error events over all hours in the current month for all organizations. format: int64 type: integer event_management_correlation_agg_sum: - description: Shows the sum of all Event Management correlations over all - hours in the current month for all organizations. + description: Shows the sum of all Event Management correlations over all hours in the current month for all organizations. format: int64 type: integer event_management_correlation_correlated_events_agg_sum: - description: Shows the sum of all Event Management correlated events over - all hours in the current month for all organizations. + description: Shows the sum of all Event Management correlated events over all hours in the current month for all organizations. format: int64 type: integer event_management_correlation_correlated_related_events_agg_sum: - description: Shows the sum of all Event Management correlated related events - over all hours in the current month for all organizations. + description: Shows the sum of all Event Management correlated related events over all hours in the current month for all organizations. format: int64 type: integer fargate_container_profiler_profiling_fargate_avg_sum: - description: The average number of Profiling Fargate tasks over all hours - in the current month for all organizations. + description: The average number of Profiling Fargate tasks over all hours in the current month for all organizations. format: int64 type: integer fargate_container_profiler_profiling_fargate_eks_avg_sum: - description: The average number of Profiling Fargate Elastic Kubernetes - Service tasks over all hours in the current month for all organizations. + description: The average number of Profiling Fargate Elastic Kubernetes Service tasks over all hours in the current month for all organizations. format: int64 type: integer fargate_tasks_count_avg_sum: - description: Shows the average of all Fargate tasks over all hours in the - current month for all organizations. + description: Shows the average of all Fargate tasks over all hours in the current month for all organizations. format: int64 type: integer fargate_tasks_count_hwm_sum: - description: Shows the sum of the high-water marks of all Fargate tasks - over all hours in the current month for all organizations. + description: Shows the sum of the high-water marks of all Fargate tasks over all hours in the current month for all organizations. format: int64 type: integer flex_logs_compute_large_avg_sum: - description: Shows the average number of Flex Logs Compute Large Instances - over all hours in the current months for all organizations. + description: Shows the average number of Flex Logs Compute Large Instances over all hours in the current months for all organizations. format: int64 type: integer flex_logs_compute_medium_avg_sum: - description: Shows the average number of Flex Logs Compute Medium Instances - over all hours in the current months for all organizations. + description: Shows the average number of Flex Logs Compute Medium Instances over all hours in the current months for all organizations. format: int64 type: integer flex_logs_compute_small_avg_sum: - description: Shows the average number of Flex Logs Compute Small Instances - over all hours in the current months for all organizations. + description: Shows the average number of Flex Logs Compute Small Instances over all hours in the current months for all organizations. format: int64 type: integer flex_logs_compute_xlarge_avg_sum: - description: Shows the average number of Flex Logs Compute Extra Large Instances - over all hours in the current months for all organizations. + description: Shows the average number of Flex Logs Compute Extra Large Instances over all hours in the current months for all organizations. format: int64 type: integer flex_logs_compute_xsmall_avg_sum: - description: Shows the average number of Flex Logs Compute Extra Small Instances - over all hours in the current months for all organizations. + description: Shows the average number of Flex Logs Compute Extra Small Instances over all hours in the current months for all organizations. format: int64 type: integer flex_logs_starter_avg_sum: - description: Shows the average number of Flex Logs Starter Instances over - all hours in the current months for all organizations. + description: Shows the average number of Flex Logs Starter Instances over all hours in the current months for all organizations. format: int64 type: integer flex_logs_starter_storage_index_avg_sum: - description: Shows the average number of Flex Logs Starter Storage Index - Instances over all hours in the current months for all organizations. + description: Shows the average number of Flex Logs Starter Storage Index Instances over all hours in the current months for all organizations. format: int64 type: integer flex_logs_starter_storage_retention_adjustment_avg_sum: - description: Shows the average number of Flex Logs Starter Storage Retention - Adjustment Instances over all hours in the current months for all organizations. + description: Shows the average number of Flex Logs Starter Storage Retention Adjustment Instances over all hours in the current months for all organizations. format: int64 type: integer flex_stored_logs_avg_sum: - description: Shows the average of all Flex Stored Logs over all hours in - the current months for all organizations. + description: Shows the average of all Flex Stored Logs over all hours in the current months for all organizations. format: int64 type: integer forwarding_events_bytes_agg_sum: - description: Shows the sum of all logs forwarding bytes over all hours in - the current month for all organizations (data available as of April 1, - 2023) + description: Shows the sum of all logs forwarding bytes over all hours in the current month for all organizations (data available as of April 1, 2023) format: int64 type: integer gcp_host_top99p_sum: - description: Shows the 99th percentile of all GCP hosts over all hours in - the current month for all organizations. + description: Shows the 99th percentile of all GCP hosts over all hours in the current month for all organizations. format: int64 type: integer heroku_host_top99p_sum: - description: Shows the 99th percentile of all Heroku dynos over all hours - in the current month for all organizations. + description: Shows the 99th percentile of all Heroku dynos over all hours in the current month for all organizations. format: int64 type: integer incident_management_monthly_active_users_hwm_sum: - description: Shows sum of the high-water marks of incident management monthly - active users in the current month for all organizations. + description: Shows sum of the high-water marks of incident management monthly active users in the current month for all organizations. format: int64 type: integer incident_management_seats_hwm_sum: - description: Shows the sum of the high-water marks of Incident Management - seats over all hours in the current month for all organizations. + description: Shows the sum of the high-water marks of Incident Management seats over all hours in the current month for all organizations. format: int64 type: integer indexed_events_count_agg_sum: deprecated: true - description: Shows the sum of all log events indexed over all hours in the - current month for all organizations (To be deprecated on October 1st, - 2024). + description: Shows the sum of all log events indexed over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer infra_edge_monitoring_devices_top99p_sum: - description: Shows the 99th percentile of all Edge Devices Monitoring devices - over all hours in the current month for all organizations. + description: Shows the 99th percentile of all Edge Devices Monitoring devices over all hours in the current month for all organizations. format: int64 type: integer infra_host_top99p_sum: - description: Shows the 99th percentile of all distinct infrastructure hosts - over all hours in the current month for all organizations. + description: Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current month for all organizations. format: int64 type: integer ingested_events_bytes_agg_sum: - description: Shows the sum of all log bytes ingested over all hours in the - current month for all organizations. + description: Shows the sum of all log bytes ingested over all hours in the current month for all organizations. format: int64 type: integer iot_device_agg_sum: - description: Shows the sum of all IoT devices over all hours in the current - month for all organizations. + description: Shows the sum of all IoT devices over all hours in the current month for all organizations. format: int64 type: integer iot_device_top99p_sum: - description: Shows the 99th percentile of all IoT devices over all hours - in the current month of all organizations. + description: Shows the 99th percentile of all IoT devices over all hours in the current month of all organizations. format: int64 type: integer last_updated: - description: Shows the most recent hour in the current month for all organizations - for which all usages were calculated. + description: Shows the most recent hour in the current month for all organizations for which all usages were calculated. format: date-time type: string live_indexed_events_agg_sum: deprecated: true - description: Shows the sum of all live logs indexed over all hours in the - current month for all organization (To be deprecated on October 1st, 2024). + description: Shows the sum of all live logs indexed over all hours in the current month for all organization (To be deprecated on October 1st, 2024). format: int64 type: integer live_ingested_bytes_agg_sum: - description: Shows the sum of all live logs bytes ingested over all hours - in the current month for all organizations (data available as of December - 1, 2020). + description: Shows the sum of all live logs bytes ingested over all hours in the current month for all organizations (data available as of December 1, 2020). format: int64 type: integer llm_observability_agg_sum: - description: Sum of all LLM observability sessions for all hours in the - current month for all organizations. + description: Sum of all LLM observability sessions for all hours in the current month for all organizations. format: int64 type: integer llm_observability_min_spend_agg_sum: - description: Minimum spend for LLM observability sessions for all hours - in the current month for all organizations. + description: Minimum spend for LLM observability sessions for all hours in the current month for all organizations. format: int64 type: integer logs_by_retention: - $ref: '#/components/schemas/LogsByRetention' + $ref: "#/components/schemas/LogsByRetention" mobile_rum_lite_session_count_agg_sum: deprecated: true - description: Shows the sum of all mobile lite sessions over all hours in - the current month for all organizations (To be deprecated on October 1st, - 2024). + description: Shows the sum of all mobile lite sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_agg_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions over all hours in - the current month for all organizations (To be deprecated on October 1st, - 2024). + description: Shows the sum of all mobile RUM sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_android_agg_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions on Android over all - hours in the current month for all organizations (To be deprecated on - October 1st, 2024). + description: Shows the sum of all mobile RUM sessions on Android over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_flutter_agg_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions on Flutter over all - hours in the current month for all organizations (To be deprecated on - October 1st, 2024). + description: Shows the sum of all mobile RUM sessions on Flutter over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_ios_agg_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions on iOS over all hours - in the current month for all organizations (To be deprecated on October - 1st, 2024). + description: Shows the sum of all mobile RUM sessions on iOS over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_reactnative_agg_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions on React Native over - all hours in the current month for all organizations (To be deprecated - on October 1st, 2024). + description: Shows the sum of all mobile RUM sessions on React Native over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_session_count_roku_agg_sum: deprecated: true - description: Shows the sum of all mobile RUM sessions on Roku over all hours - in the current month for all organizations (To be deprecated on October - 1st, 2024). + description: Shows the sum of all mobile RUM sessions on Roku over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer mobile_rum_units_agg_sum: deprecated: true - description: Shows the sum of all mobile RUM units over all hours in the - current month for all organizations (To be deprecated on October 1st, - 2024). + description: Shows the sum of all mobile RUM units over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer ndm_netflow_events_agg_sum: - description: Shows the sum of all Network Device Monitoring NetFlow events - over all hours in the current month for all organizations. + description: Shows the sum of all Network Device Monitoring NetFlow events over all hours in the current month for all organizations. format: int64 type: integer netflow_indexed_events_count_agg_sum: deprecated: true - description: Shows the sum of all Network flows indexed over all hours in - the current month for all organizations (To be deprecated on October 1st, - 2024). + description: Shows the sum of all Network flows indexed over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer network_device_wireless_top99p_sum: - description: Shows the 99th percentile of all Network Device Monitoring - wireless devices over all hours in the current month for all organizations. + description: Shows the 99th percentile of all Network Device Monitoring wireless devices over all hours in the current month for all organizations. format: int64 type: integer network_path_agg_sum: - description: Shows the sum of all Network Path scheduled tests over all - hours in the current month for all organizations. + description: Shows the sum of all Network Path scheduled tests over all hours in the current month for all organizations. format: int64 type: integer npm_host_top99p_sum: - description: Shows the 99th percentile of all distinct Cloud Network Monitoring - hosts (formerly known as Network hosts) over all hours in the current - month for all organizations. + description: Shows the 99th percentile of all distinct Cloud Network Monitoring hosts (formerly known as Network hosts) over all hours in the current month for all organizations. format: int64 type: integer observability_pipelines_bytes_processed_agg_sum: - description: Sum of all observability pipelines bytes processed over all - hours in the current month for all organizations. + description: Sum of all observability pipelines bytes processed over all hours in the current month for all organizations. format: int64 type: integer oci_host_agg_sum: - description: Shows the sum of Oracle Cloud Infrastructure hosts over all - hours in the current months for all organizations + description: Shows the sum of Oracle Cloud Infrastructure hosts over all hours in the current months for all organizations format: int64 type: integer oci_host_top99p_sum: - description: Shows the 99th percentile of Oracle Cloud Infrastructure hosts - over all hours in the current months for all organizations + description: Shows the 99th percentile of Oracle Cloud Infrastructure hosts over all hours in the current months for all organizations format: int64 type: integer on_call_seat_hwm_sum: - description: Shows the sum of the high-water marks of On-Call seats over - all hours in the current month for all organizations. + description: Shows the sum of the high-water marks of On-Call seats over all hours in the current month for all organizations. format: int64 type: integer online_archive_events_count_agg_sum: - description: Sum of all online archived events over all hours in the current - month for all organizations. + description: Sum of all online archived events over all hours in the current month for all organizations. format: int64 type: integer opentelemetry_apm_host_top99p_sum: - description: Shows the 99th percentile of APM hosts reported by the Datadog - exporter for the OpenTelemetry Collector over all hours in the current - month for all organizations. + description: Shows the 99th percentile of APM hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current month for all organizations. format: int64 type: integer opentelemetry_host_top99p_sum: - description: Shows the 99th percentile of all hosts reported by the Datadog - exporter for the OpenTelemetry Collector over all hours in the current - month for all organizations. + description: Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current month for all organizations. format: int64 type: integer product_analytics_agg_sum: - description: Sum of all product analytics sessions for all hours in the - current month for all organizations. + description: Sum of all product analytics sessions for all hours in the current month for all organizations. format: int64 type: integer profiling_aas_count_top99p_sum: - description: Shows the 99th percentile of all profiled Azure app services - over all hours in the current month for all organizations. + description: Shows the 99th percentile of all profiled Azure app services over all hours in the current month for all organizations. format: int64 type: integer profiling_container_agent_count_avg: - description: Shows the average number of profiled containers over all hours - in the current month for all organizations. + description: Shows the average number of profiled containers over all hours in the current month for all organizations. format: int64 type: integer profiling_host_count_top99p_sum: - description: Shows the 99th percentile of all profiled hosts over all hours - in the current month for all organizations. + description: Shows the 99th percentile of all profiled hosts over all hours in the current month for all organizations. format: int64 type: integer proxmox_host_agg_sum: - description: Sum of all Proxmox hosts over all hours in the current month - for all organizations. + description: Sum of all Proxmox hosts over all hours in the current month for all organizations. format: int64 type: integer proxmox_host_top99p_sum: - description: Sum of the 99th percentile of all Proxmox hosts over all hours - in the current month for all organizations. + description: Sum of the 99th percentile of all Proxmox hosts over all hours in the current month for all organizations. format: int64 type: integer published_app_hwm_sum: - description: Shows the high-water mark of all published applications over - all hours in the current month for all organizations. + description: Shows the high-water mark of all published applications over all hours in the current month for all organizations. format: int64 type: integer rehydrated_indexed_events_agg_sum: deprecated: true - description: Shows the sum of all rehydrated logs indexed over all hours - in the current month for all organizations (To be deprecated on October - 1st, 2024). + description: Shows the sum of all rehydrated logs indexed over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer rehydrated_ingested_bytes_agg_sum: - description: Shows the sum of all rehydrated logs bytes ingested over all - hours in the current month for all organizations (data available as of - December 1, 2020). + description: Shows the sum of all rehydrated logs bytes ingested over all hours in the current month for all organizations (data available as of December 1, 2020). format: int64 type: integer rum_browser_and_mobile_session_count: - description: Shows the sum of all mobile sessions and all browser lite and - legacy sessions over all hours in the current month for all organizations - (To be deprecated on October 1st, 2024). + description: Shows the sum of all mobile sessions and all browser lite and legacy sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer rum_browser_legacy_session_count_agg_sum: - description: Shows the sum of all browser RUM legacy sessions over all hours - in the current month for all organizations (To be introduced on October - 1st, 2024). + description: Shows the sum of all browser RUM legacy sessions over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_browser_lite_session_count_agg_sum: - description: Shows the sum of all browser RUM lite sessions over all hours - in the current month for all organizations (To be introduced on October - 1st, 2024). + description: Shows the sum of all browser RUM lite sessions over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_browser_replay_session_count_agg_sum: - description: Shows the sum of all browser RUM Session Replay counts over - all hours in the current month for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all browser RUM Session Replay counts over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_indexed_sessions_agg_sum: - description: Sum of all RUM indexed sessions for all hours in the current - month for all organizations. + description: Sum of all RUM indexed sessions for all hours in the current month for all organizations. format: int64 type: integer rum_ingested_sessions_agg_sum: - description: Sum of all RUM ingested sessions for all hours in the current - month for all organizations. + description: Sum of all RUM ingested sessions for all hours in the current month for all organizations. format: int64 type: integer rum_lite_session_count_agg_sum: - description: Shows the sum of all RUM lite sessions (browser and mobile) - over all hours in the current month for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all RUM lite sessions (browser and mobile) over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_android_agg_sum: - description: Shows the sum of all mobile RUM legacy sessions on Android - over all hours in the current month for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM legacy sessions on Android over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_flutter_agg_sum: - description: Shows the sum of all mobile RUM legacy sessions on Flutter - over all hours in the current month for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM legacy sessions on Flutter over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_ios_agg_sum: - description: Shows the sum of all mobile RUM legacy sessions on iOS over - all hours in the current month for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM legacy sessions on iOS over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_reactnative_agg_sum: - description: Shows the sum of all mobile RUM legacy sessions on React Native - over all hours in the current month for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM legacy sessions on React Native over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_legacy_session_count_roku_agg_sum: - description: Shows the sum of all mobile RUM legacy sessions on Roku over - all hours in the current month for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM legacy sessions on Roku over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_android_agg_sum: - description: Shows the sum of all mobile RUM lite sessions on Android over - all hours in the current month for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM lite sessions on Android over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_flutter_agg_sum: - description: Shows the sum of all mobile RUM lite sessions on Flutter over - all hours in the current month for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM lite sessions on Flutter over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_ios_agg_sum: - description: Shows the sum of all mobile RUM lite sessions on iOS over all - hours in the current month for all organizations (To be introduced on - October 1st, 2024). + description: Shows the sum of all mobile RUM lite sessions on iOS over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_kotlinmultiplatform_agg_sum: - description: Shows the sum of all mobile RUM lite sessions on Kotlin Multiplatform - over all hours within the current month for all organizations. + description: Shows the sum of all mobile RUM lite sessions on Kotlin Multiplatform over all hours within the current month for all organizations. format: int64 type: integer rum_mobile_lite_session_count_reactnative_agg_sum: - description: Shows the sum of all mobile RUM lite sessions on React Native - over all hours in the current month for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM lite sessions on React Native over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_roku_agg_sum: - description: Shows the sum of all mobile RUM lite sessions on Roku over - all hours within the current month for all organizations (To be introduced - on October 1st, 2024). + description: Shows the sum of all mobile RUM lite sessions on Roku over all hours within the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_mobile_lite_session_count_unity_agg_sum: - description: Shows the sum of all mobile RUM lite sessions on Unity over - all hours within the current month for all organizations. + description: Shows the sum of all mobile RUM lite sessions on Unity over all hours within the current month for all organizations. format: int64 type: integer rum_mobile_replay_session_count_android_agg_sum: - description: Shows the sum of all mobile RUM replay sessions on Android - over all hours within the current month for all organizations. + description: Shows the sum of all mobile RUM replay sessions on Android over all hours within the current month for all organizations. format: int64 type: integer rum_mobile_replay_session_count_ios_agg_sum: - description: Shows the sum of all mobile RUM replay sessions on iOS over - all hours within the current month for all organizations. + description: Shows the sum of all mobile RUM replay sessions on iOS over all hours within the current month for all organizations. format: int64 type: integer rum_mobile_replay_session_count_kotlinmultiplatform_agg_sum: - description: Shows the sum of all mobile RUM replay sessions on Kotlin Multiplatform - over all hours within the current month for all organizations. + description: Shows the sum of all mobile RUM replay sessions on Kotlin Multiplatform over all hours within the current month for all organizations. format: int64 type: integer rum_mobile_replay_session_count_reactnative_agg_sum: - description: Shows the sum of all mobile RUM replay sessions on React Native - over all hours within the current month for all organizations. + description: Shows the sum of all mobile RUM replay sessions on React Native over all hours within the current month for all organizations. format: int64 type: integer rum_replay_session_count_agg_sum: - description: Shows the sum of all RUM Session Replay counts over all hours - in the current month for all organizations (To be introduced on October - 1st, 2024). + description: Shows the sum of all RUM Session Replay counts over all hours in the current month for all organizations (To be introduced on October 1st, 2024). format: int64 type: integer rum_session_count_agg_sum: deprecated: true - description: Shows the sum of all browser RUM lite sessions over all hours - in the current month for all organizations (To be deprecated on October - 1st, 2024). + description: Shows the sum of all browser RUM lite sessions over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer rum_session_replay_add_on_agg_sum: - description: Sum of all RUM session replay add-on sessions for all hours - in the current month for all organizations. + description: Sum of all RUM session replay add-on sessions for all hours in the current month for all organizations. format: int64 type: integer rum_total_session_count_agg_sum: - description: Shows the sum of RUM sessions (browser and mobile) over all - hours in the current month for all organizations. + description: Shows the sum of RUM sessions (browser and mobile) over all hours in the current month for all organizations. format: int64 type: integer rum_units_agg_sum: deprecated: true - description: Shows the sum of all browser and mobile RUM units over all - hours in the current month for all organizations (To be deprecated on - October 1st, 2024). + description: Shows the sum of all browser and mobile RUM units over all hours in the current month for all organizations (To be deprecated on October 1st, 2024). format: int64 type: integer sca_fargate_count_avg_sum: - description: Shows the average of all Software Composition Analysis Fargate - tasks over all hours in the current months for all organizations. + description: Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current months for all organizations. format: int64 type: integer sca_fargate_count_hwm_sum: - description: Shows the sum of the high-water marks of all Software Composition - Analysis Fargate tasks over all hours in the current months for all organizations. + description: Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current months for all organizations. format: int64 type: integer sds_apm_scanned_bytes_sum: - description: Sum of all APM bytes scanned with sensitive data scanner in - the current month for all organizations. + description: Sum of all APM bytes scanned with sensitive data scanner in the current month for all organizations. format: int64 type: integer sds_events_scanned_bytes_sum: - description: Sum of all event stream events bytes scanned with sensitive - data scanner in the current month for all organizations. + description: Sum of all event stream events bytes scanned with sensitive data scanner in the current month for all organizations. format: int64 type: integer sds_logs_scanned_bytes_sum: - description: Shows the sum of all bytes scanned of logs usage by the Sensitive - Data Scanner over all hours in the current month for all organizations. + description: Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for all organizations. format: int64 type: integer sds_rum_scanned_bytes_sum: - description: Sum of all RUM bytes scanned with sensitive data scanner in - the current month for all organizations. + description: Sum of all RUM bytes scanned with sensitive data scanner in the current month for all organizations. format: int64 type: integer sds_total_scanned_bytes_sum: - description: Shows the sum of all bytes scanned across all usage types by - the Sensitive Data Scanner over all hours in the current month for all - organizations. + description: Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for all organizations. format: int64 type: integer serverless_apps_apm_apm_azure_appservice_instances_avg_sum: - description: Sum of the average number of Serverless Apps with Application - Performance Monitoring for Azure App Service instances in the current - month for all organizations. + description: Sum of the average number of Serverless Apps with Application Performance Monitoring for Azure App Service instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_apm_azure_azurefunction_instances_avg_sum: - description: Sum of the average number of Serverless Apps with Application - Performance Monitoring for Azure Function instances in the current month - for all organizations. + description: Sum of the average number of Serverless Apps with Application Performance Monitoring for Azure Function instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_apm_azure_containerapp_instances_avg_sum: - description: Sum of the average number of Serverless Apps with Application - Performance Monitoring for Azure Container App instances in the current - month for all organizations. + description: Sum of the average number of Serverless Apps with Application Performance Monitoring for Azure Container App instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_apm_fargate_ecs_tasks_avg_sum: - description: Sum of the average number of Serverless Apps with Application - Performance Monitoring for Fargate Elastic Container Service tasks in - the current month for all organizations. + description: Sum of the average number of Serverless Apps with Application Performance Monitoring for Fargate Elastic Container Service tasks in the current month for all organizations. format: int64 type: integer serverless_apps_apm_apm_gcp_cloudfunction_instances_avg_sum: - description: Sum of the average number of Serverless Apps with Application - Performance Monitoring for Google Cloud Platform Cloud Function instances - in the current month for all organizations. + description: Sum of the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Function instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_apm_gcp_cloudrun_instances_avg_sum: - description: Sum of the average number of Serverless Apps with Application - Performance Monitoring for Google Cloud Platform Cloud Run instances in - the current month for all organizations. + description: Sum of the average number of Serverless Apps with Application Performance Monitoring for Google Cloud Platform Cloud Run instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_avg_sum: - description: Sum of the average number of Serverless Apps with Application - Performance Monitoring in the current month for all organizations. + description: Sum of the average number of Serverless Apps with Application Performance Monitoring in the current month for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_appservice_instances_avg_sum: - description: Sum of the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for Azure App Service instances - in the current month for all organizations. + description: Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure App Service instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_azurefunction_instances_avg_sum: - description: Sum of the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for Azure Function instances - in the current month for all organizations. + description: Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Function instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_azure_containerapp_instances_avg_sum: - description: Sum of the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for Azure Container App instances - in the current month for all organizations. + description: Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Azure Container App instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_gcp_cloudfunction_instances_avg_sum: - description: Sum of the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for Google Cloud Platform Cloud - Function instances in the current month for all organizations. + description: Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Function instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_apm_gcp_cloudrun_instances_avg_sum: - description: Sum of the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate for Google Cloud Platform Cloud - Run instances in the current month for all organizations. + description: Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate for Google Cloud Platform Cloud Run instances in the current month for all organizations. format: int64 type: integer serverless_apps_apm_excl_fargate_avg_sum: - description: Sum of the average number of Serverless Apps with Application - Performance Monitoring excluding Fargate in the current month for all - organizations. + description: Sum of the average number of Serverless Apps with Application Performance Monitoring excluding Fargate in the current month for all organizations. format: int64 type: integer serverless_apps_azure_container_app_instances_avg_sum: - description: Sum of the average number of Serverless Apps for Azure Container - App instances in the current month for all organizations. + description: Sum of the average number of Serverless Apps for Azure Container App instances in the current month for all organizations. format: int64 type: integer serverless_apps_azure_count_avg_sum: - description: Sum of the average number of Serverless Apps for Azure in the - current month for all organizations. + description: Sum of the average number of Serverless Apps for Azure in the current month for all organizations. format: int64 type: integer serverless_apps_azure_function_app_instances_avg_sum: - description: Sum of the average number of Serverless Apps for Azure Function - App instances in the current month for all organizations. + description: Sum of the average number of Serverless Apps for Azure Function App instances in the current month for all organizations. format: int64 type: integer serverless_apps_azure_web_app_instances_avg_sum: - description: Sum of the average number of Serverless Apps for Azure Web - App instances in the current month for all organizations. + description: Sum of the average number of Serverless Apps for Azure Web App instances in the current month for all organizations. format: int64 type: integer serverless_apps_ecs_avg_sum: - description: Sum of the average number of Serverless Apps for Elastic Container - Service in the current month for all organizations. + description: Sum of the average number of Serverless Apps for Elastic Container Service in the current month for all organizations. format: int64 type: integer serverless_apps_eks_avg_sum: - description: Sum of the average number of Serverless Apps for Elastic Kubernetes - Service in the current month for all organizations. + description: Sum of the average number of Serverless Apps for Elastic Kubernetes Service in the current month for all organizations. format: int64 type: integer serverless_apps_excl_fargate_avg_sum: - description: Sum of the average number of Serverless Apps excluding Fargate - in the current month for all organizations. + description: Sum of the average number of Serverless Apps excluding Fargate in the current month for all organizations. format: int64 type: integer serverless_apps_excl_fargate_azure_container_app_instances_avg_sum: - description: Sum of the average number of Serverless Apps excluding Fargate - for Azure Container App instances in the current month for all organizations. + description: Sum of the average number of Serverless Apps excluding Fargate for Azure Container App instances in the current month for all organizations. format: int64 type: integer serverless_apps_excl_fargate_azure_function_app_instances_avg_sum: - description: Sum of the average number of Serverless Apps excluding Fargate - for Azure Function App instances in the current month for all organizations. + description: Sum of the average number of Serverless Apps excluding Fargate for Azure Function App instances in the current month for all organizations. format: int64 type: integer serverless_apps_excl_fargate_azure_web_app_instances_avg_sum: - description: Sum of the average number of Serverless Apps excluding Fargate - for Azure Web App instances in the current month for all organizations. + description: Sum of the average number of Serverless Apps excluding Fargate for Azure Web App instances in the current month for all organizations. format: int64 type: integer serverless_apps_excl_fargate_google_cloud_functions_instances_avg_sum: - description: Sum of the average number of Serverless Apps excluding Fargate - for Google Cloud Platform Cloud Functions instances in the current month - for all organizations. + description: Sum of the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Functions instances in the current month for all organizations. format: int64 type: integer serverless_apps_excl_fargate_google_cloud_run_instances_avg_sum: - description: Sum of the average number of Serverless Apps excluding Fargate - for Google Cloud Platform Cloud Run instances in the current month for - all organizations. + description: Sum of the average number of Serverless Apps excluding Fargate for Google Cloud Platform Cloud Run instances in the current month for all organizations. format: int64 type: integer serverless_apps_google_cloud_functions_instances_avg_sum: - description: Sum of the average number of Serverless Apps for Google Cloud - Platform Cloud Functions instances in the current month for all organizations. + description: Sum of the average number of Serverless Apps for Google Cloud Platform Cloud Functions instances in the current month for all organizations. format: int64 type: integer serverless_apps_google_cloud_run_instances_avg_sum: - description: Sum of the average number of Serverless Apps for Google Cloud - Platform Cloud Run instances in the current month for all organizations. + description: Sum of the average number of Serverless Apps for Google Cloud Platform Cloud Run instances in the current month for all organizations. format: int64 type: integer serverless_apps_google_count_avg_sum: - description: Sum of the average number of Serverless Apps for Google Cloud - in the current month for all organizations. + description: Sum of the average number of Serverless Apps for Google Cloud in the current month for all organizations. format: int64 type: integer serverless_apps_total_count_avg_sum: - description: Sum of the average number of Serverless Apps for Azure and - Google Cloud in the current month for all organizations. + description: Sum of the average number of Serverless Apps for Azure and Google Cloud in the current month for all organizations. format: int64 type: integer siem_analyzed_logs_add_on_count_agg_sum: - description: Shows the sum of all log events analyzed by Cloud SIEM over - all hours in the current month for all organizations. + description: Shows the sum of all log events analyzed by Cloud SIEM over all hours in the current month for all organizations. format: int64 type: integer start_date: - description: Shows the first date of usage in the current month for all - organizations. + description: Shows the first date of usage in the current month for all organizations. format: date-time type: string synthetics_browser_check_calls_count_agg_sum: - description: Shows the sum of all Synthetic browser tests over all hours - in the current month for all organizations. + description: Shows the sum of all Synthetic browser tests over all hours in the current month for all organizations. format: int64 type: integer synthetics_check_calls_count_agg_sum: - description: Shows the sum of all Synthetic API tests over all hours in - the current month for all organizations. + description: Shows the sum of all Synthetic API tests over all hours in the current month for all organizations. format: int64 type: integer synthetics_mobile_test_runs_agg_sum: - description: Shows the sum of Synthetic mobile application tests over all - hours in the current month for all organizations. + description: Shows the sum of Synthetic mobile application tests over all hours in the current month for all organizations. format: int64 type: integer synthetics_parallel_testing_max_slots_hwm_sum: - description: Shows the sum of the high-water marks of used synthetics parallel - testing slots over all hours in the current month for all organizations. + description: Shows the sum of the high-water marks of used synthetics parallel testing slots over all hours in the current month for all organizations. format: int64 type: integer trace_search_indexed_events_count_agg_sum: - description: Shows the sum of all Indexed Spans indexed over all hours in - the current month for all organizations. + description: Shows the sum of all Indexed Spans indexed over all hours in the current month for all organizations. format: int64 type: integer twol_ingested_events_bytes_agg_sum: - description: Shows the sum of all ingested APM span bytes over all hours - in the current month for all organizations. + description: Shows the sum of all ingested APM span bytes over all hours in the current month for all organizations. format: int64 type: integer universal_service_monitoring_host_top99p_sum: - description: Shows the 99th percentile of all Universal Service Monitoring - hosts over all hours in the current month for all organizations. + description: Shows the 99th percentile of all Universal Service Monitoring hosts over all hours in the current month for all organizations. format: int64 type: integer usage: description: An array of objects regarding hourly usage. items: - $ref: '#/components/schemas/UsageSummaryDate' + $ref: "#/components/schemas/UsageSummaryDate" type: array vsphere_host_top99p_sum: - description: Shows the 99th percentile of all vSphere hosts over all hours - in the current month for all organizations. + description: Shows the 99th percentile of all vSphere hosts over all hours in the current month for all organizations. format: int64 type: integer vuln_management_host_count_top99p_sum: - description: Shows the 99th percentile of all Application Vulnerability - Management hosts over all hours in the current month for all organizations. + description: Shows the 99th percentile of all Application Vulnerability Management hosts over all hours in the current month for all organizations. format: int64 type: integer workflow_executions_usage_agg_sum: - description: Sum of all workflows executed over all hours in the current - month for all organizations. + description: Sum of all workflows executed over all hours in the current month for all organizations. format: int64 type: integer type: object @@ -25507,18 +23122,16 @@ components: type: string type: object UsageSyntheticsAPIResponse: - description: Response containing the number of Synthetics API tests run for - each hour for a given organization. + description: Response containing the number of Synthetics API tests run for each hour for a given organization. properties: usage: description: Get hourly usage for Synthetics API tests. items: - $ref: '#/components/schemas/UsageSyntheticsAPIHour' + $ref: "#/components/schemas/UsageSyntheticsAPIHour" type: array type: object UsageSyntheticsBrowserHour: - description: Number of Synthetics Browser tests run for each hour for a given - organization. + description: Number of Synthetics Browser tests run for each hour for a given organization. properties: browser_check_calls_count: description: Contains the number of Synthetics Browser tests run. @@ -25537,13 +23150,12 @@ components: type: string type: object UsageSyntheticsBrowserResponse: - description: Response containing the number of Synthetics Browser tests run - for each hour for a given organization. + description: Response containing the number of Synthetics Browser tests run for each hour for a given organization. properties: usage: description: Get hourly usage for Synthetics Browser tests. items: - $ref: '#/components/schemas/UsageSyntheticsBrowserHour' + $ref: "#/components/schemas/UsageSyntheticsBrowserHour" type: array type: object UsageSyntheticsHour: @@ -25565,14 +23177,12 @@ components: type: string type: object UsageSyntheticsResponse: - description: Response containing the number of Synthetics API tests run for - each hour for a given organization. + description: Response containing the number of Synthetics API tests run for each hour for a given organization. properties: usage: - description: Array with the number of hourly Synthetics test run for a given - organization. + description: Array with the number of hourly Synthetics test run for a given organization. items: - $ref: '#/components/schemas/UsageSyntheticsHour' + $ref: "#/components/schemas/UsageSyntheticsHour" type: array type: object UsageTimeseriesHour: @@ -25583,18 +23193,15 @@ components: format: date-time type: string num_custom_input_timeseries: - description: Contains the number of custom metrics that are inputs for aggregations - (metric configured is custom). + description: Contains the number of custom metrics that are inputs for aggregations (metric configured is custom). format: int64 type: integer num_custom_output_timeseries: - description: Contains the number of custom metrics that are outputs for - aggregations (metric configured is custom). + description: Contains the number of custom metrics that are outputs for aggregations (metric configured is custom). format: int64 type: integer num_custom_timeseries: - description: Contains sum of non-aggregation custom metrics and custom metrics - that are outputs for aggregations. + description: Contains sum of non-aggregation custom metrics and custom metrics that are outputs for aggregations. format: int64 type: integer org_name: @@ -25610,7 +23217,7 @@ components: usage: description: An array of objects regarding hourly usage of timeseries. items: - $ref: '#/components/schemas/UsageTimeseriesHour' + $ref: "#/components/schemas/UsageTimeseriesHour" type: array type: object UsageTopAvgMetricsHour: @@ -25625,7 +23232,7 @@ components: format: int64 type: integer metric_category: - $ref: '#/components/schemas/UsageMetricCategory' + $ref: "#/components/schemas/UsageMetricCategory" metric_name: description: Contains the custom metric name. type: string @@ -25634,17 +23241,15 @@ components: description: The object containing document metadata. properties: day: - description: The day value from the user request that contains the returned - usage data. (If day was used the request) + description: The day value from the user request that contains the returned usage data. (If day was used the request) format: date-time type: string month: - description: The month value from the user request that contains the returned - usage data. (If month was used the request) + description: The month value from the user request that contains the returned usage data. (If month was used the request) format: date-time type: string pagination: - $ref: '#/components/schemas/UsageTopAvgMetricsPagination' + $ref: "#/components/schemas/UsageTopAvgMetricsPagination" type: object UsageTopAvgMetricsPagination: description: The metadata for the current pagination. @@ -25654,8 +23259,7 @@ components: format: int64 type: integer next_record_id: - description: The cursor to get the next results (if any). To make the next - request, use the same parameters and add `next_record_id`. + description: The cursor to get the next results (if any). To make the next request, use the same parameters and add `next_record_id`. nullable: true type: string total_number_of_records: @@ -25665,22 +23269,21 @@ components: type: integer type: object UsageTopAvgMetricsResponse: - description: Response containing the number of hourly recorded custom metrics - for a given organization. + description: Response containing the number of hourly recorded custom metrics for a given organization. properties: metadata: - $ref: '#/components/schemas/UsageTopAvgMetricsMetadata' + $ref: "#/components/schemas/UsageTopAvgMetricsMetadata" usage: description: Number of hourly recorded custom metrics for a given organization. items: - $ref: '#/components/schemas/UsageTopAvgMetricsHour' + $ref: "#/components/schemas/UsageTopAvgMetricsHour" type: array type: object User: description: Create, edit, and disable users. properties: access_role: - $ref: '#/components/schemas/AccessRole' + $ref: "#/components/schemas/AccessRole" disabled: description: The new disabled status of the user. example: false @@ -25721,18 +23324,17 @@ components: users: description: Array of users. items: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" type: array type: object UserResponse: description: A Datadog User. properties: user: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" type: object Version: - description: Version of the updated signal. If server side version is higher, - update will be rejected. + description: Version of the updated signal. If server side version is higher, update will be rejected. example: 0 format: int64 type: integer @@ -25740,51 +23342,46 @@ components: description: The viewing preferences for a shared dashboard. properties: high_density: - description: Whether the widgets on the shared dashboard should be displayed - with high density. + description: Whether the widgets on the shared dashboard should be displayed with high density. type: boolean theme: - $ref: '#/components/schemas/ViewingPreferencesTheme' + $ref: "#/components/schemas/ViewingPreferencesTheme" type: object ViewingPreferencesTheme: - description: The theme of the shared dashboard view. "system" follows your system's - default viewing theme. + description: The theme of the shared dashboard view. "system" follows your system's default viewing theme. enum: - - system - - light - - dark + - "system" + - "light" + - "dark" type: string x-enum-varnames: - - SYSTEM - - LIGHT - - DARK + - SYSTEM + - LIGHT + - DARK WebhooksIntegration: description: Datadog-Webhooks integration. properties: custom_headers: - description: 'If `null`, uses no header. - - If given a JSON payload, these will be headers attached to your webhook.' + description: |- + If `null`, uses no header. + If given a JSON payload, these will be headers attached to your webhook. nullable: true type: string encode_as: - $ref: '#/components/schemas/WebhooksIntegrationEncoding' + $ref: "#/components/schemas/WebhooksIntegrationEncoding" name: - description: 'The name of the webhook. It corresponds with ``. - + description: |- + The name of the webhook. It corresponds with ``. Learn more on how to use it in - - [monitor notifications](https://docs.datadoghq.com/monitors/notify).' + [monitor notifications](https://docs.datadoghq.com/monitors/notify). example: WEBHOOK_NAME type: string payload: - description: 'If `null`, uses the default payload. - + description: |- + If `null`, uses the default payload. If given a JSON payload, the webhook returns the payload - specified by the given payload. - - [Webhooks variable usage](https://docs.datadoghq.com/integrations/webhooks/#usage).' + [Webhooks variable usage](https://docs.datadoghq.com/integrations/webhooks/#usage). nullable: true type: string url: @@ -25792,17 +23389,16 @@ components: example: https://example.com/webhook type: string required: - - name - - url + - name + - url type: object WebhooksIntegrationCustomVariable: description: Custom variable for Webhook integration. properties: is_secret: - description: 'Make custom variable is secret or not. - - If the custom variable is secret, the value is not returned in the response - payload.' + description: |- + Make custom variable is secret or not. + If the custom variable is secret, the value is not returned in the response payload. example: true type: boolean name: @@ -25814,49 +23410,44 @@ components: example: CUSTOM_VARIABLE_VALUE type: string required: - - name - - value - - is_secret + - name + - value + - is_secret type: object WebhooksIntegrationCustomVariableResponse: description: Custom variable for Webhook integration. properties: is_secret: - description: 'Make custom variable is secret or not. - - If the custom variable is secret, the value is not returned in the response - payload.' + description: |- + Make custom variable is secret or not. + If the custom variable is secret, the value is not returned in the response payload. example: true type: boolean name: - description: The name of the variable. It corresponds with ``. - It must only contains upper-case characters, integers or underscores. + description: The name of the variable. It corresponds with ``. It must only contains upper-case characters, integers or underscores. example: CUSTOM_VARIABLE_NAME type: string value: - description: Value of the custom variable. It won't be returned if the variable - is secret. + description: Value of the custom variable. It won't be returned if the variable is secret. example: CUSTOM_VARIABLE_VALUE type: string required: - - name - - is_secret + - name + - is_secret type: object WebhooksIntegrationCustomVariableUpdateRequest: - description: 'Update request of a custom variable object. - + description: |- + Update request of a custom variable object. - *All properties are optional.*' + *All properties are optional.* properties: is_secret: - description: 'Make custom variable is secret or not. - - If the custom variable is secret, the value is not returned in the response - payload.' + description: |- + Make custom variable is secret or not. + If the custom variable is secret, the value is not returned in the response payload. type: boolean name: - description: The name of the variable. It corresponds with ``. - It must only contains upper-case characters, integers or underscores. + description: The name of the variable. It corresponds with ``. It must only contains upper-case characters, integers or underscores. example: CUSTOM_VARIABLE_NAME type: string value: @@ -25868,41 +23459,38 @@ components: default: json description: Encoding type. Can be given either `json` or `form`. enum: - - json - - form + - json + - form type: string x-enum-varnames: - - JSON - - FORM + - JSON + - FORM WebhooksIntegrationUpdateRequest: - description: 'Update request of a Webhooks integration object. + description: |- + Update request of a Webhooks integration object. - - *All properties are optional.*' + *All properties are optional.* properties: custom_headers: - description: 'If `null`, uses no header. - - If given a JSON payload, these will be headers attached to your webhook.' + description: |- + If `null`, uses no header. + If given a JSON payload, these will be headers attached to your webhook. type: string encode_as: - $ref: '#/components/schemas/WebhooksIntegrationEncoding' + $ref: "#/components/schemas/WebhooksIntegrationEncoding" name: - description: 'The name of the webhook. It corresponds with ``. - + description: |- + The name of the webhook. It corresponds with ``. Learn more on how to use it in - - [monitor notifications](https://docs.datadoghq.com/monitors/notify).' + [monitor notifications](https://docs.datadoghq.com/monitors/notify). example: WEBHOOK_NAME type: string payload: - description: 'If `null`, uses the default payload. - + description: |- + If `null`, uses the default payload. If given a JSON payload, the webhook returns the payload - specified by the given payload. - - [Webhooks variable usage](https://docs.datadoghq.com/integrations/webhooks/#usage).' + [Webhooks variable usage](https://docs.datadoghq.com/integrations/webhooks/#usage). nullable: true type: string url: @@ -25911,40 +23499,42 @@ components: type: string type: object Widget: - description: "Information about widget.\n\n**Note**: The `layout` property is - required for widgets in dashboards with `free` `layout_type`.\n For the - **new dashboard layout**, the `layout` property depends on the `reflow_type` - of the dashboard.\n - If `reflow_type` is `fixed`, `layout` is required.\n - \ - If `reflow_type` is `auto`, `layout` should not be set." + description: |- + Information about widget. + + **Note**: The `layout` property is required for widgets in dashboards with `free` `layout_type`. + For the **new dashboard layout**, the `layout` property depends on the `reflow_type` of the dashboard. + - If `reflow_type` is `fixed`, `layout` is required. + - If `reflow_type` is `auto`, `layout` should not be set. properties: definition: - $ref: '#/components/schemas/WidgetDefinition' + $ref: "#/components/schemas/WidgetDefinition" id: description: ID of the widget. format: int64 type: integer layout: - $ref: '#/components/schemas/WidgetLayout' + $ref: "#/components/schemas/WidgetLayout" required: - - definition + - definition type: object WidgetAggregator: description: Aggregator used for the request. enum: - - avg - - last - - max - - min - - sum - - percentile + - avg + - last + - max + - min + - sum + - percentile type: string x-enum-varnames: - - AVERAGE - - LAST - - MAXIMUM - - MINIMUM - - SUM - - PERCENTILE + - AVERAGE + - LAST + - MAXIMUM + - MINIMUM + - SUM + - PERCENTILE WidgetAxis: description: Axis controls for the widget. properties: @@ -25952,84 +23542,78 @@ components: description: Set to `true` to include zero. type: boolean label: - description: The label of the axis to display on the graph. Only usable - on Scatterplot Widgets. + description: The label of the axis to display on the graph. Only usable on Scatterplot Widgets. type: string max: default: auto - description: Specifies maximum numeric value to show on the axis. Defaults - to `auto`. + description: Specifies maximum numeric value to show on the axis. Defaults to `auto`. type: string min: default: auto - description: Specifies minimum numeric value to show on the axis. Defaults - to `auto`. + description: Specifies minimum numeric value to show on the axis. Defaults to `auto`. type: string scale: default: linear - description: Specifies the scale type. Possible values are `linear`, `log`, - `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). + description: Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). type: string type: object WidgetChangeType: description: Show the absolute or the relative change. enum: - - absolute - - relative + - absolute + - relative type: string x-enum-varnames: - - ABSOLUTE - - RELATIVE + - ABSOLUTE + - RELATIVE WidgetColorPreference: description: Which color to use on the widget. enum: - - background - - text + - background + - text type: string x-enum-varnames: - - BACKGROUND - - TEXT + - BACKGROUND + - TEXT WidgetComparator: description: Comparator to apply. enum: - - '=' - - '>' - - '>=' - - < - - <= - example: '>' + - "=" + - ">" + - ">=" + - "<" + - "<=" + example: ">" type: string x-enum-varnames: - - EQUAL_TO - - GREATER_THAN - - GREATER_THAN_OR_EQUAL_TO - - LESS_THAN - - LESS_THAN_OR_EQUAL_TO + - EQUAL_TO + - GREATER_THAN + - GREATER_THAN_OR_EQUAL_TO + - LESS_THAN + - LESS_THAN_OR_EQUAL_TO WidgetCompareTo: description: Timeframe used for the change comparison. enum: - - hour_before - - day_before - - week_before - - month_before + - hour_before + - day_before + - week_before + - month_before type: string x-enum-varnames: - - HOUR_BEFORE - - DAY_BEFORE - - WEEK_BEFORE - - MONTH_BEFORE + - HOUR_BEFORE + - DAY_BEFORE + - WEEK_BEFORE + - MONTH_BEFORE WidgetConditionalFormat: description: Define a conditional format for the widget. properties: comparator: - $ref: '#/components/schemas/WidgetComparator' + $ref: "#/components/schemas/WidgetComparator" custom_bg_color: - description: Color palette to apply to the background, same values available - as palette. + description: Color palette to apply to the background, same values available as palette. type: string custom_fg_color: - description: Color palette to apply to the foreground, same values available - as palette. + description: Color palette to apply to the foreground, same values available as palette. type: string hide_value: description: True hides values. @@ -26038,11 +23622,10 @@ components: description: Displays an image as the background. type: string metric: - description: Metric from the request to correlate this conditional format - with. + description: Metric from the request to correlate this conditional format with. type: string palette: - $ref: '#/components/schemas/WidgetPalette' + $ref: "#/components/schemas/WidgetPalette" timeframe: description: Defines the displayed timeframe. type: string @@ -26052,124 +23635,120 @@ components: format: double type: number required: - - comparator - - value - - palette + - comparator + - value + - palette type: object WidgetCustomLink: - description: Custom links help you connect a data value to a URL, like a Datadog - page or your AWS console. + description: Custom links help you connect a data value to a URL, like a Datadog page or your AWS console. properties: is_hidden: description: The flag for toggling context menu link visibility. type: boolean label: - description: The label for the custom link URL. Keep the label short and - descriptive. Use metrics and tags as variables. - example: Search logs for {{host}} + description: The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. + example: "Search logs for {{host}}" type: string link: - description: The URL of the custom link. URL must include `http` or `https`. - A relative URL must start with `/`. - example: https://app.datadoghq.com/logs?query={{host}} + description: The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. + example: "https://app.datadoghq.com/logs?query={{host}}" type: string override_label: - description: The label ID that refers to a context menu link. Can be `logs`, - `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. - example: logs + description: The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. + example: "logs" type: string type: object WidgetDefinition: - description: '[Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/).' + description: >- + [Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/). oneOf: - - $ref: '#/components/schemas/AlertGraphWidgetDefinition' - - $ref: '#/components/schemas/AlertValueWidgetDefinition' - - $ref: '#/components/schemas/BarChartWidgetDefinition' - - $ref: '#/components/schemas/ChangeWidgetDefinition' - - $ref: '#/components/schemas/CheckStatusWidgetDefinition' - - $ref: '#/components/schemas/DistributionWidgetDefinition' - - $ref: '#/components/schemas/EventStreamWidgetDefinition' - - $ref: '#/components/schemas/EventTimelineWidgetDefinition' - - $ref: '#/components/schemas/FreeTextWidgetDefinition' - - $ref: '#/components/schemas/FunnelWidgetDefinition' - - $ref: '#/components/schemas/GeomapWidgetDefinition' - - $ref: '#/components/schemas/GroupWidgetDefinition' - - $ref: '#/components/schemas/HeatMapWidgetDefinition' - - $ref: '#/components/schemas/HostMapWidgetDefinition' - - $ref: '#/components/schemas/IFrameWidgetDefinition' - - $ref: '#/components/schemas/ImageWidgetDefinition' - - $ref: '#/components/schemas/ListStreamWidgetDefinition' - - $ref: '#/components/schemas/LogStreamWidgetDefinition' - - $ref: '#/components/schemas/MonitorSummaryWidgetDefinition' - - $ref: '#/components/schemas/NoteWidgetDefinition' - - $ref: '#/components/schemas/PowerpackWidgetDefinition' - - $ref: '#/components/schemas/QueryValueWidgetDefinition' - - $ref: '#/components/schemas/RunWorkflowWidgetDefinition' - - $ref: '#/components/schemas/SLOListWidgetDefinition' - - $ref: '#/components/schemas/SLOWidgetDefinition' - - $ref: '#/components/schemas/ScatterPlotWidgetDefinition' - - $ref: '#/components/schemas/ServiceMapWidgetDefinition' - - $ref: '#/components/schemas/ServiceSummaryWidgetDefinition' - - $ref: '#/components/schemas/SplitGraphWidgetDefinition' - - $ref: '#/components/schemas/SunburstWidgetDefinition' - - $ref: '#/components/schemas/TableWidgetDefinition' - - $ref: '#/components/schemas/TimeseriesWidgetDefinition' - - $ref: '#/components/schemas/ToplistWidgetDefinition' - - $ref: '#/components/schemas/TopologyMapWidgetDefinition' - - $ref: '#/components/schemas/TreeMapWidgetDefinition' + - $ref: "#/components/schemas/AlertGraphWidgetDefinition" + - $ref: "#/components/schemas/AlertValueWidgetDefinition" + - $ref: "#/components/schemas/BarChartWidgetDefinition" + - $ref: "#/components/schemas/ChangeWidgetDefinition" + - $ref: "#/components/schemas/CheckStatusWidgetDefinition" + - $ref: "#/components/schemas/DistributionWidgetDefinition" + - $ref: "#/components/schemas/EventStreamWidgetDefinition" + - $ref: "#/components/schemas/EventTimelineWidgetDefinition" + - $ref: "#/components/schemas/FreeTextWidgetDefinition" + - $ref: "#/components/schemas/FunnelWidgetDefinition" + - $ref: "#/components/schemas/GeomapWidgetDefinition" + - $ref: "#/components/schemas/GroupWidgetDefinition" + - $ref: "#/components/schemas/HeatMapWidgetDefinition" + - $ref: "#/components/schemas/HostMapWidgetDefinition" + - $ref: "#/components/schemas/IFrameWidgetDefinition" + - $ref: "#/components/schemas/ImageWidgetDefinition" + - $ref: "#/components/schemas/ListStreamWidgetDefinition" + - $ref: "#/components/schemas/LogStreamWidgetDefinition" + - $ref: "#/components/schemas/MonitorSummaryWidgetDefinition" + - $ref: "#/components/schemas/NoteWidgetDefinition" + - $ref: "#/components/schemas/PowerpackWidgetDefinition" + - $ref: "#/components/schemas/QueryValueWidgetDefinition" + - $ref: "#/components/schemas/RunWorkflowWidgetDefinition" + - $ref: "#/components/schemas/SLOListWidgetDefinition" + - $ref: "#/components/schemas/SLOWidgetDefinition" + - $ref: "#/components/schemas/ScatterPlotWidgetDefinition" + - $ref: "#/components/schemas/ServiceMapWidgetDefinition" + - $ref: "#/components/schemas/ServiceSummaryWidgetDefinition" + - $ref: "#/components/schemas/SplitGraphWidgetDefinition" + - $ref: "#/components/schemas/SunburstWidgetDefinition" + - $ref: "#/components/schemas/TableWidgetDefinition" + - $ref: "#/components/schemas/TimeseriesWidgetDefinition" + - $ref: "#/components/schemas/ToplistWidgetDefinition" + - $ref: "#/components/schemas/TopologyMapWidgetDefinition" + - $ref: "#/components/schemas/TreeMapWidgetDefinition" WidgetDisplayType: description: Type of display to use for the request. enum: - - area - - bars - - line - - overlay + - area + - bars + - line + - overlay type: string x-enum-varnames: - - AREA - - BARS - - LINE - - OVERLAY + - AREA + - BARS + - LINE + - OVERLAY WidgetEvent: deprecated: true - description: 'Event overlay control options. - + description: |- + Event overlay control options. See the dedicated [Events JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/widget_json/#events-schema) - - to learn how to build the ``.' + to learn how to build the ``. properties: q: description: Query definition. - example: '' + example: "" type: string tags_execution: description: The execution method for multi-value filters. type: string required: - - q + - q type: object WidgetEventSize: description: Size to use to display an event. enum: - - s - - l + - s + - l type: string x-enum-varnames: - - SMALL - - LARGE + - SMALL + - LARGE WidgetFieldSort: description: Which column and order to sort by properties: column: description: Facet path for the column - example: '' + example: "" type: string order: - $ref: '#/components/schemas/WidgetSort' + $ref: "#/components/schemas/WidgetSort" required: - - column - - order + - column + - order type: object WidgetFormula: description: Formula to be used in a widget query. @@ -26178,58 +23757,57 @@ components: description: Expression alias. type: string cell_display_mode: - $ref: '#/components/schemas/TableWidgetCellDisplayMode' + $ref: "#/components/schemas/TableWidgetCellDisplayMode" cell_display_mode_options: - $ref: '#/components/schemas/WidgetFormulaCellDisplayModeOptions' + $ref: "#/components/schemas/WidgetFormulaCellDisplayModeOptions" conditional_formats: description: List of conditional formats. items: - $ref: '#/components/schemas/WidgetConditionalFormat' + $ref: "#/components/schemas/WidgetConditionalFormat" type: array formula: description: String expression built from queries, formulas, and functions. - example: func(a) + b + example: "func(a) + b" type: string limit: - $ref: '#/components/schemas/WidgetFormulaLimit' + $ref: "#/components/schemas/WidgetFormulaLimit" number_format: - $ref: '#/components/schemas/WidgetNumberFormat' + $ref: "#/components/schemas/WidgetNumberFormat" style: - $ref: '#/components/schemas/WidgetFormulaStyle' + $ref: "#/components/schemas/WidgetFormulaStyle" required: - - formula + - formula type: object WidgetFormulaCellDisplayModeOptions: - description: Cell display mode options for the widget formula. (only if `cell_display_mode` - is set to `trend`). + description: Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). properties: trend_type: - $ref: '#/components/schemas/WidgetFormulaCellDisplayModeOptionsTrendType' + $ref: "#/components/schemas/WidgetFormulaCellDisplayModeOptionsTrendType" y_scale: - $ref: '#/components/schemas/WidgetFormulaCellDisplayModeOptionsYScale' + $ref: "#/components/schemas/WidgetFormulaCellDisplayModeOptionsYScale" type: object WidgetFormulaCellDisplayModeOptionsTrendType: description: Trend type for the cell display mode options. enum: - - area - - line - - bars + - area + - line + - bars example: area type: string x-enum-varnames: - - AREA - - LINE - - BARS + - AREA + - LINE + - BARS WidgetFormulaCellDisplayModeOptionsYScale: description: Y scale for the cell display mode options. enum: - - shared - - independent + - shared + - independent example: shared type: string x-enum-varnames: - - SHARED - - INDEPENDENT + - SHARED + - INDEPENDENT WidgetFormulaLimit: description: Options for limiting results returned. properties: @@ -26238,7 +23816,7 @@ components: format: int64 type: integer order: - $ref: '#/components/schemas/QuerySortOrder' + $ref: "#/components/schemas/QuerySortOrder" type: object WidgetFormulaSort: description: The formula to sort the widget by. @@ -26250,21 +23828,17 @@ components: minimum: 0 type: integer order: - $ref: '#/components/schemas/WidgetSort' + $ref: "#/components/schemas/WidgetSort" type: - $ref: '#/components/schemas/FormulaType' - required: - - type - - index - - order + $ref: "#/components/schemas/FormulaType" + required: ["type", "index", "order"] type: object WidgetFormulaStyle: description: Styling options for widget formulas. properties: palette: - description: The color palette used to display the formula. A guide to the - available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors - example: classic + description: The color palette used to display the formula. A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors + example: "classic" type: string palette_index: description: Index specifying which color to use within the palette. @@ -26277,75 +23851,68 @@ components: properties: name: description: The name of the group. - example: group_name + example: "group_name" type: string order: - $ref: '#/components/schemas/WidgetSort' + $ref: "#/components/schemas/WidgetSort" type: - $ref: '#/components/schemas/GroupType' - required: - - type - - name - - order + $ref: "#/components/schemas/GroupType" + required: ["type", "name", "order"] type: object WidgetGrouping: description: The kind of grouping to use. enum: - - check - - cluster + - check + - cluster example: check type: string x-enum-varnames: - - CHECK - - CLUSTER + - CHECK + - CLUSTER WidgetHistogramRequestType: - description: Request type for distribution of point values for distribution - metrics. Query space aggregator must be `histogram:` for points - distributions. + description: Request type for distribution of point values for distribution metrics. Query space aggregator must be `histogram:` for points distributions. enum: - - histogram + - histogram example: histogram type: string x-enum-varnames: - - HISTOGRAM + - HISTOGRAM WidgetHorizontalAlign: description: Horizontal alignment. enum: - - center - - left - - right + - center + - left + - right type: string x-enum-varnames: - - CENTER - - LEFT - - RIGHT + - CENTER + - LEFT + - RIGHT WidgetImageSizing: - description: 'How to size the image on the widget. The values are based on the - image `object-fit` CSS properties. - - **Note**: `zoom`, `fit` and `center` values are deprecated.' - enum: - - fill - - contain - - cover - - none - - scale-down - - zoom - - fit - - center - type: string - x-enum-varnames: - - FILL - - CONTAIN - - COVER - - NONE - - SCALEDOWN - - ZOOM - - FIT - - CENTER + description: |- + How to size the image on the widget. The values are based on the image `object-fit` CSS properties. + **Note**: `zoom`, `fit` and `center` values are deprecated. + enum: + - fill + - contain + - cover + - none + - scale-down + - zoom + - fit + - center + type: string + x-enum-varnames: + - FILL + - CONTAIN + - COVER + - NONE + - SCALEDOWN + - ZOOM + - FIT + - CENTER WidgetLayout: - description: The layout for a widget on a `free` or **new dashboard layout** - dashboard. + description: The layout for a widget on a `free` or **new dashboard layout** dashboard. properties: height: description: The height of the widget. Should be a non-negative integer. @@ -26354,11 +23921,9 @@ components: minimum: 0 type: integer is_column_break: - description: 'Whether the widget should be the first one on the second column - in high density or not. - - **Note**: Only for the **new dashboard layout** and only one widget in - the dashboard should have this property set to `true`.' + description: |- + Whether the widget should be the first one on the second column in high density or not. + **Note**: Only for the **new dashboard layout** and only one widget in the dashboard should have this property set to `true`. type: boolean width: description: The width of the widget. Should be a non-negative integer. @@ -26367,33 +23932,31 @@ components: minimum: 0 type: integer x: - description: The position of the widget on the x (horizontal) axis. Should - be a non-negative integer. + description: The position of the widget on the x (horizontal) axis. Should be a non-negative integer. example: 0 format: int64 minimum: 0 type: integer y: - description: The position of the widget on the y (vertical) axis. Should - be a non-negative integer. + description: The position of the widget on the y (vertical) axis. Should be a non-negative integer. example: 0 format: int64 minimum: 0 type: integer required: - - x - - y - - width - - height + - x + - y + - width + - height type: object WidgetLayoutType: description: Layout type of the group. enum: - - ordered + - ordered example: ordered type: string x-enum-varnames: - - ORDERED + - ORDERED WidgetLegacyLiveSpan: additionalProperties: false description: Wrapper for live span @@ -26402,201 +23965,198 @@ components: description: Whether to hide incomplete cost data in the widget. type: boolean live_span: - $ref: '#/components/schemas/WidgetLiveSpan' + $ref: "#/components/schemas/WidgetLiveSpan" type: object WidgetLegendSize: - description: Available legend sizes for a widget. Should be one of "0", "2", - "4", "8", "16", or "auto". + description: Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". type: string WidgetLineType: description: Type of lines displayed. enum: - - dashed - - dotted - - solid + - dashed + - dotted + - solid type: string x-enum-varnames: - - DASHED - - DOTTED - - SOLID + - DASHED + - DOTTED + - SOLID WidgetLineWidth: description: Width of line displayed. enum: - - normal - - thick - - thin + - normal + - thick + - thin type: string x-enum-varnames: - - NORMAL - - THICK - - THIN + - NORMAL + - THICK + - THIN WidgetLiveSpan: description: The available timeframes depend on the widget you are using. enum: - - 1m - - 5m - - 10m - - 15m - - 30m - - 1h - - 4h - - 1d - - 2d - - 1w - - 1mo - - 3mo - - 6mo - - week_to_date - - month_to_date - - 1y - - alert + - 1m + - 5m + - 10m + - 15m + - 30m + - 1h + - 4h + - 1d + - 2d + - 1w + - 1mo + - 3mo + - 6mo + - week_to_date + - month_to_date + - 1y + - alert example: 5m type: string x-enum-varnames: - - PAST_ONE_MINUTE - - PAST_FIVE_MINUTES - - PAST_TEN_MINUTES - - PAST_FIFTEEN_MINUTES - - PAST_THIRTY_MINUTES - - PAST_ONE_HOUR - - PAST_FOUR_HOURS - - PAST_ONE_DAY - - PAST_TWO_DAYS - - PAST_ONE_WEEK - - PAST_ONE_MONTH - - PAST_THREE_MONTHS - - PAST_SIX_MONTHS - - WEEK_TO_DATE - - MONTH_TO_DATE - - PAST_ONE_YEAR - - ALERT + - PAST_ONE_MINUTE + - PAST_FIVE_MINUTES + - PAST_TEN_MINUTES + - PAST_FIFTEEN_MINUTES + - PAST_THIRTY_MINUTES + - PAST_ONE_HOUR + - PAST_FOUR_HOURS + - PAST_ONE_DAY + - PAST_TWO_DAYS + - PAST_ONE_WEEK + - PAST_ONE_MONTH + - PAST_THREE_MONTHS + - PAST_SIX_MONTHS + - WEEK_TO_DATE + - MONTH_TO_DATE + - PAST_ONE_YEAR + - ALERT WidgetLiveSpanUnit: description: Unit of the time span. enum: - - minute - - hour - - day - - week - - month - - year + - minute + - hour + - day + - week + - month + - year example: minute type: string x-enum-varnames: - - MINUTE - - HOUR - - DAY - - WEEK - - MONTH - - YEAR + - MINUTE + - HOUR + - DAY + - WEEK + - MONTH + - YEAR WidgetMargin: - description: 'Size of the margins around the image. - - **Note**: `small` and `large` values are deprecated.' - enum: - - sm - - md - - lg - - small - - large - type: string - x-enum-varnames: - - SM - - MD - - LG - - SMALL - - LARGE + description: |- + Size of the margins around the image. + **Note**: `small` and `large` values are deprecated. + enum: + - sm + - md + - lg + - small + - large + type: string + x-enum-varnames: + - SM + - MD + - LG + - SMALL + - LARGE WidgetMarker: - description: Markers allow you to add visual conditional formatting for your - graphs. + description: Markers allow you to add visual conditional formatting for your graphs. properties: display_type: - description: "Combination of:\n - A severity error, warning, ok, or info\n - \ - A line type: dashed, solid, or bold\nIn this case of a Distribution - widget, this can be set to be `percentile`." - example: error dashed + description: |- + Combination of: + - A severity error, warning, ok, or info + - A line type: dashed, solid, or bold + In this case of a Distribution widget, this can be set to be `percentile`. + example: "error dashed" type: string label: description: Label to display over the marker. - example: Error threshold + example: "Error threshold" type: string time: description: Timestamp for the widget. type: string value: - description: 'Value to apply. Can be a single value y = 15 or a range of - values 0 < y < 10. - - For Distribution widgets with `display_type` set to `percentile`, this - should be - - a numeric percentile value (for example, "90" for P90).' - example: y = 15 + description: |- + Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. + For Distribution widgets with `display_type` set to `percentile`, this should be + a numeric percentile value (for example, "90" for P90). + example: "y = 15" type: string required: - - value + - value type: object WidgetMessageDisplay: description: Amount of log lines to display enum: - - inline - - expanded-md - - expanded-lg + - inline + - expanded-md + - expanded-lg type: string x-enum-varnames: - - INLINE - - EXPANDED_MEDIUM - - EXPANDED_LARGE + - INLINE + - EXPANDED_MEDIUM + - EXPANDED_LARGE WidgetMonitorSummaryDisplayFormat: description: What to display on the widget. enum: - - counts - - countsAndList - - list + - counts + - countsAndList + - list type: string x-enum-varnames: - - COUNTS - - COUNTS_AND_LIST - - LIST + - COUNTS + - COUNTS_AND_LIST + - LIST WidgetMonitorSummarySort: description: Widget sorting methods. enum: - - name - - group - - status - - tags - - triggered - - group,asc - - group,desc - - name,asc - - name,desc - - status,asc - - status,desc - - tags,asc - - tags,desc - - triggered,asc - - triggered,desc - - priority,asc - - priority,desc + - name + - group + - status + - tags + - triggered + - "group,asc" + - "group,desc" + - "name,asc" + - "name,desc" + - "status,asc" + - "status,desc" + - "tags,asc" + - "tags,desc" + - "triggered,asc" + - "triggered,desc" + - "priority,asc" + - "priority,desc" example: name,asc type: string x-enum-varnames: - - NAME - - GROUP - - STATUS - - TAGS - - TRIGGERED - - GROUP_ASCENDING - - GROUP_DESCENDING - - NAME_ASCENDING - - NAME_DESCENDING - - STATUS_ASCENDING - - STATUS_DESCENDING - - TAGS_ASCENDING - - TAGS_DESCENDING - - TRIGGERED_ASCENDING - - TRIGGERED_DESCENDING - - PRIORITY_ASCENDING - - PRIORITY_DESCENDING + - NAME + - GROUP + - STATUS + - TAGS + - TRIGGERED + - GROUP_ASCENDING + - GROUP_DESCENDING + - NAME_ASCENDING + - NAME_DESCENDING + - STATUS_ASCENDING + - STATUS_DESCENDING + - TAGS_ASCENDING + - TAGS_DESCENDING + - TRIGGERED_ASCENDING + - TRIGGERED_DESCENDING + - PRIORITY_ASCENDING + - PRIORITY_DESCENDING WidgetNewFixedSpan: description: Used for fixed span times, such as 'March 1 to March 7'. properties: @@ -26616,20 +24176,19 @@ components: minimum: 0 type: integer type: - $ref: '#/components/schemas/WidgetNewFixedSpanType' + $ref: "#/components/schemas/WidgetNewFixedSpanType" required: - - type - - from - - to + - type + - from + - to type: object WidgetNewFixedSpanType: description: Type "fixed" denotes a fixed span. - enum: - - fixed - example: fixed + enum: ["fixed"] + example: "fixed" type: string x-enum-varnames: - - FIXED + - FIXED WidgetNewLiveSpan: description: Used for arbitrary live span times, such as 17 minutes or 6 hours. properties: @@ -26637,9 +24196,9 @@ components: description: Whether to hide incomplete cost data in the widget. type: boolean type: - $ref: '#/components/schemas/WidgetNewLiveSpanType' + $ref: "#/components/schemas/WidgetNewLiveSpanType" unit: - $ref: '#/components/schemas/WidgetLiveSpanUnit' + $ref: "#/components/schemas/WidgetLiveSpanUnit" value: description: Value of the time span. example: 4 @@ -26647,101 +24206,100 @@ components: minimum: 1 type: integer required: - - type - - value - - unit + - type + - value + - unit type: object WidgetNewLiveSpanType: description: Type "live" denotes a live span in the new format. - enum: - - live - example: live + enum: ["live"] + example: "live" type: string x-enum-varnames: - - LIVE + - LIVE WidgetNodeType: description: Which type of node to use in the map. enum: - - host - - container + - host + - container type: string x-enum-varnames: - - HOST - - CONTAINER + - HOST + - CONTAINER WidgetNumberFormat: description: Number format options for the widget. properties: unit: - $ref: '#/components/schemas/NumberFormatUnit' + $ref: "#/components/schemas/NumberFormatUnit" unit_scale: - $ref: '#/components/schemas/NumberFormatUnitScale' + $ref: "#/components/schemas/NumberFormatUnitScale" type: object WidgetOrderBy: description: What to order by. enum: - - change - - name - - present - - past + - change + - name + - present + - past type: string x-enum-varnames: - - CHANGE - - NAME - - PRESENT - - PAST + - CHANGE + - NAME + - PRESENT + - PAST WidgetPalette: description: Color palette to apply. enum: - - blue - - custom_bg - - custom_image - - custom_text - - gray_on_white - - grey - - green - - orange - - red - - red_on_white - - white_on_gray - - white_on_green - - green_on_white - - white_on_red - - white_on_yellow - - yellow_on_white - - black_on_light_yellow - - black_on_light_green - - black_on_light_red + - blue + - custom_bg + - custom_image + - custom_text + - gray_on_white + - grey + - green + - orange + - red + - red_on_white + - white_on_gray + - white_on_green + - green_on_white + - white_on_red + - white_on_yellow + - yellow_on_white + - black_on_light_yellow + - black_on_light_green + - black_on_light_red example: blue type: string x-enum-varnames: - - BLUE - - CUSTOM_BACKGROUND - - CUSTOM_IMAGE - - CUSTOM_TEXT - - GRAY_ON_WHITE - - GREY - - GREEN - - ORANGE - - RED - - RED_ON_WHITE - - WHITE_ON_GRAY - - WHITE_ON_GREEN - - GREEN_ON_WHITE - - WHITE_ON_RED - - WHITE_ON_YELLOW - - YELLOW_ON_WHITE - - BLACK_ON_LIGHT_YELLOW - - BLACK_ON_LIGHT_GREEN - - BLACK_ON_LIGHT_RED + - BLUE + - CUSTOM_BACKGROUND + - CUSTOM_IMAGE + - CUSTOM_TEXT + - GRAY_ON_WHITE + - GREY + - GREEN + - ORANGE + - RED + - RED_ON_WHITE + - WHITE_ON_GRAY + - WHITE_ON_GREEN + - GREEN_ON_WHITE + - WHITE_ON_RED + - WHITE_ON_YELLOW + - YELLOW_ON_WHITE + - BLACK_ON_LIGHT_YELLOW + - BLACK_ON_LIGHT_GREEN + - BLACK_ON_LIGHT_RED WidgetRequestStyle: description: Define request widget style. properties: line_type: - $ref: '#/components/schemas/WidgetLineType' + $ref: "#/components/schemas/WidgetLineType" line_width: - $ref: '#/components/schemas/WidgetLineWidth' + $ref: "#/components/schemas/WidgetLineWidth" order_by: - $ref: '#/components/schemas/WidgetStyleOrderBy' + $ref: "#/components/schemas/WidgetStyleOrderBy" palette: description: Color palette to apply to the widget. type: string @@ -26749,35 +24307,35 @@ components: WidgetServiceSummaryDisplayFormat: description: Number of columns to display. enum: - - one_column - - two_column - - three_column + - one_column + - two_column + - three_column type: string x-enum-varnames: - - ONE_COLUMN - - TWO_COLUMN - - THREE_COLUMN + - ONE_COLUMN + - TWO_COLUMN + - THREE_COLUMN WidgetSizeFormat: description: Size of the widget. enum: - - small - - medium - - large + - small + - medium + - large type: string x-enum-varnames: - - SMALL - - MEDIUM - - LARGE + - SMALL + - MEDIUM + - LARGE WidgetSort: description: Widget sorting methods. enum: - - asc - - desc + - asc + - desc example: desc type: string x-enum-varnames: - - ASCENDING - - DESCENDING + - ASCENDING + - DESCENDING WidgetSortBy: description: The controls for sorting the widget. properties: @@ -26789,14 +24347,14 @@ components: order_by: description: The array of items to sort the widget by in order. items: - $ref: '#/components/schemas/WidgetSortOrderBy' + $ref: "#/components/schemas/WidgetSortOrderBy" type: array type: object WidgetSortOrderBy: - description: The item to sort the widget by. + description: "The item to sort the widget by." oneOf: - - $ref: '#/components/schemas/WidgetFormulaSort' - - $ref: '#/components/schemas/WidgetGroupSort' + - $ref: "#/components/schemas/WidgetFormulaSort" + - $ref: "#/components/schemas/WidgetGroupSort" WidgetStyle: description: Widget style definition. properties: @@ -26805,112 +24363,111 @@ components: type: string type: object WidgetStyleOrderBy: - description: 'How to order series in timeseries visualizations. - + description: |- + How to order series in timeseries visualizations. - `tags`: Order series alphabetically by tag name (default behavior) - - - `values`: Order series by their current metric values (typically descending)' + - `values`: Order series by their current metric values (typically descending) enum: - - tags - - values + - tags + - values type: string x-enum-varnames: - - TAGS - - VALUES + - TAGS + - VALUES WidgetSummaryType: description: Which summary type should be used. enum: - - monitors - - groups - - combined + - monitors + - groups + - combined type: string x-enum-varnames: - - MONITORS - - GROUPS - - COMBINED + - MONITORS + - GROUPS + - COMBINED WidgetTextAlign: description: How to align the text on the widget. enum: - - center - - left - - right + - center + - left + - right type: string x-enum-varnames: - - CENTER - - LEFT - - RIGHT + - CENTER + - LEFT + - RIGHT WidgetTickEdge: description: Define how you want to align the text on the widget. enum: - - bottom - - left - - right - - top + - bottom + - left + - right + - top type: string x-enum-varnames: - - BOTTOM - - LEFT - - RIGHT - - TOP + - BOTTOM + - LEFT + - RIGHT + - TOP WidgetTime: description: Time setting for the widget. oneOf: - - $ref: '#/components/schemas/WidgetLegacyLiveSpan' - - $ref: '#/components/schemas/WidgetNewLiveSpan' - - $ref: '#/components/schemas/WidgetNewFixedSpan' + - $ref: "#/components/schemas/WidgetLegacyLiveSpan" + - $ref: "#/components/schemas/WidgetNewLiveSpan" + - $ref: "#/components/schemas/WidgetNewFixedSpan" WidgetTimeWindows: description: Define a time window. enum: - - 7d - - 30d - - 90d - - week_to_date - - previous_week - - month_to_date - - previous_month - - global_time - type: string - x-enum-varnames: - - SEVEN_DAYS - - THIRTY_DAYS - - NINETY_DAYS - - WEEK_TO_DATE - - PREVIOUS_WEEK - - MONTH_TO_DATE - - PREVIOUS_MONTH - - GLOBAL_TIME + - 7d + - 30d + - 90d + - week_to_date + - previous_week + - month_to_date + - previous_month + - global_time + type: string + x-enum-varnames: + - SEVEN_DAYS + - THIRTY_DAYS + - NINETY_DAYS + - WEEK_TO_DATE + - PREVIOUS_WEEK + - MONTH_TO_DATE + - PREVIOUS_MONTH + - GLOBAL_TIME WidgetVerticalAlign: description: Vertical alignment. enum: - - center - - top - - bottom + - center + - top + - bottom type: string x-enum-varnames: - - CENTER - - TOP - - BOTTOM + - CENTER + - TOP + - BOTTOM WidgetViewMode: description: Define how you want the SLO to be displayed. enum: - - overall - - component - - both + - overall + - component + - both type: string x-enum-varnames: - - OVERALL - - COMPONENT - - BOTH + - OVERALL + - COMPONENT + - BOTH WidgetVizType: description: Whether to display the Alert Graph as a timeseries or a top list. enum: - - timeseries - - toplist + - timeseries + - toplist example: timeseries type: string x-enum-varnames: - - TIMESERIES - - TOPLIST + - TIMESERIES + - TOPLIST securitySchemes: AuthZ: description: This API uses OAuth 2 with the implicit grant flow. @@ -26922,60 +24479,42 @@ components: apm_api_catalog_write: Add, modify, and delete API catalog definitions. apm_read: Read and query APM and Trace Analytics. apm_service_catalog_read: View service catalog and service definitions. - apm_service_catalog_write: Add, modify, and delete service catalog definitions - when those definitions are maintained by Datadog. + apm_service_catalog_write: Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog. billing_read: View your organization's billing information. cases_read: View Cases. cases_write: Create and update cases. - ci_visibility_pipelines_write: Create CI Visibility pipeline spans using - the API. + ci_visibility_pipelines_write: Create CI Visibility pipeline spans using the API. ci_visibility_read: View CI Visibility. - cloud_cost_management_read: View Cloud Cost pages and the cloud cost data - source in dashboards and notebooks. For more details, see the Cloud - Cost Management docs. - cloud_cost_management_write: Configure cloud cost accounts and global - customizations. For more details, see the Cloud Cost Management docs. + cloud_cost_management_read: View Cloud Cost pages and the cloud cost data source in dashboards and notebooks. For more details, see the Cloud Cost Management docs. + cloud_cost_management_write: Configure cloud cost accounts and global customizations. For more details, see the Cloud Cost Management docs. code_analysis_read: View Code Analysis. - continuous_profiler_pgo_read: Read and query Continuous Profiler data - for Profile-Guided Optimization (PGO). + continuous_profiler_pgo_read: Read and query Continuous Profiler data for Profile-Guided Optimization (PGO). coterm_read: Read terminal recordings. coterm_write: Write terminal recordings. create_webhooks: Create webhooks integrations. - dashboards_embed_share: Create, modify, and delete shared dashboards with - share type 'embed'. - dashboards_invite_share: Create, modify, and delete shared dashboards - with share type 'invite'. - dashboards_public_share: Generate public and authenticated links to share - dashboards or embeddable graphs externally. + dashboards_embed_share: Create, modify, and delete shared dashboards with share type 'embed'. + dashboards_invite_share: Create, modify, and delete shared dashboards with share type 'invite'. + dashboards_public_share: Generate public and authenticated links to share dashboards or embeddable graphs externally. dashboards_read: View dashboards. dashboards_write: Create and change dashboards. data_scanner_read: View Data Scanner configurations. data_scanner_write: Edit Data Scanner configurations. - embeddable_graphs_share: Generate public links to share embeddable graphs - externally. + embeddable_graphs_share: Generate public links to share embeddable graphs externally. events_read: Read Events data. hosts_read: List hosts and their attributes. - incident_notification_settings_write: Configure Incidents Notification - settings. + incident_notification_settings_write: Configure Incidents Notification settings. incident_read: View incidents in Datadog. incident_settings_write: Configure Incident Settings. incident_write: Create, view, and manage incidents in Datadog. metrics_read: View custom metrics. - monitors_downtime: Set downtimes to suppress alerts from any monitor in - an organization. Mute and unmute monitors. The ability to write monitors - is not required to set downtimes. + monitors_downtime: Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes. monitors_read: View monitors. monitors_write: Edit, delete, and resolve individual monitors. - org_management: Edit org configurations, including authentication and - certain security preferences such as configuring SAML, renaming an org, - configuring allowed login methods, creating child orgs, subscribing - & unsubscribing from apps in the marketplace, and enabling & disabling - Remote Configuration for the entire organization. + org_management: Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization. security_comments_read: Read comments of vulnerabilities. security_monitoring_filters_read: Read Security Filters. security_monitoring_filters_write: Create, edit, and delete Security Filters. - security_monitoring_findings_read: View a list of findings that include - both misconfigurations and identity risks. + security_monitoring_findings_read: View a list of findings that include both misconfigurations and identity risks. security_monitoring_rules_read: Read Detection Rules. security_monitoring_rules_write: Create and edit Detection Rules. security_monitoring_signals_read: View Security Signals. @@ -26983,32 +24522,22 @@ components: security_monitoring_suppressions_write: Write Rule Suppressions. security_pipelines_read: View Security Pipelines. security_pipelines_write: Create, edit, and delete CSM Security Pipelines. - slos_corrections: Apply, edit, and delete SLO status corrections. A user - with this permission can make status corrections, even if they do not - have permission to edit those SLOs. + slos_corrections: Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs. slos_read: View SLOs and status corrections. slos_write: Create, edit, and delete SLOs. - synthetics_global_variable_read: View, search, and use Synthetics global - variables. - synthetics_global_variable_write: Create, edit, and delete global variables - for Synthetics. - synthetics_private_location_read: View, search, and use Synthetics private - locations. - synthetics_private_location_write: Create and delete private locations - in addition to having access to the associated installation guidelines. + synthetics_global_variable_read: View, search, and use Synthetics global variables. + synthetics_global_variable_write: Create, edit, and delete global variables for Synthetics. + synthetics_private_location_read: View, search, and use Synthetics private locations. + synthetics_private_location_write: Create and delete private locations in addition to having access to the associated installation guidelines. synthetics_read: List and view configured Synthetic tests and test results. synthetics_write: Create, edit, and delete Synthetic tests. - teams_manage: Manage Teams. Create, delete, rename, and edit metadata - of all Teams. To control Team membership across all Teams, use the User - Access Manage permission. - teams_read: Read Teams data. A User with this permission can view Team - names, metadata, and which Users are on each Team. + teams_manage: Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission. + teams_read: Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team. test_optimization_read: View Test Optimization. timeseries_query: Query Timeseries data. usage_read: View your organization's usage and usage attribution. user_access_invite: Invite other users to your organization. - user_access_manage: Disable users, manage user roles, manage SAML-to-role - mappings, and configure logs restriction queries. + user_access_manage: Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries. user_access_read: View users and their roles and settings. workflows_read: View workflows. workflows_run: Run workflows. @@ -27052,7 +24581,7 @@ info: url: https://www.datadoghq.com/support/ description: Collection of all Datadog Public endpoints. title: Datadog API V1 Collection - version: '1.0' + version: "1.0" openapi: 3.0.0 paths: /: @@ -27060,74 +24589,74 @@ paths: description: Get information about Datadog IP ranges. operationId: GetIPRanges responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IPRanges' + $ref: "#/components/schemas/IPRanges" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: [] servers: - - url: https://{subdomain}.{site} - variables: - site: - default: datadoghq.com - description: The regional site for Datadog customers. - enum: - - datadoghq.com - - us3.datadoghq.com - - us5.datadoghq.com - - ap1.datadoghq.com - - ap2.datadoghq.com - - datadoghq.eu - - ddog-gov.com - subdomain: - default: ip-ranges - description: The subdomain where the API is deployed. - - url: '{protocol}://{name}' - variables: - name: - default: ip-ranges.datadoghq.com - description: Full site DNS name. - protocol: - default: https - description: The protocol for accessing the API. - - url: https://{subdomain}.datadoghq.com - variables: - subdomain: - default: ip-ranges - description: The subdomain where the API is deployed. + - url: https://{subdomain}.{site} + variables: + site: + default: datadoghq.com + description: The regional site for Datadog customers. + enum: + - datadoghq.com + - us3.datadoghq.com + - us5.datadoghq.com + - ap1.datadoghq.com + - ap2.datadoghq.com + - datadoghq.eu + - ddog-gov.com + subdomain: + default: ip-ranges + description: The subdomain where the API is deployed. + - url: "{protocol}://{name}" + variables: + name: + default: ip-ranges.datadoghq.com + description: Full site DNS name. + protocol: + default: https + description: The protocol for accessing the API. + - url: https://{subdomain}.datadoghq.com + variables: + subdomain: + default: ip-ranges + description: The subdomain where the API is deployed. summary: List IP Ranges tags: - - IP Ranges + - IP Ranges /api/v1/api_key: get: description: Get all API keys available for your account. operationId: ListAPIKeys responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApiKeyListResponse' + $ref: "#/components/schemas/ApiKeyListResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all API keys tags: - - Key Management - x-permission: + - Key Management + "x-permission": operator: OR permissions: - - api_keys_read + - api_keys_read post: description: Creates an API key with a given name. operationId: CreateAPIKey @@ -27135,2851 +24664,2758 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ApiKey' + $ref: "#/components/schemas/ApiKey" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApiKeyResponse' + $ref: "#/components/schemas/ApiKeyResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an API key tags: - - Key Management + - Key Management x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - api_keys_write + - api_keys_write /api/v1/api_key/{key}: delete: description: Delete a given API key. operationId: DeleteAPIKey parameters: - - description: The specific API key you are working with. - in: path - name: key - required: true - schema: - type: string + - description: The specific API key you are working with. + in: path + name: key + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApiKeyResponse' + $ref: "#/components/schemas/ApiKeyResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an API key tags: - - Key Management - x-permission: + - Key Management + "x-permission": operator: OR permissions: - - api_keys_delete + - api_keys_delete get: description: Get a given API key. operationId: GetAPIKey parameters: - - description: The specific API key you are working with. - in: path - name: key - required: true - schema: - type: string + - description: The specific API key you are working with. + in: path + name: key + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApiKeyResponse' + $ref: "#/components/schemas/ApiKeyResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get API key tags: - - Key Management - x-permission: + - Key Management + "x-permission": operator: OR permissions: - - api_keys_read + - api_keys_read put: description: Edit an API key name. operationId: UpdateAPIKey parameters: - - description: The specific API key you are working with. - in: path - name: key - required: true - schema: - type: string + - description: The specific API key you are working with. + in: path + name: key + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApiKey' + $ref: "#/components/schemas/ApiKey" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApiKeyResponse' + $ref: "#/components/schemas/ApiKeyResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Edit an API key tags: - - Key Management + - Key Management x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - api_keys_write + - api_keys_write /api/v1/application_key: get: - description: 'Get all application keys available for your Datadog account. - - This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).' + description: |- + Get all application keys available for your Datadog account. + This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). operationId: ListApplicationKeys responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationKeyListResponse' + $ref: "#/components/schemas/ApplicationKeyListResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all application keys tags: - - Key Management - x-permission: + - Key Management + "x-permission": operator: OR permissions: - - org_app_keys_read - - user_app_keys + - org_app_keys_read + - user_app_keys post: - description: 'Create an application key with a given name. - - This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).' + description: |- + Create an application key with a given name. + This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). operationId: CreateApplicationKey requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApplicationKey' + $ref: "#/components/schemas/ApplicationKey" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationKeyResponse' + $ref: "#/components/schemas/ApplicationKeyResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Conflict - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an application key tags: - - Key Management + - Key Management x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_app_keys + - user_app_keys /api/v1/application_key/{key}: delete: - description: 'Delete a given application key. - - This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).' + description: |- + Delete a given application key. + This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). operationId: DeleteApplicationKey parameters: - - description: The specific APP key you are working with. - in: path - name: key - required: true - schema: - type: string + - description: The specific APP key you are working with. + in: path + name: key + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationKeyResponse' + $ref: "#/components/schemas/ApplicationKeyResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an application key tags: - - Key Management - x-permission: + - Key Management + "x-permission": operator: OR permissions: - - org_app_keys_write - - user_app_keys + - org_app_keys_write + - user_app_keys get: - description: 'Get a given application key. - - This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).' + description: |- + Get a given application key. + This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). operationId: GetApplicationKey parameters: - - description: The specific APP key you are working with. - in: path - name: key - required: true - schema: - type: string + - description: The specific APP key you are working with. + in: path + name: key + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationKeyResponse' + $ref: "#/components/schemas/ApplicationKeyResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get an application key tags: - - Key Management - x-permission: + - Key Management + "x-permission": operator: OR permissions: - - org_app_keys_read - - user_app_keys + - org_app_keys_read + - user_app_keys put: - description: 'Edit an application key name. - - This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).' + description: |- + Edit an application key name. + This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). operationId: UpdateApplicationKey parameters: - - description: The specific APP key you are working with. - in: path - name: key - required: true - schema: - type: string + - description: The specific APP key you are working with. + in: path + name: key + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApplicationKey' + $ref: "#/components/schemas/ApplicationKey" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationKeyResponse' + $ref: "#/components/schemas/ApplicationKeyResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Conflict - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Edit an application key tags: - - Key Management + - Key Management x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - org_app_keys_write - - user_app_keys + - org_app_keys_write + - user_app_keys /api/v1/check_run: post: - description: 'Submit a list of Service Checks. - + description: |- + Submit a list of Service Checks. **Notes**: - - A valid API key is required. - - - Service checks can be submitted up to 10 minutes in the past.' + - Service checks can be submitted up to 10 minutes in the past. operationId: SubmitServiceCheck requestBody: content: application/json: schema: - $ref: '#/components/schemas/ServiceChecks' + $ref: "#/components/schemas/ServiceChecks" description: Service Check request body. required: true responses: - '202': + "202": content: text/json: schema: - $ref: '#/components/schemas/IntakePayloadAccepted' + $ref: "#/components/schemas/IntakePayloadAccepted" description: Payload accepted - '400': + "400": content: text/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: text/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '408': + "408": content: text/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Request timeout - '413': + "413": content: text/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Payload too large - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] + - apiKeyAuth: [] summary: Submit a Service Check tags: - - Service Checks + - Service Checks x-codegen-request-body-name: body /api/v1/daily_custom_reports: get: deprecated: true - description: 'Get daily custom reports. - + description: |- + Get daily custom reports. **Note:** This endpoint will be fully deprecated on December 1, 2022. - - Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) - for the associated migration guide.' + Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) for the associated migration guide. operationId: GetDailyCustomReports parameters: - - description: The number of files to return in the response. `[default=60]`. - in: query - name: page[size] - required: false - schema: - format: int64 - type: integer - - description: The identifier of the first page to return. This parameter is - used for the pagination feature `[default=0]`. - in: query - name: page[number] - required: false - schema: - format: int64 - type: integer - - description: 'The direction to sort by: `[desc, asc]`.' - in: query - name: sort_dir - required: false - schema: - $ref: '#/components/schemas/UsageSortDirection' - - description: 'The field to sort by: `[computed_on, size, start_date, end_date]`.' - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/UsageSort' + - description: The number of files to return in the response. `[default=60]`. + in: query + name: page[size] + required: false + schema: + format: int64 + type: integer + - description: The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. + in: query + name: page[number] + required: false + schema: + format: int64 + type: integer + - description: "The direction to sort by: `[desc, asc]`." + in: query + name: sort_dir + required: false + schema: + $ref: "#/components/schemas/UsageSortDirection" + - description: "The field to sort by: `[computed_on, size, start_date, end_date]`." + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/UsageSort" responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageCustomReportsResponse' + $ref: "#/components/schemas/UsageCustomReportsResponse" description: OK - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests summary: Get the list of available daily custom reports tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/daily_custom_reports/{report_id}: get: deprecated: true - description: 'Get specified daily custom reports. - + description: |- + Get specified daily custom reports. **Note:** This endpoint will be fully deprecated on December 1, 2022. - - Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) - for the associated migration guide.' + Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) for the associated migration guide. operationId: GetSpecifiedDailyCustomReports parameters: - - description: Date of the report in the format `YYYY-MM-DD`. - in: path - name: report_id - required: true - schema: - type: string + - description: Date of the report in the format `YYYY-MM-DD`. + in: path + name: report_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageSpecifiedCustomReportsResponse' + $ref: "#/components/schemas/UsageSpecifiedCustomReportsResponse" description: OK - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '404': + "404": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests summary: Get specified daily custom reports tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/dashboard: delete: - description: Delete dashboards using the specified IDs. If there are any failures, - no dashboards will be deleted (partial success is not allowed). + description: Delete dashboards using the specified IDs. If there are any failures, no dashboards will be deleted (partial success is not allowed). operationId: DeleteDashboards requestBody: content: application/json: examples: json-request-body: - value: - data: - - id: 123-abc-456 - type: dashboard - - id: 789-def-101 - type: dashboard + value: {"data": [{"id": "123-abc-456", "type": "dashboard"}, {"id": "789-def-101", "type": "dashboard"}]} schema: - $ref: '#/components/schemas/DashboardBulkDeleteRequest' + $ref: "#/components/schemas/DashboardBulkDeleteRequest" description: Delete dashboards request body. required: true responses: - '204': + "204": description: No Content - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Dashboards Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_write summary: Delete dashboards tags: - - Dashboards + - Dashboards x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - dashboards_write + - dashboards_write get: - description: 'Get all dashboards. - + description: |- + Get all dashboards. **Note**: This query will only return custom created or cloned dashboards. - - This query will not return preset dashboards.' + This query will not return preset dashboards. operationId: ListDashboards parameters: - - description: 'When `true`, this query only returns shared custom created - - or cloned dashboards.' - in: query - name: filter[shared] - required: false - schema: - type: boolean - - description: 'When `true`, this query returns only deleted custom-created - - or cloned dashboards. This parameter is incompatible with `filter[shared]`.' - in: query - name: filter[deleted] - required: false - schema: - type: boolean - - description: The maximum number of dashboards returned in the list. - in: query - name: count - required: false - schema: - default: 100 - format: int64 - type: integer - - description: The specific offset to use as the beginning of the returned response. - in: query - name: start - required: false - schema: - format: int64 - type: integer + - description: |- + When `true`, this query only returns shared custom created + or cloned dashboards. + in: query + name: filter[shared] + required: false + schema: + type: boolean + - description: |- + When `true`, this query returns only deleted custom-created + or cloned dashboards. This parameter is incompatible with `filter[shared]`. + in: query + name: filter[deleted] + required: false + schema: + type: boolean + - description: The maximum number of dashboards returned in the list. + in: query + name: count + required: false + schema: + default: 100 + format: int64 + type: integer + - description: The specific offset to use as the beginning of the returned response. + in: query + name: start + required: false + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DashboardSummary' + $ref: "#/components/schemas/DashboardSummary" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_read summary: Get all dashboards tags: - - Dashboards + - Dashboards x-pagination: limitParam: count pageOffsetParam: start resultsPath: dashboards - x-permission: + "x-permission": operator: OR permissions: - - dashboards_read + - dashboards_read patch: - description: Restore dashboards using the specified IDs. If there are any failures, - no dashboards will be restored (partial success is not allowed). + description: Restore dashboards using the specified IDs. If there are any failures, no dashboards will be restored (partial success is not allowed). operationId: RestoreDashboards requestBody: content: application/json: examples: json-request-body: - value: - data: - - id: 123-abc-456 - type: dashboard - - id: 789-def-101 - type: dashboard + value: {"data": [{"id": "123-abc-456", "type": "dashboard"}, {"id": "789-def-101", "type": "dashboard"}]} schema: - $ref: '#/components/schemas/DashboardRestoreRequest' + $ref: "#/components/schemas/DashboardRestoreRequest" description: Restore dashboards request body. required: true responses: - '204': + "204": description: No Content - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Dashboards Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_write summary: Restore deleted dashboards tags: - - Dashboards + - Dashboards x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - dashboards_write + - dashboards_write post: - description: 'Create a dashboard using the specified options. When defining - queries in your widgets, take note of which queries should have the `as_count()` - or `as_rate()` modifiers appended. - - Refer to the following [documentation](https://docs.datadoghq.com/developers/metrics/type_modifiers/?tab=count#in-application-modifiers) - for more information on these modifiers.' + description: |- + Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the `as_count()` or `as_rate()` modifiers appended. + Refer to the following [documentation](https://docs.datadoghq.com/developers/metrics/type_modifiers/?tab=count#in-application-modifiers) for more information on these modifiers. operationId: CreateDashboard requestBody: content: application/json: schema: - $ref: '#/components/schemas/Dashboard' + $ref: "#/components/schemas/Dashboard" description: Create a dashboard request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Dashboard' + $ref: "#/components/schemas/Dashboard" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_write summary: Create a new dashboard tags: - - Dashboards + - Dashboards x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - dashboards_write + - dashboards_write /api/v1/dashboard/lists/manual: get: - description: Fetch all of your existing dashboard list definitions. + description: >- + Fetch all of your existing dashboard list definitions. operationId: ListDashboardLists responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DashboardListListResponse' + $ref: "#/components/schemas/DashboardListListResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_read summary: Get all dashboard lists tags: - - Dashboard Lists - x-permission: + - Dashboard Lists + "x-permission": operator: OR permissions: - - dashboards_read + - dashboards_read post: - description: Create an empty dashboard list. + description: >- + Create an empty dashboard list. operationId: CreateDashboardList requestBody: content: application/json: schema: - $ref: '#/components/schemas/DashboardList' + $ref: "#/components/schemas/DashboardList" description: Create a dashboard list request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DashboardList' + $ref: "#/components/schemas/DashboardList" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_write summary: Create a dashboard list tags: - - Dashboard Lists + - Dashboard Lists x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - dashboards_write + - dashboards_write /api/v1/dashboard/lists/manual/{list_id}: delete: - description: Delete a dashboard list. + description: >- + Delete a dashboard list. operationId: DeleteDashboardList parameters: - - description: ID of the dashboard list to delete. - in: path - name: list_id - required: true - schema: - format: int64 - type: integer + - description: ID of the dashboard list to delete. + in: path + name: list_id + required: true + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DashboardListDeleteResponse' + $ref: "#/components/schemas/DashboardListDeleteResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_write summary: Delete a dashboard list tags: - - Dashboard Lists - x-permission: + - Dashboard Lists + "x-permission": operator: OR permissions: - - dashboards_write + - dashboards_write get: - description: Fetch an existing dashboard list's definition. + description: >- + Fetch an existing dashboard list's definition. operationId: GetDashboardList parameters: - - description: ID of the dashboard list to fetch. - in: path - name: list_id - required: true - schema: - format: int64 - type: integer + - description: ID of the dashboard list to fetch. + in: path + name: list_id + required: true + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DashboardList' + $ref: "#/components/schemas/DashboardList" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_read summary: Get a dashboard list tags: - - Dashboard Lists - x-permission: + - Dashboard Lists + "x-permission": operator: OR permissions: - - dashboards_read + - dashboards_read put: - description: Update the name of a dashboard list. + description: >- + Update the name of a dashboard list. operationId: UpdateDashboardList parameters: - - description: ID of the dashboard list to update. - in: path - name: list_id - required: true - schema: - format: int64 - type: integer + - description: ID of the dashboard list to update. + in: path + name: list_id + required: true + schema: + format: int64 + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/DashboardList' + $ref: "#/components/schemas/DashboardList" description: Update a dashboard list request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DashboardList' + $ref: "#/components/schemas/DashboardList" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_write summary: Update a dashboard list tags: - - Dashboard Lists + - Dashboard Lists x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - dashboards_write + - dashboards_write /api/v1/dashboard/public: post: - description: Share a specified private dashboard, generating a URL at which - it can be publicly viewed. + description: >- + Share a specified private dashboard, generating a URL at which it can be publicly viewed. operationId: CreatePublicDashboard requestBody: content: application/json: examples: json-request-body: - value: - dashboard_id: 123-abc-456 - dashboard_type: custom_timeboard - share_type: open + value: {"dashboard_id": "123-abc-456", "dashboard_type": "custom_timeboard", "share_type": "open"} schema: - $ref: '#/components/schemas/SharedDashboard' + $ref: "#/components/schemas/SharedDashboard" description: Create a shared dashboard request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SharedDashboard' + $ref: "#/components/schemas/SharedDashboard" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Dashboard Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_public_share - - AuthZ: - - dashboards_embed_share - - AuthZ: - - dashboards_invite_share + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_public_share + - AuthZ: + - dashboards_embed_share + - AuthZ: + - dashboards_invite_share summary: Create a shared dashboard tags: - - Dashboards + - Dashboards x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - dashboards_public_share - - dashboards_embed_share - - dashboards_invite_share + - dashboards_public_share + - dashboards_embed_share + - dashboards_invite_share /api/v1/dashboard/public/{token}: delete: - description: Revoke the public URL for a dashboard (rendering it private) associated - with the specified token. + description: >- + Revoke the public URL for a dashboard (rendering it private) associated with the specified token. operationId: DeletePublicDashboard parameters: - - description: The token of the shared dashboard. - in: path - name: token - required: true - schema: - type: string + - description: The token of the shared dashboard. + in: path + name: token + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteSharedDashboardResponse' + $ref: "#/components/schemas/DeleteSharedDashboardResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Shared Dashboard Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_public_share - - AuthZ: - - dashboards_embed_share - - AuthZ: - - dashboards_invite_share + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_public_share + - AuthZ: + - dashboards_embed_share + - AuthZ: + - dashboards_invite_share summary: Revoke a shared dashboard URL tags: - - Dashboards - x-permission: + - Dashboards + "x-permission": operator: OR permissions: - - dashboards_public_share - - dashboards_embed_share - - dashboards_invite_share + - dashboards_public_share + - dashboards_embed_share + - dashboards_invite_share get: - description: Fetch an existing shared dashboard's sharing metadata associated - with the specified token. + description: >- + Fetch an existing shared dashboard's sharing metadata associated with the specified token. operationId: GetPublicDashboard parameters: - - description: The token of the shared dashboard. Generated when a dashboard - is shared. - in: path - name: token - required: true - schema: - type: string + - description: The token of the shared dashboard. Generated when a dashboard is shared. + in: path + name: token + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SharedDashboard' + $ref: "#/components/schemas/SharedDashboard" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Shared Dashboard Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_read summary: Get a shared dashboard tags: - - Dashboards - x-permission: + - Dashboards + "x-permission": operator: OR permissions: - - dashboards_read + - dashboards_read put: description: Update a shared dashboard associated with the specified token. operationId: UpdatePublicDashboard parameters: - - description: The token of the shared dashboard. - in: path - name: token - required: true - schema: - type: string + - description: The token of the shared dashboard. + in: path + name: token + required: true + schema: + type: string requestBody: content: application/json: examples: json-request-body: - value: - global_time: - live_span: 1h - selectable_template_vars: - - default_value: '*' - name: exampleVar - prefix: test - visible_tags: - - selectableValue1 - - selectableValue2 - share_list: - - test@datadoghq.com - - test2@datadoghq.com - share_type: invite + value: {"global_time": {"live_span": "1h"}, "selectable_template_vars": [{"default_value": "*", "name": "exampleVar", "prefix": "test", "visible_tags": ["selectableValue1", "selectableValue2"]}], "share_list": ["test@datadoghq.com", "test2@datadoghq.com"], "share_type": "invite"} schema: - $ref: '#/components/schemas/SharedDashboardUpdateRequest' + $ref: "#/components/schemas/SharedDashboardUpdateRequest" description: Update Dashboard request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SharedDashboard' + $ref: "#/components/schemas/SharedDashboard" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_public_share - - AuthZ: - - dashboards_embed_share - - AuthZ: - - dashboards_invite_share + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_public_share + - AuthZ: + - dashboards_embed_share + - AuthZ: + - dashboards_invite_share summary: Update a shared dashboard tags: - - Dashboards + - Dashboards x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - dashboards_public_share - - dashboards_embed_share - - dashboards_invite_share + - dashboards_public_share + - dashboards_embed_share + - dashboards_invite_share /api/v1/dashboard/public/{token}/invitation: delete: - description: Revoke previously sent invitation emails and active sessions used - to access a given shared dashboard for specific email addresses. + description: >- + Revoke previously sent invitation emails and active sessions used to access a given shared dashboard for specific email addresses. operationId: DeletePublicDashboardInvitation parameters: - - description: The token of the shared dashboard. - in: path - name: token - required: true - schema: - type: string + - description: The token of the shared dashboard. + in: path + name: token + required: true + schema: + type: string requestBody: content: application/json: examples: json-request-body: - value: - data: - attributes: - email: test@datadoghq.com - type: public_dashboard_invitation + value: {"data": {"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}} schema: - $ref: '#/components/schemas/SharedDashboardInvites' + $ref: "#/components/schemas/SharedDashboardInvites" description: Shared Dashboard Invitation deletion request body. required: true responses: - '204': + "204": description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_invite_share + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_invite_share summary: Revoke shared dashboard invitations tags: - - Dashboards + - Dashboards x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - dashboards_invite_share + - dashboards_invite_share get: - description: Describe the invitations that exist for the given shared dashboard - (paginated). + description: >- + Describe the invitations that exist for the given shared dashboard (paginated). operationId: GetPublicDashboardInvitations parameters: - - description: Token of the shared dashboard for which to fetch invitations. - in: path - name: token - required: true - schema: - type: string - - description: The number of records to return in a single request. - in: query - name: page_size - required: false - schema: - format: int64 - type: integer - - description: The page to access (base 0). - in: query - name: page_number - required: false - schema: - format: int64 - type: integer + - description: Token of the shared dashboard for which to fetch invitations. + in: path + name: token + required: true + schema: + type: string + - description: The number of records to return in a single request. + in: query + name: page_size + required: false + schema: + format: int64 + type: integer + - description: The page to access (base 0). + in: query + name: page_number + required: false + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SharedDashboardInvites' + $ref: "#/components/schemas/SharedDashboardInvites" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_invite_share + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_invite_share summary: Get all invitations for a shared dashboard tags: - - Dashboards - x-permission: + - Dashboards + "x-permission": operator: OR permissions: - - dashboards_invite_share + - dashboards_invite_share post: - description: Send emails to specified email addresses containing links to access - a given authenticated shared dashboard. Email addresses must already belong - to the authenticated shared dashboard's share_list. + description: >- + Send emails to specified email addresses containing links to access a given authenticated shared dashboard. Email addresses must already belong to the authenticated shared dashboard's share_list. operationId: SendPublicDashboardInvitation parameters: - - description: The token of the shared dashboard. - in: path - name: token - required: true - schema: - type: string + - description: The token of the shared dashboard. + in: path + name: token + required: true + schema: + type: string requestBody: content: application/json: examples: json-request-body: - value: - data: - - attributes: - email: test@datadoghq.com - type: public_dashboard_invitation + value: {"data": [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}]} schema: - $ref: '#/components/schemas/SharedDashboardInvites' + $ref: "#/components/schemas/SharedDashboardInvites" description: Shared Dashboard Invitation request body. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/SharedDashboardInvites' + $ref: "#/components/schemas/SharedDashboardInvites" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_invite_share + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_invite_share summary: Send shared dashboard invitation email tags: - - Dashboards + - Dashboards x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - dashboards_invite_share + - dashboards_invite_share /api/v1/dashboard/{dashboard_id}: delete: description: Delete a dashboard using the specified ID. operationId: DeleteDashboard parameters: - - description: The ID of the dashboard. - in: path - name: dashboard_id - required: true - schema: - type: string + - description: The ID of the dashboard. + in: path + name: dashboard_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DashboardDeleteResponse' + $ref: "#/components/schemas/DashboardDeleteResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Dashboards Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_write summary: Delete a dashboard tags: - - Dashboards - x-permission: + - Dashboards + "x-permission": operator: OR permissions: - - dashboards_write + - dashboards_write get: description: Get a dashboard using the specified ID. operationId: GetDashboard parameters: - - description: The ID of the dashboard. - in: path - name: dashboard_id - required: true - schema: - type: string + - description: The ID of the dashboard. + in: path + name: dashboard_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Dashboard' + $ref: "#/components/schemas/Dashboard" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_read summary: Get a dashboard tags: - - Dashboards - x-permission: + - Dashboards + "x-permission": operator: OR permissions: - - dashboards_read + - dashboards_read put: description: Update a dashboard using the specified ID. operationId: UpdateDashboard parameters: - - description: The ID of the dashboard. - in: path - name: dashboard_id - required: true - schema: - type: string + - description: The ID of the dashboard. + in: path + name: dashboard_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Dashboard' + $ref: "#/components/schemas/Dashboard" description: Update Dashboard request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Dashboard' + $ref: "#/components/schemas/Dashboard" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_write summary: Update a dashboard tags: - - Dashboards + - Dashboards x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - dashboards_write + - dashboards_write /api/v1/distribution_points: post: - description: "The distribution points end-point allows you to post distribution - data that can be graphed on Datadog\u2019s dashboards." + description: The distribution points end-point allows you to post distribution data that can be graphed on Datadog’s dashboards. operationId: SubmitDistributionPoints parameters: - - description: HTTP header used to compress the media-type. - in: header - name: Content-Encoding - required: false - schema: - $ref: '#/components/schemas/DistributionPointsContentEncoding' + - description: HTTP header used to compress the media-type. + in: header + name: Content-Encoding + required: false + schema: + $ref: "#/components/schemas/DistributionPointsContentEncoding" requestBody: content: text/json: examples: dynamic-points: - description: "Post time-series data that can be graphed on Datadog\u2019s - dashboards." + description: Post time-series data that can be graphed on Datadog’s dashboards. externalValue: examples/metrics/distribution-points.json.sh summary: Dynamic Points x-variables: - NOW: $(date +%s) + NOW: "$(date +%s)" schema: - $ref: '#/components/schemas/DistributionPointsPayload' + $ref: "#/components/schemas/DistributionPointsPayload" required: true responses: - '202': + "202": content: text/json: schema: - $ref: '#/components/schemas/IntakePayloadAccepted' + $ref: "#/components/schemas/IntakePayloadAccepted" description: Payload accepted - '400': + "400": content: text/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: text/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '408': + "408": content: text/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Request timeout - '413': + "413": content: text/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Payload too large - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] + - apiKeyAuth: [] summary: Submit distribution points tags: - - Metrics + - Metrics x-codegen-request-body-name: body /api/v1/downtime: get: deprecated: true - description: Get all scheduled downtimes. **Note:** This endpoint has been deprecated. - Please use v2 endpoints. + description: |- + Get all scheduled downtimes. **Note:** This endpoint has been deprecated. Please use v2 endpoints. operationId: ListDowntimes parameters: - - description: Only return downtimes that are active when the request is made. - in: query - name: current_only - required: false - schema: - type: boolean - - description: Return creator information. - in: query - name: with_creator - required: false - schema: - type: boolean + - description: Only return downtimes that are active when the request is made. + in: query + name: current_only + required: false + schema: + type: boolean + - description: Return creator information. + in: query + name: with_creator + required: false + schema: + type: boolean responses: - '200': + "200": content: application/json: schema: items: - $ref: '#/components/schemas/Downtime' + $ref: "#/components/schemas/Downtime" type: array description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_read summary: Get all downtimes tags: - - Downtimes - x-permission: + - Downtimes + "x-permission": operator: OR permissions: - - monitors_read + - monitors_read post: deprecated: true - description: Schedule a downtime. **Note:** This endpoint has been deprecated. - Please use v2 endpoints. + description: |- + Schedule a downtime. **Note:** This endpoint has been deprecated. Please use v2 endpoints. operationId: CreateDowntime requestBody: content: application/json: schema: - $ref: '#/components/schemas/Downtime' + $ref: "#/components/schemas/Downtime" description: Schedule a downtime request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Downtime' + $ref: "#/components/schemas/Downtime" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_downtime + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_downtime summary: Schedule a downtime tags: - - Downtimes + - Downtimes x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - monitors_downtime + - monitors_downtime /api/v1/downtime/cancel/by_scope: post: deprecated: true - description: Delete all downtimes that match the scope of `X`. **Note:** This - only interacts with Downtimes created using v1 endpoints. This endpoint has - been deprecated and will not be replaced. Please use v2 endpoints to find - and cancel downtimes. + description: |- + Delete all downtimes that match the scope of `X`. **Note:** This only interacts with Downtimes created using v1 endpoints. This endpoint has been deprecated and will not be replaced. Please use v2 endpoints to find and cancel downtimes. operationId: CancelDowntimesByScope requestBody: content: application/json: schema: - $ref: '#/components/schemas/CancelDowntimesByScopeRequest' + $ref: "#/components/schemas/CancelDowntimesByScopeRequest" description: Scope to cancel downtimes for. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CanceledDowntimesIds' + $ref: "#/components/schemas/CanceledDowntimesIds" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Downtimes not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_downtime + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_downtime summary: Cancel downtimes by scope tags: - - Downtimes + - Downtimes x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - monitors_downtime + - monitors_downtime /api/v1/downtime/{downtime_id}: delete: deprecated: true - description: Cancel a downtime. **Note:** This endpoint has been deprecated. - Please use v2 endpoints. + description: |- + Cancel a downtime. **Note:** This endpoint has been deprecated. Please use v2 endpoints. operationId: CancelDowntime parameters: - - description: ID of the downtime to cancel. - in: path - name: downtime_id - required: true - schema: - example: 123456 - format: int64 - type: integer + - description: ID of the downtime to cancel. + in: path + name: downtime_id + required: true + schema: + example: 123456 + format: int64 + type: integer responses: - '204': + "204": description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Downtime not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_downtime + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_downtime summary: Cancel a downtime tags: - - Downtimes - x-permission: + - Downtimes + "x-permission": operator: OR permissions: - - monitors_downtime + - monitors_downtime get: deprecated: true - description: Get downtime detail by `downtime_id`. **Note:** This endpoint has - been deprecated. Please use v2 endpoints. + description: |- + Get downtime detail by `downtime_id`. **Note:** This endpoint has been deprecated. Please use v2 endpoints. operationId: GetDowntime parameters: - - description: ID of the downtime to fetch. - in: path - name: downtime_id - required: true - schema: - example: 123456 - format: int64 - type: integer + - description: ID of the downtime to fetch. + in: path + name: downtime_id + required: true + schema: + example: 123456 + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Downtime' + $ref: "#/components/schemas/Downtime" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Downtime not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_read summary: Get a downtime tags: - - Downtimes - x-permission: + - Downtimes + "x-permission": operator: OR permissions: - - monitors_read + - monitors_read put: deprecated: true - description: Update a single downtime by `downtime_id`. **Note:** This endpoint - has been deprecated. Please use v2 endpoints. + description: |- + Update a single downtime by `downtime_id`. **Note:** This endpoint has been deprecated. Please use v2 endpoints. operationId: UpdateDowntime parameters: - - description: ID of the downtime to update. - in: path - name: downtime_id - required: true - schema: - example: 123456 - format: int64 - type: integer - style: simple + - description: ID of the downtime to update. + in: path + name: downtime_id + required: true + schema: + example: 123456 + format: int64 + type: integer + style: simple requestBody: content: application/json: schema: - $ref: '#/components/schemas/Downtime' + $ref: "#/components/schemas/Downtime" description: Update a downtime request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Downtime' + $ref: "#/components/schemas/Downtime" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Downtime not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_downtime + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_downtime summary: Update a downtime tags: - - Downtimes + - Downtimes x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - monitors_downtime + - monitors_downtime /api/v1/events: get: - description: "The event stream can be queried and filtered by time, priority, - sources and tags.\n\n**Notes**:\n- If the event you\u2019re querying contains - markdown formatting of any kind,\nyou may see characters such as `%`,`\\`,`n` - in your output.\n\n- This endpoint returns a maximum of `1000` most recent - results. To return additional results,\nidentify the last timestamp of the - last result and set that as the `end` query time to\npaginate the results. - You can also use the page parameter to specify which set of `1000` results - to return." - operationId: ListEvents - parameters: - - description: POSIX timestamp. - in: query - name: start - required: true - schema: - format: int64 - type: integer - - description: POSIX timestamp. - in: query - name: end - required: true - schema: - format: int64 - type: integer - - description: Priority of your events, either `low` or `normal`. - in: query - name: priority - required: false - schema: - $ref: '#/components/schemas/EventPriority' - - description: A comma separated string of sources. - in: query - name: sources - schema: - type: string - - description: A comma separated list indicating what tags, if any, should be - used to filter the list of events. - example: host:host0 - in: query - name: tags - required: false - schema: - type: string - - description: 'Set unaggregated to `true` to return all events within the specified - [`start`,`end`] timeframe. - - Otherwise if an event is aggregated to a parent event with a timestamp outside - of the timeframe, - - it won''t be available in the output. Aggregated events with `is_aggregate=true` - in the response will still be returned unless exclude_aggregate is set to - `true.`' - in: query - name: unaggregated - required: false - schema: - type: boolean - - description: 'Set `exclude_aggregate` to `true` to only return unaggregated - events where `is_aggregate=false` in the response. If the `exclude_aggregate` - parameter is set to `true`, + description: |- + The event stream can be queried and filtered by time, priority, sources and tags. - then the unaggregated parameter is ignored and will be `true` by default.' - in: query - name: exclude_aggregate - required: false - schema: - type: boolean - - description: 'By default 1000 results are returned per request. Set page to - the number of the page to return with `0` being the first page. The page - parameter can only be used + **Notes**: + - If the event you’re querying contains markdown formatting of any kind, + you may see characters such as `%`,`\`,`n` in your output. - when either unaggregated or exclude_aggregate is set to `true.`' - in: query - name: page - required: false - schema: - format: int32 - maximum: 2147483647 - type: integer + - This endpoint returns a maximum of `1000` most recent results. To return additional results, + identify the last timestamp of the last result and set that as the `end` query time to + paginate the results. You can also use the page parameter to specify which set of `1000` results to return. + operationId: ListEvents + parameters: + - description: POSIX timestamp. + in: query + name: start + required: true + schema: + format: int64 + type: integer + - description: POSIX timestamp. + in: query + name: end + required: true + schema: + format: int64 + type: integer + - description: Priority of your events, either `low` or `normal`. + in: query + name: priority + required: false + schema: + $ref: "#/components/schemas/EventPriority" + - description: A comma separated string of sources. + in: query + name: sources + schema: + type: string + - description: |- + A comma separated list indicating what tags, if any, should be used to filter the list of events. + example: "host:host0" + in: query + name: tags + required: false + schema: + type: string + - description: |- + Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe. + Otherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe, + it won't be available in the output. Aggregated events with `is_aggregate=true` in the response will still be returned unless exclude_aggregate is set to `true.` + in: query + name: unaggregated + required: false + schema: + type: boolean + - description: |- + Set `exclude_aggregate` to `true` to only return unaggregated events where `is_aggregate=false` in the response. If the `exclude_aggregate` parameter is set to `true`, + then the unaggregated parameter is ignored and will be `true` by default. + in: query + name: exclude_aggregate + required: false + schema: + type: boolean + - description: |- + By default 1000 results are returned per request. Set page to the number of the page to return with `0` being the first page. The page parameter can only be used + when either unaggregated or exclude_aggregate is set to `true.` + in: query + name: page + required: false + schema: + format: int32 + maximum: 2147483647 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EventListResponse' + $ref: "#/components/schemas/EventListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - events_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - events_read summary: Get a list of events tags: - - Events - x-permission: + - Events + "x-permission": operator: OR permissions: - - events_read + - events_read post: - description: 'This endpoint allows you to post events to the stream. - - Tag them, set priority and event aggregate them with other events.' + description: |- + This endpoint allows you to post events to the stream. + Tag them, set priority and event aggregate them with other events. operationId: CreateEvent requestBody: content: application/json: schema: - $ref: '#/components/schemas/EventCreateRequest' + $ref: "#/components/schemas/EventCreateRequest" description: Event request object required: true responses: - '202': + "202": content: application/json: schema: - $ref: '#/components/schemas/EventCreateResponse' + $ref: "#/components/schemas/EventCreateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] + - apiKeyAuth: [] summary: Post an event tags: - - Events + - Events x-codegen-request-body-name: body /api/v1/events/{event_id}: get: - description: "This endpoint allows you to query for event details.\n\n**Note**: - If the event you\u2019re querying contains markdown formatting of any kind,\nyou - may see characters such as `%`,`\\`,`n` in your output." + description: |- + This endpoint allows you to query for event details. + + **Note**: If the event you’re querying contains markdown formatting of any kind, + you may see characters such as `%`,`\`,`n` in your output. operationId: GetEvent parameters: - - description: The ID of the event. - in: path - name: event_id - required: true - schema: - format: int64 - type: integer + - description: The ID of the event. + in: path + name: event_id + required: true + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EventResponse' + $ref: "#/components/schemas/EventResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - events_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - events_read summary: Get an event tags: - - Events - x-permission: + - Events + "x-permission": operator: OR permissions: - - events_read + - events_read /api/v1/graph/snapshot: get: - description: 'Take graph snapshots. Snapshots are PNG images generated by rendering - a specified widget in a web page and capturing it once the data is available. - The image is then uploaded to cloud storage. + description: |- + Take graph snapshots. Snapshots are PNG images generated by rendering a specified widget in a web page and capturing it once the data is available. The image is then uploaded to cloud storage. - - **Note**: When a snapshot is created, there is some delay before it is available.' + **Note**: When a snapshot is created, there is some delay before it is available. operationId: GetGraphSnapshot parameters: - - description: The metric query. - in: query - name: metric_query - schema: - type: string - x-docs-curl-required: true - - description: The POSIX timestamp of the start of the query in seconds. - in: query - name: start - required: true - schema: - format: int64 - type: integer - - description: The POSIX timestamp of the end of the query in seconds. - in: query - name: end - required: true - schema: - format: int64 - type: integer - - description: A query that adds event bands to the graph. - in: query - name: event_query - required: false - schema: - type: string - - description: 'A JSON document defining the graph. `graph_def` can be used - instead of `metric_query`. - - The JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar) - - and should be formatted to a single line then URL encoded.' - in: query - name: graph_def - required: false - schema: - type: string - - description: A title for the graph. If no title is specified, the graph does - not have a title. - in: query - name: title - required: false - schema: - type: string - - description: The height of the graph. If no height is specified, the graph's - original height is used. - in: query - name: height - required: false - schema: - format: int64 - type: integer - - description: The width of the graph. If no width is specified, the graph's - original width is used. - in: query - name: width - required: false - schema: - format: int64 - type: integer + - description: The metric query. + in: query + name: metric_query + schema: + type: string + x-docs-curl-required: true + - description: The POSIX timestamp of the start of the query in seconds. + in: query + name: start + required: true + schema: + format: int64 + type: integer + - description: The POSIX timestamp of the end of the query in seconds. + in: query + name: end + required: true + schema: + format: int64 + type: integer + - description: A query that adds event bands to the graph. + in: query + name: event_query + required: false + schema: + type: string + - description: |- + A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. + The JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar) + and should be formatted to a single line then URL encoded. + in: query + name: graph_def + required: false + schema: + type: string + - description: A title for the graph. If no title is specified, the graph does not have a title. + in: query + name: title + required: false + schema: + type: string + - description: The height of the graph. If no height is specified, the graph's original height is used. + in: query + name: height + required: false + schema: + format: int64 + type: integer + - description: The width of the graph. If no width is specified, the graph's original width is used. + in: query + name: width + required: false + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GraphSnapshot' + $ref: "#/components/schemas/GraphSnapshot" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Take graph snapshots tags: - - Snapshots - x-permission: + - Snapshots + "x-permission": operator: OPEN permissions: [] /api/v1/host/{host_name}/mute: post: - description: Mute a host. **Note:** This creates a [Downtime V2](https://docs.datadoghq.com/api/latest/downtimes/#schedule-a-downtime) - for the host. + description: Mute a host. **Note:** This creates a [Downtime V2](https://docs.datadoghq.com/api/latest/downtimes/#schedule-a-downtime) for the host. operationId: MuteHost parameters: - - description: Name of the host to mute. - in: path - name: host_name - required: true - schema: - type: string + - description: Name of the host to mute. + in: path + name: host_name + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/HostMuteSettings' + $ref: "#/components/schemas/HostMuteSettings" description: Mute a host request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/HostMuteResponse' + $ref: "#/components/schemas/HostMuteResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Invalid Parameter Error - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Mute a host tags: - - Hosts + - Hosts x-codegen-request-body-name: body /api/v1/host/{host_name}/unmute: post: description: Unmutes a host. This endpoint takes no JSON arguments. operationId: UnmuteHost parameters: - - description: Name of the host to unmute. - in: path - name: host_name - required: true - schema: - type: string + - description: Name of the host to unmute. + in: path + name: host_name + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/HostMuteResponse' + $ref: "#/components/schemas/HostMuteResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Invalid Parameter Error - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Unmute a host tags: - - Hosts + - Hosts x-codegen-request-body-name: body /api/v1/hosts: get: - description: 'This endpoint allows searching for hosts by name, alias, or tag. - + description: |- + This endpoint allows searching for hosts by name, alias, or tag. Hosts live within the past 3 hours are included by default. - Retention is 7 days. - Results are paginated with a max of 1000 results at a time. - - **Note:** If the host is an Amazon EC2 instance, `id` is replaced with `aws_id` - in the response. - - **Note**: To enrich the data returned by this endpoint with security scans, - see the new [api/v2/security/scanned-assets-metadata](https://docs.datadoghq.com/api/latest/security-monitoring/#list-scanned-assets-metadata) - endpoint.' + **Note:** If the host is an Amazon EC2 instance, `id` is replaced with `aws_id` in the response. + **Note**: To enrich the data returned by this endpoint with security scans, see the new [api/v2/security/scanned-assets-metadata](https://docs.datadoghq.com/api/latest/security-monitoring/#list-scanned-assets-metadata) endpoint. operationId: ListHosts parameters: - - description: String to filter search results. - in: query - name: filter - required: false - schema: - type: string - - description: Sort hosts by this field. - in: query - name: sort_field - required: false - schema: - type: string - - description: Direction of sort. Options include `asc` and `desc`. - in: query - name: sort_dir - required: false - schema: - type: string - - description: Specify the starting point for the host search results. For example, - if you set `count` to 100 and the first 100 results have already been returned, - you can set `start` to `101` to get the next 100 results. - in: query - name: start - required: false - schema: - format: int64 - type: integer - - description: Number of hosts to return. Max 1000. - in: query - name: count - required: false - schema: - format: int64 - type: integer - - description: Number of seconds since UNIX epoch from which you want to search - your hosts. - in: query - name: from - required: false - schema: - format: int64 - type: integer - - description: Include information on the muted status of hosts and when the - mute expires. - in: query - name: include_muted_hosts_data - required: false - schema: - type: boolean - - description: Include additional metadata about the hosts (agent_version, machine, - platform, processor, etc.). - in: query - name: include_hosts_metadata - required: false - schema: - type: boolean + - description: String to filter search results. + in: query + name: filter + required: false + schema: + type: string + - description: Sort hosts by this field. + in: query + name: sort_field + required: false + schema: + type: string + - description: Direction of sort. Options include `asc` and `desc`. + in: query + name: sort_dir + required: false + schema: + type: string + - description: Specify the starting point for the host search results. For example, if you set `count` to 100 and the first 100 results have already been returned, you can set `start` to `101` to get the next 100 results. + in: query + name: start + required: false + schema: + format: int64 + type: integer + - description: Number of hosts to return. Max 1000. + in: query + name: count + required: false + schema: + format: int64 + type: integer + - description: Number of seconds since UNIX epoch from which you want to search your hosts. + in: query + name: from + required: false + schema: + format: int64 + type: integer + - description: Include information on the muted status of hosts and when the mute expires. + in: query + name: include_muted_hosts_data + required: false + schema: + type: boolean + - description: Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.). + in: query + name: include_hosts_metadata + required: false + schema: + type: boolean responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/HostListResponse' + $ref: "#/components/schemas/HostListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Invalid Parameter Error - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - hosts_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - hosts_read summary: Get all hosts for your organization tags: - - Hosts - x-permission: + - Hosts + "x-permission": operator: OR permissions: - - hosts_read + - hosts_read /api/v1/hosts/totals: get: - description: 'This endpoint returns the total number of active and up hosts - in your Datadog account. - - Active means the host has reported in the past hour, and up means it has reported - in the past two hours.' + description: |- + This endpoint returns the total number of active and up hosts in your Datadog account. + Active means the host has reported in the past hour, and up means it has reported in the past two hours. operationId: GetHostTotals parameters: - - description: Number of seconds from which you want to get total number of - active hosts. - in: query - name: from - required: false - schema: - format: int64 - type: integer + - description: Number of seconds from which you want to get total number of active hosts. + in: query + name: from + required: false + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/HostTotals' + $ref: "#/components/schemas/HostTotals" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Invalid Parameter Error - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - hosts_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - hosts_read summary: Get the total number of active hosts tags: - - Hosts - x-permission: + - Hosts + "x-permission": operator: OR permissions: - - hosts_read + - hosts_read /api/v1/integration/aws: delete: deprecated: true - description: '**This endpoint is deprecated - use the V2 endpoints instead.** - Delete a Datadog-AWS integration matching the specified `account_id` and `role_name - parameters`.' + description: "**This endpoint is deprecated - use the V2 endpoints instead.** Delete a Datadog-AWS integration matching the specified `account_id` and `role_name parameters`." operationId: DeleteAWSAccount requestBody: content: application/json: schema: - $ref: '#/components/schemas/AWSAccountDeleteRequest' + $ref: "#/components/schemas/AWSAccountDeleteRequest" description: AWS request object required: true responses: - '200': + "200": content: application/json: schema: type: object description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Conflict Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an AWS integration tags: - - AWS Integration + - AWS Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - aws_configurations_manage + - aws_configurations_manage get: deprecated: true - description: '**This endpoint is deprecated - use the V2 endpoints instead.** - List all Datadog-AWS integrations available in your Datadog organization.' + description: "**This endpoint is deprecated - use the V2 endpoints instead.** List all Datadog-AWS integrations available in your Datadog organization." operationId: ListAWSAccounts parameters: - - description: Only return AWS accounts that matches this `account_id`. - in: query - name: account_id - required: false - schema: - type: string - - description: Only return AWS accounts that matches this role_name. - in: query - name: role_name - required: false - schema: - type: string - - description: Only return AWS accounts that matches this `access_key_id`. - in: query - name: access_key_id - required: false - schema: - type: string + - description: Only return AWS accounts that matches this `account_id`. + in: query + name: account_id + required: false + schema: + type: string + - description: Only return AWS accounts that matches this role_name. + in: query + name: role_name + required: false + schema: + type: string + - description: Only return AWS accounts that matches this `access_key_id`. + in: query + name: access_key_id + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSAccountListResponse' + $ref: "#/components/schemas/AWSAccountListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List all AWS integrations tags: - - AWS Integration - x-permission: + - AWS Integration + "x-permission": operator: OR permissions: - - aws_configuration_read + - aws_configuration_read post: deprecated: true - description: '**This endpoint is deprecated - use the V2 endpoints instead.** - Create a Datadog-Amazon Web Services integration. - + description: |- + **This endpoint is deprecated - use the V2 endpoints instead.** Create a Datadog-Amazon Web Services integration. Using the `POST` method updates your integration configuration - by adding your new configuration to the existing one in your Datadog organization. - - A unique AWS Account ID for role based authentication.' + A unique AWS Account ID for role based authentication. operationId: CreateAWSAccount requestBody: content: application/json: schema: - $ref: '#/components/schemas/AWSAccount' + $ref: "#/components/schemas/AWSAccount" description: AWS Request Object required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSAccountCreateResponse' + $ref: "#/components/schemas/AWSAccountCreateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Conflict Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an AWS integration tags: - - AWS Integration + - AWS Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - aws_configurations_manage + - aws_configurations_manage put: deprecated: true - description: '**This endpoint is deprecated - use the V2 endpoints instead.** - Update a Datadog-Amazon Web Services integration.' + description: "**This endpoint is deprecated - use the V2 endpoints instead.** Update a Datadog-Amazon Web Services integration." operationId: UpdateAWSAccount parameters: - - description: Only return AWS accounts that matches this `account_id`. - in: query - name: account_id - required: false - schema: - type: string - - description: 'Only return AWS accounts that match this `role_name`. - - Required if `account_id` is specified.' - in: query - name: role_name - required: false - schema: - type: string - - description: 'Only return AWS accounts that matches this `access_key_id`. - - Required if none of the other two options are specified.' - in: query - name: access_key_id - required: false - schema: - type: string + - description: Only return AWS accounts that matches this `account_id`. + in: query + name: account_id + required: false + schema: + type: string + - description: |- + Only return AWS accounts that match this `role_name`. + Required if `account_id` is specified. + in: query + name: role_name + required: false + schema: + type: string + - description: |- + Only return AWS accounts that matches this `access_key_id`. + Required if none of the other two options are specified. + in: query + name: access_key_id + required: false + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/AWSAccount' + $ref: "#/components/schemas/AWSAccount" description: AWS request object required: true responses: - '200': + "200": content: application/json: schema: type: object description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Conflict Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update an AWS integration tags: - - AWS Integration + - AWS Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - aws_configuration_edit + - aws_configuration_edit /api/v1/integration/aws/available_namespace_rules: get: deprecated: true - description: '**This endpoint is deprecated - use the V2 endpoints instead.** - List all namespace rules for a given Datadog-AWS integration. This endpoint - takes no arguments.' + description: "**This endpoint is deprecated - use the V2 endpoints instead.** List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments." operationId: ListAvailableAWSNamespaces responses: - '200': + "200": content: application/json: schema: - example: - - namespace1 - - namespace2 - - namespace3 + example: ["namespace1", "namespace2", "namespace3"] items: type: string type: array description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List namespace rules tags: - - AWS Integration - x-permission: + - AWS Integration + "x-permission": operator: OR permissions: - - aws_configuration_read + - aws_configuration_read /api/v1/integration/aws/event_bridge: delete: deprecated: true - description: '**This endpoint is deprecated - use the V2 endpoints instead.** - Delete an Amazon EventBridge source.' + description: "**This endpoint is deprecated - use the V2 endpoints instead.** Delete an Amazon EventBridge source." operationId: DeleteAWSEventBridgeSource requestBody: content: application/json: schema: - $ref: '#/components/schemas/AWSEventBridgeDeleteRequest' - description: Delete the Amazon EventBridge source with the given name, region, - and associated AWS account. + $ref: "#/components/schemas/AWSEventBridgeDeleteRequest" + description: Delete the Amazon EventBridge source with the given name, region, and associated AWS account. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSEventBridgeDeleteResponse' + $ref: "#/components/schemas/AWSEventBridgeDeleteResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an Amazon EventBridge source tags: - - AWS Integration + - AWS Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations get: deprecated: true - description: '**This endpoint is deprecated - use the V2 endpoints instead.** - Get all Amazon EventBridge sources.' + description: "**This endpoint is deprecated - use the V2 endpoints instead.** Get all Amazon EventBridge sources." operationId: ListAWSEventBridgeSources parameters: [] responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSEventBridgeListResponse' + $ref: "#/components/schemas/AWSEventBridgeListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all Amazon EventBridge sources tags: - - AWS Integration - x-permission: + - AWS Integration + "x-permission": operator: OPEN permissions: [] post: deprecated: true - description: '**This endpoint is deprecated - use the V2 endpoints instead.** - Create an Amazon EventBridge source.' + description: "**This endpoint is deprecated - use the V2 endpoints instead.** Create an Amazon EventBridge source." operationId: CreateAWSEventBridgeSource requestBody: content: application/json: schema: - $ref: '#/components/schemas/AWSEventBridgeCreateRequest' - description: Create an Amazon EventBridge source for an AWS account with a - given name and region. + $ref: "#/components/schemas/AWSEventBridgeCreateRequest" + description: Create an Amazon EventBridge source for an AWS account with a given name and region. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSEventBridgeCreateResponse' + $ref: "#/components/schemas/AWSEventBridgeCreateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an Amazon EventBridge source tags: - - AWS Integration + - AWS Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v1/integration/aws/filtering: delete: deprecated: true @@ -29989,79 +27425,78 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AWSTagFilterDeleteRequest' - description: Delete a tag filtering entry for a given AWS account and `dd-aws` - namespace. + $ref: "#/components/schemas/AWSTagFilterDeleteRequest" + description: Delete a tag filtering entry for a given AWS account and `dd-aws` namespace. required: true responses: - '200': + "200": content: application/json: schema: example: {} type: object description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a tag filtering entry tags: - - AWS Integration + - AWS Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - aws_configuration_edit + - aws_configuration_edit get: deprecated: true description: Get all AWS tag filters. operationId: ListAWSTagFilters parameters: - - description: Only return AWS filters that matches this `account_id`. - in: query - name: account_id - required: true - schema: - type: string + - description: Only return AWS filters that matches this `account_id`. + in: query + name: account_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSTagFilterListResponse' + $ref: "#/components/schemas/AWSTagFilterListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all AWS tag filters tags: - - AWS Integration - x-permission: + - AWS Integration + "x-permission": operator: OR permissions: - - aws_configuration_read + - aws_configuration_read post: deprecated: true description: Set an AWS tag filter. @@ -30070,781 +27505,741 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AWSTagFilterCreateRequest' - description: 'Set an AWS tag filter using an `aws_account_identifier`, `namespace`, - and filtering string. - - Namespace options are `application_elb`, `elb`, `lambda`, `network_elb`, - `rds`, `sqs`, and `custom`.' + $ref: "#/components/schemas/AWSTagFilterCreateRequest" + description: |- + Set an AWS tag filter using an `aws_account_identifier`, `namespace`, and filtering string. + Namespace options are `application_elb`, `elb`, `lambda`, `network_elb`, `rds`, `sqs`, and `custom`. required: true responses: - '200': + "200": content: application/json: schema: example: {} type: object description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Set an AWS tag filter tags: - - AWS Integration + - AWS Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - aws_configuration_edit + - aws_configuration_edit /api/v1/integration/aws/generate_new_external_id: put: deprecated: true - description: '**This endpoint is deprecated - use the V2 endpoints instead.** - Generate a new AWS external ID for a given AWS account ID and role name pair.' + description: "**This endpoint is deprecated - use the V2 endpoints instead.** Generate a new AWS external ID for a given AWS account ID and role name pair." operationId: CreateNewAWSExternalID requestBody: content: application/json: schema: - $ref: '#/components/schemas/AWSAccount' - description: 'Your Datadog role delegation name. - + $ref: "#/components/schemas/AWSAccount" + description: |- + Your Datadog role delegation name. For more information about your AWS account Role name, - - see the [Datadog AWS integration configuration info](https://docs.datadoghq.com/integrations/amazon_web_services/#setup).' + see the [Datadog AWS integration configuration info](https://docs.datadoghq.com/integrations/amazon_web_services/#setup). required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSAccountCreateResponse' + $ref: "#/components/schemas/AWSAccountCreateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Generate a new external ID tags: - - AWS Integration + - AWS Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - aws_configuration_edit + - aws_configuration_edit /api/v1/integration/aws/logs: delete: - description: Delete a Datadog-AWS logs configuration by removing the specific - Lambda ARN associated with a given AWS account. + description: >- + Delete a Datadog-AWS logs configuration by removing the specific Lambda ARN associated with a given AWS account. operationId: DeleteAWSLambdaARN requestBody: content: application/json: schema: - $ref: '#/components/schemas/AWSAccountAndLambdaRequest' + $ref: "#/components/schemas/AWSAccountAndLambdaRequest" description: Delete AWS Lambda ARN request body. required: true responses: - '200': + "200": content: application/json: schema: type: object description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an AWS Logs integration tags: - - AWS Logs Integration + - AWS Logs Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - aws_configuration_edit + - aws_configuration_edit get: deprecated: true - description: List all Datadog-AWS Logs integrations configured in your Datadog - account. + description: >- + List all Datadog-AWS Logs integrations configured in your Datadog account. operationId: ListAWSLogsIntegrations responses: - '200': + "200": content: application/json: schema: - example: - - account_id: '123456789101' - lambdas: [] - services: - - s3 - - elb - - elbv2 - - cloudfront - - redshift - - lambda + example: [{"account_id": "123456789101", "lambdas": [], "services": ["s3", "elb", "elbv2", "cloudfront", "redshift", "lambda"]}] items: - $ref: '#/components/schemas/AWSLogsListResponse' + $ref: "#/components/schemas/AWSLogsListResponse" type: array description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List all AWS Logs integrations tags: - - AWS Logs Integration - x-permission: + - AWS Logs Integration + "x-permission": operator: OR permissions: - - aws_configuration_read + - aws_configuration_read post: - description: Attach the Lambda ARN of the Lambda created for the Datadog-AWS - log collection to your AWS account ID to enable log collection. + description: >- + Attach the Lambda ARN of the Lambda created for the Datadog-AWS log collection to your AWS account ID to enable log collection. operationId: CreateAWSLambdaARN requestBody: content: application/json: schema: - $ref: '#/components/schemas/AWSAccountAndLambdaRequest' + $ref: "#/components/schemas/AWSAccountAndLambdaRequest" description: AWS Log Lambda Async request body. required: true responses: - '200': + "200": content: application/json: schema: type: object description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Add AWS Log Lambda ARN tags: - - AWS Logs Integration + - AWS Logs Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - aws_configuration_edit + - aws_configuration_edit /api/v1/integration/aws/logs/check_async: post: - description: 'Test if permissions are present to add a log-forwarding triggers - for the given services and AWS account. The input - - is the same as for Enable an AWS service log collection. Subsequent requests - will always repeat the above, so this - + description: |- + Test if permissions are present to add a log-forwarding triggers for the given services and AWS account. The input + is the same as for Enable an AWS service log collection. Subsequent requests will always repeat the above, so this endpoint can be polled intermittently instead of blocking. - - - Returns a status of ''created'' when it''s checking if the Lambda exists - in the account. - - - Returns a status of ''waiting'' while checking. - - - Returns a status of ''checked and ok'' if the Lambda exists. - - - Returns a status of ''error'' if the Lambda does not exist.' + - Returns a status of 'created' when it's checking if the Lambda exists in the account. + - Returns a status of 'waiting' while checking. + - Returns a status of 'checked and ok' if the Lambda exists. + - Returns a status of 'error' if the Lambda does not exist. operationId: CheckAWSLogsLambdaAsync requestBody: content: application/json: schema: - $ref: '#/components/schemas/AWSAccountAndLambdaRequest' + $ref: "#/components/schemas/AWSAccountAndLambdaRequest" description: Check AWS Log Lambda Async request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSLogsAsyncResponse' + $ref: "#/components/schemas/AWSLogsAsyncResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Check that an AWS Lambda Function exists tags: - - AWS Logs Integration + - AWS Logs Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - aws_configuration_read + - aws_configuration_read /api/v1/integration/aws/logs/services: get: deprecated: true - description: '**This endpoint is deprecated - use the V2 endpoint instead.** - Get the list of current AWS services that Datadog offers automatic log collection. - Use returned service IDs with the services parameter for the Enable an AWS - service log collection API endpoint.' + description: >- + **This endpoint is deprecated - use the V2 endpoint instead.** Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint. operationId: ListAWSLogsServices responses: - '200': - content: - application/json: - schema: - example: - - id: s3 - label: S3 Access Logs - - id: elb - label: Classic ELB Access Logs - - id: elbv2 - label: Application ELB Access Logs - - id: cloudfront - label: CloudFront Access Logs - - id: redshift - label: Redshift Logs - - id: lambda - label: Lambda Cloudwatch Logs + "200": + content: + application/json: + schema: + example: [{"id": "s3", "label": "S3 Access Logs"}, {"id": "elb", "label": "Classic ELB Access Logs"}, {"id": "elbv2", "label": "Application ELB Access Logs"}, {"id": "cloudfront", "label": "CloudFront Access Logs"}, {"id": "redshift", "label": "Redshift Logs"}, {"id": "lambda", "label": "Lambda Cloudwatch Logs"}] items: - $ref: '#/components/schemas/AWSLogsListServicesResponse' + $ref: "#/components/schemas/AWSLogsListServicesResponse" type: array description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get list of AWS log ready services tags: - - AWS Logs Integration - x-permission: + - AWS Logs Integration + "x-permission": operator: OR permissions: - - aws_configuration_read + - aws_configuration_read post: deprecated: true - description: Enable automatic log collection for a list of services. This should - be run after running `CreateAWSLambdaARN` to save the configuration. + description: >- + Enable automatic log collection for a list of services. This should be run after running `CreateAWSLambdaARN` to save the configuration. operationId: EnableAWSLogServices requestBody: content: application/json: schema: - $ref: '#/components/schemas/AWSLogsServicesRequest' + $ref: "#/components/schemas/AWSLogsServicesRequest" description: Enable AWS Log Services request body. required: true responses: - '200': + "200": content: application/json: schema: type: object description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Enable an AWS Logs integration tags: - - AWS Logs Integration + - AWS Logs Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - aws_configuration_edit + - aws_configuration_edit /api/v1/integration/aws/logs/services_async: post: - description: "Test if permissions are present to add log-forwarding triggers - for the\ngiven services and AWS account. Input is the same as for `EnableAWSLogServices`.\nDone - async, so can be repeatedly polled in a non-blocking fashion until\nthe async - request completes.\n\n- Returns a status of `created` when it's checking if - the permissions exists\n in the AWS account.\n- Returns a status of `waiting` - while checking.\n- Returns a status of `checked and ok` if the Lambda exists.\n- - Returns a status of `error` if the Lambda does not exist." + description: |- + Test if permissions are present to add log-forwarding triggers for the + given services and AWS account. Input is the same as for `EnableAWSLogServices`. + Done async, so can be repeatedly polled in a non-blocking fashion until + the async request completes. + + - Returns a status of `created` when it's checking if the permissions exists + in the AWS account. + - Returns a status of `waiting` while checking. + - Returns a status of `checked and ok` if the Lambda exists. + - Returns a status of `error` if the Lambda does not exist. operationId: CheckAWSLogsServicesAsync requestBody: content: application/json: schema: - $ref: '#/components/schemas/AWSLogsServicesRequest' + $ref: "#/components/schemas/AWSLogsServicesRequest" description: Check AWS Logs Async Services request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSLogsAsyncResponse' + $ref: "#/components/schemas/AWSLogsAsyncResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Check permissions for log services tags: - - AWS Logs Integration + - AWS Logs Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - aws_configuration_read + - aws_configuration_read /api/v1/integration/azure: delete: - description: Delete a given Datadog-Azure integration from your Datadog account. + description: |- + Delete a given Datadog-Azure integration from your Datadog account. operationId: DeleteAzureIntegration requestBody: content: application/json: schema: - $ref: '#/components/schemas/AzureAccount' + $ref: "#/components/schemas/AzureAccount" description: Delete a given Datadog-Azure integration request body. required: true responses: - '200': + "200": content: application/json: schema: example: {} type: object description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an Azure integration tags: - - Azure Integration + - Azure Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - azure_configurations_manage + - azure_configurations_manage get: - description: List all Datadog-Azure integrations configured in your Datadog - account. + description: |- + List all Datadog-Azure integrations configured in your Datadog account. operationId: ListAzureIntegration responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AzureAccountListResponse' + $ref: "#/components/schemas/AzureAccountListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List all Azure integrations tags: - - Azure Integration - x-permission: + - Azure Integration + "x-permission": operator: OR permissions: - - azure_configuration_read + - azure_configuration_read post: - description: 'Create a Datadog-Azure integration. - - - Using the `POST` method updates your integration configuration by adding your - new + description: |- + Create a Datadog-Azure integration. + Using the `POST` method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization. - - Using the `PUT` method updates your integration configuration by replacing - your - - current configuration with the new one sent to your Datadog organization.' + Using the `PUT` method updates your integration configuration by replacing your + current configuration with the new one sent to your Datadog organization. operationId: CreateAzureIntegration requestBody: content: application/json: schema: - $ref: '#/components/schemas/AzureAccount' - description: Create a Datadog-Azure integration for your Datadog account request - body. + $ref: "#/components/schemas/AzureAccount" + description: Create a Datadog-Azure integration for your Datadog account request body. required: true responses: - '200': + "200": content: application/json: schema: example: {} type: object description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an Azure integration tags: - - Azure Integration + - Azure Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - azure_configurations_manage + - azure_configurations_manage put: - description: 'Update a Datadog-Azure integration. Requires an existing `tenant_name` - and `client_id`. - - Any other fields supplied will overwrite existing values. To overwrite `tenant_name` - or `client_id`, - - use `new_tenant_name` and `new_client_id`. To leave a field unchanged, do - not supply that field in the payload.' + description: |- + Update a Datadog-Azure integration. Requires an existing `tenant_name` and `client_id`. + Any other fields supplied will overwrite existing values. To overwrite `tenant_name` or `client_id`, + use `new_tenant_name` and `new_client_id`. To leave a field unchanged, do not supply that field in the payload. operationId: UpdateAzureIntegration requestBody: content: application/json: schema: - $ref: '#/components/schemas/AzureAccount' + $ref: "#/components/schemas/AzureAccount" description: Update a Datadog-Azure integration request body. required: true responses: - '200': + "200": content: application/json: schema: example: {} type: object description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update an Azure integration tags: - - Azure Integration + - Azure Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - azure_configuration_edit + - azure_configuration_edit /api/v1/integration/azure/host_filters: post: - description: Update the defined list of host filters for a given Datadog-Azure - integration. + description: |- + Update the defined list of host filters for a given Datadog-Azure integration. operationId: UpdateAzureHostFilters requestBody: content: application/json: schema: - $ref: '#/components/schemas/AzureAccount' + $ref: "#/components/schemas/AzureAccount" description: Update a Datadog-Azure integration's host filters request body. required: true responses: - '200': + "200": content: application/json: schema: example: {} type: object description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update Azure integration host filters tags: - - Azure Integration + - Azure Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - azure_configuration_edit + - azure_configuration_edit /api/v1/integration/gcp: delete: deprecated: true - description: "This endpoint is deprecated \u2013 use the V2 endpoints instead. - Delete a given Datadog-GCP integration." + description: |- + This endpoint is deprecated – use the V2 endpoints instead. Delete a given Datadog-GCP integration. operationId: DeleteGCPIntegration requestBody: content: application/json: schema: - $ref: '#/components/schemas/GCPAccount' + $ref: "#/components/schemas/GCPAccount" description: Delete a given Datadog-GCP integration. required: true responses: - '200': + "200": content: application/json: schema: example: {} type: object description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a GCP integration tags: - - GCP Integration + - GCP Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - gcp_configurations_manage + - gcp_configurations_manage get: deprecated: true - description: "This endpoint is deprecated \u2013 use the V2 endpoints instead. - List all Datadog-GCP integrations configured in your Datadog account." + description: |- + This endpoint is deprecated – use the V2 endpoints instead. List all Datadog-GCP integrations configured in your Datadog account. operationId: ListGCPIntegration responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GCPAccountListResponse' + $ref: "#/components/schemas/GCPAccountListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List all GCP integrations tags: - - GCP Integration - x-permission: + - GCP Integration + "x-permission": operator: OR permissions: - - gcp_configuration_read + - gcp_configuration_read post: deprecated: true - description: "This endpoint is deprecated \u2013 use the V2 endpoints instead. - Create a Datadog-GCP integration." + description: |- + This endpoint is deprecated – use the V2 endpoints instead. Create a Datadog-GCP integration. operationId: CreateGCPIntegration requestBody: content: application/json: schema: - $ref: '#/components/schemas/GCPAccount' + $ref: "#/components/schemas/GCPAccount" description: Create a Datadog-GCP integration. required: true responses: - '200': + "200": content: application/json: schema: example: {} type: object description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a GCP integration tags: - - GCP Integration + - GCP Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - gcp_configurations_manage + - gcp_configurations_manage put: deprecated: true - description: "This endpoint is deprecated \u2013 use the V2 endpoints instead. - Update a Datadog-GCP integrations host_filters and/or auto-mute.\nRequires - a `project_id` and `client_email`, however these fields cannot be updated.\nIf - you need to update these fields, delete and use the create (`POST`) endpoint.\nThe - unspecified fields will keep their original values." + description: |- + This endpoint is deprecated – use the V2 endpoints instead. Update a Datadog-GCP integrations host_filters and/or auto-mute. + Requires a `project_id` and `client_email`, however these fields cannot be updated. + If you need to update these fields, delete and use the create (`POST`) endpoint. + The unspecified fields will keep their original values. operationId: UpdateGCPIntegration requestBody: content: application/json: schema: - $ref: '#/components/schemas/GCPAccount' + $ref: "#/components/schemas/GCPAccount" description: Update a Datadog-GCP integration. required: true responses: - '200': + "200": content: application/json: schema: example: {} type: object description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a GCP integration tags: - - GCP Integration + - GCP Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - gcp_configuration_edit + - gcp_configuration_edit /api/v1/integration/pagerduty/configuration/services: post: description: Create a new service object in the PagerDuty integration. @@ -30853,371 +28248,372 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PagerDutyService' + $ref: "#/components/schemas/PagerDutyService" description: Create a new service object request body. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/PagerDutyServiceName' + $ref: "#/components/schemas/PagerDutyServiceName" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a new service object tags: - - PagerDuty Integration + - PagerDuty Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v1/integration/pagerduty/configuration/services/{service_name}: delete: description: Delete a single service object in the Datadog-PagerDuty integration. operationId: DeletePagerDutyIntegrationService parameters: - - description: The service name - in: path - name: service_name - required: true - schema: - type: string + - description: The service name + in: path + name: service_name + required: true + schema: + type: string responses: - '204': + "204": description: No Content - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a single service object tags: - - PagerDuty Integration - x-permission: + - PagerDuty Integration + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations get: - description: Get service name in the Datadog-PagerDuty integration. + description: |- + Get service name in the Datadog-PagerDuty integration. operationId: GetPagerDutyIntegrationService parameters: - - description: The service name. - in: path - name: service_name - required: true - schema: - type: string + - description: The service name. + in: path + name: service_name + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PagerDutyServiceName' + $ref: "#/components/schemas/PagerDutyServiceName" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a single service object tags: - - PagerDuty Integration - x-permission: + - PagerDuty Integration + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read put: description: Update a single service object in the Datadog-PagerDuty integration. operationId: UpdatePagerDutyIntegrationService parameters: - - description: The service name - in: path - name: service_name - required: true - schema: - type: string + - description: The service name + in: path + name: service_name + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/PagerDutyServiceKey' + $ref: "#/components/schemas/PagerDutyServiceKey" description: Update an existing service object request body. required: true responses: - '200': + "200": description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a single service object tags: - - PagerDuty Integration + - PagerDuty Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v1/integration/slack/configuration/accounts/{account_name}/channels: get: description: Get a list of all channels configured for your Datadog-Slack integration. operationId: GetSlackIntegrationChannels parameters: - - $ref: '#/components/parameters/SlackAccountNamePathParameter' + - $ref: "#/components/parameters/SlackAccountNamePathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SlackIntegrationChannels' + $ref: "#/components/schemas/SlackIntegrationChannels" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all channels in a Slack integration tags: - - Slack Integration - x-permission: + - Slack Integration + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read post: description: Add a channel to your Datadog-Slack integration. operationId: CreateSlackIntegrationChannel parameters: - - $ref: '#/components/parameters/SlackAccountNamePathParameter' + - $ref: "#/components/parameters/SlackAccountNamePathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SlackIntegrationChannel' + $ref: "#/components/schemas/SlackIntegrationChannel" description: Payload describing Slack channel to be created required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SlackIntegrationChannel' + $ref: "#/components/schemas/SlackIntegrationChannel" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a Slack integration channel tags: - - Slack Integration + - Slack Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name}: delete: description: Remove a channel from your Datadog-Slack integration. operationId: RemoveSlackIntegrationChannel parameters: - - $ref: '#/components/parameters/SlackAccountNamePathParameter' - - $ref: '#/components/parameters/SlackChannelNamePathParameter' + - $ref: "#/components/parameters/SlackAccountNamePathParameter" + - $ref: "#/components/parameters/SlackChannelNamePathParameter" responses: - '204': + "204": description: The channel was removed successfully. - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Remove a Slack integration channel tags: - - Slack Integration - x-permission: + - Slack Integration + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations get: description: Get a channel configured for your Datadog-Slack integration. operationId: GetSlackIntegrationChannel parameters: - - $ref: '#/components/parameters/SlackAccountNamePathParameter' - - $ref: '#/components/parameters/SlackChannelNamePathParameter' + - $ref: "#/components/parameters/SlackAccountNamePathParameter" + - $ref: "#/components/parameters/SlackChannelNamePathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SlackIntegrationChannel' + $ref: "#/components/schemas/SlackIntegrationChannel" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a Slack integration channel tags: - - Slack Integration - x-permission: + - Slack Integration + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read patch: description: Update a channel used in your Datadog-Slack integration. operationId: UpdateSlackIntegrationChannel parameters: - - $ref: '#/components/parameters/SlackAccountNamePathParameter' - - $ref: '#/components/parameters/SlackChannelNamePathParameter' + - $ref: "#/components/parameters/SlackAccountNamePathParameter" + - $ref: "#/components/parameters/SlackChannelNamePathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SlackIntegrationChannel' + $ref: "#/components/schemas/SlackIntegrationChannel" description: Payload describing fields and values to be updated. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SlackIntegrationChannel' + $ref: "#/components/schemas/SlackIntegrationChannel" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a Slack integration channel tags: - - Slack Integration + - Slack Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v1/integration/webhooks/configuration/custom-variables: post: description: Creates an endpoint with the name ``. @@ -31226,174 +28622,173 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/WebhooksIntegrationCustomVariable' + $ref: "#/components/schemas/WebhooksIntegrationCustomVariable" description: Define a custom variable request body. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/WebhooksIntegrationCustomVariableResponse' + $ref: "#/components/schemas/WebhooksIntegrationCustomVariableResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a custom variable tags: - - Webhooks Integration + - Webhooks Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}: delete: description: Deletes the endpoint with the name ``. operationId: DeleteWebhooksIntegrationCustomVariable parameters: - - description: The name of the custom variable. - in: path - name: custom_variable_name - required: true - schema: - type: string + - description: The name of the custom variable. + in: path + name: custom_variable_name + required: true + schema: + type: string responses: - '200': + "200": description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a custom variable tags: - - Webhooks Integration - x-permission: + - Webhooks Integration + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations get: - description: 'Shows the content of the custom variable with the name ``. - + description: |- + Shows the content of the custom variable with the name ``. If the custom variable is secret, the value does not return in the - - response payload.' + response payload. operationId: GetWebhooksIntegrationCustomVariable parameters: - - description: The name of the custom variable. - in: path - name: custom_variable_name - required: true - schema: - type: string + - description: The name of the custom variable. + in: path + name: custom_variable_name + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/WebhooksIntegrationCustomVariableResponse' + $ref: "#/components/schemas/WebhooksIntegrationCustomVariableResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a custom variable tags: - - Webhooks Integration - x-permission: + - Webhooks Integration + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read put: description: Updates the endpoint with the name ``. operationId: UpdateWebhooksIntegrationCustomVariable parameters: - - description: The name of the custom variable. - in: path - name: custom_variable_name - required: true - schema: - type: string + - description: The name of the custom variable. + in: path + name: custom_variable_name + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/WebhooksIntegrationCustomVariableUpdateRequest' + $ref: "#/components/schemas/WebhooksIntegrationCustomVariableUpdateRequest" description: Update an existing custom variable request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/WebhooksIntegrationCustomVariableResponse' + $ref: "#/components/schemas/WebhooksIntegrationCustomVariableResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a custom variable tags: - - Webhooks Integration + - Webhooks Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v1/integration/webhooks/configuration/webhooks: post: description: Creates an endpoint with the name ``. @@ -31402,612 +28797,602 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/WebhooksIntegration' + $ref: "#/components/schemas/WebhooksIntegration" description: Create a webhooks integration request body. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/WebhooksIntegration' + $ref: "#/components/schemas/WebhooksIntegration" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - create_webhooks + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - create_webhooks summary: Create a webhooks integration tags: - - Webhooks Integration + - Webhooks Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - create_webhooks + - create_webhooks /api/v1/integration/webhooks/configuration/webhooks/{webhook_name}: delete: - description: Deletes the endpoint with the name ``. + description: Deletes the endpoint with the name ``. This action cannot be undone. operationId: DeleteWebhooksIntegration parameters: - - description: The name of the webhook. - in: path - name: webhook_name - required: true - schema: - type: string + - description: The name of the webhook. + in: path + name: webhook_name + required: true + schema: + type: string responses: - '200': + "200": description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a webhook tags: - - Webhooks Integration - x-permission: + - Webhooks Integration + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations get: description: Gets the content of the webhook with the name ``. operationId: GetWebhooksIntegration parameters: - - description: The name of the webhook. - in: path - name: webhook_name - required: true - schema: - type: string + - description: The name of the webhook. + in: path + name: webhook_name + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/WebhooksIntegration' + $ref: "#/components/schemas/WebhooksIntegration" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a webhook integration tags: - - Webhooks Integration - x-permission: + - Webhooks Integration + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read put: description: Updates the endpoint with the name ``. operationId: UpdateWebhooksIntegration parameters: - - description: The name of the webhook. - in: path - name: webhook_name - required: true - schema: - type: string - requestBody: + - description: The name of the webhook. + in: path + name: webhook_name + required: true + schema: + type: string + requestBody: content: application/json: schema: - $ref: '#/components/schemas/WebhooksIntegrationUpdateRequest' + $ref: "#/components/schemas/WebhooksIntegrationUpdateRequest" description: Update an existing Datadog-Webhooks integration. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/WebhooksIntegration' + $ref: "#/components/schemas/WebhooksIntegration" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a webhook tags: - - Webhooks Integration + - Webhooks Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v1/logs-queries/list: post: - description: 'List endpoint returns logs that match a log search query. - + description: |- + List endpoint returns logs that match a log search query. [Results are paginated][1]. - **If you are considering archiving logs for your organization, - consider use of the Datadog archive capabilities instead of the log list API. - See [Datadog Logs Archive documentation][2].** - [1]: /logs/guide/collect-multiple-logs-with-pagination - - [2]: https://docs.datadoghq.com/logs/archives' + [2]: https://docs.datadoghq.com/logs/archives operationId: ListLogs requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogsListRequest' + $ref: "#/components/schemas/LogsListRequest" description: Logs filter required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsListResponse' + $ref: "#/components/schemas/LogsListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/LogsAPIErrorResponse' + $ref: "#/components/schemas/LogsAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Search logs tags: - - Logs + - Logs x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_read_data + - logs_read_data /api/v1/logs/config/index-order: get: - description: Get the current order of your log indexes. This endpoint takes - no JSON arguments. + description: |- + Get the current order of your log indexes. This endpoint takes no JSON arguments. operationId: GetLogsIndexOrder responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsIndexesOrder' + $ref: "#/components/schemas/LogsIndexesOrder" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get indexes order tags: - - Logs Indexes - x-permission: + - Logs Indexes + "x-permission": operator: OR permissions: - - logs_read_config + - logs_read_config put: - description: 'This endpoint updates the index order of your organization. - - It returns the index order object passed in the request body when the request - is successful.' + description: |- + This endpoint updates the index order of your organization. + It returns the index order object passed in the request body when the request is successful. operationId: UpdateLogsIndexOrder requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogsIndexesOrder' + $ref: "#/components/schemas/LogsIndexesOrder" description: Object containing the new ordered list of index names required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsIndexesOrder' + $ref: "#/components/schemas/LogsIndexesOrder" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/LogsAPIErrorResponse' + $ref: "#/components/schemas/LogsAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update indexes order tags: - - Logs Indexes + - Logs Indexes x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_modify_indexes + - logs_modify_indexes /api/v1/logs/config/indexes: get: - description: 'The Index object describes the configuration of a log index. - - This endpoint returns an array of the `LogIndex` objects of your organization.' + description: |- + The Index object describes the configuration of a log index. + This endpoint returns an array of the `LogIndex` objects of your organization. operationId: ListLogIndexes responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsIndexListResponse' + $ref: "#/components/schemas/LogsIndexListResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all indexes tags: - - Logs Indexes - x-permission: + - Logs Indexes + "x-permission": operator: OR permissions: - - logs_read_config + - logs_read_config post: - description: Creates a new index. Returns the Index object passed in the request - body when the request is successful. + description: |- + Creates a new index. Returns the Index object passed in the request body when the request is successful. operationId: CreateLogsIndex requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogsIndex' + $ref: "#/components/schemas/LogsIndex" description: Object containing the new index. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsIndex' + $ref: "#/components/schemas/LogsIndex" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/LogsAPIErrorResponse' + $ref: "#/components/schemas/LogsAPIErrorResponse" description: Invalid Parameter Error - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/LogsAPILimitReachedResponse' + $ref: "#/components/schemas/LogsAPILimitReachedResponse" description: Unprocessable Entity - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an index tags: - - Logs Indexes + - Logs Indexes x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_modify_indexes + - logs_modify_indexes /api/v1/logs/config/indexes/{name}: delete: - description: 'Delete an existing index from your organization. Index deletions - are permanent and cannot be reverted. - - You cannot recreate an index with the same name as deleted ones.' + description: |- + Delete an existing index from your organization. Index deletions are permanent and cannot be reverted. + You cannot recreate an index with the same name as deleted ones. operationId: DeleteLogsIndex parameters: - - description: Name of the log index. - in: path - name: name - required: true - schema: - type: string + - description: Name of the log index. + in: path + name: name + required: true + schema: + type: string responses: - '200': + "200": description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/LogsAPIErrorResponse' + $ref: "#/components/schemas/LogsAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an index tags: - - Logs Indexes - x-permission: + - Logs Indexes + "x-permission": operator: OR permissions: - - logs_modify_indexes + - logs_modify_indexes get: - description: Get one log index from your organization. This endpoint takes no - JSON arguments. + description: |- + Get one log index from your organization. This endpoint takes no JSON arguments. operationId: GetLogsIndex parameters: - - description: Name of the log index. - in: path - name: name - required: true - schema: - type: string + - description: Name of the log index. + in: path + name: name + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsIndex' + $ref: "#/components/schemas/LogsIndex" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/LogsAPIErrorResponse' + $ref: "#/components/schemas/LogsAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get an index tags: - - Logs Indexes - x-permission: + - Logs Indexes + "x-permission": operator: OR permissions: - - logs_read_config + - logs_read_config put: - description: "Update an index as identified by its name.\nReturns the Index - object passed in the request body when the request is successful.\n\nUsing - the `PUT` method updates your index\u2019s configuration by **replacing**\nyour - current configuration with the new one sent to your Datadog organization." + description: |- + Update an index as identified by its name. + Returns the Index object passed in the request body when the request is successful. + + Using the `PUT` method updates your index’s configuration by **replacing** + your current configuration with the new one sent to your Datadog organization. operationId: UpdateLogsIndex parameters: - - description: Name of the log index. - in: path - name: name - required: true - schema: - type: string + - description: Name of the log index. + in: path + name: name + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogsIndexUpdateRequest' + $ref: "#/components/schemas/LogsIndexUpdateRequest" description: Object containing the new `LogsIndexUpdateRequest`. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsIndex' + $ref: "#/components/schemas/LogsIndex" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/LogsAPIErrorResponse' + $ref: "#/components/schemas/LogsAPIErrorResponse" description: Invalid Parameter Error - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/LogsAPIErrorResponse' + $ref: "#/components/schemas/LogsAPIErrorResponse" description: Too Many Requests summary: Update an index tags: - - Logs Indexes + - Logs Indexes x-codegen-request-body-name: body /api/v1/logs/config/pipeline-order: get: - description: 'Get the current order of your pipelines. - - This endpoint takes no JSON arguments.' + description: |- + Get the current order of your pipelines. + This endpoint takes no JSON arguments. operationId: GetLogsPipelineOrder responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsPipelinesOrder' + $ref: "#/components/schemas/LogsPipelinesOrder" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get pipeline order tags: - - Logs Pipelines - x-permission: + - Logs Pipelines + "x-permission": operator: OR permissions: - - logs_read_config + - logs_read_config put: - description: 'Update the order of your pipelines. Since logs are processed sequentially, - reordering a pipeline may change - - the structure and content of the data processed by other pipelines and their - processors. - - - **Note**: Using the `PUT` method updates your pipeline order by replacing - your current order + description: |- + Update the order of your pipelines. Since logs are processed sequentially, reordering a pipeline may change + the structure and content of the data processed by other pipelines and their processors. - with the new one sent to your Datadog organization.' + **Note**: Using the `PUT` method updates your pipeline order by replacing your current order + with the new one sent to your Datadog organization. operationId: UpdateLogsPipelineOrder requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogsPipelinesOrder' + $ref: "#/components/schemas/LogsPipelinesOrder" description: Object containing the new ordered list of pipeline IDs. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsPipelinesOrder' + $ref: "#/components/schemas/LogsPipelinesOrder" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/LogsAPIErrorResponse' + $ref: "#/components/schemas/LogsAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/LogsAPIErrorResponse' + $ref: "#/components/schemas/LogsAPIErrorResponse" description: Unprocessable Entity - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update pipeline order tags: - - Logs Pipelines + - Logs Pipelines x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_write_pipelines + - logs_write_pipelines /api/v1/logs/config/pipelines: get: - description: 'Get all pipelines from your organization. - - This endpoint takes no JSON arguments.' + description: |- + Get all pipelines from your organization. + This endpoint takes no JSON arguments. operationId: ListLogsPipelines responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsPipelineList' + $ref: "#/components/schemas/LogsPipelineList" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all pipelines tags: - - Logs Pipelines - x-permission: + - Logs Pipelines + "x-permission": operator: OR permissions: - - logs_read_config + - logs_read_config post: description: Create a pipeline in your organization. operationId: CreateLogsPipeline @@ -32015,598 +29400,666 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogsPipeline' + $ref: "#/components/schemas/LogsPipeline" description: Definition of the new pipeline. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsPipeline' + $ref: "#/components/schemas/LogsPipeline" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/LogsAPIErrorResponse' + $ref: "#/components/schemas/LogsAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a pipeline tags: - - Logs Pipelines + - Logs Pipelines x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_write_pipelines + - logs_write_pipelines /api/v1/logs/config/pipelines/{pipeline_id}: delete: - description: 'Delete a given pipeline from your organization. - - This endpoint takes no JSON arguments.' + description: |- + Delete a given pipeline from your organization. + This endpoint takes no JSON arguments. operationId: DeleteLogsPipeline parameters: - - description: ID of the pipeline to delete. - in: path - name: pipeline_id - required: true - schema: - type: string + - description: ID of the pipeline to delete. + in: path + name: pipeline_id + required: true + schema: + type: string responses: - '200': + "200": description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/LogsAPIErrorResponse' + $ref: "#/components/schemas/LogsAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a pipeline tags: - - Logs Pipelines - x-permission: + - Logs Pipelines + "x-permission": operator: OR permissions: - - logs_write_pipelines + - logs_write_pipelines get: - description: 'Get a specific pipeline from your organization. - - This endpoint takes no JSON arguments.' + description: |- + Get a specific pipeline from your organization. + This endpoint takes no JSON arguments. operationId: GetLogsPipeline parameters: - - description: ID of the pipeline to get. - in: path - name: pipeline_id - required: true - schema: - type: string + - description: ID of the pipeline to get. + in: path + name: pipeline_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsPipeline' + $ref: "#/components/schemas/LogsPipeline" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/LogsAPIErrorResponse' + $ref: "#/components/schemas/LogsAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a pipeline tags: - - Logs Pipelines - x-permission: + - Logs Pipelines + "x-permission": operator: OR permissions: - - logs_read_config + - logs_read_config put: - description: "Update a given pipeline configuration to change it\u2019s processors - or their order.\n\n**Note**: Using this method updates your pipeline configuration - by **replacing**\nyour current configuration with the new one sent to your - Datadog organization." + description: |- + Update a given pipeline configuration to change it’s processors or their order. + + **Note**: Using this method updates your pipeline configuration by **replacing** + your current configuration with the new one sent to your Datadog organization. operationId: UpdateLogsPipeline parameters: - - description: ID of the pipeline to delete. - in: path - name: pipeline_id - required: true - schema: - type: string + - description: ID of the pipeline to delete. + in: path + name: pipeline_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogsPipeline' + $ref: "#/components/schemas/LogsPipeline" description: New definition of the pipeline. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsPipeline' + $ref: "#/components/schemas/LogsPipeline" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/LogsAPIErrorResponse' + $ref: "#/components/schemas/LogsAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a pipeline tags: - - Logs Pipelines + - Logs Pipelines x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_write_pipelines + - logs_write_pipelines /api/v1/metrics: get: - description: Get the list of actively reporting metrics from a given time until - now. + description: Get the list of actively reporting metrics from a given time until now. operationId: ListActiveMetrics parameters: - - description: Seconds since the Unix epoch. - in: query - name: from - required: true - schema: - format: int64 - type: integer - - description: 'Hostname for filtering the list of metrics returned. - - If set, metrics retrieved are those with the corresponding hostname tag.' - in: query - name: host - required: false - schema: - type: string - - description: 'Filter metrics that have been submitted with the given tags. - Supports boolean and wildcard expressions. - - Cannot be combined with other filters.' - example: env IN (staging,test) AND service:web - in: query - name: tag_filter - required: false - schema: - type: string + - description: Seconds since the Unix epoch. + in: query + name: from + required: true + schema: + format: int64 + type: integer + - description: |- + Hostname for filtering the list of metrics returned. + If set, metrics retrieved are those with the corresponding hostname tag. + in: query + name: host + required: false + schema: + type: string + - description: |- + Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. + Cannot be combined with other filters. + example: "env IN (staging,test) AND service:web" + in: query + name: tag_filter + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MetricsListResponse' + $ref: "#/components/schemas/MetricsListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - metrics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - metrics_read summary: Get active metrics list tags: - - Metrics - x-permission: + - Metrics + "x-permission": operator: OR permissions: - - metrics_read + - metrics_read /api/v1/metrics/{metric_name}: get: description: Get metadata about a specific metric. operationId: GetMetricMetadata parameters: - - description: Name of the metric for which to get metadata. - in: path - name: metric_name - required: true - schema: - type: string + - description: Name of the metric for which to get metadata. + in: path + name: metric_name + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MetricMetadata' + $ref: "#/components/schemas/MetricMetadata" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - metrics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - metrics_read summary: Get metric metadata tags: - - Metrics - x-permission: + - Metrics + "x-permission": operator: OR permissions: - - metrics_read + - metrics_read put: - description: Edit metadata of a specific metric. Find out more about [supported - types](https://docs.datadoghq.com/developers/metrics). + description: |- + Edit metadata of a specific metric. Find out more about [supported types](https://docs.datadoghq.com/developers/metrics). operationId: UpdateMetricMetadata parameters: - - description: Name of the metric for which to edit metadata. - in: path - name: metric_name - required: true - schema: - type: string + - description: Name of the metric for which to edit metadata. + in: path + name: metric_name + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/MetricMetadata' + $ref: "#/components/schemas/MetricMetadata" description: New metadata. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MetricMetadata' + $ref: "#/components/schemas/MetricMetadata" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Edit metric metadata tags: - - Metrics + - Metrics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - metrics_metadata_write + - metrics_metadata_write /api/v1/monitor: get: - description: Get all monitors from your organization. + description: |- + Get all monitors from your organization. operationId: ListMonitors parameters: - - description: 'When specified, shows additional information about the group - states. - - Choose one or more from `all`, `alert`, `warn`, and `no data`.' - in: query - name: group_states - required: false - schema: - example: alert - type: string - - description: A string to filter monitors by name. - in: query - name: name - required: false - schema: - type: string - - description: 'A comma separated list indicating what tags, if any, should - be used to filter the list of monitors by scope. - - For example, `host:host0`.' - in: query - name: tags - required: false - schema: - example: host:host0 - type: string - - description: 'A comma separated list indicating what service and/or custom - tags, if any, should be used to filter the list of monitors. - - Tags created in the Datadog UI automatically have the service key prepended. - For example, `service:my-app`.' - in: query - name: monitor_tags - required: false - schema: - example: service:my-app - type: string - - description: If this argument is set to true, then the returned data includes - all current active downtimes for each monitor. - in: query - name: with_downtimes - required: false - schema: - type: boolean - - description: Use this parameter for paginating through large sets of monitors. - Start with a value of zero, make a request, set the value to the last ID - of result set, and then repeat until the response is empty. - in: query - name: id_offset - required: false - schema: - format: int64 - type: integer - - description: The page to start paginating from. If this argument is not specified, - the request returns all monitors without pagination. - in: query - name: page - required: false - schema: - example: 0 - format: int64 - type: integer - - description: The number of monitors to return per page. If the page argument - is not specified, the default behavior returns all monitors without a `page_size` - limit. However, if page is specified and `page_size` is not, the argument - defaults to 100. - in: query - name: page_size - required: false - schema: - default: 100 - example: 20 - format: int32 - maximum: 1000 - type: integer + - description: |- + When specified, shows additional information about the group states. + Choose one or more from `all`, `alert`, `warn`, and `no data`. + in: query + name: group_states + required: false + schema: + example: alert + type: string + - description: A string to filter monitors by name. + in: query + name: name + required: false + schema: + type: string + - description: |- + A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. + For example, `host:host0`. + in: query + name: tags + required: false + schema: + example: "host:host0" + type: string + - description: |- + A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors. + Tags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`. + in: query + name: monitor_tags + required: false + schema: + example: "service:my-app" + type: string + - description: If this argument is set to true, then the returned data includes all current active downtimes for each monitor. + in: query + name: with_downtimes + required: false + schema: + type: boolean + - description: Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty. + in: query + name: id_offset + required: false + schema: + format: int64 + type: integer + - description: The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination. + in: query + name: page + required: false + schema: + example: 0 + format: int64 + type: integer + - description: The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100. + in: query + name: page_size + required: false + schema: + default: 100 + example: 20 + format: int32 + maximum: 1000 + type: integer responses: - '200': + "200": content: application/json: schema: description: An array of monitor objects. items: - $ref: '#/components/schemas/Monitor' + $ref: "#/components/schemas/Monitor" type: array description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_read summary: Get all monitors tags: - - Monitors + - Monitors x-pagination: limitParam: page_size pageParam: page - x-permission: + "x-permission": operator: OR permissions: - - monitors_read + - monitors_read post: - description: "Create a monitor using the specified options.\n\n#### Monitor - Types\n\nThe type of monitor chosen from:\n\n- anomaly: `query alert`\n- APM: - `query alert` or `trace-analytics alert`\n- composite: `composite`\n- custom: - `service check`\n- forecast: `query alert`\n- host: `service check`\n- integration: - `query alert` or `service check`\n- live process: `process alert`\n- logs: - `log alert`\n- metric: `query alert`\n- network: `service check`\n- outlier: - `query alert`\n- process: `service check`\n- rum: `rum alert`\n- SLO: `slo - alert`\n- watchdog: `event-v2 alert`\n- event-v2: `event-v2 alert`\n- audit: - `audit alert`\n- error-tracking: `error-tracking alert`\n- database-monitoring: - `database-monitoring alert`\n- network-performance: `network-performance alert`\n- - cloud cost: `cost alert`\n- network-path: `network-path alert`\n\n**Notes**:\n- - Synthetic monitors are created through the Synthetics API. See the [Synthetics - API](https://docs.datadoghq.com/api/latest/synthetics/) documentation for - more information.\n- Log monitors require an unscoped App Key.\n\n#### Query - Types\n\n##### Metric Alert Query\n\nExample: `time_aggr(time_window):space_aggr:metric{tags} - [by {key}] operator #`\n\n- `time_aggr`: avg, sum, max, min, change, or pct_change\n- - `time_window`: `last_#m` (with `#` between 1 and 10080 depending on the monitor - type) or `last_#h`(with `#` between 1 and 168 depending on the monitor type) - or `last_1d`, or `last_1w`\n- `space_aggr`: avg, sum, min, or max\n- `tags`: - one or more tags (comma-separated), or *\n- `key`: a 'key' in key:value tag - syntax; defines a separate alert for each tag in the group (multi-alert)\n- - `operator`: <, <=, >, >=, ==, or !=\n- `#`: an integer or decimal number used - to set the threshold\n\nIf you are using the `_change_` or `_pct_change_` - time aggregator, instead use `change_aggr(time_aggr(time_window),\ntimeshift):space_aggr:metric{tags} - [by {key}] operator #` with:\n\n- `change_aggr` change, pct_change\n- `time_aggr` - avg, sum, max, min [Learn more](https://docs.datadoghq.com/monitors/create/types/#define-the-conditions)\n- - `time_window` last\\_#m (between 1 and 2880 depending on the monitor type), - last\\_#h (between 1 and 48 depending on the monitor type), or last_#d (1 - or 2)\n- `timeshift` #m_ago (5, 10, 15, or 30), #h_ago (1, 2, or 4), or 1d_ago\n\nUse - this to create an outlier monitor using the following query:\n`avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} - by {host}, 'dbscan', 7) > 0`\n\n##### Service Check Query\n\nExample: `\"check\".over(tags).last(count).by(group).count_by_status()`\n\n- - `check` name of the check, for example `datadog.agent.up`\n- `tags` one or - more quoted tags (comma-separated), or \"*\". for example: `.over(\"env:prod\", - \"role:db\")`; `over` cannot be blank.\n- `count` must be at greater than - or equal to your max threshold (defined in the `options`). It is limited to - 100.\nFor example, if you've specified to notify on 1 critical, 3 ok, and - 2 warn statuses, `count` should be at least 3.\n- `group` must be specified - for check monitors. Per-check grouping is already explicitly known for some - service checks.\nFor example, Postgres integration monitors are tagged by - `db`, `host`, and `port`, and Network monitors by `host`, `instance`, and - `url`. See [Service Checks](https://docs.datadoghq.com/api/latest/service-checks/) - documentation for more information.\n\n##### Event Alert Query\n\n**Note:** - The Event Alert Query has been replaced by the Event V2 Alert Query. For more - information, see the [Event Migration guide](https://docs.datadoghq.com/service_management/events/guides/migrating_to_new_events_features/).\n\n##### - Event V2 Alert Query\n\nExample: `events(query).rollup(rollup_method[, measure]).last(time_window) - operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- - `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`.\n- - `measure` For `avg` and cardinality `rollup_method` - specify the measure - or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), - #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- - `#` an integer or decimal number used to set the threshold.\n\n##### Process - Alert Query\n\nExample: `processes(search).over(tags).rollup('count').last(timeframe) - operator #`\n\n- `search` free text search string for querying processes.\nMatching - processes match results on the [Live Processes](https://docs.datadoghq.com/infrastructure/process/?tab=linuxwindows) - page.\n- `tags` one or more tags (comma-separated)\n- `timeframe` the timeframe - to roll up the counts. Examples: 10m, 4h. Supported timeframes: s, m, h and - d\n- `operator` <, <=, >, >=, ==, or !=\n- `#` an integer or decimal number - used to set the threshold\n\n##### Logs Alert Query\n\nExample: `logs(query).index(index_name).rollup(rollup_method[, - measure]).last(time_window) operator #`\n\n- `query` The search query - following - the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- - `index_name` For multi-index organizations, the log index in which the request - is performed.\n- `rollup_method` The stats roll-up method - supports `count`, - `avg` and `cardinality`.\n- `measure` For `avg` and cardinality `rollup_method` - - specify the measure or the facet name you want to use.\n- `time_window` - #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, - `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n##### - Composite Query\n\nExample: `12345 && 67890`, where `12345` and `67890` are - the IDs of non-composite monitors\n\n* `name` [*required*, *default* = **dynamic, - based on query**]: The name of the alert.\n* `message` [*required*, *default* - = **dynamic, based on query**]: A message to include with notifications for - this monitor.\nEmail notifications can be sent to specific users by using - the same '@username' notation as events.\n* `tags` [*optional*, *default* - = **empty list**]: A list of tags to associate with your monitor.\nWhen getting - all monitor details via the API, use the `monitor_tags` argument to filter - results by these tags.\nIt is only available via the API and isn't visible - or editable in the Datadog UI.\n\n##### SLO Alert Query\n\nExample: `error_budget(\"slo_id\").over(\"time_window\") - operator #`\n\n- `slo_id`: The alphanumeric SLO ID of the SLO you are configuring - the alert for.\n- `time_window`: The time window of the SLO target you wish - to alert on. Valid options: `7d`, `30d`, `90d`.\n- `operator`: `>=` or `>`\n\n##### - Audit Alert Query\n\nExample: `audits(query).rollup(rollup_method[, measure]).last(time_window) - operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- - `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`.\n- - `measure` For `avg` and cardinality `rollup_method` - specify the measure - or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), - #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- - `#` an integer or decimal number used to set the threshold.\n\n##### CI Pipelines - Alert Query\n\nExample: `ci-pipelines(query).rollup(rollup_method[, measure]).last(time_window) - operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.\n- - `measure` For `avg` and cardinality `rollup_method` - specify the measure - or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), - #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- - `#` an integer or decimal number used to set the threshold.\n\n##### CI Tests - Alert Query\n\nExample: `ci-tests(query).rollup(rollup_method[, measure]).last(time_window) - operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.\n- - `measure` For `avg` and cardinality `rollup_method` - specify the measure - or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), - #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- - `#` an integer or decimal number used to set the threshold.\n\n##### Error - Tracking Alert Query\n\n\"New issue\" example: `error-tracking(query).source(issue_source).new().rollup(rollup_method[, - measure]).by(group_by).last(time_window) operator #`\n\"High impact issue\" - example: `error-tracking(query).source(issue_source).impact().rollup(rollup_method[, - measure]).by(group_by).last(time_window) operator #`\n\n- `query` The search - query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- - `issue_source` The issue source - supports `all`, `browser`, `mobile` and - `backend` and defaults to `all` if omitted.\n- `rollup_method` The stats roll-up - method - supports `count`, `avg`, and `cardinality` and defaults to `count` - if omitted.\n- `measure` For `avg` and cardinality `rollup_method` - specify - the measure or the facet name you want to use.\n- `group by` Comma-separated - list of attributes to group by - should contain at least `issue.id`.\n- `time_window` - #m (between 1 and 2880), #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, - `>=`, `==`, or `!=`.\n- `#` an integer or decimal number used to set the threshold.\n\n**Database - Monitoring Alert Query**\n\nExample: `database-monitoring(query).rollup(rollup_method[, - measure]).last(time_window) operator #`\n\n- `query` The search query - following - the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.\n- - `measure` For `avg` and cardinality `rollup_method` - specify the measure - or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), - #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- - `#` an integer or decimal number used to set the threshold.\n\n**Network Performance - Alert Query**\n\nExample: `network-performance(query).rollup(rollup_method[, - measure]).last(time_window) operator #`\n\n- `query` The search query - following - the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.\n- - `measure` For `avg` and cardinality `rollup_method` - specify the measure - or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), - #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- - `#` an integer or decimal number used to set the threshold.\n\n**Cost Alert - Query**\n\nExample: `formula(query).timeframe_type(time_window).function(parameter) - operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- - `timeframe_type` The timeframe type to evaluate the cost\n - for `forecast` - supports `current`\n - for `change`, `anomaly`, `threshold` supports - `last`\n- `time_window` - supports daily roll-up e.g. `7d`\n- `function` - - [optional, defaults to `threshold` monitor if omitted] supports `change`, - `anomaly`, `forecast`\n- `parameter` Specify the parameter of the type\n - - for `change`:\n - supports `relative`, `absolute`\n - [optional] - supports `#`, where `#` is an integer or decimal number used to set the threshold\n - \ - for `anomaly`:\n - supports `direction=both`, `direction=above`, - `direction=below`\n - [optional] supports `threshold=#`, where `#` - is an integer or decimal number used to set the threshold\n- `operator`\n - \ - for `threshold` supports `<`, `<=`, `>`, `>=`, `==`, or `!=`\n - - for `change` supports `>`, `<`\n - for `anomaly` supports `>=`\n - for - `forecast` supports `>`\n- `#` an integer or decimal number used to set the - threshold.\n\n**Network Path Alert Query**\n\nExample: `network-path(query).index(index_name).rollup(rollup_method[, - measure]).last(time_window) operator #`\n\n- `query` The search query - following - the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n- - `index_name` The data type to monitor on - supports `netpath-path` and `netpath-hop`.\n- - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.\n- - `measure` For `avg` and cardinality `rollup_method` - specify the measure - or the facet name you want to use.\n- `time_window` #m (between 1 and 2880), - #h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- - `#` an integer or decimal number used to set the threshold." + description: |- + Create a monitor using the specified options. + + #### Monitor Types + + The type of monitor chosen from: + + - anomaly: `query alert` + - APM: `query alert` or `trace-analytics alert` + - composite: `composite` + - custom: `service check` + - forecast: `query alert` + - host: `service check` + - integration: `query alert` or `service check` + - live process: `process alert` + - logs: `log alert` + - metric: `query alert` + - network: `service check` + - outlier: `query alert` + - process: `service check` + - rum: `rum alert` + - SLO: `slo alert` + - watchdog: `event-v2 alert` + - event-v2: `event-v2 alert` + - audit: `audit alert` + - error-tracking: `error-tracking alert` + - database-monitoring: `database-monitoring alert` + - network-performance: `network-performance alert` + - cloud cost: `cost alert` + - network-path: `network-path alert` + + **Notes**: + - Synthetic monitors are created through the Synthetics API. See the [Synthetics API](https://docs.datadoghq.com/api/latest/synthetics/) documentation for more information. + - Log monitors require an unscoped App Key. + + #### Query Types + + ##### Metric Alert Query + + Example: `time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator #` + + - `time_aggr`: avg, sum, max, min, change, or pct_change + - `time_window`: `last_#m` (with `#` between 1 and 10080 depending on the monitor type) or `last_#h`(with `#` between 1 and 168 depending on the monitor type) or `last_1d`, or `last_1w` + - `space_aggr`: avg, sum, min, or max + - `tags`: one or more tags (comma-separated), or * + - `key`: a 'key' in key:value tag syntax; defines a separate alert for each tag in the group (multi-alert) + - `operator`: <, <=, >, >=, ==, or != + - `#`: an integer or decimal number used to set the threshold + + If you are using the `_change_` or `_pct_change_` time aggregator, instead use `change_aggr(time_aggr(time_window), + timeshift):space_aggr:metric{tags} [by {key}] operator #` with: + + - `change_aggr` change, pct_change + - `time_aggr` avg, sum, max, min [Learn more](https://docs.datadoghq.com/monitors/create/types/#define-the-conditions) + - `time_window` last\_#m (between 1 and 2880 depending on the monitor type), last\_#h (between 1 and 48 depending on the monitor type), or last_#d (1 or 2) + - `timeshift` #m_ago (5, 10, 15, or 30), #h_ago (1, 2, or 4), or 1d_ago + + Use this to create an outlier monitor using the following query: + `avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0` + + ##### Service Check Query + + Example: `"check".over(tags).last(count).by(group).count_by_status()` + + - `check` name of the check, for example `datadog.agent.up` + - `tags` one or more quoted tags (comma-separated), or "*". for example: `.over("env:prod", "role:db")`; `over` cannot be blank. + - `count` must be at greater than or equal to your max threshold (defined in the `options`). It is limited to 100. + For example, if you've specified to notify on 1 critical, 3 ok, and 2 warn statuses, `count` should be at least 3. + - `group` must be specified for check monitors. Per-check grouping is already explicitly known for some service checks. + For example, Postgres integration monitors are tagged by `db`, `host`, and `port`, and Network monitors by `host`, `instance`, and `url`. See [Service Checks](https://docs.datadoghq.com/api/latest/service-checks/) documentation for more information. + + ##### Event Alert Query + + **Note:** The Event Alert Query has been replaced by the Event V2 Alert Query. For more information, see the [Event Migration guide](https://docs.datadoghq.com/service_management/events/guides/migrating_to_new_events_features/). + + ##### Event V2 Alert Query + + Example: `events(query).rollup(rollup_method[, measure]).last(time_window) operator #` + + - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). + - `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`. + - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. + - `time_window` #m (between 1 and 2880), #h (between 1 and 48). + - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. + - `#` an integer or decimal number used to set the threshold. + + ##### Process Alert Query + + Example: `processes(search).over(tags).rollup('count').last(timeframe) operator #` + + - `search` free text search string for querying processes. + Matching processes match results on the [Live Processes](https://docs.datadoghq.com/infrastructure/process/?tab=linuxwindows) page. + - `tags` one or more tags (comma-separated) + - `timeframe` the timeframe to roll up the counts. Examples: 10m, 4h. Supported timeframes: s, m, h and d + - `operator` <, <=, >, >=, ==, or != + - `#` an integer or decimal number used to set the threshold + + ##### Logs Alert Query + + Example: `logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #` + + - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). + - `index_name` For multi-index organizations, the log index in which the request is performed. + - `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`. + - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. + - `time_window` #m (between 1 and 2880), #h (between 1 and 48). + - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. + - `#` an integer or decimal number used to set the threshold. + + ##### Composite Query + + Example: `12345 && 67890`, where `12345` and `67890` are the IDs of non-composite monitors + + * `name` [*required*, *default* = **dynamic, based on query**]: The name of the alert. + * `message` [*required*, *default* = **dynamic, based on query**]: A message to include with notifications for this monitor. + Email notifications can be sent to specific users by using the same '@username' notation as events. + * `tags` [*optional*, *default* = **empty list**]: A list of tags to associate with your monitor. + When getting all monitor details via the API, use the `monitor_tags` argument to filter results by these tags. + It is only available via the API and isn't visible or editable in the Datadog UI. + + ##### SLO Alert Query + + Example: `error_budget("slo_id").over("time_window") operator #` + + - `slo_id`: The alphanumeric SLO ID of the SLO you are configuring the alert for. + - `time_window`: The time window of the SLO target you wish to alert on. Valid options: `7d`, `30d`, `90d`. + - `operator`: `>=` or `>` + + ##### Audit Alert Query + + Example: `audits(query).rollup(rollup_method[, measure]).last(time_window) operator #` + + - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). + - `rollup_method` The stats roll-up method - supports `count`, `avg` and `cardinality`. + - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. + - `time_window` #m (between 1 and 2880), #h (between 1 and 48). + - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. + - `#` an integer or decimal number used to set the threshold. + + ##### CI Pipelines Alert Query + + Example: `ci-pipelines(query).rollup(rollup_method[, measure]).last(time_window) operator #` + + - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). + - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`. + - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. + - `time_window` #m (between 1 and 2880), #h (between 1 and 48). + - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. + - `#` an integer or decimal number used to set the threshold. + + ##### CI Tests Alert Query + + Example: `ci-tests(query).rollup(rollup_method[, measure]).last(time_window) operator #` + + - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). + - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`. + - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. + - `time_window` #m (between 1 and 2880), #h (between 1 and 48). + - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. + - `#` an integer or decimal number used to set the threshold. + + ##### Error Tracking Alert Query + + "New issue" example: `error-tracking(query).source(issue_source).new().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #` + "High impact issue" example: `error-tracking(query).source(issue_source).impact().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #` + + - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). + - `issue_source` The issue source - supports `all`, `browser`, `mobile` and `backend` and defaults to `all` if omitted. + - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality` and defaults to `count` if omitted. + - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. + - `group by` Comma-separated list of attributes to group by - should contain at least `issue.id`. + - `time_window` #m (between 1 and 2880), #h (between 1 and 48). + - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. + - `#` an integer or decimal number used to set the threshold. + + **Database Monitoring Alert Query** + + Example: `database-monitoring(query).rollup(rollup_method[, measure]).last(time_window) operator #` + + - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). + - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`. + - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. + - `time_window` #m (between 1 and 2880), #h (between 1 and 48). + - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. + - `#` an integer or decimal number used to set the threshold. + + **Network Performance Alert Query** + + Example: `network-performance(query).rollup(rollup_method[, measure]).last(time_window) operator #` + + - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). + - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`. + - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. + - `time_window` #m (between 1 and 2880), #h (between 1 and 48). + - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. + - `#` an integer or decimal number used to set the threshold. + + **Cost Alert Query** + + Example: `formula(query).timeframe_type(time_window).function(parameter) operator #` + + - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). + - `timeframe_type` The timeframe type to evaluate the cost + - for `forecast` supports `current` + - for `change`, `anomaly`, `threshold` supports `last` + - `time_window` - supports daily roll-up e.g. `7d` + - `function` - [optional, defaults to `threshold` monitor if omitted] supports `change`, `anomaly`, `forecast` + - `parameter` Specify the parameter of the type + - for `change`: + - supports `relative`, `absolute` + - [optional] supports `#`, where `#` is an integer or decimal number used to set the threshold + - for `anomaly`: + - supports `direction=both`, `direction=above`, `direction=below` + - [optional] supports `threshold=#`, where `#` is an integer or decimal number used to set the threshold + - `operator` + - for `threshold` supports `<`, `<=`, `>`, `>=`, `==`, or `!=` + - for `change` supports `>`, `<` + - for `anomaly` supports `>=` + - for `forecast` supports `>` + - `#` an integer or decimal number used to set the threshold. + + **Network Path Alert Query** + + Example: `network-path(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #` + + - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/). + - `index_name` The data type to monitor on - supports `netpath-path` and `netpath-hop`. + - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`. + - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use. + - `time_window` #m (between 1 and 2880), #h (between 1 and 48). + - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`. + - `#` an integer or decimal number used to set the threshold. operationId: CreateMonitor requestBody: content: @@ -32614,895 +30067,860 @@ paths: examples: json-request-body: value: - message: You may need to add web hosts if this is consistently high. - name: Bytes received on host0 + message: "You may need to add web hosts if this is consistently high." + name: "Bytes received on host0" options: no_data_timeframe: 20 notify_no_data: true - query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100 - tags: - - app:webserver - - frontend - type: query alert + query: "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100" + tags: ["app:webserver", "frontend"] + type: "query alert" schema: - $ref: '#/components/schemas/Monitor' + $ref: "#/components/schemas/Monitor" description: Create a monitor request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Monitor' + $ref: "#/components/schemas/Monitor" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_write summary: Create a monitor tags: - - Monitors + - Monitors x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - monitors_write + - monitors_write /api/v1/monitor/can_delete: get: description: Check if the given monitors can be deleted. operationId: CheckCanDeleteMonitor parameters: - - description: The IDs of the monitor to check. - explode: false - in: query - name: monitor_ids - required: true - schema: - items: - example: 666486743 - format: int64 - type: integer - type: array - style: form + - description: The IDs of the monitor to check. + explode: false + in: query + name: monitor_ids + required: true + schema: + items: + example: 666486743 + format: int64 + type: integer + type: array + style: form responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CheckCanDeleteMonitorResponse' + $ref: "#/components/schemas/CheckCanDeleteMonitorResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/CheckCanDeleteMonitorResponse' + $ref: "#/components/schemas/CheckCanDeleteMonitorResponse" description: Deletion conflict error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_read summary: Check if a monitor can be deleted tags: - - Monitors - x-permission: + - Monitors + "x-permission": operator: OR permissions: - - monitors_read + - monitors_read /api/v1/monitor/groups/search: get: - description: Search and filter your monitor groups details. + description: |- + Search and filter your monitor groups details. operationId: SearchMonitorGroups parameters: - - description: 'After entering a search query on the [Triggered Monitors page][1], - use the query parameter value in the - - URL of the page as a value for this parameter. For more information, see - the [Manage Monitors documentation][2]. - - - The query can contain any number of space-separated monitor attributes, - for instance: `query="type:metric group_status:alert"`. - - - [1]: https://app.datadoghq.com/monitors/triggered - - [2]: /monitors/manage/#triggered-monitors' - in: query - name: query - required: false - schema: - type: string - - description: Page to start paginating from. - in: query - name: page - required: false - schema: - default: 0 - format: int64 - type: integer - - description: Number of monitors to return per page. - in: query - name: per_page - required: false - schema: - default: 30 - format: int64 - type: integer - - description: 'String for sort order, composed of field and sort order separate - by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. - Supported fields: - + - description: |- + After entering a search query on the [Triggered Monitors page][1], use the query parameter value in the + URL of the page as a value for this parameter. For more information, see the [Manage Monitors documentation][2]. - * `name` + The query can contain any number of space-separated monitor attributes, for instance: `query="type:metric group_status:alert"`. - * `status` - - * `tags`' - in: query - name: sort - required: false - schema: - type: string + [1]: https://app.datadoghq.com/monitors/triggered + [2]: /monitors/manage/#triggered-monitors + in: query + name: query + required: false + schema: + type: string + - description: Page to start paginating from. + in: query + name: page + required: false + schema: + default: 0 + format: int64 + type: integer + - description: Number of monitors to return per page. + in: query + name: per_page + required: false + schema: + default: 30 + format: int64 + type: integer + - description: |- + String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields: + + * `name` + * `status` + * `tags` + in: query + name: sort + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MonitorGroupSearchResponse' + $ref: "#/components/schemas/MonitorGroupSearchResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_read summary: Monitors group search tags: - - Monitors - x-permission: + - Monitors + "x-permission": operator: OR permissions: - - monitors_read + - monitors_read /api/v1/monitor/search: get: - description: Search and filter your monitors details. + description: |- + Search and filter your monitors details. operationId: SearchMonitors parameters: - - description: 'After entering a search query in your [Manage Monitor page][1] - use the query parameter value in the - - URL of the page as value for this parameter. Consult the dedicated [manage - monitor documentation][2] - - page to learn more. - - - The query can contain any number of space-separated monitor attributes, - for instance `query="type:metric status:alert"`. - - - [1]: https://app.datadoghq.com/monitors/manage - - [2]: /monitors/manage/#find-the-monitors' - in: query - name: query - required: false - schema: - type: string - - description: Page to start paginating from. - in: query - name: page - required: false - schema: - default: 0 - format: int64 - type: integer - - description: Number of monitors to return per page. - in: query - name: per_page - required: false - schema: - default: 30 - format: int64 - type: integer - - description: 'String for sort order, composed of field and sort order separate - by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. - Supported fields: - - - * `name` - - * `status` - - * `tags`' - in: query - name: sort - required: false - schema: - type: string + - description: |- + After entering a search query in your [Manage Monitor page][1] use the query parameter value in the + URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2] + page to learn more. + + The query can contain any number of space-separated monitor attributes, for instance `query="type:metric status:alert"`. + + [1]: https://app.datadoghq.com/monitors/manage + [2]: /monitors/manage/#find-the-monitors + in: query + name: query + required: false + schema: + type: string + - description: Page to start paginating from. + in: query + name: page + required: false + schema: + default: 0 + format: int64 + type: integer + - description: Number of monitors to return per page. + in: query + name: per_page + required: false + schema: + default: 30 + format: int64 + type: integer + - description: |- + String for sort order, composed of field and sort order separate by a comma, for example `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields: + + * `name` + * `status` + * `tags` + in: query + name: sort + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MonitorSearchResponse' + $ref: "#/components/schemas/MonitorSearchResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_read summary: Monitors search tags: - - Monitors - x-permission: + - Monitors + "x-permission": operator: OR permissions: - - monitors_read + - monitors_read /api/v1/monitor/validate: post: - description: 'Validate the monitor provided in the request. - + description: |- + Validate the monitor provided in the request. - **Note**: Log monitors require an unscoped App Key.' + **Note**: Log monitors require an unscoped App Key. operationId: ValidateMonitor requestBody: content: application/json: schema: - $ref: '#/components/schemas/Monitor' + $ref: "#/components/schemas/Monitor" description: Monitor request object required: true responses: - '200': + "200": content: application/json: schema: example: {} type: object description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Invalid JSON - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_read summary: Validate a monitor tags: - - Monitors + - Monitors x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - monitors_read + - monitors_read /api/v1/monitor/{monitor_id}: delete: description: Delete the specified monitor operationId: DeleteMonitor parameters: - - description: The ID of the monitor. - in: path - name: monitor_id - required: true - schema: - example: 666486743 - format: int64 - type: integer - - description: Delete the monitor even if it's referenced by other resources - (for example SLO, composite monitor). - in: query - name: force - required: false - schema: - example: 'false' - type: string + - description: The ID of the monitor. + in: path + name: monitor_id + required: true + schema: + example: 666486743 + format: int64 + type: integer + - description: Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor). + in: query + name: force + required: false + schema: + example: "false" + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DeletedMonitor' + $ref: "#/components/schemas/DeletedMonitor" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Item not found error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_write summary: Delete a monitor tags: - - Monitors - x-permission: + - Monitors + "x-permission": operator: OR permissions: - - monitors_write + - monitors_write get: description: Get details about the specified monitor from your organization. operationId: GetMonitor parameters: - - description: The ID of the monitor - in: path - name: monitor_id - required: true - schema: - example: 666486743 - format: int64 - type: integer - - description: When specified, shows additional information about the group - states. Choose one or more from `all`, `alert`, `warn`, and `no data`. - in: query - name: group_states - required: false - schema: - type: string - - description: If this argument is set to true, then the returned data includes - all current active downtimes for the monitor. - in: query - name: with_downtimes - required: false - schema: - type: boolean - - description: If this argument is set to `true`, the returned data includes - all assets tied to this monitor. - in: query - name: with_assets - required: false - schema: - type: boolean + - description: The ID of the monitor + in: path + name: monitor_id + required: true + schema: + example: 666486743 + format: int64 + type: integer + - description: When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. + in: query + name: group_states + required: false + schema: + type: string + - description: If this argument is set to true, then the returned data includes all current active downtimes for the monitor. + in: query + name: with_downtimes + required: false + schema: + type: boolean + - description: If this argument is set to `true`, the returned data includes all assets tied to this monitor. + in: query + name: with_assets + required: false + schema: + type: boolean responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Monitor' + $ref: "#/components/schemas/Monitor" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Monitor Not Found error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_read summary: Get a monitor's details tags: - - Monitors - x-permission: + - Monitors + "x-permission": operator: OR permissions: - - monitors_read + - monitors_read put: description: Edit the specified monitor. operationId: UpdateMonitor parameters: - - description: The ID of the monitor. - in: path - name: monitor_id - required: true - schema: - example: 666486743 - format: int64 - type: integer + - description: The ID of the monitor. + in: path + name: monitor_id + required: true + schema: + example: 666486743 + format: int64 + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/MonitorUpdateRequest' + $ref: "#/components/schemas/MonitorUpdateRequest" description: Edit a monitor request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Monitor' + $ref: "#/components/schemas/Monitor" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Monitor Not Found error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_write summary: Edit a monitor tags: - - Monitors + - Monitors x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - monitors_write + - monitors_write /api/v1/monitor/{monitor_id}/downtimes: get: deprecated: true - description: Get all active v1 downtimes for the specified monitor. **Note:** - This endpoint has been deprecated. Please use v2 endpoints. + description: |- + Get all active v1 downtimes for the specified monitor. **Note:** This endpoint has been deprecated. Please use v2 endpoints. operationId: ListMonitorDowntimes parameters: - - description: The id of the monitor - in: path - name: monitor_id - required: true - schema: - format: int64 - type: integer + - description: The id of the monitor + in: path + name: monitor_id + required: true + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: items: - $ref: '#/components/schemas/Downtime' + $ref: "#/components/schemas/Downtime" type: array description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Monitor Not Found error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_read summary: Get active downtimes for a monitor tags: - - Downtimes + - Downtimes x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - monitors_read + - monitors_read /api/v1/monitor/{monitor_id}/validate: post: description: Validate the monitor provided in the request. operationId: ValidateExistingMonitor parameters: - - description: The ID of the monitor - in: path - name: monitor_id - required: true - schema: - example: 666486743 - format: int64 - type: integer + - description: The ID of the monitor + in: path + name: monitor_id + required: true + schema: + example: 666486743 + format: int64 + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/Monitor' + $ref: "#/components/schemas/Monitor" description: Monitor request object required: true responses: - '200': + "200": content: application/json: schema: example: {} type: object description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Invalid JSON - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_read summary: Validate an existing monitor tags: - - Monitors + - Monitors x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - monitors_read + - monitors_read /api/v1/monthly_custom_reports: get: deprecated: true - description: 'Get monthly custom reports. - + description: |- + Get monthly custom reports. **Note:** This endpoint will be fully deprecated on December 1, 2022. - - Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) - for the associated migration guide.' + Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) for the associated migration guide. operationId: GetMonthlyCustomReports parameters: - - description: The number of files to return in the response `[default=60].` - in: query - name: page[size] - required: false - schema: - format: int64 - type: integer - - description: The identifier of the first page to return. This parameter is - used for the pagination feature `[default=0]`. - in: query - name: page[number] - required: false - schema: - format: int64 - type: integer - - description: 'The direction to sort by: `[desc, asc]`.' - in: query - name: sort_dir - required: false - schema: - $ref: '#/components/schemas/UsageSortDirection' - - description: 'The field to sort by: `[computed_on, size, start_date, end_date]`.' - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/UsageSort' + - description: The number of files to return in the response `[default=60].` + in: query + name: page[size] + required: false + schema: + format: int64 + type: integer + - description: The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. + in: query + name: page[number] + required: false + schema: + format: int64 + type: integer + - description: "The direction to sort by: `[desc, asc]`." + in: query + name: sort_dir + required: false + schema: + $ref: "#/components/schemas/UsageSortDirection" + - description: "The field to sort by: `[computed_on, size, start_date, end_date]`." + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/UsageSort" responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageCustomReportsResponse' + $ref: "#/components/schemas/UsageCustomReportsResponse" description: OK - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests summary: Get the list of available monthly custom reports tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/monthly_custom_reports/{report_id}: get: deprecated: true - description: 'Get specified monthly custom reports. - + description: |- + Get specified monthly custom reports. **Note:** This endpoint will be fully deprecated on December 1, 2022. - - Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) - for the associated migration guide.' + Refer to [Migrating from v1 to v2 of the Usage Attribution API](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) for the associated migration guide. operationId: GetSpecifiedMonthlyCustomReports parameters: - - description: Date of the report in the format `YYYY-MM-DD`. - in: path - name: report_id - required: true - schema: - type: string + - description: Date of the report in the format `YYYY-MM-DD`. + in: path + name: report_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageSpecifiedCustomReportsResponse' + $ref: "#/components/schemas/UsageSpecifiedCustomReportsResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '404': + "404": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests summary: Get specified monthly custom reports tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/notebooks: get: - description: 'Get all notebooks. This can also be used to search for notebooks - with a particular `query` in the notebook - - `name` or author `handle`.' + description: |- + Get all notebooks. This can also be used to search for notebooks with a particular `query` in the notebook + `name` or author `handle`. operationId: ListNotebooks parameters: - - description: Return notebooks created by the given `author_handle`. - in: query - name: author_handle - required: false - schema: - example: test@datadoghq.com - type: string - style: form - - description: Return notebooks not created by the given `author_handle`. - in: query - name: exclude_author_handle - required: false - schema: - example: test@datadoghq.com - type: string - style: form - - description: The index of the first notebook you want returned. - in: query - name: start - required: false - schema: - example: 0 - format: int64 - type: integer - style: form - - description: The number of notebooks to be returned. - in: query - name: count - required: false - schema: - default: 100 - example: 5 - format: int64 - type: integer - style: form - - description: Sort by field `modified`, `name`, or `created`. - in: query - name: sort_field - required: false - schema: - default: modified - example: modified - type: string - style: form - - description: Sort by direction `asc` or `desc`. - in: query - name: sort_dir - required: false - schema: - default: desc - example: desc - type: string - style: form - - description: Return only notebooks with `query` string in notebook name or - author handle. - in: query - name: query - required: false - schema: - example: postmortem - type: string - style: form - - description: Value of `false` excludes the `cells` and global `time` for each - notebook. - in: query - name: include_cells - required: false - schema: - default: true - example: false - type: boolean - style: form - - description: True value returns only template notebooks. Default is false - (returns only non-template notebooks). - in: query - name: is_template - required: false - schema: - default: false - example: false - type: boolean - style: form - - description: If type is provided, returns only notebooks with that metadata - type. Default does not have type filtering. - in: query - name: type - required: false - schema: - example: investigation - type: string - style: form + - description: Return notebooks created by the given `author_handle`. + in: query + name: author_handle + required: false + schema: + example: test@datadoghq.com + type: string + style: form + - description: Return notebooks not created by the given `author_handle`. + in: query + name: exclude_author_handle + required: false + schema: + example: test@datadoghq.com + type: string + style: form + - description: The index of the first notebook you want returned. + in: query + name: start + required: false + schema: + example: 0 + format: int64 + type: integer + style: form + - description: The number of notebooks to be returned. + in: query + name: count + required: false + schema: + default: 100 + example: 5 + format: int64 + type: integer + style: form + - description: Sort by field `modified`, `name`, or `created`. + in: query + name: sort_field + required: false + schema: + default: modified + example: modified + type: string + style: form + - description: Sort by direction `asc` or `desc`. + in: query + name: sort_dir + required: false + schema: + default: desc + example: desc + type: string + style: form + - description: Return only notebooks with `query` string in notebook name or author handle. + in: query + name: query + required: false + schema: + example: postmortem + type: string + style: form + - description: Value of `false` excludes the `cells` and global `time` for each notebook. + in: query + name: include_cells + required: false + schema: + default: true + example: false + type: boolean + style: form + - description: True value returns only template notebooks. Default is false (returns only non-template notebooks). + in: query + name: is_template + required: false + schema: + default: false + example: false + type: boolean + style: form + - description: If type is provided, returns only notebooks with that metadata type. Default does not have type filtering. + in: query + name: type + required: false + schema: + example: investigation + type: string + style: form responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/NotebooksResponse' + $ref: "#/components/schemas/NotebooksResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all notebooks tags: - - Notebooks + - Notebooks x-pagination: limitParam: count pageOffsetParam: start resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - notebooks_read + - notebooks_read post: description: Create a notebook using the specified options. operationId: CreateNotebook @@ -33511,935 +30929,854 @@ paths: application/json: examples: json-request-body: - value: - data: - attributes: - cells: - - attributes: - definition: - text: '## Some test markdown - - - With some example content.' - type: markdown - type: notebook_cells - - attributes: - definition: - requests: - - display_type: line - q: avg:system.load.1{*} - style: - line_type: solid - line_width: normal - palette: dog_classic - show_legend: true - type: timeseries - yaxis: - scale: linear - graph_size: m - split_by: - keys: [] - tags: [] - time: null - type: notebook_cells - name: Example Notebook - time: - live_span: 1h - type: notebooks + value: {"data": {"attributes": {"cells": [{"attributes": {"definition": {"text": "## Some test markdown\n\nWith some example content.", "type": "markdown"}}, "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "type": "notebook_cells"}], "name": "Example Notebook", "time": {"live_span": "1h"}}, "type": "notebooks"}} schema: - $ref: '#/components/schemas/NotebookCreateRequest' + $ref: "#/components/schemas/NotebookCreateRequest" description: The JSON description of the notebook you want to create. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/NotebookResponse' + $ref: "#/components/schemas/NotebookResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a notebook tags: - - Notebooks + - Notebooks x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - notebooks_write + - notebooks_write /api/v1/notebooks/{notebook_id}: delete: description: Delete a notebook using the specified ID. operationId: DeleteNotebook parameters: - - description: Unique ID, assigned when you create the notebook. - in: path - name: notebook_id - required: true - schema: - format: int64 - type: integer + - description: Unique ID, assigned when you create the notebook. + in: path + name: notebook_id + required: true + schema: + format: int64 + type: integer responses: - '204': + "204": description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a notebook tags: - - Notebooks - x-permission: + - Notebooks + "x-permission": operator: OR permissions: - - notebooks_write + - notebooks_write get: description: Get a notebook using the specified notebook ID. operationId: GetNotebook parameters: - - description: Unique ID, assigned when you create the notebook. - in: path - name: notebook_id - required: true - schema: - format: int64 - type: integer + - description: Unique ID, assigned when you create the notebook. + in: path + name: notebook_id + required: true + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/NotebookResponse' + $ref: "#/components/schemas/NotebookResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a notebook tags: - - Notebooks - x-permission: + - Notebooks + "x-permission": operator: OR permissions: - - notebooks_read + - notebooks_read put: description: Update a notebook using the specified ID. operationId: UpdateNotebook parameters: - - description: Unique ID, assigned when you create the notebook. - in: path - name: notebook_id - required: true - schema: - format: int64 - type: integer + - description: Unique ID, assigned when you create the notebook. + in: path + name: notebook_id + required: true + schema: + format: int64 + type: integer requestBody: content: application/json: examples: json-request-body: - value: - data: - attributes: - cells: - - attributes: - definition: - text: '## Some updated test markdown - - - With some example content.' - type: markdown - type: notebook_cells - - attributes: - definition: - requests: - - display_type: bars - q: avg:system.load.1{*} - style: - line_type: solid - line_width: normal - palette: warm - show_legend: true - type: timeseries - yaxis: - scale: linear - graph_size: m - split_by: - keys: [] - tags: [] - time: null - id: abcd1234 - type: notebook_cells - name: Example Notebook - time: - live_span: 1h - type: notebooks + value: {"data": {"attributes": {"cells": [{"attributes": {"definition": {"text": "## Some updated test markdown\n\nWith some example content.", "type": "markdown"}}, "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "bars", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "warm"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "id": "abcd1234", "type": "notebook_cells"}], "name": "Example Notebook", "time": {"live_span": "1h"}}, "type": "notebooks"}} schema: - $ref: '#/components/schemas/NotebookUpdateRequest' + $ref: "#/components/schemas/NotebookUpdateRequest" description: Update notebook request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/NotebookResponse' + $ref: "#/components/schemas/NotebookResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Conflict - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a notebook tags: - - Notebooks + - Notebooks x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - notebooks_write + - notebooks_write /api/v1/org: get: description: This endpoint returns data on your top-level organization. operationId: ListOrgs responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OrganizationListResponse' + $ref: "#/components/schemas/OrganizationListResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List your managed organizations tags: - - Organizations - x-permission: + - Organizations + "x-permission": operator: OR permissions: - - org_management + - org_management post: - description: 'Create a child organization. - + description: |- + Create a child organization. This endpoint requires the - [multi-organization account](https://docs.datadoghq.com/account_management/multi_organization/) - feature and must be enabled by - [contacting support](https://docs.datadoghq.com/help/). - Once a new child organization is created, you can interact with it - by using the `org.public_id`, `api_key.key`, and - - `application_key.hash` provided in the response.' + `application_key.hash` provided in the response. operationId: CreateChildOrg requestBody: content: application/json: schema: - $ref: '#/components/schemas/OrganizationCreateBody' + $ref: "#/components/schemas/OrganizationCreateBody" description: Organization object that needs to be created required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OrganizationCreateResponse' + $ref: "#/components/schemas/OrganizationCreateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a child organization tags: - - Organizations + - Organizations x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - org_management + - org_management /api/v1/org/{public_id}: get: description: Get organization information. operationId: GetOrg parameters: - - description: The `public_id` of the organization you are operating within. - in: path - name: public_id - required: true - schema: - example: abc123 - type: string + - description: The `public_id` of the organization you are operating within. + in: path + name: public_id + required: true + schema: + example: "abc123" + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OrganizationResponse' + $ref: "#/components/schemas/OrganizationResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get organization information tags: - - Organizations + - Organizations put: description: Update your organization. operationId: UpdateOrg parameters: - - description: The `public_id` of the organization you are operating within. - in: path - name: public_id - required: true - schema: - example: abc123 - type: string + - description: The `public_id` of the organization you are operating within. + in: path + name: public_id + required: true + schema: + example: "abc123" + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Organization' + $ref: "#/components/schemas/Organization" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OrganizationResponse' + $ref: "#/components/schemas/OrganizationResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update your organization tags: - - Organizations + - Organizations x-codegen-request-body-name: body /api/v1/org/{public_id}/downgrade: post: - description: Only available for MSP customers. Removes a child organization - from the hierarchy of the master organization and places the child organization - on a 30-day trial. + description: Only available for MSP customers. Removes a child organization from the hierarchy of the master organization and places the child organization on a 30-day trial. operationId: DowngradeOrg parameters: - - description: The `public_id` of the organization you are operating within. - in: path - name: public_id - required: true - schema: - example: abc123 - type: string + - description: The `public_id` of the organization you are operating within. + in: path + name: public_id + required: true + schema: + example: "abc123" + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OrgDowngradedResponse' + $ref: "#/components/schemas/OrgDowngradedResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Spin-off Child Organization tags: - - Organizations + - Organizations /api/v1/org/{public_id}/idp_metadata: post: - description: 'There are a couple of options for updating the Identity Provider - (IdP) - + description: |- + There are a couple of options for updating the Identity Provider (IdP) metadata from your SAML IdP. - * **Multipart Form-Data**: Post the IdP metadata file using a form post. - - * **XML Body:** Post the IdP metadata file as the body of the request.' + * **XML Body:** Post the IdP metadata file as the body of the request. operationId: UploadIdPForOrg parameters: - - description: The `public_id` of the organization you are operating with - in: path - name: public_id - required: true - schema: - example: abc123 - type: string + - description: The `public_id` of the organization you are operating with + in: path + name: public_id + required: true + schema: + example: "abc123" + type: string requestBody: content: multipart/form-data: schema: - $ref: '#/components/schemas/IdpFormData' + $ref: "#/components/schemas/IdpFormData" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IdpResponse' + $ref: "#/components/schemas/IdpResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '415': + "415": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Unsupported Media Type - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Upload IdP metadata tags: - - Organizations + - Organizations x-codegen-request-body-name: body /api/v1/query: get: description: Query timeseries points. operationId: QueryMetrics parameters: - - description: Start of the queried time period, seconds since the Unix epoch. - in: query - name: from - required: true - schema: - format: int64 - type: integer - - description: End of the queried time period, seconds since the Unix epoch. - in: query - name: to - required: true - schema: - format: int64 - type: integer - - description: Query string. - in: query - name: query - required: true - schema: - type: string + - description: Start of the queried time period, seconds since the Unix epoch. + in: query + name: from + required: true + schema: + format: int64 + type: integer + - description: End of the queried time period, seconds since the Unix epoch. + in: query + name: to + required: true + schema: + format: int64 + type: integer + - description: Query string. + in: query + name: query + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MetricsQueryResponse' + $ref: "#/components/schemas/MetricsQueryResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - timeseries_query + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - timeseries_query summary: Query timeseries points tags: - - Metrics - x-permission: + - Metrics + "x-permission": operator: OR permissions: - - timeseries_query + - timeseries_query /api/v1/search: get: deprecated: true - description: '**Note**: This endpoint is deprecated. Use `/api/v2/metrics` instead. - + description: |- + **Note**: This endpoint is deprecated. Use `/api/v2/metrics` instead. - Search for metrics from the last 24 hours in Datadog.' + Search for metrics from the last 24 hours in Datadog. operationId: ListMetrics parameters: - - description: Query string to search metrics upon. Can optionally be prefixed - with `metrics:`. - in: query - name: q - required: true - schema: - type: string + - description: Query string to search metrics upon. Can optionally be prefixed with `metrics:`. + in: query + name: q + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MetricSearchResponse' + $ref: "#/components/schemas/MetricSearchResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - metrics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - metrics_read summary: Search metrics tags: - - Metrics - x-permission: + - Metrics + "x-permission": operator: OR permissions: - - metrics_read + - metrics_read /api/v1/security_analytics/signals/{signal_id}/add_to_incident: patch: - description: Add a security signal to an incident. This makes it possible to - search for signals by incident within the signal explorer and to view the - signals on the incident timeline. + description: >- + Add a security signal to an incident. This makes it possible to search for signals by incident within the signal explorer and to view the signals on the incident timeline. operationId: AddSecurityMonitoringSignalToIncident parameters: - - $ref: '#/components/parameters/SignalID' + - $ref: "#/components/parameters/SignalID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddSignalToIncidentRequest' + $ref: "#/components/schemas/AddSignalToIncidentRequest" description: Attributes describing the signal update. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SuccessfulSignalUpdateResponse' + $ref: "#/components/schemas/SuccessfulSignalUpdateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Add a security signal to an incident - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_signals_write + - security_monitoring_signals_write /api/v1/security_analytics/signals/{signal_id}/assignee: patch: deprecated: true - description: This endpoint is deprecated - Modify the triage assignee of a security - signal. + description: |- + This endpoint is deprecated - Modify the triage assignee of a security signal. operationId: EditSecurityMonitoringSignalAssignee parameters: - - $ref: '#/components/parameters/SignalID' + - $ref: "#/components/parameters/SignalID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SignalAssigneeUpdateRequest' + $ref: "#/components/schemas/SignalAssigneeUpdateRequest" description: Attributes describing the signal update. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SuccessfulSignalUpdateResponse' + $ref: "#/components/schemas/SuccessfulSignalUpdateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Modify the triage assignee of a security signal - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_signals_write + - security_monitoring_signals_write /api/v1/security_analytics/signals/{signal_id}/state: patch: deprecated: true - description: This endpoint is deprecated - Change the triage state of a security - signal. + description: |- + This endpoint is deprecated - Change the triage state of a security signal. operationId: EditSecurityMonitoringSignalState parameters: - - $ref: '#/components/parameters/SignalID' + - $ref: "#/components/parameters/SignalID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SignalStateUpdateRequest' + $ref: "#/components/schemas/SignalStateUpdateRequest" description: Attributes describing the signal update. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SuccessfulSignalUpdateResponse' + $ref: "#/components/schemas/SuccessfulSignalUpdateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Change the triage state of a security signal - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_signals_write + - security_monitoring_signals_write /api/v1/series: post: - description: "The metrics end-point allows you to post time-series data that - can be graphed on Datadog\u2019s dashboards.\nThe maximum payload size is - 3.2 megabytes (3200000 bytes). Compressed payloads must have a decompressed - size of less than 62 megabytes (62914560 bytes).\n\nIf you\u2019re 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- 40 bytes for the metric - names\n- 50 bytes for the timeseries\n- The full payload is approximately - 100 bytes. However, with the DogStatsD API,\ncompression is applied, which - reduces the payload size." + description: |- + The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards. + The maximum payload size is 3.2 megabytes (3200000 bytes). Compressed payloads must have a decompressed size of less than 62 megabytes (62914560 bytes). + + If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect: + + - 64 bits for the timestamp + - 64 bits for the value + - 40 bytes for the metric names + - 50 bytes for the timeseries + - The full payload is approximately 100 bytes. However, with the DogStatsD API, + compression is applied, which reduces the payload size. operationId: SubmitMetrics parameters: - - description: HTTP header used to compress the media-type. - in: header - name: Content-Encoding - required: false - schema: - $ref: '#/components/schemas/MetricContentEncoding' + - description: HTTP header used to compress the media-type. + in: header + name: Content-Encoding + required: false + schema: + $ref: "#/components/schemas/MetricContentEncoding" requestBody: content: text/json: examples: dynamic-points: - description: "Post time-series data that can be graphed on Datadog\u2019s - dashboards." + description: Post time-series data that can be graphed on Datadog’s dashboards. externalValue: examples/metrics/dynamic-points.json.sh summary: Dynamic Points x-variables: NOW: $(date +%s) schema: - $ref: '#/components/schemas/MetricsPayload' + $ref: "#/components/schemas/MetricsPayload" required: true responses: - '202': + "202": content: text/json: schema: - $ref: '#/components/schemas/IntakePayloadAccepted' + $ref: "#/components/schemas/IntakePayloadAccepted" description: Payload accepted - '400': + "400": content: text/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: text/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '408': + "408": content: text/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Request timeout - '413': + "413": content: text/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Payload too large - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] + - apiKeyAuth: [] summary: Submit metrics tags: - - Metrics + - Metrics x-codegen-request-body-name: body /api/v1/slo: get: description: Get a list of service level objective objects for your organization. operationId: ListSLOs parameters: - - description: A comma separated list of the IDs of the service level objectives - objects. - example: id1, id2, id3 - in: query - name: ids - required: false - schema: - type: string - - description: The query string to filter results based on SLO names. - example: monitor - in: query - name: query - required: false - schema: - type: string - - description: The query string to filter results based on a single SLO tag. - example: env:prod - in: query - name: tags_query - required: false - schema: - type: string - - description: The query string to filter results based on SLO numerator and - denominator. - example: aws.elb.request_count - in: query - name: metrics_query - required: false - schema: - type: string - - description: The number of SLOs to return in the response. - in: query - name: limit - required: false - schema: - default: 1000 - format: int64 - type: integer - - description: The specific offset to use as the beginning of the returned response. - in: query - name: offset - required: false - schema: - format: int64 - type: integer + - description: |- + A comma separated list of the IDs of the service level objectives objects. + example: "id1, id2, id3" + in: query + name: ids + required: false + schema: + type: string + - description: The query string to filter results based on SLO names. + example: "monitor" + in: query + name: query + required: false + schema: + type: string + - description: The query string to filter results based on a single SLO tag. + example: "env:prod" + in: query + name: tags_query + required: false + schema: + type: string + - description: |- + The query string to filter results based on SLO numerator and denominator. + example: "aws.elb.request_count" + in: query + name: metrics_query + required: false + schema: + type: string + - description: |- + The number of SLOs to return in the response. + in: query + name: limit + required: false + schema: + default: 1000 + format: int64 + type: integer + - description: |- + The specific offset to use as the beginning of the returned response. + in: query + name: offset + required: false + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SLOListResponse' + $ref: "#/components/schemas/SLOListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - slos_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - slos_read summary: Get all SLOs tags: - - Service Level Objectives + - Service Level Objectives x-pagination: limitParam: limit pageOffsetParam: offset resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - slos_read + - slos_read post: description: Create a service level objective object. operationId: CreateSLO @@ -34447,809 +31784,807 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceLevelObjectiveRequest' + $ref: "#/components/schemas/ServiceLevelObjectiveRequest" description: Service level objective request object. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SLOListResponse' + $ref: "#/components/schemas/SLOListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - slos_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - slos_write summary: Create an SLO object tags: - - Service Level Objectives + - Service Level Objectives x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - slos_write + - slos_write /api/v1/slo/bulk_delete: post: - description: 'Delete (or partially delete) multiple service level objective - objects. - + description: |- + Delete (or partially delete) multiple service level objective objects. This endpoint facilitates deletion of one or more thresholds for one or more - - service level objective objects. If all thresholds are deleted, the service - level - - objective object is deleted as well.' + service level objective objects. If all thresholds are deleted, the service level + objective object is deleted as well. operationId: DeleteSLOTimeframeInBulk requestBody: content: application/json: schema: - $ref: '#/components/schemas/SLOBulkDelete' + $ref: "#/components/schemas/SLOBulkDelete" description: Delete multiple service level objective objects request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SLOBulkDeleteResponse' + $ref: "#/components/schemas/SLOBulkDeleteResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - slos_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - slos_write summary: Bulk Delete SLO Timeframes tags: - - Service Level Objectives + - Service Level Objectives x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - slos_write + - slos_write /api/v1/slo/can_delete: get: - description: 'Check if an SLO can be safely deleted. For example, - - assure an SLO can be deleted without disrupting a dashboard.' + description: |- + Check if an SLO can be safely deleted. For example, + assure an SLO can be deleted without disrupting a dashboard. operationId: CheckCanDeleteSLO parameters: - - description: A comma separated list of the IDs of the service level objectives - objects. - example: id1, id2, id3 - in: query - name: ids - required: true - schema: - type: string + - description: |- + A comma separated list of the IDs of the service level objectives objects. + example: "id1, id2, id3" + in: query + name: ids + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CheckCanDeleteSLOResponse' + $ref: "#/components/schemas/CheckCanDeleteSLOResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/CheckCanDeleteSLOResponse' + $ref: "#/components/schemas/CheckCanDeleteSLOResponse" description: Conflict - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - slos_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - slos_read summary: Check if SLOs can be safely deleted tags: - - Service Level Objectives - x-permission: + - Service Level Objectives + "x-permission": operator: OR permissions: - - slos_read + - slos_read /api/v1/slo/correction: get: - description: Get all Service Level Objective corrections. + description: |- + Get all Service Level Objective corrections. operationId: ListSLOCorrection parameters: - - description: The specific offset to use as the beginning of the returned response. - in: query - name: offset - required: false - schema: - format: int64 - type: integer - - description: The number of SLO corrections to return in the response. Default - is 25. - in: query - name: limit - required: false - schema: - default: 25 - format: int64 - type: integer + - description: |- + The specific offset to use as the beginning of the returned response. + in: query + name: offset + required: false + schema: + format: int64 + type: integer + - description: |- + The number of SLO corrections to return in the response. Default is 25. + in: query + name: limit + required: false + schema: + default: 25 + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SLOCorrectionListResponse' + $ref: "#/components/schemas/SLOCorrectionListResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - slos_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - slos_read summary: Get all SLO corrections tags: - - Service Level Objective Corrections + - Service Level Objective Corrections x-pagination: limitParam: limit pageOffsetParam: offset resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - slos_read + - slos_read post: - description: Create an SLO Correction. + description: |- + Create an SLO Correction. operationId: CreateSLOCorrection requestBody: content: application/json: schema: - $ref: '#/components/schemas/SLOCorrectionCreateRequest' + $ref: "#/components/schemas/SLOCorrectionCreateRequest" description: Create an SLO Correction required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SLOCorrectionResponse' + $ref: "#/components/schemas/SLOCorrectionResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: SLO Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - slos_corrections + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - slos_corrections summary: Create an SLO correction tags: - - Service Level Objective Corrections + - Service Level Objective Corrections x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - slos_corrections + - slos_corrections /api/v1/slo/correction/{slo_correction_id}: delete: - description: Permanently delete the specified SLO correction object. + description: |- + Permanently delete the specified SLO correction object. operationId: DeleteSLOCorrection parameters: - - description: The ID of the SLO correction object. - in: path - name: slo_correction_id - required: true - schema: - type: string + - description: The ID of the SLO correction object. + in: path + name: slo_correction_id + required: true + schema: + type: string responses: - '204': + "204": description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an SLO correction tags: - - Service Level Objective Corrections + - Service Level Objective Corrections get: - description: Get an SLO correction. + description: |- + Get an SLO correction. operationId: GetSLOCorrection parameters: - - description: The ID of the SLO correction object. - in: path - name: slo_correction_id - required: true - schema: - type: string + - description: The ID of the SLO correction object. + in: path + name: slo_correction_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SLOCorrectionResponse' + $ref: "#/components/schemas/SLOCorrectionResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get an SLO correction for an SLO tags: - - Service Level Objective Corrections + - Service Level Objective Corrections patch: description: Update the specified SLO correction object. operationId: UpdateSLOCorrection parameters: - - description: The ID of the SLO correction object. - in: path - name: slo_correction_id - required: true - schema: - type: string + - description: The ID of the SLO correction object. + in: path + name: slo_correction_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SLOCorrectionUpdateRequest' + $ref: "#/components/schemas/SLOCorrectionUpdateRequest" description: The edited SLO correction object. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SLOCorrectionResponse' + $ref: "#/components/schemas/SLOCorrectionResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update an SLO correction tags: - - Service Level Objective Corrections + - Service Level Objective Corrections x-codegen-request-body-name: body /api/v1/slo/search: get: description: Get a list of service level objective objects for your organization. operationId: SearchSLO parameters: - - description: 'The query string to filter results based on SLO names. - - Some examples of queries include `service:` - - and ``.' - in: query - name: query - required: false - schema: - type: string - - description: The number of files to return in the response `[default=10]`. - in: query - name: page[size] - required: false - schema: - format: int64 - type: integer - - description: The identifier of the first page to return. This parameter is - used for the pagination feature `[default=0]`. - in: query - name: page[number] - required: false - schema: - format: int64 - type: integer - - description: Whether or not to return facet information in the response `[default=false]`. - in: query - name: include_facets - required: false - schema: - type: boolean + - description: |- + The query string to filter results based on SLO names. + Some examples of queries include `service:` + and ``. + in: query + name: query + required: false + schema: + type: string + - description: The number of files to return in the response `[default=10]`. + in: query + name: page[size] + required: false + schema: + format: int64 + type: integer + - description: The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. + in: query + name: page[number] + required: false + schema: + format: int64 + type: integer + - description: Whether or not to return facet information in the response `[default=false]`. + in: query + name: include_facets + required: false + schema: + type: boolean responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SearchSLOResponse' + $ref: "#/components/schemas/SearchSLOResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - slos_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - slos_read summary: Search for SLOs tags: - - Service Level Objectives - x-permission: + - Service Level Objectives + "x-permission": operator: OR permissions: - - slos_read + - slos_read /api/v1/slo/{slo_id}: delete: - description: 'Permanently delete the specified service level objective object. - + description: |- + Permanently delete the specified service level objective object. If an SLO is used in a dashboard, the `DELETE /v1/slo/` endpoint returns - - a 409 conflict error because the SLO is referenced in a dashboard.' + a 409 conflict error because the SLO is referenced in a dashboard. operationId: DeleteSLO parameters: - - description: The ID of the service level objective. - in: path - name: slo_id - required: true - schema: - type: string - - description: Delete the monitor even if it's referenced by other resources - (for example SLO, composite monitor). - in: query - name: force - required: false - schema: - type: string + - description: The ID of the service level objective. + in: path + name: slo_id + required: true + schema: + type: string + - description: Delete the monitor even if it's referenced by other resources (for example SLO, composite monitor). + in: query + name: force + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SLODeleteResponse' + $ref: "#/components/schemas/SLODeleteResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/SLODeleteResponse' + $ref: "#/components/schemas/SLODeleteResponse" description: Conflict - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - slos_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - slos_write summary: Delete an SLO tags: - - Service Level Objectives - x-permission: + - Service Level Objectives + "x-permission": operator: OR permissions: - - slos_write + - slos_write get: description: Get a service level objective object. operationId: GetSLO parameters: - - description: The ID of the service level objective object. - in: path - name: slo_id - required: true - schema: - type: string - - description: Get the IDs of SLO monitors that reference this SLO. - example: true - in: query - name: with_configured_alert_ids - required: false - schema: - type: boolean + - description: The ID of the service level objective object. + in: path + name: slo_id + required: true + schema: + type: string + - description: Get the IDs of SLO monitors that reference this SLO. + example: true + in: query + name: with_configured_alert_ids + required: false + schema: + type: boolean responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SLOResponse' + $ref: "#/components/schemas/SLOResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - slos_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - slos_read summary: Get an SLO's details tags: - - Service Level Objectives - x-permission: + - Service Level Objectives + "x-permission": operator: OR permissions: - - slos_read + - slos_read put: description: Update the specified service level objective object. operationId: UpdateSLO parameters: - - description: The ID of the service level objective object. - in: path - name: slo_id - required: true - schema: - type: string + - description: The ID of the service level objective object. + in: path + name: slo_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ServiceLevelObjective' + $ref: "#/components/schemas/ServiceLevelObjective" description: The edited service level objective request object. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SLOListResponse' + $ref: "#/components/schemas/SLOListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - slos_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - slos_write summary: Update an SLO tags: - - Service Level Objectives + - Service Level Objectives x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - slos_write + - slos_write /api/v1/slo/{slo_id}/corrections: get: - description: Get corrections applied to an SLO + description: |- + Get corrections applied to an SLO operationId: GetSLOCorrections parameters: - - description: The ID of the service level objective object. - in: path - name: slo_id - required: true - schema: - type: string + - description: The ID of the service level objective object. + in: path + name: slo_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SLOCorrectionListResponse' + $ref: "#/components/schemas/SLOCorrectionListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - slos_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - slos_read summary: Get Corrections For an SLO tags: - - Service Level Objectives - x-permission: + - Service Level Objectives + "x-permission": operator: OR permissions: - - slos_read + - slos_read /api/v1/slo/{slo_id}/history: get: - description: "Get a specific SLO\u2019s history, regardless of its SLO type.\n\nThe - detailed history data is structured according to the source data type.\nFor - example, metric data is included for event SLOs that use\nthe metric source, - and monitor SLO types include the monitor transition history.\n\n**Note:** - There are different response formats for event based and time based SLOs.\nExamples - of both are shown." + description: |- + Get a specific SLO’s history, regardless of its SLO type. + + The detailed history data is structured according to the source data type. + For example, metric data is included for event SLOs that use + the metric source, and monitor SLO types include the monitor transition history. + + **Note:** There are different response formats for event based and time based SLOs. + Examples of both are shown. operationId: GetSLOHistory parameters: - - description: The ID of the service level objective object. - in: path - name: slo_id - required: true - schema: - type: string - - description: The `from` timestamp for the query window in epoch seconds. - in: query - name: from_ts - required: true - schema: - format: int64 - type: integer - - description: The `to` timestamp for the query window in epoch seconds. - in: query - name: to_ts - required: true - schema: - format: int64 - type: integer - - description: The SLO target. If `target` is passed in, the response will include - the remaining error budget and a timeframe value of `custom`. - in: query - name: target - schema: - exclusiveMaximum: true - exclusiveMinimum: true - format: double - maximum: 100 - minimum: 0 - type: number - - description: 'Defaults to `true`. If any SLO corrections are applied and this - parameter is set to `false`, - - then the corrections will not be applied and the SLI values will not be - affected.' - in: query - name: apply_correction - required: false - schema: - type: boolean + - description: The ID of the service level objective object. + in: path + name: slo_id + required: true + schema: + type: string + - description: The `from` timestamp for the query window in epoch seconds. + in: query + name: from_ts + required: true + schema: + format: int64 + type: integer + - description: The `to` timestamp for the query window in epoch seconds. + in: query + name: to_ts + required: true + schema: + format: int64 + type: integer + - description: The SLO target. If `target` is passed in, the response will include the remaining error budget and a timeframe value of `custom`. + in: query + name: target + schema: + exclusiveMaximum: true + exclusiveMinimum: true + format: double + maximum: 100 + minimum: 0 + type: number + - description: |- + Defaults to `true`. If any SLO corrections are applied and this parameter is set to `false`, + then the corrections will not be applied and the SLI values will not be affected. + in: query + name: apply_correction + required: false + schema: + type: boolean responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SLOHistoryResponse' + $ref: "#/components/schemas/SLOHistoryResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - slos_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - slos_read summary: Get an SLO's history tags: - - Service Level Objectives - x-permission: + - Service Level Objectives + "x-permission": operator: OR permissions: - - slos_read + - slos_read /api/v1/synthetics/ci/batch/{batch_id}: get: description: Get a batch's updated details. operationId: GetSyntheticsCIBatch parameters: - - description: The ID of the batch. - in: path - name: batch_id - required: true - schema: - type: string + - description: The ID of the batch. + in: path + name: batch_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsBatchDetails' + $ref: "#/components/schemas/SyntheticsBatchDetails" description: OK - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Batch does not exist. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_read summary: Get details of batch tags: - - Synthetics - x-permission: + - Synthetics + "x-permission": operator: OR permissions: - - synthetics_read + - synthetics_read /api/v1/synthetics/locations: get: - description: 'Get the list of public and private locations available for Synthetic - - tests. No arguments required.' + description: |- + Get the list of public and private locations available for Synthetic + tests. No arguments required. operationId: ListLocations responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsLocations' + $ref: "#/components/schemas/SyntheticsLocations" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_private_location_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_private_location_read summary: Get all locations (public and private) tags: - - Synthetics - x-permission: + - Synthetics + "x-permission": operator: OR permissions: - - synthetics_private_location_read + - synthetics_private_location_read /api/v1/synthetics/private-locations: post: description: Create a new Synthetic private location. @@ -35258,243 +32593,242 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsPrivateLocation' + $ref: "#/components/schemas/SyntheticsPrivateLocation" description: Details of the private location to create. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsPrivateLocationCreationResponse' + $ref: "#/components/schemas/SyntheticsPrivateLocationCreationResponse" description: OK - '402': + "402": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Quota reached for private locations - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Private locations are not activated for the user - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_private_location_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_private_location_write summary: Create a private location tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_private_location_write + - synthetics_private_location_write /api/v1/synthetics/private-locations/{location_id}: delete: description: Delete a Synthetic private location. operationId: DeletePrivateLocation parameters: - - description: The ID of the private location. - in: path - name: location_id - required: true - schema: - type: string + - description: The ID of the private location. + in: path + name: location_id + required: true + schema: + type: string responses: - '204': + "204": description: OK - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Private locations are not activated for the user - - - Private location does not exist' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Private locations are not activated for the user + - Private location does not exist + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_private_location_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_private_location_write summary: Delete a private location tags: - - Synthetics - x-permission: + - Synthetics + "x-permission": operator: OR permissions: - - synthetics_private_location_write + - synthetics_private_location_write get: description: Get a Synthetic private location. operationId: GetPrivateLocation parameters: - - description: The ID of the private location. - in: path - name: location_id - required: true - schema: - type: string + - description: The ID of the private location. + in: path + name: location_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsPrivateLocation' + $ref: "#/components/schemas/SyntheticsPrivateLocation" description: OK - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Synthetic private locations are not activated for the user - - - Private location does not exist' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Synthetic private locations are not activated for the user + - Private location does not exist + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_private_location_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_private_location_read summary: Get a private location tags: - - Synthetics - x-permission: + - Synthetics + "x-permission": operator: OR permissions: - - synthetics_private_location_read + - synthetics_private_location_read put: description: Edit a Synthetic private location. operationId: UpdatePrivateLocation parameters: - - description: The ID of the private location. - in: path - name: location_id - required: true - schema: - type: string + - description: The ID of the private location. + in: path + name: location_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsPrivateLocation' + $ref: "#/components/schemas/SyntheticsPrivateLocation" description: Details of the private location to be updated. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsPrivateLocation' + $ref: "#/components/schemas/SyntheticsPrivateLocation" description: OK - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Private locations are not activated for the user - - - Private location does not exist' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Private locations are not activated for the user + - Private location does not exist + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_private_location_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_private_location_write summary: Edit a private location tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_private_location_write + - synthetics_private_location_write /api/v1/synthetics/settings/default_locations: get: description: Get the default locations settings. operationId: GetSyntheticsDefaultLocations responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsDefaultLocations' + $ref: "#/components/schemas/SyntheticsDefaultLocations" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get the default locations tags: - - Synthetics - x-permission: + - Synthetics + "x-permission": operator: OR permissions: - - synthetics_default_settings_read + - synthetics_default_settings_read /api/v1/synthetics/tests: get: description: Get the list of all Synthetic tests. operationId: ListTests parameters: - - description: Used for pagination. The number of tests returned in the page. - in: query - name: page_size - required: false - schema: - default: 100 - format: int64 - type: integer - - description: Used for pagination. Which page you want to retrieve. Starts - at zero. - in: query - name: page_number - required: false - schema: - format: int64 - type: integer + - description: Used for pagination. The number of tests returned in the page. + in: query + name: page_size + required: false + schema: + default: 100 + format: int64 + type: integer + - description: Used for pagination. Which page you want to retrieve. Starts at zero. + in: query + name: page_number + required: false + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsListTestsResponse' + $ref: "#/components/schemas/SyntheticsListTestsResponse" description: OK - Returns the list of all Synthetic tests. - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Synthetic Monitoring is not activated for the user. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_read summary: Get the list of all Synthetic tests tags: - - Synthetics + - Synthetics x-pagination: limitParam: page_size pageParam: page_number resultsPath: tests - x-permission: + "x-permission": operator: OR permissions: - - synthetics_read + - synthetics_read /api/v1/synthetics/tests/api: post: description: Create a Synthetic API test. @@ -35509,22 +32843,22 @@ paths: value: config: assertions: - - operator: lessThan - target: 1000 - type: responseTime - - operator: is - target: 200 - type: statusCode - - operator: is - property: content-type - target: text/html; charset=UTF-8 - type: header + - operator: lessThan + target: 1000 + type: responseTime + - operator: is + target: 200 + type: statusCode + - operator: is + property: content-type + target: text/html; charset=UTF-8 + type: header request: method: GET - url: https://example.com + url: "https://example.com" locations: - - azure:eastus - - aws:eu-west-3 + - "azure:eastus" + - "aws:eu-west-3" message: MY_NOTIFICATION_MESSAGE name: MY_TEST_NAME options: @@ -35541,68 +32875,72 @@ paths: status: live subtype: http tags: - - env:production + - "env:production" type: api 2-multistep-api-test: - description: 'Example of a multistep API test running on a fake furniture - store. - - It creates a card, select a product and then add the product to - the card.' + description: |- + Example of a multistep API test running on a fake furniture store. + It creates a card, select a product and then add the product to the card. summary: Create a Multistep API test value: config: steps: - - assertions: - - operator: lessThan - target: 30000 - type: responseTime - extractedValues: - - field: location - name: CART_ID - parser: - type: regex - value: (?:[^\\/](?!(\\|/)))+$ - type: http_header - name: Get a cart - request: - method: POST - timeout: 30 - url: https://api.shopist.io/carts - subtype: http - - assertions: - - operator: is - target: 200 - type: statusCode - extractedValues: - - name: PRODUCT_ID - parser: - type: json_path - value: $[0].id['$oid'] - type: http_body - name: Get a product - request: - method: GET - timeout: 30 - url: https://api.shopist.io/products.json - subtype: http - - assertions: - - operator: is - target: 201 - type: statusCode - name: Add product to cart - request: - body: "{\n \"cart_item\": {\n \"product_id\": \"{{ PRODUCT_ID - }}\",\n \"amount_paid\": 500,\n \"quantity\": 1\n - \ },\n \"cart_id\": \"{{ CART_ID }}\"\n}" - headers: - content-type: application/json - method: POST - timeout: 30 - url: https://api.shopist.io/add_item.json - subtype: http + - assertions: + - operator: lessThan + target: 30000 + type: responseTime + extractedValues: + - field: location + name: CART_ID + parser: + type: regex + value: '(?:[^\\/](?!(\\|/)))+$' + type: http_header + name: Get a cart + request: + method: POST + timeout: 30 + url: "https://api.shopist.io/carts" + subtype: http + - assertions: + - operator: is + target: 200 + type: statusCode + extractedValues: + - name: PRODUCT_ID + parser: + type: json_path + value: "$[0].id['$oid']" + type: http_body + name: Get a product + request: + method: GET + timeout: 30 + url: "https://api.shopist.io/products.json" + subtype: http + - assertions: + - operator: is + target: 201 + type: statusCode + name: Add product to cart + request: + body: |- + { + "cart_item": { + "product_id": "{{ PRODUCT_ID }}", + "amount_paid": 500, + "quantity": 1 + }, + "cart_id": "{{ CART_ID }}" + } + headers: + content-type: application/json + method: POST + timeout: 30 + url: "https://api.shopist.io/add_item.json" + subtype: http locations: - - aws:us-west-2 + - "aws:us-west-2" message: MY_NOTIFICATION_MESSAGE name: MY_TEST_NAME options: @@ -35619,165 +32957,164 @@ paths: status: live subtype: multi tags: - - env:prod + - "env:prod" type: api schema: - $ref: '#/components/schemas/SyntheticsAPITest' + $ref: "#/components/schemas/SyntheticsAPITest" description: Details of the test to create. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsAPITest' + $ref: "#/components/schemas/SyntheticsAPITest" description: OK - Returns the created test details. - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- JSON format is wrong - - - Creation failed' - '402': + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - JSON format is wrong + - Creation failed + "402": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Test quota is reached - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Create an API test tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_write + - synthetics_write /api/v1/synthetics/tests/api/{public_id}: get: - description: 'Get the detailed configuration associated with - - a Synthetic API test.' + description: |- + Get the detailed configuration associated with + a Synthetic API test. operationId: GetAPITest parameters: - - description: The public ID of the test to get details from. - in: path - name: public_id - required: true - schema: - type: string + - description: The public ID of the test to get details from. + in: path + name: public_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsAPITest' + $ref: "#/components/schemas/SyntheticsAPITest" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Synthetic Monitoring is not activated for the user - - - Test is not owned by the user' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Synthetic Monitoring is not activated for the user + - Test is not owned by the user + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_read summary: Get an API test tags: - - Synthetics - x-permission: + - Synthetics + "x-permission": operator: OR permissions: - - synthetics_read + - synthetics_read put: description: Edit the configuration of a Synthetic API test. operationId: UpdateAPITest parameters: - - description: The public ID of the test to get details from. - in: path - name: public_id - required: true - schema: - type: string + - description: The public ID of the test to get details from. + in: path + name: public_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsAPITest' + $ref: "#/components/schemas/SyntheticsAPITest" description: New test details to be saved. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsAPITest' + $ref: "#/components/schemas/SyntheticsAPITest" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- JSON format is wrong - - - Updating sub-type is forbidden' - '403': + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - JSON format is wrong + - Updating sub-type is forbidden + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Synthetic Monitoring is not activated for the user - + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Synthetic Monitoring is not activated for the user - Test is not owned by the user - - - Test can''t be found' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + - Test can't be found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Edit an API test tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_write + - synthetics_write /api/v1/synthetics/tests/browser: post: description: Create a Synthetic browser test. @@ -35786,288 +33123,287 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsBrowserTest' + $ref: "#/components/schemas/SyntheticsBrowserTest" description: Details of the test to create. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsBrowserTest' + $ref: "#/components/schemas/SyntheticsBrowserTest" description: OK - Returns the created test details. - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- JSON format is wrong - - - Creation failed' - '402': + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - JSON format is wrong + - Creation failed + "402": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Test quota is reached - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Create a browser test tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_write + - synthetics_write /api/v1/synthetics/tests/browser/{public_id}: get: - description: 'Get the detailed configuration (including steps) associated with - - a Synthetic browser test.' + description: |- + Get the detailed configuration (including steps) associated with + a Synthetic browser test. operationId: GetBrowserTest parameters: - - description: The public ID of the test to get details from. - in: path - name: public_id - required: true - schema: - type: string + - description: The public ID of the test to get details from. + in: path + name: public_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsBrowserTest' + $ref: "#/components/schemas/SyntheticsBrowserTest" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Synthetic Monitoring is not activated for the user - - - Test is not owned by the user' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Synthetic Monitoring is not activated for the user + - Test is not owned by the user + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_read summary: Get a browser test tags: - - Synthetics - x-permission: + - Synthetics + "x-permission": operator: OR permissions: - - synthetics_read + - synthetics_read put: description: Edit the configuration of a Synthetic browser test. operationId: UpdateBrowserTest parameters: - - description: The public ID of the test to edit. - in: path - name: public_id - required: true - schema: - type: string + - description: The public ID of the test to edit. + in: path + name: public_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsBrowserTest' + $ref: "#/components/schemas/SyntheticsBrowserTest" description: New test details to be saved. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsBrowserTest' + $ref: "#/components/schemas/SyntheticsBrowserTest" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- JSON format is wrong - - - Updating sub-type is forbidden' - '403': + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - JSON format is wrong + - Updating sub-type is forbidden + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Synthetic Monitoring is not activated for the user - + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Synthetic Monitoring is not activated for the user - Test is not owned by the user - - - Test can''t be found' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + - Test can't be found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Edit a browser test tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_write + - synthetics_write /api/v1/synthetics/tests/browser/{public_id}/results: get: - description: Get the last 150 test results summaries for a given Synthetic browser - test. + description: |- + Get the last 150 test results summaries for a given Synthetic browser test. operationId: GetBrowserTestLatestResults parameters: - - description: 'The public ID of the browser test for which to search results - - for.' - in: path - name: public_id - required: true - schema: - type: string - - description: Timestamp in milliseconds from which to start querying results. - in: query - name: from_ts - required: false - schema: - format: int64 - type: integer - - description: Timestamp in milliseconds up to which to query results. - in: query - name: to_ts - required: false - schema: - format: int64 - type: integer - - description: Locations for which to query results. - in: query - name: probe_dc - required: false - schema: - items: + - description: |- + The public ID of the browser test for which to search results + for. + in: path + name: public_id + required: true + schema: type: string - type: array + - description: Timestamp in milliseconds from which to start querying results. + in: query + name: from_ts + required: false + schema: + format: int64 + type: integer + - description: Timestamp in milliseconds up to which to query results. + in: query + name: to_ts + required: false + schema: + format: int64 + type: integer + - description: Locations for which to query results. + in: query + name: probe_dc + required: false + schema: + items: + type: string + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsGetBrowserTestLatestResultsResponse' + $ref: "#/components/schemas/SyntheticsGetBrowserTestLatestResultsResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Synthetic Monitoring is not activated for the user - - - Test is not owned by the user' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Synthetic Monitoring is not activated for the user + - Test is not owned by the user + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_read summary: Get a browser test's latest results summaries tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_read + - synthetics_read /api/v1/synthetics/tests/browser/{public_id}/results/{result_id}: get: description: Get a specific full result from a given Synthetic browser test. operationId: GetBrowserTestResult parameters: - - description: 'The public ID of the browser test to which the target result - - belongs.' - in: path - name: public_id - required: true - schema: - type: string - - description: The ID of the result to get. - in: path - name: result_id - required: true - schema: - type: string + - description: |- + The public ID of the browser test to which the target result + belongs. + in: path + name: public_id + required: true + schema: + type: string + - description: The ID of the result to get. + in: path + name: result_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsBrowserTestResultFull' + $ref: "#/components/schemas/SyntheticsBrowserTestResultFull" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Synthetic Monitoring is not activated for the user - - - Test or result is not owned by the user' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Synthetic Monitoring is not activated for the user + - Test or result is not owned by the user + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_read summary: Get a browser test result tags: - - Synthetics - x-permission: + - Synthetics + "x-permission": operator: OR permissions: - - synthetics_read + - synthetics_read /api/v1/synthetics/tests/delete: post: description: Delete multiple Synthetic tests by ID. @@ -36076,56 +33412,54 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsDeleteTestsPayload' + $ref: "#/components/schemas/SyntheticsDeleteTestsPayload" description: Public ID list of the Synthetic tests to be deleted. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsDeleteTestsResponse' + $ref: "#/components/schemas/SyntheticsDeleteTestsResponse" description: OK. - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- JSON format is wrong - - - Test cannot be deleted as it''s used elsewhere (as a sub-test or in - an uptime widget) - - - Some IDs are not owned by the user' - '403': + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - JSON format is wrong + - Test cannot be deleted as it's used elsewhere (as a sub-test or in an uptime widget) + - Some IDs are not owned by the user + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Tests to be deleted can''t be found - - - Synthetic is not activated for the user' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Tests to be deleted can't be found + - Synthetic is not activated for the user + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Delete tests tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_write + - synthetics_write /api/v1/synthetics/tests/mobile: post: description: Create a Synthetic mobile test. @@ -36134,242 +33468,241 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsMobileTest' + $ref: "#/components/schemas/SyntheticsMobileTest" description: Details of the test to create. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsMobileTest' + $ref: "#/components/schemas/SyntheticsMobileTest" description: OK - Returns the created test details. - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- JSON format is wrong - - - Creation failed' - '402': + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - JSON format is wrong + - Creation failed + "402": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Test quota is reached - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Create a mobile test tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_write + - synthetics_write /api/v1/synthetics/tests/mobile/{public_id}: get: - description: 'Get the detailed configuration associated with - - a Synthetic mobile test.' + description: |- + Get the detailed configuration associated with + a Synthetic mobile test. operationId: GetMobileTest parameters: - - description: The public ID of the test to get details from. - in: path - name: public_id - required: true - schema: - type: string + - description: The public ID of the test to get details from. + in: path + name: public_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsMobileTest' + $ref: "#/components/schemas/SyntheticsMobileTest" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Synthetic Monitoring is not activated for the user - - - Test is not owned by the user' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Synthetic Monitoring is not activated for the user + - Test is not owned by the user + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_read summary: Get a mobile test tags: - - Synthetics - x-permission: + - Synthetics + "x-permission": operator: OR permissions: - - synthetics_read + - synthetics_read put: description: Edit the configuration of a Synthetic mobile test. operationId: UpdateMobileTest parameters: - - description: The public ID of the test to get details from. - in: path - name: public_id - required: true - schema: - type: string + - description: The public ID of the test to get details from. + in: path + name: public_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsMobileTest' + $ref: "#/components/schemas/SyntheticsMobileTest" description: New test details to be saved. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsMobileTest' + $ref: "#/components/schemas/SyntheticsMobileTest" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- JSON format is wrong - - - Updating sub-type is forbidden' - '403': + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - JSON format is wrong + - Updating sub-type is forbidden + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Synthetic Monitoring is not activated for the user - + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Synthetic Monitoring is not activated for the user - Test is not owned by the user - - - Test can''t be found' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + - Test can't be found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Edit a mobile test tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_write + - synthetics_write /api/v1/synthetics/tests/search: get: - description: Search for Synthetic tests. + description: |- + Search for Synthetic tests. operationId: SearchTests parameters: - - description: The search query. - in: query - name: text - required: false - schema: - type: string - - description: If true, include the full configuration for each test in the - response. - in: query - name: include_full_config - required: false - schema: - type: boolean - - description: If true, return only facets instead of full test details. - in: query - name: facets_only - required: false - schema: - type: boolean - - description: The offset from which to start returning results. - in: query - name: start - required: false - schema: - default: 0 - format: int64 - type: integer - - description: The maximum number of results to return. - in: query - name: count - required: false - schema: - default: 50 - format: int64 - type: integer - - description: The sort order for the results (e.g., `name,asc` or `name,desc`). - in: query - name: sort - required: false - schema: - default: name,asc - type: string + - description: The search query. + in: query + name: text + required: false + schema: + type: string + - description: If true, include the full configuration for each test in the response. + in: query + name: include_full_config + required: false + schema: + type: boolean + - description: If true, return only facets instead of full test details. + in: query + name: facets_only + required: false + schema: + type: boolean + - description: The offset from which to start returning results. + in: query + name: start + required: false + schema: + default: 0 + format: int64 + type: integer + - description: The maximum number of results to return. + in: query + name: count + required: false + schema: + default: 50 + format: int64 + type: integer + - description: The sort order for the results (e.g., `name,asc` or `name,desc`). + in: query + name: sort + required: false + schema: + default: name,asc + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsListTestsResponse' + $ref: "#/components/schemas/SyntheticsListTestsResponse" description: OK - Returns the list of Synthetic tests matching the search. - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_read summary: Search Synthetic tests tags: - - Synthetics - x-permission: + - Synthetics + "x-permission": operator: OR permissions: - - synthetics_read + - synthetics_read /api/v1/synthetics/tests/trigger: post: description: Trigger a set of Synthetic tests. @@ -36378,37 +33711,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsTriggerBody' + $ref: "#/components/schemas/SyntheticsTriggerBody" description: The identifiers of the tests to trigger. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsTriggerCITestsResponse' + $ref: "#/components/schemas/SyntheticsTriggerCITestsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Trigger Synthetic tests tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_write + - synthetics_write /api/v1/synthetics/tests/trigger/ci: post: description: Trigger a set of Synthetic tests for continuous integration. @@ -36417,37 +33750,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsCITestBody' + $ref: "#/components/schemas/SyntheticsCITestBody" description: Details of the test to trigger. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsTriggerCITestsResponse' + $ref: "#/components/schemas/SyntheticsTriggerCITestsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: JSON format is wrong - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Trigger tests from CI/CD pipelines tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_write + - synthetics_write /api/v1/synthetics/tests/uptimes: post: description: Fetch uptime for multiple Synthetic tests by ID. @@ -36456,370 +33789,370 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsFetchUptimesPayload' + $ref: "#/components/schemas/SyntheticsFetchUptimesPayload" description: Public ID list of the Synthetic tests and timeframe. required: true responses: - '200': + "200": content: application/json: schema: items: - $ref: '#/components/schemas/SyntheticsTestUptime' + $ref: "#/components/schemas/SyntheticsTestUptime" type: array description: OK. - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- JSON format is wrong' - '403': + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - JSON format is wrong + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_read summary: Fetch uptime for multiple tests tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_read + - synthetics_read /api/v1/synthetics/tests/{public_id}: get: description: Get the detailed configuration associated with a Synthetic test. operationId: GetTest parameters: - - description: The public ID of the test to get details from. - in: path - name: public_id - required: true - schema: - type: string + - description: The public ID of the test to get details from. + in: path + name: public_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsTestDetailsWithoutSteps' + $ref: "#/components/schemas/SyntheticsTestDetailsWithoutSteps" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Synthetic is not activated for the user - - - Test is not owned by the user' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Synthetic is not activated for the user + - Test is not owned by the user + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_read summary: Get a test configuration tags: - - Synthetics - x-permission: + - Synthetics + "x-permission": operator: OR permissions: - - synthetics_read + - synthetics_read patch: description: Patch the configuration of a Synthetic test with partial data. operationId: PatchTest parameters: - - description: The public ID of the test to patch. - in: path - name: public_id - required: true - schema: - type: string + - description: The public ID of the test to patch. + in: path + name: public_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsPatchTestBody' - description: '[JSON Patch](https://jsonpatch.com/) compliant list of operations' + $ref: "#/components/schemas/SyntheticsPatchTestBody" + description: "[JSON Patch](https://jsonpatch.com/) compliant list of operations" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsTestDetails' + $ref: "#/components/schemas/SyntheticsTestDetails" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- JSON format is wrong - - - Updating sub-type is forbidden' - '403': + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - JSON format is wrong + - Updating sub-type is forbidden + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Synthetic Monitoring is not activated for the user - + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Synthetic Monitoring is not activated for the user - Test is not owned by the user - - - Test can''t be found' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + - Test can't be found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Patch a Synthetic test tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_write + - synthetics_write /api/v1/synthetics/tests/{public_id}/results: get: - description: Get the last 150 test results summaries for a given Synthetic API - test. + description: |- + Get the last 150 test results summaries for a given Synthetic API test. operationId: GetAPITestLatestResults parameters: - - description: The public ID of the test for which to search results for. - in: path - name: public_id - required: true - schema: - type: string - - description: Timestamp in milliseconds from which to start querying results. - in: query - name: from_ts - required: false - schema: - format: int64 - type: integer - - description: Timestamp in milliseconds up to which to query results. - in: query - name: to_ts - required: false - schema: - format: int64 - type: integer - - description: Locations for which to query results. - in: query - name: probe_dc - required: false - schema: - items: + - description: The public ID of the test for which to search results for. + in: path + name: public_id + required: true + schema: type: string - type: array + - description: Timestamp in milliseconds from which to start querying results. + in: query + name: from_ts + required: false + schema: + format: int64 + type: integer + - description: Timestamp in milliseconds up to which to query results. + in: query + name: to_ts + required: false + schema: + format: int64 + type: integer + - description: Locations for which to query results. + in: query + name: probe_dc + required: false + schema: + items: + type: string + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsGetAPITestLatestResultsResponse' + $ref: "#/components/schemas/SyntheticsGetAPITestLatestResultsResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Synthetic is not activated for the user - - - Test is not owned by the user' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Synthetic is not activated for the user + - Test is not owned by the user + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_read summary: Get an API test's latest results summaries tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_read + - synthetics_read /api/v1/synthetics/tests/{public_id}/results/{result_id}: get: description: Get a specific full result from a given Synthetic API test. operationId: GetAPITestResult parameters: - - description: The public ID of the API test to which the target result belongs. - in: path - name: public_id - required: true - schema: - type: string - - description: The ID of the result to get. - in: path - name: result_id - required: true - schema: - type: string + - description: The public ID of the API test to which the target result belongs. + in: path + name: public_id + required: true + schema: + type: string + - description: The ID of the result to get. + in: path + name: result_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsAPITestResultFull' + $ref: "#/components/schemas/SyntheticsAPITestResultFull" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Synthetic Monitoring is not activated for the user - - - Test or result is not owned by the user' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Synthetic Monitoring is not activated for the user + - Test or result is not owned by the user + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_read summary: Get an API test result tags: - - Synthetics - x-permission: + - Synthetics + "x-permission": operator: OR permissions: - - synthetics_read + - synthetics_read /api/v1/synthetics/tests/{public_id}/status: put: description: Pause or start a Synthetic test by changing the status. operationId: UpdateTestPauseStatus parameters: - - description: The public ID of the Synthetic test to update. - in: path - name: public_id - required: true - schema: - type: string + - description: The public ID of the Synthetic test to update. + in: path + name: public_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsUpdateTestPauseStatusPayload' + $ref: "#/components/schemas/SyntheticsUpdateTestPauseStatusPayload" description: Status to set the given Synthetic test to. required: true responses: - '200': + "200": content: application/json: schema: type: boolean description: OK - Returns a boolean indicating if the update was successful. - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: JSON format is wrong. - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - description: '- Synthetic Monitoring is not activated for the user - - - Test is not owned by the user' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/APIErrorResponse" + description: |- + - Synthetic Monitoring is not activated for the user + - Test is not owned by the user + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Pause or start a test tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_write + - synthetics_write /api/v1/synthetics/variables: get: description: Get the list of all Synthetic global variables. operationId: ListGlobalVariables responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsListGlobalVariablesResponse' + $ref: "#/components/schemas/SyntheticsListGlobalVariablesResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_global_variable_read - - AuthZ: - - apm_api_catalog_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_global_variable_read + - AuthZ: + - apm_api_catalog_read summary: Get all global variables tags: - - Synthetics - x-permission: + - Synthetics + "x-permission": operator: OR permissions: - - synthetics_global_variable_read - - apm_api_catalog_read + - synthetics_global_variable_read + - apm_api_catalog_read post: description: Create a Synthetic global variable. operationId: CreateGlobalVariable @@ -36827,2996 +34160,2810 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsGlobalVariableRequest' + $ref: "#/components/schemas/SyntheticsGlobalVariableRequest" description: Details of the global variable to create. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsGlobalVariable' + $ref: "#/components/schemas/SyntheticsGlobalVariable" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Invalid request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Conflict - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_global_variable_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_global_variable_write summary: Create a global variable tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_global_variable_write + - synthetics_global_variable_write /api/v1/synthetics/variables/{variable_id}: delete: description: Delete a Synthetic global variable. operationId: DeleteGlobalVariable parameters: - - description: The ID of the global variable. - in: path - name: variable_id - required: true - schema: - type: string + - description: The ID of the global variable. + in: path + name: variable_id + required: true + schema: + type: string responses: - '200': + "200": description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: JSON format is wrong - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_global_variable_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_global_variable_write summary: Delete a global variable tags: - - Synthetics - x-permission: + - Synthetics + "x-permission": operator: OR permissions: - - synthetics_global_variable_write + - synthetics_global_variable_write get: description: Get the detailed configuration of a global variable. operationId: GetGlobalVariable parameters: - - description: The ID of the global variable. - in: path - name: variable_id - required: true - schema: - type: string + - description: The ID of the global variable. + in: path + name: variable_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsGlobalVariable' + $ref: "#/components/schemas/SyntheticsGlobalVariable" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_global_variable_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_global_variable_read summary: Get a global variable tags: - - Synthetics + - Synthetics put: description: Edit a Synthetic global variable. operationId: EditGlobalVariable parameters: - - description: The ID of the global variable. - in: path - name: variable_id - required: true - schema: - type: string + - description: The ID of the global variable. + in: path + name: variable_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsGlobalVariableRequest' + $ref: "#/components/schemas/SyntheticsGlobalVariableRequest" description: Details of the global variable to update. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsGlobalVariable' + $ref: "#/components/schemas/SyntheticsGlobalVariable" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Invalid request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_global_variable_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_global_variable_write summary: Edit a global variable tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_global_variable_write + - synthetics_global_variable_write /api/v1/tags/hosts: get: - description: Returns a mapping of tags to hosts. For each tag, the response - returns a list of host names that contain this tag. There is a restriction - of 10k total host names from the org that can be attached to tags and returned. + description: Returns a mapping of tags to hosts. For each tag, the response returns a list of host names that contain this tag. There is a restriction of 10k total host names from the org that can be attached to tags and returned. operationId: ListHostTags parameters: - - description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). - Use "user" source for custom-defined tags. - in: query - name: source - required: false - schema: - type: string + - description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). Use "user" source for custom-defined tags. + in: query + name: source + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TagToHosts' + $ref: "#/components/schemas/TagToHosts" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get All Host Tags tags: - - Tags - x-permission: + - Tags + "x-permission": operator: OPEN permissions: [] /api/v1/tags/hosts/{host_name}: delete: - description: 'This endpoint allows you to remove all tags - - for a single host. If no source is specified, only deletes from the source - "User".' + description: |- + This endpoint allows you to remove all tags + for a single host. If no source is specified, only deletes from the source "User". operationId: DeleteHostTags parameters: - - description: Specified host name to delete tags - in: path - name: host_name - required: true - schema: - type: string - - description: Source of the tags to be deleted. [Complete list of source attribute - values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). - Use "user" source for custom-defined tags. - in: query - name: source - required: false - schema: - type: string + - description: Specified host name to delete tags + in: path + name: host_name + required: true + schema: + type: string + - description: |- + Source of the tags to be deleted. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). Use "user" source for custom-defined tags. + in: query + name: source + required: false + schema: + type: string responses: - '204': + "204": description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Remove host tags tags: - - Tags + - Tags get: description: Return the list of tags that apply to a given host. operationId: GetHostTags parameters: - - description: Name of the host to retrieve tags for - in: path - name: host_name - required: true - schema: - type: string - - description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). - Use "user" source for custom-defined tags. - in: query - name: source - required: false - schema: - type: string + - description: Name of the host to retrieve tags for + in: path + name: host_name + required: true + schema: + type: string + - description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). Use "user" source for custom-defined tags. + in: query + name: source + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/HostTags' + $ref: "#/components/schemas/HostTags" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get Host Tags tags: - - Tags + - Tags post: - description: 'This endpoint allows you to add new tags to a host, - - optionally specifying what source these tags come from. If tags already exist, - appends new tags to the tag list. If no source is specified, defaults to "user".' + description: |- + This endpoint allows you to add new tags to a host, + optionally specifying what source these tags come from. If tags already exist, appends new tags to the tag list. If no source is specified, defaults to "user". operationId: CreateHostTags parameters: - - description: Specified host name to add new tags - in: path - name: host_name - required: true - schema: - type: string - - description: Source to add tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). - Use "user" source for custom-defined tags. If no source is specified, defaults - to "user". - example: chef - in: query - name: source - required: false - schema: - type: string + - description: Specified host name to add new tags + in: path + name: host_name + required: true + schema: + type: string + - description: |- + Source to add tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). Use "user" source for custom-defined tags. If no source is specified, defaults to "user". + example: "chef" + in: query + name: source + required: false + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/HostTags' + $ref: "#/components/schemas/HostTags" description: Update host tags request body. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/HostTags' + $ref: "#/components/schemas/HostTags" description: Created - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Add tags to a host tags: - - Tags + - Tags x-codegen-request-body-name: body put: - description: 'This endpoint allows you to update/replace all tags in - - an integration source with those supplied in the request.' + description: |- + This endpoint allows you to update/replace all tags in + an integration source with those supplied in the request. operationId: UpdateHostTags parameters: - - description: Specified host name to change tags - in: path - name: host_name - required: true - schema: - type: string - - description: Source to update tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). - Use "user" source for custom-defined tags. If no source specified, defaults - to "user". - in: query - name: source - required: false - schema: - type: string + - description: Specified host name to change tags + in: path + name: host_name + required: true + schema: + type: string + - description: |- + Source to update tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). Use "user" source for custom-defined tags. If no source specified, defaults to "user". + in: query + name: source + required: false + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/HostTags' + $ref: "#/components/schemas/HostTags" description: Add tags to host required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/HostTags' + $ref: "#/components/schemas/HostTags" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update host tags tags: - - Tags + - Tags x-codegen-request-body-name: body /api/v1/usage/analyzed_logs: get: deprecated: true - description: 'Get hourly usage for analyzed logs (Security Monitoring). - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for analyzed logs (Security Monitoring). + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageAnalyzedLogs parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageAnalyzedLogsResponse' + $ref: "#/components/schemas/UsageAnalyzedLogsResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for analyzed logs tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/audit_logs: get: deprecated: true - description: 'Get hourly usage for audit logs. - - **Note:** This endpoint has been deprecated.' + description: |- + Get hourly usage for audit logs. + **Note:** This endpoint has been deprecated. operationId: GetUsageAuditLogs parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageAuditLogsResponse' + $ref: "#/components/schemas/UsageAuditLogsResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for audit logs tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/aws_lambda: get: deprecated: true - description: 'Get hourly usage for Lambda. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for Lambda. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageLambda parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage ending **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageLambdaResponse' + $ref: "#/components/schemas/UsageLambdaResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for Lambda tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/billable-summary: get: - description: 'Get billable usage across your account. - + description: |- + Get billable usage across your account. - This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).' + This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/). operationId: GetUsageBillableSummary parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` - for usage starting this month.' - in: query - name: month - required: false - schema: - format: date-time - type: string - - 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`. - in: query - name: include_connected_accounts - required: false - schema: - default: false - type: boolean + - description: "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month." + in: query + name: month + required: false + schema: + format: date-time + type: string + - 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`." + in: query + name: include_connected_accounts + required: false + schema: + default: false + type: boolean responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageBillableSummaryResponse' + $ref: "#/components/schemas/UsageBillableSummaryResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get billable usage across your account tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/ci-app: get: deprecated: true - description: 'Get hourly usage for CI visibility (tests, pipeline, and spans). - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for CI visibility (tests, pipeline, and spans). + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageCIApp parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageCIVisibilityResponse' + $ref: "#/components/schemas/UsageCIVisibilityResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for CI visibility tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/cspm: get: deprecated: true - description: 'Get hourly usage for cloud security management (CSM) pro. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for cloud security management (CSM) pro. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageCloudSecurityPostureManagement parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageCloudSecurityPostureManagementResponse' + $ref: "#/components/schemas/UsageCloudSecurityPostureManagementResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for CSM Pro tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/cws: get: deprecated: true - description: 'Get hourly usage for cloud workload security. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for cloud workload security. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageCWS parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageCWSResponse' + $ref: "#/components/schemas/UsageCWSResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for cloud workload security tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/dbm: get: deprecated: true - description: 'Get hourly usage for database monitoring - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for database monitoring + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageDBM parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageDBMResponse' + $ref: "#/components/schemas/UsageDBMResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for database monitoring tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/fargate: get: deprecated: true - description: 'Get hourly usage for [Fargate](https://docs.datadoghq.com/integrations/ecs_fargate/). - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for [Fargate](https://docs.datadoghq.com/integrations/ecs_fargate/). + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageFargate parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage ending **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageFargateResponse' + $ref: "#/components/schemas/UsageFargateResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for Fargate tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/hosts: get: deprecated: true - description: 'Get hourly usage for hosts and containers. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for hosts and containers. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageHosts parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage ending **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string - responses: - '200': - content: + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." + in: query + name: end_hr + required: false + schema: + format: date-time + type: string + responses: + "200": + content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageHostsResponse' + $ref: "#/components/schemas/UsageHostsResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for hosts and containers tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/hourly-attribution: get: - description: "Get hourly usage attribution. Multi-region data is available starting - March 1, 2023.\n\nThis API endpoint is paginated. To make sure you receive - all records, check if the value of `next_record_id` is\nset in the response. - If it is, make another request and pass `next_record_id` as a parameter.\nPseudo - code example:\n\n```\nresponse := GetHourlyUsageAttribution(start_month)\ncursor - := response.metadata.pagination.next_record_id\nWHILE cursor != null BEGIN\n - \ sleep(5 seconds) # Avoid running into rate limit\n response := GetHourlyUsageAttribution(start_month, - next_record_id=cursor)\n cursor := response.metadata.pagination.next_record_id\nEND\n```" + description: |- + Get hourly usage attribution. Multi-region data is available starting March 1, 2023. + + This API endpoint is paginated. To make sure you receive all records, check if the value of `next_record_id` is + set in the response. If it is, make another request and pass `next_record_id` as a parameter. + Pseudo code example: + + ``` + response := GetHourlyUsageAttribution(start_month) + cursor := response.metadata.pagination.next_record_id + WHILE cursor != null BEGIN + sleep(5 seconds) # Avoid running into rate limit + response := GetHourlyUsageAttribution(start_month, next_record_id=cursor) + cursor := response.metadata.pagination.next_record_id + END + ``` operationId: GetHourlyUsageAttribution parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string - - description: 'Usage type to retrieve. Usage types are in the format `_usage`. - - Example: `infra_host_usage` - - To obtain the complete list of active usage types that can be used to replace - - `` in the field names, make a request to the [Get usage attribution - types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types).' - in: query - name: usage_type - required: true - schema: - $ref: '#/components/schemas/HourlyUsageAttributionUsageType' - - description: List following results with a next_record_id provided in the - previous query. - in: query - name: next_record_id - required: false - schema: - type: string - - description: 'Comma separated list of tags used to group usage. If no value - is provided the usage will not be broken down by tags. - + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string + - description: |- + Usage type to retrieve. Usage types are in the format `_usage`. + Example: `infra_host_usage` + To obtain the complete list of active usage types that can be used to replace + `` in the field names, make a request to the [Get usage attribution types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types). + in: query + name: usage_type + required: true + schema: + $ref: "#/components/schemas/HourlyUsageAttributionUsageType" + - description: List following results with a next_record_id provided in the previous query. + in: query + name: next_record_id + required: false + schema: + type: string + - description: |- + Comma separated list of tags used to group usage. If no value is provided the usage will not be broken down by tags. - To see which tags are available, look for the value of `tag_config_source` - in the API response.' - in: query - name: tag_breakdown_keys - required: false - schema: - type: string - - description: Include child org usage in the response. Defaults to `true`. - in: query - name: include_descendants - required: false - schema: - default: true - type: boolean + To see which tags are available, look for the value of `tag_config_source` in the API response. + in: query + name: tag_breakdown_keys + required: false + schema: + type: string + - description: "Include child org usage in the response. Defaults to `true`." + in: query + name: include_descendants + required: false + schema: + default: true + type: boolean responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/HourlyUsageAttributionResponse' + $ref: "#/components/schemas/HourlyUsageAttributionResponse" description: OK - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage attribution tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/incident-management: get: deprecated: true - description: 'Get hourly usage for incident management. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for incident management. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetIncidentManagement parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageIncidentManagementResponse' + $ref: "#/components/schemas/UsageIncidentManagementResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for incident management tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/indexed-spans: get: deprecated: true - description: 'Get hourly usage for indexed spans. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for indexed spans. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageIndexedSpans parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageIndexedSpansResponse' + $ref: "#/components/schemas/UsageIndexedSpansResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for indexed spans tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/ingested-spans: get: deprecated: true - description: 'Get hourly usage for ingested spans. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for ingested spans. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetIngestedSpans parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageIngestedSpansResponse' + $ref: "#/components/schemas/UsageIngestedSpansResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for ingested spans tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/iot: get: deprecated: true - description: 'Get hourly usage for IoT. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for IoT. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageInternetOfThings parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageIoTResponse' + $ref: "#/components/schemas/UsageIoTResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for IoT tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/logs: get: deprecated: true - description: 'Get hourly usage for logs. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for logs. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageLogs parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage ending **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageLogsResponse' + $ref: "#/components/schemas/UsageLogsResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for logs tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/logs-by-retention: get: deprecated: true - description: 'Get hourly usage for indexed logs by retention period. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for indexed logs by retention period. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageLogsByRetention parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageLogsByRetentionResponse' + $ref: "#/components/schemas/UsageLogsByRetentionResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly logs usage by retention tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/logs_by_index: get: - description: Get hourly usage for logs by index. + description: |- + Get hourly usage for logs by index. operationId: GetUsageLogsByIndex parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage ending **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string - - description: Comma-separated list of log index names. - in: query - name: index_name - required: false - schema: - items: + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time type: string - type: array + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." + in: query + name: end_hr + required: false + schema: + format: date-time + type: string + - description: Comma-separated list of log index names. + in: query + name: index_name + required: false + schema: + items: + type: string + type: array responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageLogsByIndexResponse' + $ref: "#/components/schemas/UsageLogsByIndexResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for logs by index tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/monthly-attribution: get: - description: "Get monthly usage attribution. Multi-region data is available - starting March 1, 2023.\n\nThis API endpoint is paginated. To make sure you - receive all records, check if the value of `next_record_id` is\nset in the - response. If it is, make another request and pass `next_record_id` as a parameter.\nPseudo - code example:\n\n```\nresponse := GetMonthlyUsageAttribution(start_month)\ncursor - := response.metadata.pagination.next_record_id\nWHILE cursor != null BEGIN\n - \ sleep(5 seconds) # Avoid running into rate limit\n response := GetMonthlyUsageAttribution(start_month, - next_record_id=cursor)\n cursor := response.metadata.pagination.next_record_id\nEND\n```" + description: |- + Get monthly usage attribution. Multi-region data is available starting March 1, 2023. + + This API endpoint is paginated. To make sure you receive all records, check if the value of `next_record_id` is + set in the response. If it is, make another request and pass `next_record_id` as a parameter. + Pseudo code example: + + ``` + response := GetMonthlyUsageAttribution(start_month) + cursor := response.metadata.pagination.next_record_id + WHILE cursor != null BEGIN + sleep(5 seconds) # Avoid running into rate limit + response := GetMonthlyUsageAttribution(start_month, next_record_id=cursor) + cursor := response.metadata.pagination.next_record_id + END + ``` operationId: GetMonthlyUsageAttribution parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` - for usage beginning in this month. - - Maximum of 15 months ago.' - in: query - name: start_month - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` - for usage ending this month.' - in: query - name: end_month - required: false - schema: - format: date-time - type: string - - description: 'Comma-separated list of usage types to return, or `*` for all - usage types. - - Usage types are in the format `_usage` and `_percentage`. - - Example: `infra_host_usage,infra_host_percentage` - - To obtain the complete list of usage attribution types that can be used - to replace - - `` in the field names, make a request to the [Get usage attribution - types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types).' - in: query - name: fields - required: true - schema: - $ref: '#/components/schemas/MonthlyUsageAttributionSupportedMetrics' - - description: 'The direction to sort by: `[desc, asc]`.' - in: query - name: sort_direction - required: false - schema: - $ref: '#/components/schemas/UsageSortDirection' - - description: 'The field to sort by. Sort fields are in the format `_usage`. - - Example: `infra_host_usage` - - To obtain the complete list of usage attribution types that can be used - to replace - - `` in the field names, make a request to the [Get usage attribution - types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types).' - in: query - name: sort_name - required: false - schema: - $ref: '#/components/schemas/MonthlyUsageAttributionSupportedMetrics' - - description: 'Comma separated list of tag keys used to group usage. If no - value is provided the usage will not be broken down by tags. - - - To see which tags are available, look for the value of `tag_config_source` - in the API response.' - in: query - name: tag_breakdown_keys - required: false - schema: - type: string - - description: List following results with a next_record_id provided in the - previous query. - in: query - name: next_record_id - required: false - schema: - type: string - - description: Include child org usage in the response. Defaults to `true`. - in: query - name: include_descendants - required: false - schema: - default: true - type: boolean + - description: |- + Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. + Maximum of 15 months ago. + in: query + name: start_month + required: true + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month." + in: query + name: end_month + required: false + schema: + format: date-time + type: string + - description: |- + Comma-separated list of usage types to return, or `*` for all usage types. + Usage types are in the format `_usage` and `_percentage`. + Example: `infra_host_usage,infra_host_percentage` + To obtain the complete list of usage attribution types that can be used to replace + `` in the field names, make a request to the [Get usage attribution types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types). + in: query + name: fields + required: true + schema: + $ref: "#/components/schemas/MonthlyUsageAttributionSupportedMetrics" + - description: "The direction to sort by: `[desc, asc]`." + in: query + name: sort_direction + required: false + schema: + $ref: "#/components/schemas/UsageSortDirection" + - description: |- + The field to sort by. Sort fields are in the format `_usage`. + Example: `infra_host_usage` + To obtain the complete list of usage attribution types that can be used to replace + `` in the field names, make a request to the [Get usage attribution types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types). + in: query + name: sort_name + required: false + schema: + $ref: "#/components/schemas/MonthlyUsageAttributionSupportedMetrics" + - description: |- + Comma separated list of tag keys used to group usage. If no value is provided the usage will not be broken down by tags. + + To see which tags are available, look for the value of `tag_config_source` in the API response. + in: query + name: tag_breakdown_keys + required: false + schema: + type: string + - description: List following results with a next_record_id provided in the previous query. + in: query + name: next_record_id + required: false + schema: + type: string + - description: "Include child org usage in the response. Defaults to `true`." + in: query + name: include_descendants + required: false + schema: + default: true + type: boolean responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/MonthlyUsageAttributionResponse' + $ref: "#/components/schemas/MonthlyUsageAttributionResponse" description: OK - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get monthly usage attribution tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/network_flows: get: deprecated: true - description: 'Get hourly usage for network flows. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for network flows. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageNetworkFlows parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageNetworkFlowsResponse' + $ref: "#/components/schemas/UsageNetworkFlowsResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: get hourly usage for network flows tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/network_hosts: get: deprecated: true - description: 'Get hourly usage for network hosts. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for network hosts. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageNetworkHosts parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage ending **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageNetworkHostsResponse' + $ref: "#/components/schemas/UsageNetworkHostsResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for network hosts tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/online-archive: get: deprecated: true - description: 'Get hourly usage for online archive. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for online archive. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageOnlineArchive parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageOnlineArchiveResponse' + $ref: "#/components/schemas/UsageOnlineArchiveResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for online archive tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/profiling: get: deprecated: true - description: 'Get hourly usage for profiled hosts. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for profiled hosts. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageProfiling parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageProfilingResponse' + $ref: "#/components/schemas/UsageProfilingResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for profiled hosts tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/rum: get: deprecated: true - description: 'Get hourly usage for [RUM](https://docs.datadoghq.com/real_user_monitoring/) - Units. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for [RUM](https://docs.datadoghq.com/real_user_monitoring/) Units. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageRumUnits parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage ending **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageRumUnitsResponse' + $ref: "#/components/schemas/UsageRumUnitsResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for RUM units tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/rum_sessions: get: deprecated: true - description: 'Get hourly usage for [RUM](https://docs.datadoghq.com/real_user_monitoring/) - Sessions. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for [RUM](https://docs.datadoghq.com/real_user_monitoring/) Sessions. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageRumSessions parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage ending **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string - - description: 'RUM type: `[browser, mobile]`. Defaults to `browser`.' - in: query - name: type - required: false - schema: - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." + in: query + name: end_hr + required: false + schema: + format: date-time + type: string + - description: "RUM type: `[browser, mobile]`. Defaults to `browser`." + in: query + name: type + required: false + schema: + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageRumSessionsResponse' + $ref: "#/components/schemas/UsageRumSessionsResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for RUM sessions tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/sds: get: deprecated: true - description: 'Get hourly usage for sensitive data scanner. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for sensitive data scanner. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageSDS parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageSDSResponse' + $ref: "#/components/schemas/UsageSDSResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for sensitive data scanner tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/snmp: get: deprecated: true - description: 'Get hourly usage for SNMP devices. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for SNMP devices. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageSNMP parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageSNMPResponse' + $ref: "#/components/schemas/UsageSNMPResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for SNMP devices tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/summary: get: - description: 'Get all usage across your account. - + description: |- + Get all usage across your account. - This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).' + This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/). operationId: GetUsageSummary parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` - for usage beginning in this month. - - Maximum of 15 months ago.' - in: query - name: start_month - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` - for usage ending this month.' - in: query - name: end_month - required: false - schema: - format: date-time - type: string - - description: Include usage summaries for each sub-org. - in: query - name: include_org_details - required: false - schema: - type: boolean - - 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`. - in: query - name: include_connected_accounts - required: false - schema: - default: false - type: boolean + - description: |- + Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. + Maximum of 15 months ago. + in: query + name: start_month + required: true + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month." + in: query + name: end_month + required: false + schema: + format: date-time + type: string + - description: Include usage summaries for each sub-org. + in: query + name: include_org_details + required: false + schema: + type: boolean + - 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`." + in: query + name: include_connected_accounts + required: false + schema: + default: false + type: boolean responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageSummaryResponse' + $ref: "#/components/schemas/UsageSummaryResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get usage across your account tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/synthetics: get: deprecated: true - description: 'Get hourly usage for [synthetics checks](https://docs.datadoghq.com/synthetics/). - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for [synthetics checks](https://docs.datadoghq.com/synthetics/). + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageSynthetics parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage ending **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageSyntheticsResponse' + $ref: "#/components/schemas/UsageSyntheticsResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for synthetics checks tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/synthetics_api: get: deprecated: true - description: 'Get hourly usage for [synthetics API checks](https://docs.datadoghq.com/synthetics/). - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for [synthetics API checks](https://docs.datadoghq.com/synthetics/). + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageSyntheticsAPI parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage ending **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageSyntheticsAPIResponse' + $ref: "#/components/schemas/UsageSyntheticsAPIResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for synthetics API checks tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/synthetics_browser: get: deprecated: true - description: 'Get hourly usage for synthetics browser checks. - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for synthetics browser checks. + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageSyntheticsBrowser parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage ending **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageSyntheticsBrowserResponse' + $ref: "#/components/schemas/UsageSyntheticsBrowserResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for synthetics browser checks tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/timeseries: get: deprecated: true - description: 'Get hourly usage for [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/). - - **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). - Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) - for the associated migration guide.' + description: |- + Get hourly usage for [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/). + **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). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide. operationId: GetUsageTimeseries parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage ending **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageTimeseriesResponse' + $ref: "#/components/schemas/UsageTimeseriesResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for custom metrics tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/usage/top_avg_metrics: get: - description: Get all [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/) - by hourly average. Use the month parameter to get a month-to-date data resolution - or use the day parameter to get a daily resolution. One of the two is required, - and only one of the two is allowed. + description: Get all [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/) by hourly average. Use the month parameter to get a month-to-date data resolution or use the day parameter to get a daily resolution. One of the two is required, and only one of the two is allowed. operationId: GetUsageTopAvgMetrics parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] - for usage beginning at this hour. (Either month or day should be specified, - but not both)' - in: query - name: month - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] - for usage beginning at this hour. (Either month or day should be specified, - but not both)' - in: query - name: day - schema: - format: date-time - type: string - - description: Comma-separated list of metric names. - in: query - name: names - required: false - schema: - items: + - description: "Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)" + in: query + name: month + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)" + in: query + name: day + schema: + format: date-time + type: string + - description: Comma-separated list of metric names. + in: query + name: names + required: false + schema: + items: + type: string + type: array + - description: Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified. + in: query + name: limit + required: false + schema: + default: 500 + format: int32 + maximum: 5000 + minimum: 1 + type: integer + - description: List following results with a next_record_id provided in the previous query. + in: query + name: next_record_id + required: false + schema: type: string - type: array - - description: Maximum number of results to return (between 1 and 5000) - defaults - to 500 results if limit not specified. - in: query - name: limit - required: false - schema: - default: 500 - format: int32 - maximum: 5000 - minimum: 1 - type: integer - - description: List following results with a next_record_id provided in the - previous query. - in: query - name: next_record_id - required: false - schema: - type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageTopAvgMetricsResponse' + $ref: "#/components/schemas/UsageTopAvgMetricsResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get all custom metrics by hourly average tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v1/user: get: description: List all users for your organization. operationId: ListUsers responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserListResponse' + $ref: "#/components/schemas/UserListResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_read summary: List all users tags: - - Users - x-permission: + - Users + "x-permission": operator: OR permissions: - - user_access_read + - user_access_read post: - description: 'Create a user for your organization. - + description: |- + Create a user for your organization. **Note**: Users can only be created with the admin access role - - if application keys belong to administrators.' + if application keys belong to administrators. operationId: CreateUser requestBody: content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" description: User object that needs to be created. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserResponse' + $ref: "#/components/schemas/UserResponse" description: User created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Conflict - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a user tags: - - Users + - Users x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_invite - /api/v1/user/{user_handle}: + - user_access_invite + "/api/v1/user/{user_handle}": delete: - description: 'Delete a user from an organization. - + description: |- + Delete a user from an organization. **Note**: This endpoint can only be used with application keys belonging to - - administrators.' + administrators. operationId: DisableUser parameters: - - description: The handle of the user. - in: path - name: user_handle - required: true - schema: - example: test@datadoghq.com - type: string + - description: The handle of the user. + in: path + name: user_handle + required: true + schema: + example: test@datadoghq.com + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserDisableResponse' + $ref: "#/components/schemas/UserDisableResponse" description: User disabled - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Disable a user tags: - - Users + - Users get: description: Get a user's details. operationId: GetUser parameters: - - description: The ID of the user. - in: path - name: user_handle - required: true - schema: - example: test@datadoghq.com - type: string + - description: The ID of the user. + in: path + name: user_handle + required: true + schema: + example: test@datadoghq.com + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserResponse' + $ref: "#/components/schemas/UserResponse" description: OK for get user - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get user details tags: - - Users + - Users put: - description: 'Update a user information. - + description: |- + Update a user information. - **Note**: It can only be used with application keys belonging to administrators.' + **Note**: It can only be used with application keys belonging to administrators. operationId: UpdateUser parameters: - - description: The ID of the user. - in: path - name: user_handle - required: true - schema: - example: test@datadoghq.com - type: string + - description: The ID of the user. + in: path + name: user_handle + required: true + schema: + example: test@datadoghq.com + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" description: Description of the update. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserResponse' + $ref: "#/components/schemas/UserResponse" description: User updated - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a user tags: - - Users + - Users x-codegen-request-body-name: body /api/v1/validate: get: - description: Check if the API key (not the APP key) is valid. If invalid, a - 403 is returned. + description: Check if the API key (not the APP key) is valid. If invalid, a 403 is returned. operationId: Validate responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AuthenticationValidationResponse' + $ref: "#/components/schemas/AuthenticationValidationResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] + - apiKeyAuth: [] summary: Validate API key tags: - - Authentication - x-permission: + - Authentication + "x-permission": operator: OPEN permissions: [] /v1/input: post: deprecated: true - description: 'Send your logs to your Datadog platform over HTTP. Limits per - HTTP request are: - + description: |- + Send your logs to your Datadog platform over HTTP. Limits per HTTP request are: - Maximum content size per payload (uncompressed): 5MB - - Maximum size for a single log: 1MB - - Maximum array size if sending multiple logs in an array: 1000 entries - Any log exceeding 1MB is accepted and truncated by Datadog: - - - For a single log request, the API truncates the log at 1MB and returns a - 2xx. - - - For a multi-logs request, the API processes all logs, truncates only logs - larger than 1MB, and returns a 2xx. - + - For a single log request, the API truncates the log at 1MB and returns a 2xx. + - For a multi-logs request, the API processes all logs, truncates only logs larger than 1MB, and returns a 2xx. Datadog recommends sending your logs compressed. - - Add the `Content-Encoding: gzip` header to the request when sending compressed - logs. - + Add the `Content-Encoding: gzip` header to the request when sending compressed logs. The status codes answered by the HTTP API are: - - 200: OK - - 400: Bad request (likely an issue in the payload formatting) - - 403: Permission issue (likely using an invalid API Key) - - 413: Payload too large (batch is above 5MB uncompressed) - - - 5xx: Internal error, request should be retried after some time' + - 5xx: Internal error, request should be retried after some time operationId: SubmitLog parameters: - - description: HTTP header used to compress the media-type. - in: header - name: Content-Encoding - required: false - schema: - $ref: '#/components/schemas/ContentEncoding' - - description: Log tags can be passed as query parameters with `text/plain` - content type. - example: env:prod,user:my-user - in: query - name: ddtags - required: false - schema: - type: string + - description: HTTP header used to compress the media-type. + in: header + name: Content-Encoding + required: false + schema: + $ref: "#/components/schemas/ContentEncoding" + - description: Log tags can be passed as query parameters with `text/plain` content type. + example: "env:prod,user:my-user" + in: query + name: ddtags + required: false + schema: + type: string requestBody: content: application/json: @@ -39825,31 +36972,30 @@ paths: description: Pass multiple log objects at once. summary: Multi JSON Messages value: - - message: hello - - message: world + - message: hello + - message: world schema: - $ref: '#/components/schemas/HTTPLog' + $ref: "#/components/schemas/HTTPLog" application/json;simple: examples: simple-json-message: - description: Log attributes can be passed as `key:value` pairs in - valid JSON messages. + description: Log attributes can be passed as `key:value` pairs in valid JSON messages. summary: Simple JSON Message value: - ddsource: agent - ddtags: env:prod,user:joe.doe - hostname: fa1e1e739d95 + ddsource: "agent" + ddtags: "env:prod,user:joe.doe" + hostname: "fa1e1e739d95" message: hello world schema: - $ref: '#/components/schemas/HTTPLogItem' + $ref: "#/components/schemas/HTTPLogItem" application/logplex-1: examples: multi-raw-message: description: Submit log messages. summary: Multi Logplex Messages - value: 'hello - - world' + value: |- + hello + world simple-logplex-message: description: Submit log string. summary: Simple Logplex Message @@ -39861,13 +37007,12 @@ paths: multi-raw-message: description: Submit log string. summary: Multi Raw Messages - value: 'hello - - world' + value: |- + hello + world simple-raw-message: - description: 'Submit log string. Log attributes can be passed as query - parameters in the URL. This enables the addition of tags or the - source by using the `ddtags` and `ddsource` parameters: `?host=my-hostname&service=my-service&ddsource=my-source&ddtags=env:prod,user:my-user`.' + description: >- + Submit log string. Log attributes can be passed as query parameters in the URL. This enables the addition of tags or the source by using the `ddtags` and `ddsource` parameters: `?host=my-hostname&service=my-service&ddsource=my-source&ddtags=env:prod,user:my-user`. summary: Simple Raw Message value: hello world schema: @@ -39875,399 +37020,341 @@ paths: description: Log to send (JSON format). required: true responses: - '200': + "200": content: application/json: schema: type: object description: Response from server (always 200 empty JSON). - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/HTTPLogError' + $ref: "#/components/schemas/HTTPLogError" description: unexpected error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] + - apiKeyAuth: [] servers: - - url: https://{subdomain}.{site} - variables: - site: - default: datadoghq.com - description: The regional site for Datadog customers. - enum: - - datadoghq.com - - us3.datadoghq.com - - us5.datadoghq.com - - ap1.datadoghq.com - - ap2.datadoghq.com - - datadoghq.eu - - ddog-gov.com - subdomain: - default: http-intake.logs - description: The subdomain where the API is deployed. - - url: '{protocol}://{name}' - variables: - name: - default: http-intake.logs.datadoghq.com - description: Full site DNS name. - protocol: - default: https - description: The protocol for accessing the API. - - url: https://{subdomain}.{site} - variables: - site: - default: datadoghq.com - description: Any Datadog deployment. - subdomain: - default: http-intake.logs - description: The subdomain where the API is deployed. + - url: https://{subdomain}.{site} + variables: + site: + default: datadoghq.com + description: The regional site for Datadog customers. + enum: + - datadoghq.com + - us3.datadoghq.com + - us5.datadoghq.com + - ap1.datadoghq.com + - ap2.datadoghq.com + - datadoghq.eu + - ddog-gov.com + subdomain: + default: http-intake.logs + description: The subdomain where the API is deployed. + - url: "{protocol}://{name}" + variables: + name: + default: http-intake.logs.datadoghq.com + description: Full site DNS name. + protocol: + default: https + description: The protocol for accessing the API. + - url: https://{subdomain}.{site} + variables: + site: + default: datadoghq.com + description: Any Datadog deployment. + subdomain: + default: http-intake.logs + description: The subdomain where the API is deployed. summary: Send logs tags: - - Logs + - Logs x-codegen-request-body-name: body security: -- apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] servers: -- url: https://{subdomain}.{site} - variables: - site: - default: datadoghq.com - description: The regional site for Datadog customers. - enum: - - datadoghq.com - - us3.datadoghq.com - - us5.datadoghq.com - - ap1.datadoghq.com - - ap2.datadoghq.com - - datadoghq.eu - - ddog-gov.com - subdomain: - default: api - description: The subdomain where the API is deployed. -- url: '{protocol}://{name}' - variables: - name: - default: api.datadoghq.com - description: Full site DNS name. - protocol: - default: https - description: The protocol for accessing the API. -- url: https://{subdomain}.{site} - variables: - site: - default: datadoghq.com - description: Any Datadog deployment. - subdomain: - default: api - description: The subdomain where the API is deployed. + - url: https://{subdomain}.{site} + variables: + site: + default: datadoghq.com + description: The regional site for Datadog customers. + enum: + - datadoghq.com + - us3.datadoghq.com + - us5.datadoghq.com + - ap1.datadoghq.com + - ap2.datadoghq.com + - datadoghq.eu + - ddog-gov.com + subdomain: + default: api + description: The subdomain where the API is deployed. + - url: "{protocol}://{name}" + variables: + name: + default: api.datadoghq.com + description: Full site DNS name. + protocol: + default: https + description: The protocol for accessing the API. + - url: https://{subdomain}.{site} + variables: + site: + default: datadoghq.com + description: Any Datadog deployment. + subdomain: + default: api + description: The subdomain where the API is deployed. tags: -- description: 'Configure your Datadog-AWS integration directly through the Datadog - API. - - For more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services).' - name: AWS Integration -- description: 'Configure your Datadog-AWS-Logs integration directly through Datadog - API. - - For more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection).' - externalDocs: - url: https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection - name: AWS Logs Integration -- description: "All requests to Datadog\u2019s API must be authenticated.\nRequests - that write data require reporting access and require an `API key`.\nRequests that - read data require full access and also require an `application key`.\n\n**Note:** - All Datadog API clients are configured by default to consume Datadog US site APIs.\nIf - you are on the Datadog EU site, set the environment variable `DATADOG_HOST` to\n`https://api.datadoghq.eu` - or override this value directly when creating your client.\n\n[Manage your account\u2019s - API and application keys](https://app.datadoghq.com/organization-settings/) in - Datadog, and see the [API and Application Keys page](https://docs.datadoghq.com/account_management/api-app-keys/) - in the documentation." - name: Authentication -- description: 'Configure your Datadog-Azure integration directly through the Datadog - API. - - For more information, see the [Datadog-Azure integration page](https://docs.datadoghq.com/integrations/azure).' - externalDocs: - url: https://docs.datadoghq.com/integrations/azure - name: Azure Integration -- description: 'Interact with your dashboard lists through the API to - - organize, find, and share all of your dashboards with your team and - - organization.' - name: Dashboard Lists - x-deprecated: true -- description: Manage all your dashboards, as well as access to your shared dashboards, - through the API. See the [Dashboards page](https://docs.datadoghq.com/dashboards/) - for more information. - name: Dashboards -- description: '[Downtiming](https://docs.datadoghq.com/monitors/notify/downtimes) - gives - - you greater control over monitor notifications by allowing you to globally exclude - - scopes from alerting. Downtime settings, which can be scheduled with start and - - end times, prevent all alerting related to specified Datadog tags. - - - **Note:** `curl` commands require [url encoding](https://curl.se/docs/url-syntax.html).' - name: Downtimes -- description: 'The Event Management API allows you to programmatically post events - to the Events Explorer and fetch events from the Events Explorer. See the [Event - Management page](https://docs.datadoghq.com/service_management/events/) for more - information. - - - **Update to Datadog monitor events `aggregation_key` starting March 1, 2025:** - The Datadog monitor events `aggregation_key` is unique to each Monitor ID. Starting - March 1st, this key will also include Monitor Group, making it unique per *Monitor - ID and Monitor Group*. If you''re using monitor events `aggregation_key` in dashboard - queries or the Event API, you must migrate to use `@monitor.id`. Reach out to - [support](https://www.datadoghq.com/support/) if you have any question.' - name: Events -- description: 'Configure your Datadog-Google Cloud Platform (GCP) integration directly - - through the Datadog API. Read more about the [Datadog-Google Cloud Platform integration](https://docs.datadoghq.com/integrations/google_cloud_platform).' - externalDocs: - url: https://docs.datadoghq.com/integrations/google_cloud_platform - name: GCP Integration -- description: Get information about your infrastructure hosts in Datadog, and mute - or unmute any notifications from your hosts. See the [Infrastructure page](https://docs.datadoghq.com/infrastructure/) - for more information. - name: Hosts -- description: Get a list of IP prefixes belonging to Datadog. - name: IP Ranges -- description: 'Manage your Datadog API and application keys. You need an API key - and an - - application key for a user with the required permissions to interact with these - endpoints. - - - Consult the following pages to view and manage your keys: - - - - [API Keys](https://app.datadoghq.com/organization-settings/api-keys) - - - [Application Keys](https://app.datadoghq.com/personal-settings/application-keys)' - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/account_management/api-app-keys/ - name: Key Management -- description: Search your logs and send them to your Datadog platform over HTTP. - See the [Log Management page](https://docs.datadoghq.com/logs/) for more information. - name: Logs -- description: Manage configuration of [log indexes](https://docs.datadoghq.com/logs/indexes/). - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/logs/indexes/ - name: Logs Indexes -- description: "Pipelines and processors operate on incoming logs, parsing\nand transforming - them into structured attributes for easier querying.\n\n- See the [pipelines configuration - page](https://app.datadoghq.com/logs/pipelines)\n for a list of the pipelines - and processors currently configured in web UI.\n\n- Additional API-related information - about processors can be found in the\n [processors documentation](https://docs.datadoghq.com/logs/log_configuration/processors/?tab=api#lookup-processor).\n\n- - For more information about Pipelines, see the\n [pipeline documentation](https://docs.datadoghq.com/logs/log_configuration/pipelines).\n\n**Notes:**\n\n**Grok - parsing rules may effect JSON output and require\nreturned data to be configured - before using in a request.**\nFor example, if you are using the data returned - from a\nrequest for another request body, and have a parsing rule\nthat uses a - regex pattern like `\\s` for spaces, you will\nneed to configure all escaped spaces - as `%{space}` to use\nin the body data." - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/logs/log_configuration - name: Logs Pipelines -- description: "The metrics endpoint allows you to:\n\n- Post metrics data so it can - be graphed on Datadog\u2019s dashboards\n- Query metrics from any time period\n- - Modify tag configurations for metrics\n- View tags and volumes for metrics\n\n**Note**: - A graph can only contain a set number of points\nand as the timeframe over which - a metric is viewed increases,\naggregation between points occurs to stay below - that set number.\n\nThe Post, Patch, and Delete `manage_tags` API methods can - only be performed by\na user who has the `Manage Tags for Metrics` permission.\n\nSee - the [Metrics page](https://docs.datadoghq.com/metrics/) for more information." - name: Metrics -- description: '[Monitors](https://docs.datadoghq.com/monitors) allow you to watch - a metric or check that you care about and - - notifies your team when a defined threshold has exceeded. - - - For more information, see [Creating Monitors](https://docs.datadoghq.com/monitors/create/types/). - - - **Note:** `curl` commands require [url encoding](https://curl.se/docs/url-syntax.html).' - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/monitors/create/types/ - name: Monitors -- description: 'Interact with your notebooks through the API to make it easier to - organize, find, and - - share all of your notebooks with your team and organization. For more information, - see the - - [Notebooks documentation](https://docs.datadoghq.com/notebooks/).' - externalDocs: - description: For more information, see the Notebooks documentation. - url: https://docs.datadoghq.com/notebooks/ - name: Notebooks -- description: Create, edit, and manage your organizations. Read more about [multi-org - accounts](https://docs.datadoghq.com/account_management/multi_organization). - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/account_management/multi_organization - name: Organizations -- description: 'Configure your [Datadog-PagerDuty integration](https://docs.datadoghq.com/integrations/pagerduty/) - - directly through the Datadog API.' - externalDocs: - url: https://docs.datadoghq.com/integrations/pagerduty/ - name: PagerDuty Integration -- description: Create and manage your security rules, signals, filters, and more. - See the [Datadog Security page](https://docs.datadoghq.com/security/) for more - information. - name: Security Monitoring -- description: 'The service check endpoint allows you to post check statuses for use - with monitors. - - Service check messages are limited to 500 characters. If a check is posted with - a message - - containing more than 500 characters, only the first 500 characters are displayed. - Messages - - are limited for checks with a Critical or Warning status, they are dropped for - checks with - - an OK status. - - - - [Read more about Service Check monitors][1]. - - - [Read more about Process Check monitors][2]. - - - [Read more about Network monitors][3]. - - - [Read more about Custom Check monitors][4]. - - - [Read more about Service Checks and status codes][5]. - - - [1]: https://docs.datadoghq.com/monitors/types/service_check/ - - [2]: https://docs.datadoghq.com/monitors/create/types/process_check/?tab=checkalert - - [3]: https://docs.datadoghq.com/monitors/create/types/network/?tab=checkalert - - [4]: https://docs.datadoghq.com/monitors/create/types/custom_check/?tab=checkalert - - [5]: https://docs.datadoghq.com/developers/service_checks/' - name: Service Checks -- description: "SLO Status Corrections allow you to prevent specific time periods - from negatively impacting\nyour SLO\u2019s status and error budget. You can use - Status Corrections for various purposes, such\nas removing planned maintenance - windows, non-business hours, or other time periods that do\nnot correspond to - genuine issues. See [SLO status corrections](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-status-corrections) - for more information." - name: Service Level Objective Corrections -- description: '[Service Level Objectives](https://docs.datadoghq.com/monitors/service_level_objectives/#configuration) - - (or SLOs) are a key part of the site reliability engineering toolkit. - - SLOs provide a framework for defining clear targets around application performance, - - which ultimately help teams provide a consistent customer experience, - - balance feature development with platform stability, - - and improve communication with internal and external users.' - name: Service Level Objectives -- description: 'Configure your [Datadog-Slack integration](https://docs.datadoghq.com/integrations/slack) - - directly through the Datadog API.' - externalDocs: - description: For more information about the Datadog-Slack integration, see the - integration page. - url: https://docs.datadoghq.com/integrations/slack - name: Slack Integration -- description: Take graph snapshots using the API. - name: Snapshots -- description: 'Synthetic tests use simulated requests and actions so you can monitor - the availability and performance of systems and applications. Datadog supports - the following types of synthetic tests: - - - [API tests](https://docs.datadoghq.com/synthetics/api_tests/) - - - [Browser tests](https://docs.datadoghq.com/synthetics/browser_tests) - - - [Network Path tests](https://docs.datadoghq.com/synthetics/network_path_tests/) - - - [Mobile Application tests](https://docs.datadoghq.com/synthetics/mobile_app_testing) - - - You can use the Datadog API to create, manage, and organize tests and test suites - programmatically. - - - For more information, see the [Synthetic Monitoring documentation](https://docs.datadoghq.com/synthetics/).' - name: Synthetics -- description: 'The tag endpoint allows you to assign tags to hosts, - - for example: `role:database`. Those tags are applied to - - all metrics sent by the host. Refer to hosts by name - - (`yourhost.example.com`) when fetching and applying - - tags to a particular host. - - - The component of your infrastructure responsible for a tag is identified - - by a source. For example, some valid sources include nagios, hudson, jenkins, - - users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc. Find a complete - list of source type names under [API Source Attributes](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). - - - Read more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/).' - name: Tags -- description: 'The usage metering API allows you to get hourly, daily, and - - monthly usage across multiple facets of Datadog. - - This API is available to all Pro and Enterprise customers. - - - **Note**: Usage data is delayed by up to 72 hours from when it was incurred. - - It is retained for 15 months. - - - You can retrieve up to 24 hours of hourly usage data for multiple organizations, - - and up to two months of hourly usage data for a single organization in one request. - - Learn more on the [usage details documentation](https://docs.datadoghq.com/account_management/billing/usage_details/).' - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/account_management/billing/usage_details/ - name: Usage Metering -- description: Create, edit, and disable users. - externalDocs: - url: https://docs.datadoghq.com/account_management/users - name: Users -- description: 'Configure your Datadog-Webhooks integration directly through the Datadog - API. - - See the [Webhooks integration page](https://docs.datadoghq.com/integrations/webhooks) - for more information.' - externalDocs: - url: https://docs.datadoghq.com/integrations/webhooks - name: Webhooks Integration + - description: |- + Configure your Datadog-AWS integration directly through the Datadog API. + For more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services). + name: AWS Integration + - description: |- + Configure your Datadog-AWS-Logs integration directly through Datadog API. + For more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection). + externalDocs: + url: https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection + name: AWS Logs Integration + - description: |- + All requests to Datadog’s API must be authenticated. + Requests that write data require reporting access and require an `API key`. + Requests that read data require full access and also require an `application key`. + + **Note:** All Datadog API clients are configured by default to consume Datadog US site APIs. + If you are on the Datadog EU site, set the environment variable `DATADOG_HOST` to + `https://api.datadoghq.eu` or override this value directly when creating your client. + + [Manage your account’s API and application keys](https://app.datadoghq.com/organization-settings/) in Datadog, and see the [API and Application Keys page](https://docs.datadoghq.com/account_management/api-app-keys/) in the documentation. + name: Authentication + - description: |- + Configure your Datadog-Azure integration directly through the Datadog API. + For more information, see the [Datadog-Azure integration page](https://docs.datadoghq.com/integrations/azure). + externalDocs: + url: https://docs.datadoghq.com/integrations/azure + name: Azure Integration + - description: |- + Interact with your dashboard lists through the API to + organize, find, and share all of your dashboards with your team and + organization. + name: Dashboard Lists + x-deprecated: true + - description: |- + Manage all your dashboards, as well as access to your shared dashboards, through the API. See the [Dashboards page](https://docs.datadoghq.com/dashboards/) for more information. + name: Dashboards + - description: |- + [Downtiming](https://docs.datadoghq.com/monitors/notify/downtimes) gives + you greater control over monitor notifications by allowing you to globally exclude + scopes from alerting. Downtime settings, which can be scheduled with start and + end times, prevent all alerting related to specified Datadog tags. + + **Note:** `curl` commands require [url encoding](https://curl.se/docs/url-syntax.html). + name: Downtimes + - description: |- + The Event Management API allows you to programmatically post events to the Events Explorer and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/) for more information. + + **Update to Datadog monitor events `aggregation_key` starting March 1, 2025:** The Datadog monitor events `aggregation_key` is unique to each Monitor ID. Starting March 1st, this key will also include Monitor Group, making it unique per *Monitor ID and Monitor Group*. If you're using monitor events `aggregation_key` in dashboard queries or the Event API, you must migrate to use `@monitor.id`. Reach out to [support](https://www.datadoghq.com/support/) if you have any question. + name: Events + - description: |- + Configure your Datadog-Google Cloud Platform (GCP) integration directly + through the Datadog API. Read more about the [Datadog-Google Cloud Platform integration](https://docs.datadoghq.com/integrations/google_cloud_platform). + externalDocs: + url: https://docs.datadoghq.com/integrations/google_cloud_platform + name: GCP Integration + - description: Get information about your infrastructure hosts in Datadog, and mute or unmute any notifications from your hosts. See the [Infrastructure page](https://docs.datadoghq.com/infrastructure/) for more information. + name: Hosts + - description: Get a list of IP prefixes belonging to Datadog. + name: IP Ranges + - description: |- + Manage your Datadog API and application keys. You need an API key and an + application key for a user with the required permissions to interact with these endpoints. + + Consult the following pages to view and manage your keys: + + - [API Keys](https://app.datadoghq.com/organization-settings/api-keys) + - [Application Keys](https://app.datadoghq.com/personal-settings/application-keys) + externalDocs: + description: Find out more at + url: "https://docs.datadoghq.com/account_management/api-app-keys/" + name: Key Management + - description: |- + Search your logs and send them to your Datadog platform over HTTP. See the [Log Management page](https://docs.datadoghq.com/logs/) for more information. + name: Logs + - description: |- + Manage configuration of [log indexes](https://docs.datadoghq.com/logs/indexes/). + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/logs/indexes/ + name: Logs Indexes + - description: |- + Pipelines and processors operate on incoming logs, parsing + and transforming them into structured attributes for easier querying. + + - See the [pipelines configuration page](https://app.datadoghq.com/logs/pipelines) + for a list of the pipelines and processors currently configured in web UI. + + - Additional API-related information about processors can be found in the + [processors documentation](https://docs.datadoghq.com/logs/log_configuration/processors/?tab=api#lookup-processor). + + - For more information about Pipelines, see the + [pipeline documentation](https://docs.datadoghq.com/logs/log_configuration/pipelines). + + **Notes:** + + **Grok parsing rules may effect JSON output and require + returned data to be configured before using in a request.** + For example, if you are using the data returned from a + request for another request body, and have a parsing rule + that uses a regex pattern like `\s` for spaces, you will + need to configure all escaped spaces as `%{space}` to use + in the body data. + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/logs/log_configuration + name: Logs Pipelines + - description: |- + The metrics endpoint allows you to: + + - Post metrics data so it can be graphed on Datadog’s dashboards + - Query metrics from any time period + - Modify tag configurations for metrics + - View tags and volumes for metrics + + **Note**: A graph can only contain a set number of points + and as the timeframe over which a metric is viewed increases, + aggregation between points occurs to stay below that set number. + + The Post, Patch, and Delete `manage_tags` API methods can only be performed by + a user who has the `Manage Tags for Metrics` permission. + + See the [Metrics page](https://docs.datadoghq.com/metrics/) for more information. + name: Metrics + - description: |- + [Monitors](https://docs.datadoghq.com/monitors) allow you to watch a metric or check that you care about and + notifies your team when a defined threshold has exceeded. + + For more information, see [Creating Monitors](https://docs.datadoghq.com/monitors/create/types/). + + **Note:** `curl` commands require [url encoding](https://curl.se/docs/url-syntax.html). + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/monitors/create/types/ + name: Monitors + - description: |- + Interact with your notebooks through the API to make it easier to organize, find, and + share all of your notebooks with your team and organization. For more information, see the + [Notebooks documentation](https://docs.datadoghq.com/notebooks/). + externalDocs: + description: For more information, see the Notebooks documentation. + url: https://docs.datadoghq.com/notebooks/ + name: Notebooks + - description: Create, edit, and manage your organizations. Read more about [multi-org accounts](https://docs.datadoghq.com/account_management/multi_organization). + externalDocs: + description: Find out more at + url: "https://docs.datadoghq.com/account_management/multi_organization" + name: Organizations + - description: |- + Configure your [Datadog-PagerDuty integration](https://docs.datadoghq.com/integrations/pagerduty/) + directly through the Datadog API. + externalDocs: + url: https://docs.datadoghq.com/integrations/pagerduty/ + name: PagerDuty Integration + - description: |- + Create and manage your security rules, signals, filters, and more. See the [Datadog Security page](https://docs.datadoghq.com/security/) for more information. + name: "Security Monitoring" + - description: |- + The service check endpoint allows you to post check statuses for use with monitors. + Service check messages are limited to 500 characters. If a check is posted with a message + containing more than 500 characters, only the first 500 characters are displayed. Messages + are limited for checks with a Critical or Warning status, they are dropped for checks with + an OK status. + + - [Read more about Service Check monitors][1]. + - [Read more about Process Check monitors][2]. + - [Read more about Network monitors][3]. + - [Read more about Custom Check monitors][4]. + - [Read more about Service Checks and status codes][5]. + + [1]: https://docs.datadoghq.com/monitors/types/service_check/ + [2]: https://docs.datadoghq.com/monitors/create/types/process_check/?tab=checkalert + [3]: https://docs.datadoghq.com/monitors/create/types/network/?tab=checkalert + [4]: https://docs.datadoghq.com/monitors/create/types/custom_check/?tab=checkalert + [5]: https://docs.datadoghq.com/developers/service_checks/ + name: Service Checks + - description: |- + SLO Status Corrections allow you to prevent specific time periods from negatively impacting + your SLO’s status and error budget. You can use Status Corrections for various purposes, such + as removing planned maintenance windows, non-business hours, or other time periods that do + not correspond to genuine issues. See [SLO status corrections](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-status-corrections) for more information. + name: Service Level Objective Corrections + - description: |- + [Service Level Objectives](https://docs.datadoghq.com/monitors/service_level_objectives/#configuration) + (or SLOs) are a key part of the site reliability engineering toolkit. + SLOs provide a framework for defining clear targets around application performance, + which ultimately help teams provide a consistent customer experience, + balance feature development with platform stability, + and improve communication with internal and external users. + name: Service Level Objectives + - description: |- + Configure your [Datadog-Slack integration](https://docs.datadoghq.com/integrations/slack) + directly through the Datadog API. + externalDocs: + description: For more information about the Datadog-Slack integration, see the integration page. + url: https://docs.datadoghq.com/integrations/slack + name: Slack Integration + - description: Take graph snapshots using the API. + name: Snapshots + - description: |- + Synthetic tests use simulated requests and actions so you can monitor the availability and performance of systems and applications. Datadog supports the following types of synthetic tests: + - [API tests](https://docs.datadoghq.com/synthetics/api_tests/) + - [Browser tests](https://docs.datadoghq.com/synthetics/browser_tests) + - [Network Path tests](https://docs.datadoghq.com/synthetics/network_path_tests/) + - [Mobile Application tests](https://docs.datadoghq.com/synthetics/mobile_app_testing) + + You can use the Datadog API to create, manage, and organize tests and test suites programmatically. + + For more information, see the [Synthetic Monitoring documentation](https://docs.datadoghq.com/synthetics/). + name: Synthetics + - description: |- + The tag endpoint allows you to assign tags to hosts, + for example: `role:database`. Those tags are applied to + all metrics sent by the host. Refer to hosts by name + (`yourhost.example.com`) when fetching and applying + tags to a particular host. + + The component of your infrastructure responsible for a tag is identified + by a source. For example, some valid sources include nagios, hudson, jenkins, + users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc. Find a complete list of source type names under [API Source Attributes](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). + + Read more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/). + name: Tags + - description: |- + The usage metering API allows you to get hourly, daily, and + monthly usage across multiple facets of Datadog. + This API is available to all Pro and Enterprise customers. + + **Note**: Usage data is delayed by up to 72 hours from when it was incurred. + It is retained for 15 months. + + You can retrieve up to 24 hours of hourly usage data for multiple organizations, + and up to two months of hourly usage data for a single organization in one request. + Learn more on the [usage details documentation](https://docs.datadoghq.com/account_management/billing/usage_details/). + externalDocs: + description: Find out more at + url: "https://docs.datadoghq.com/account_management/billing/usage_details/" + name: Usage Metering + - description: Create, edit, and disable users. + externalDocs: + url: https://docs.datadoghq.com/account_management/users + name: Users + - description: |- + Configure your Datadog-Webhooks integration directly through the Datadog API. + See the [Webhooks integration page](https://docs.datadoghq.com/integrations/webhooks) for more information. + externalDocs: + url: https://docs.datadoghq.com/integrations/webhooks + name: Webhooks Integration x-group-parameters: true diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 6ae3aae26d9b..cd87c2022c70 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -17,7 +17,7 @@ components: name: filter[created_at][end] required: false schema: - example: '2020-11-24T18:46:21+00:00' + example: "2020-11-24T18:46:21+00:00" type: string APIKeyFilterCreatedAtStartParameter: description: Only include API keys created on or after the specified date. @@ -25,7 +25,7 @@ components: name: filter[created_at][start] required: false schema: - example: '2020-11-24T18:46:21+00:00' + example: "2020-11-24T18:46:21+00:00" type: string APIKeyFilterModifiedAtEndParameter: description: Only include API keys modified on or before the specified date. @@ -33,7 +33,7 @@ components: name: filter[modified_at][end] required: false schema: - example: '2020-11-24T18:46:21+00:00' + example: "2020-11-24T18:46:21+00:00" type: string APIKeyFilterModifiedAtStartParameter: description: Only include API keys modified on or after the specified date. @@ -41,7 +41,7 @@ components: name: filter[modified_at][start] required: false schema: - example: '2020-11-24T18:46:21+00:00' + example: "2020-11-24T18:46:21+00:00" type: string APIKeyFilterParameter: description: Filter API keys by the specified string. @@ -58,13 +58,13 @@ components: schema: type: string APIKeyIncludeParameter: - description: Comma separated list of resource paths for related resources to - include in the response. Supported resource paths are `created_by` and `modified_by`. + description: |- + Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. in: query name: include required: false schema: - example: created_by,modified_by + example: "created_by,modified_by" type: string APIKeyReadConfigReadEnabledParameter: description: Filter API keys by remote config read enabled status. @@ -74,45 +74,40 @@ components: schema: type: boolean APIKeysSortParameter: - description: 'API key attribute used to sort results. Sort order is ascending - + description: |- + API key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the - - attribute with a minus sign.' + attribute with a minus sign. in: query name: sort required: false schema: - $ref: '#/components/schemas/APIKeysSort' + $ref: "#/components/schemas/APIKeysSort" AWSAccountConfigIDPathParameter: - description: 'Unique Datadog ID of the AWS Account Integration Config. To get - the config ID for an account, use the - + description: |- + Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) - - endpoint and query by AWS Account ID.' + endpoint and query by AWS Account ID. in: path name: aws_account_config_id required: true schema: type: string ApplicationKeyFilterCreatedAtEndParameter: - description: Only include application keys created on or before the specified - date. + description: Only include application keys created on or before the specified date. in: query name: filter[created_at][end] required: false schema: - example: '2020-11-24T18:46:21+00:00' + example: "2020-11-24T18:46:21+00:00" type: string ApplicationKeyFilterCreatedAtStartParameter: - description: Only include application keys created on or after the specified - date. + description: Only include application keys created on or after the specified date. in: query name: filter[created_at][start] required: false schema: - example: '2020-11-24T18:46:21+00:00' + example: "2020-11-24T18:46:21+00:00" type: string ApplicationKeyFilterParameter: description: Filter application keys by the specified string. @@ -136,26 +131,23 @@ components: schema: type: string ApplicationKeyIncludeParameter: - description: Resource path for related resources to include in the response. - Only `owned_by` is supported. + description: Resource path for related resources to include in the response. Only `owned_by` is supported. in: query name: include required: false schema: - example: owned_by + example: "owned_by" type: string ApplicationKeysSortParameter: - description: 'Application key attribute used to sort results. Sort order is - ascending - + description: |- + Application key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the - - attribute with a minus sign.' + attribute with a minus sign. in: query name: sort required: false schema: - $ref: '#/components/schemas/ApplicationKeysSort' + $ref: "#/components/schemas/ApplicationKeysSort" ApplicationSecurityWafCustomRuleIDParam: description: The ID of the custom rule. example: 3b5-v82-ns6 @@ -180,21 +172,21 @@ components: schema: type: string AttachmentIDPathParameter: - description: The ID of the attachment. + description: "The ID of the attachment." in: path name: attachment_id required: true schema: - example: 00000000-0000-0000-0000-000000000001 + example: "00000000-0000-0000-0000-000000000001" type: string AttachmentIncludeQueryParameter: - description: 'Resource to include in the response. Supported value: `last_modified_by_user`.' + description: "Resource to include in the response. Supported value: `last_modified_by_user`." explode: false in: query name: include required: false schema: - example: last_modified_by_user + example: "last_modified_by_user" type: string AuthNMappingID: description: The UUID of the AuthN Mapping. @@ -205,7 +197,7 @@ components: type: string AwsAccountId: description: The ID of an AWS account. - example: '123456789012' + example: "123456789012" in: path name: account_id required: true @@ -220,7 +212,7 @@ components: type: string CaseCustomAttributeIDPathParameter: description: Case Custom attribute's UUID - example: f98a5a5b-e0ff-45d4-b2f5-afe6e74de505 + example: "f98a5a5b-e0ff-45d4-b2f5-afe6e74de505" in: path name: custom_attribute_id required: true @@ -228,7 +220,7 @@ components: type: string CaseCustomAttributeKeyPathParameter: description: Case Custom attribute's key - example: aws_region + example: "aws_region" in: path name: custom_attribute_key required: true @@ -236,7 +228,7 @@ components: type: string CaseIDPathParameter: description: Case's UUID or key - example: f98a5a5b-e0ff-45d4-b2f5-afe6e74de504 + example: "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504" in: path name: case_id required: true @@ -248,10 +240,10 @@ components: name: sort[field] required: false schema: - $ref: '#/components/schemas/CaseSortableField' + $ref: "#/components/schemas/CaseSortableField" CaseTypeIDPathParameter: description: Case type's UUID - example: f98a5a5b-e0ff-45d4-b2f5-afe6e74de505 + example: "f98a5a5b-e0ff-45d4-b2f5-afe6e74de505" in: path name: case_type_id required: true @@ -259,7 +251,7 @@ components: type: string CellIDPathParameter: description: Timeline cell's UUID - example: f98a5a5b-e0ff-45d4-b2f5-afe6e74de504 + example: "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504" in: path name: cell_id required: true @@ -267,7 +259,7 @@ components: type: string ChangeRequestDecisionIDPathParameter: description: The identifier of the change request decision. - example: decision-id-0 + example: "decision-id-0" in: path name: decision_id required: true @@ -275,7 +267,7 @@ components: type: string ChangeRequestIDPathParameter: description: The identifier of the change request. - example: CHM-1234 + example: "CHM-1234" in: path name: change_request_id required: true @@ -290,7 +282,7 @@ components: format: int64 type: integer CloudWorkloadSecurityAgentRuleID: - description: The ID of the Agent rule + description: "The ID of the Agent rule" example: 3b5-v82-ns6 in: path name: agent_rule_id @@ -298,7 +290,7 @@ components: schema: type: string CloudWorkloadSecurityPathAgentPolicyID: - description: The ID of the Agent policy + description: "The ID of the Agent policy" example: 6517fcc1-cec7-4394-a655-8d6e9d085255 in: path name: policy_id @@ -306,7 +298,7 @@ components: schema: type: string CloudWorkloadSecurityQueryAgentPolicyID: - description: The ID of the Agent policy + description: "The ID of the Agent policy" example: 6517fcc1-cec7-4394-a655-8d6e9d085255 in: query name: policy_id @@ -357,15 +349,14 @@ components: type: string DatasetID: description: The ID of a defined dataset. - example: 0879ce27-29a1-481f-a12e-bc2a48ec9ae1 + example: "0879ce27-29a1-481f-a12e-bc2a48ec9ae1" in: path name: dataset_id required: true schema: type: string DisableCorrections: - description: Whether to exclude correction windows from the SLO status calculation. - Defaults to false. + description: Whether to exclude correction windows from the SLO status calculation. Defaults to false. in: query name: disable_corrections required: false @@ -379,7 +370,7 @@ components: name: entity_id required: true schema: - example: service:myservice + example: "service:myservice" type: string FastlyAccountID: description: Fastly Account id. @@ -457,7 +448,7 @@ components: name: filter[relation][type] required: false schema: - $ref: '#/components/schemas/RelationType' + $ref: "#/components/schemas/RelationType" FilterRelationByFromRef: description: Filter relations by the reference of the first entity in the relation. example: service:shopping-cart @@ -483,7 +474,7 @@ components: name: filter[type] required: false schema: - $ref: '#/components/schemas/RelationType' + $ref: "#/components/schemas/RelationType" FromTimestamp: description: The starting timestamp for the SLO status query in epoch seconds. in: query @@ -501,15 +492,14 @@ components: schema: type: string GetIssueIncludeQueryParameter: - description: Comma-separated list of relationship objects that should be included - in the response. Possible values are `assignee`, `case`, and `team_owners`. + description: Comma-separated list of relationship objects that should be included in the response. Possible values are `assignee`, `case`, and `team_owners`. explode: false in: query name: include required: false schema: items: - $ref: '#/components/schemas/GetIssueIncludeQueryParameterItem' + $ref: "#/components/schemas/GetIssueIncludeQueryParameterItem" type: array GoogleChatHandleIdPathParameter: description: Your organization handle ID. @@ -557,33 +547,31 @@ components: description: Specifies which related resources should be included in the response. explode: false in: query - name: include + name: "include" required: false schema: items: - $ref: '#/components/schemas/IncidentImpactRelatedObject' + $ref: "#/components/schemas/IncidentImpactRelatedObject" type: array IncidentImportIncludeQueryParameter: - description: Specifies which related object types to include in the response - when importing an incident. + description: Specifies which related object types to include in the response when importing an incident. explode: false in: query - name: include + name: "include" required: false schema: items: - $ref: '#/components/schemas/IncidentImportRelatedObject' + $ref: "#/components/schemas/IncidentImportRelatedObject" type: array IncidentIncludeQueryParameter: - description: Specifies which types of related objects should be included in - the response. + description: Specifies which types of related objects should be included in the response. explode: false in: query - name: include + name: "include" required: false schema: items: - $ref: '#/components/schemas/IncidentRelatedObject' + $ref: "#/components/schemas/IncidentRelatedObject" type: array IncidentIntegrationMetadataIDPathParameter: description: The UUID of the incident integration metadata. @@ -598,18 +586,18 @@ components: name: id required: true schema: - example: 00000000-0000-0000-0000-000000000001 + example: "00000000-0000-0000-0000-000000000001" format: uuid type: string IncidentNotificationRuleIncludeQueryParameter: - description: 'Comma-separated list of resources to include. Supported values: - `created_by_user`, `last_modified_by_user`, `incident_type`, `notification_template`' + description: >- + Comma-separated list of resources to include. Supported values: `created_by_user`, `last_modified_by_user`, `incident_type`, `notification_template` explode: false in: query name: include required: false schema: - example: created_by_user,incident_type,notification_template + example: "created_by_user,incident_type,notification_template" type: string IncidentNotificationTemplateIDPathParameter: description: The ID of the notification template. @@ -617,7 +605,7 @@ components: name: id required: true schema: - example: 00000000-0000-0000-0000-000000000001 + example: "00000000-0000-0000-0000-000000000001" format: uuid type: string IncidentNotificationTemplateIncidentTypeFilterQueryParameter: @@ -627,35 +615,31 @@ components: name: filter[incident-type] required: false schema: - example: 00000000-0000-0000-0000-000000000001 + example: "00000000-0000-0000-0000-000000000001" format: uuid type: string IncidentNotificationTemplateIncludeQueryParameter: - description: 'Comma-separated list of relationships to include. Supported values: - `created_by_user`, `last_modified_by_user`, `incident_type`' + description: >- + Comma-separated list of relationships to include. Supported values: `created_by_user`, `last_modified_by_user`, `incident_type` explode: false in: query name: include required: false schema: - example: created_by_user,incident_type + example: "created_by_user,incident_type" type: string IncidentSearchIncludeQueryParameter: - description: Specifies which types of related objects should be included in - the response. + description: Specifies which types of related objects should be included in the response. in: query - name: include + name: "include" required: false schema: - $ref: '#/components/schemas/IncidentRelatedObject' + $ref: "#/components/schemas/IncidentRelatedObject" IncidentSearchQueryQueryParameter: - description: 'Specifies which incidents should be returned. The query can contain - any number of incident facets - - joined by `ANDs`, along with multiple values for each of those facets joined - by `OR`s. For - - example: `state:active AND severity:(SEV-2 OR SEV-1)`.' + description: |- + Specifies which incidents should be returned. The query can contain any number of incident facets + joined by `ANDs`, along with multiple values for each of those facets joined by `OR`s. For + example: `state:active AND severity:(SEV-2 OR SEV-1)`. explode: false in: query name: query @@ -669,7 +653,7 @@ components: name: sort required: false schema: - $ref: '#/components/schemas/IncidentSearchSortOrder' + $ref: "#/components/schemas/IncidentSearchSortOrder" IncidentServiceIDPathParameter: description: The ID of the incident service. in: path @@ -678,20 +662,19 @@ components: schema: type: string IncidentServiceIncludeQueryParameter: - description: Specifies which types of related objects should be included in - the response. + description: Specifies which types of related objects should be included in the response. in: query - name: include + name: "include" required: false schema: - $ref: '#/components/schemas/IncidentRelatedObject' + $ref: "#/components/schemas/IncidentRelatedObject" IncidentServiceSearchQueryParameter: description: A search query that filters services by name. in: query - name: filter + name: "filter" required: false schema: - example: ExampleServiceName + example: "ExampleServiceName" type: string IncidentTeamIDPathParameter: description: The ID of the incident team. @@ -701,20 +684,19 @@ components: schema: type: string IncidentTeamIncludeQueryParameter: - description: Specifies which types of related objects should be included in - the response. + description: Specifies which types of related objects should be included in the response. in: query - name: include + name: "include" required: false schema: - $ref: '#/components/schemas/IncidentRelatedObject' + $ref: "#/components/schemas/IncidentRelatedObject" IncidentTeamSearchQueryParameter: description: A search query that filters teams by name. in: query - name: filter + name: "filter" required: false schema: - example: ExampleTeamName + example: "ExampleTeamName" type: string IncidentTodoIDPathParameter: description: The UUID of the incident todo. @@ -744,7 +726,7 @@ components: name: include required: false schema: - $ref: '#/components/schemas/IncludeType' + $ref: "#/components/schemas/IncludeType" InstanceId: description: The ID of the workflow instance. in: path @@ -754,7 +736,7 @@ components: type: string IssueIDPathParameter: description: The identifier of the issue. - example: c1726a66-1f64-11ee-b338-da7ad0900002 + example: "c1726a66-1f64-11ee-b338-da7ad0900002" in: path name: issue_id required: true @@ -766,11 +748,11 @@ components: name: kind_id required: true schema: - example: my-job + example: "my-job" type: string LLMObsDatasetIDPathParameter: description: The ID of the LLM Observability dataset. - example: 9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d + example: "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d" in: path name: dataset_id required: true @@ -778,7 +760,7 @@ components: type: string LLMObsExperimentIDPathParameter: description: The ID of the LLM Observability experiment. - example: 3fd6b5e0-8910-4b1c-a7d0-5b84de329012 + example: "3fd6b5e0-8910-4b1c-a7d0-5b84de329012" in: path name: experiment_id required: true @@ -786,7 +768,7 @@ components: type: string LLMObsProjectIDPathParameter: description: The ID of the LLM Observability project. - example: a33671aa-24fd-4dcd-9b33-a8ec7dde7751 + example: "a33671aa-24fd-4dcd-9b33-a8ec7dde7751" in: path name: project_id required: true @@ -874,8 +856,7 @@ components: format: int64 type: integer NDMPageSize: - description: Size for a given page. The maximum allowed value is 500. Defaults - to 50. + description: Size for a given page. The maximum allowed value is 500. Defaults to 50. in: query name: page[size] required: false @@ -886,7 +867,7 @@ components: type: integer NotificationRuleIDPathParameter: description: Notification Rule UUID - example: e555e290-ed65-49bd-ae18-8acbfcf18db7 + example: "e555e290-ed65-49bd-ae18-8acbfcf18db7" in: path name: notification_rule_id required: true @@ -894,7 +875,7 @@ components: type: string OnDemandTaskId: description: The UUID of the task. - example: 6d09294c-9ad9-42fd-a759-a0c1599b4828 + example: "6d09294c-9ad9-42fd-a759-a0c1599b4828" in: path name: task_id required: true @@ -921,7 +902,7 @@ components: name: connection_id required: true schema: - example: f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a + example: "f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a" format: uuid type: string PageNumber: @@ -971,7 +952,7 @@ components: type: string ProjectIDPathParameter: description: Project UUID - example: e555e290-ed65-49bd-ae18-8acbfcf18db7 + example: "e555e290-ed65-49bd-ae18-8acbfcf18db7" in: path name: project_id required: true @@ -979,7 +960,7 @@ components: type: string QueryFilterFrom: description: The minimum timestamp for requested security signals. - example: '2019-01-02T09:42:36.320Z' + example: "2019-01-02T09:42:36.320Z" in: query name: filter[from] required: false @@ -996,7 +977,7 @@ components: type: string QueryFilterTo: description: The maximum timestamp for requested security signals. - example: '2019-01-03T09:42:36.320Z' + example: "2019-01-03T09:42:36.320Z" in: query name: filter[to] required: false @@ -1028,7 +1009,7 @@ components: name: sort required: false schema: - $ref: '#/components/schemas/SecurityMonitoringSignalsSort' + $ref: "#/components/schemas/SecurityMonitoringSignalsSort" RelationInclude: description: Include relationship data. explode: true @@ -1036,7 +1017,7 @@ components: name: include required: false schema: - $ref: '#/components/schemas/RelationIncludeType' + $ref: "#/components/schemas/RelationIncludeType" ReportID: description: The ID of the report job. in: path @@ -1052,8 +1033,7 @@ components: schema: type: string ResourceFilterAccountID: - description: Filter resource filters by cloud provider account ID. This parameter - is only valid when provider is specified. + description: Filter resource filters by cloud provider account ID. This parameter is only valid when provider is specified. in: query name: account_id required: false @@ -1067,12 +1047,9 @@ components: schema: type: string ResourceID: - description: 'Identifier, formatted as `type:id`. Supported types: `dashboard`, - `integration-service`, `integration-webhook`, `notebook`, `reference-table`, - `security-rule`, `slo`, `workflow`, `app-builder-app`, `connection`, `connection-group`, - `rum-application`, `cross-org-connection`, `spreadsheet`, `on-call-schedule`, - `on-call-escalation-policy`, `on-call-team-routing-rules`, `logs-pipeline`.' - example: dashboard:abc-def-ghi + description: |- + Identifier, formatted as `type:id`. Supported types: `dashboard`, `integration-service`, `integration-webhook`, `notebook`, `reference-table`, `security-rule`, `slo`, `workflow`, `app-builder-app`, `connection`, `connection-group`, `rum-application`, `cross-org-connection`, `spreadsheet`, `on-call-schedule`, `on-call-escalation-policy`, `on-call-team-routing-rules`, `logs-pipeline`. + example: "dashboard:abc-def-ghi" in: path name: resource_id required: true @@ -1086,14 +1063,14 @@ components: schema: type: string RestrictionQueryRoleID: - description: The ID of the role. + description: "The ID of the role." in: path name: role_id required: true schema: type: string RestrictionQueryUserID: - description: The ID of the user. + description: "The ID of the user." in: path name: user_id required: true @@ -1147,18 +1124,16 @@ components: name: schema_version required: false schema: - $ref: '#/components/schemas/ServiceDefinitionSchemaVersions' + $ref: "#/components/schemas/ServiceDefinitionSchemaVersions" SearchIssuesIncludeQueryParameter: - description: Comma-separated list of relationship objects that should be included - in the response. Possible values are `issue`, `issue.assignee`, `issue.case`, - and `issue.team_owners`. + description: Comma-separated list of relationship objects that should be included in the response. Possible values are `issue`, `issue.assignee`, `issue.case`, and `issue.team_owners`. explode: false in: query name: include required: false schema: items: - $ref: '#/components/schemas/SearchIssuesIncludeQueryParameterItem' + $ref: "#/components/schemas/SearchIssuesIncludeQueryParameterItem" type: array SecurityFilterID: description: The ID of the security filter. @@ -1203,12 +1178,12 @@ components: schema: type: string ServiceAccountID: - description: The ID of the service account. + description: "The ID of the service account." in: path name: service_account_id required: true schema: - example: 00000000-0000-1234-0000-000000000000 + example: "00000000-0000-1234-0000-000000000000" type: string ServiceName: description: The name of the service. @@ -1216,7 +1191,7 @@ components: name: service_name required: true schema: - example: my-service + example: "my-service" type: string SignalID: description: The ID of the signal. @@ -1238,7 +1213,7 @@ components: name: slo_id required: true schema: - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string SpansMetricIDParameter: description: The name of the span-based metric. @@ -1271,12 +1246,12 @@ components: format: int64 type: integer UserID: - description: The ID of the user. + description: "The ID of the user." in: path name: user_id required: true schema: - example: 00000000-0000-9999-0000-000000000000 + example: "00000000-0000-9999-0000-000000000000" type: string WorkflowId: description: The ID of the workflow. @@ -1289,143 +1264,141 @@ components: responses: BadRequestResponse: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request ConcurrentModificationResponse: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Concurrent Modification ConflictResponse: content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Conflict FindingsBadRequestResponse: content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Bad Request: The server cannot process the request due to invalid - syntax in the request.' + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Bad Request: The server cannot process the request due to invalid syntax in the request." FindingsForbiddenResponse: content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Forbidden: Access denied' + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Forbidden: Access denied" FindingsNotFoundResponse: content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Not Found: The requested finding cannot be found.' + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Not Found: The requested finding cannot be found." FindingsTooManyRequestsResponse: content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Too many requests: The rate limit set by the API has been exceeded.' + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Too many requests: The rate limit set by the API has been exceeded." ForbiddenResponse: content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden HTTPCDGatesBadRequestResponse: content: application/json: schema: - $ref: '#/components/schemas/HTTPCDGatesBadRequestResponse' + $ref: "#/components/schemas/HTTPCDGatesBadRequestResponse" description: Bad request. HTTPCDGatesNotFoundResponse: content: application/json: schema: - $ref: '#/components/schemas/HTTPCDGatesNotFoundResponse' + $ref: "#/components/schemas/HTTPCDGatesNotFoundResponse" description: Deployment gate not found. HTTPCDRulesNotFoundResponse: content: application/json: schema: - $ref: '#/components/schemas/HTTPCDRulesNotFoundResponse' + $ref: "#/components/schemas/HTTPCDRulesNotFoundResponse" description: Deployment rule not found. NotAuthorizedResponse: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Authorized NotFoundResponse: content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found NotificationRulesList: content: - application/json: + "application/json": schema: properties: data: items: - $ref: '#/components/schemas/NotificationRule' + $ref: "#/components/schemas/NotificationRule" type: array type: object description: The list of notification rules. PreconditionFailedResponse: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Failed Precondition SpansBadRequestResponse: content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: Bad Request. + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Bad Request." SpansForbiddenResponse: content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Forbidden: Access denied.' + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Forbidden: Access denied." SpansTooManyRequestsResponse: content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Too many requests: The rate limit set by the API has been exceeded.' + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Too many requests: The rate limit set by the API has been exceeded." SpansUnprocessableEntityResponse: content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: Unprocessable Entity. + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Unprocessable Entity." TooManyRequestsResponse: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests UnauthorizedResponse: content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Unauthorized UnprocessableEntityResponse: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: The server cannot process the request because it contains invalid - data. + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: The server cannot process the request because it contains invalid data. schemas: APIErrorResponse: description: API error response. @@ -1433,14 +1406,14 @@ components: errors: description: A list of errors. example: - - Bad Request + - Bad Request items: description: A list of items. example: Bad Request type: string type: array required: - - errors + - errors type: object APIKeyCreateAttributes: description: Attributes used to create an API Key. @@ -1450,57 +1423,57 @@ components: type: string name: description: Name of the API key. - example: API Key for submitting metrics + example: "API Key for submitting metrics" type: string remote_config_read_enabled: description: The APIKeyCreateAttributes remote_config_read_enabled. type: boolean required: - - name + - name type: object APIKeyCreateData: description: Object used to create an API key. properties: attributes: - $ref: '#/components/schemas/APIKeyCreateAttributes' + $ref: "#/components/schemas/APIKeyCreateAttributes" type: - $ref: '#/components/schemas/APIKeysType' + $ref: "#/components/schemas/APIKeysType" required: - - attributes - - type + - attributes + - type type: object APIKeyCreateRequest: description: Request used to create an API key. properties: data: - $ref: '#/components/schemas/APIKeyCreateData' + $ref: "#/components/schemas/APIKeyCreateData" required: - - data + - data type: object APIKeyRelationships: description: Resources related to the API key. properties: created_by: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" modified_by: - $ref: '#/components/schemas/NullableRelationshipToUser' + $ref: "#/components/schemas/NullableRelationshipToUser" type: object APIKeyResponse: description: Response for retrieving an API key. properties: data: - $ref: '#/components/schemas/FullAPIKey' + $ref: "#/components/schemas/FullAPIKey" included: description: Array of objects related to the API key. items: - $ref: '#/components/schemas/APIKeyResponseIncludedItem' + $ref: "#/components/schemas/APIKeyResponseIncludedItem" type: array type: object APIKeyResponseIncludedItem: description: An object related to an API key. oneOf: - - $ref: '#/components/schemas/User' - - $ref: '#/components/schemas/LeakedKey' + - $ref: "#/components/schemas/User" + - $ref: "#/components/schemas/LeakedKey" APIKeyUpdateAttributes: description: Attributes used to update an API Key. properties: @@ -1509,37 +1482,37 @@ components: type: string name: description: Name of the API key. - example: API Key for submitting metrics + example: "API Key for submitting metrics" type: string remote_config_read_enabled: description: The APIKeyUpdateAttributes remote_config_read_enabled. type: boolean required: - - name + - name type: object APIKeyUpdateData: description: Object used to update an API key. properties: attributes: - $ref: '#/components/schemas/APIKeyUpdateAttributes' + $ref: "#/components/schemas/APIKeyUpdateAttributes" id: description: ID of the API key. - example: 00112233-4455-6677-8899-aabbccddeeff + example: "00112233-4455-6677-8899-aabbccddeeff" type: string type: - $ref: '#/components/schemas/APIKeysType' + $ref: "#/components/schemas/APIKeysType" required: - - attributes - - id - - type + - attributes + - id + - type type: object APIKeyUpdateRequest: description: Request used to update an API key. properties: data: - $ref: '#/components/schemas/APIKeyUpdateData' + $ref: "#/components/schemas/APIKeyUpdateData" required: - - data + - data type: object APIKeysResponse: description: Response for a list of API keys. @@ -1547,15 +1520,15 @@ components: data: description: Array of API keys. items: - $ref: '#/components/schemas/PartialAPIKey' + $ref: "#/components/schemas/PartialAPIKey" type: array included: description: Array of objects related to the API key. items: - $ref: '#/components/schemas/APIKeyResponseIncludedItem' + $ref: "#/components/schemas/APIKeyResponseIncludedItem" type: array meta: - $ref: '#/components/schemas/APIKeysResponseMeta' + $ref: "#/components/schemas/APIKeysResponseMeta" type: object APIKeysResponseMeta: description: Additional information related to api keys response. @@ -1565,7 +1538,7 @@ components: format: int64 type: integer page: - $ref: '#/components/schemas/APIKeysResponseMetaPage' + $ref: "#/components/schemas/APIKeysResponseMetaPage" type: object APIKeysResponseMetaPage: description: Additional information related to the API keys response. @@ -1579,185 +1552,181 @@ components: default: name description: Sorting options enum: - - created_at - - -created_at - - last4 - - -last4 - - modified_at - - -modified_at - - name - - -name - type: string - x-enum-varnames: - - CREATED_AT_ASCENDING - - CREATED_AT_DESCENDING - - LAST4_ASCENDING - - LAST4_DESCENDING - - MODIFIED_AT_ASCENDING - - MODIFIED_AT_DESCENDING - - NAME_ASCENDING - - NAME_DESCENDING + - created_at + - -created_at + - last4 + - -last4 + - modified_at + - -modified_at + - name + - -name + type: string + x-enum-varnames: + - CREATED_AT_ASCENDING + - CREATED_AT_DESCENDING + - LAST4_ASCENDING + - LAST4_DESCENDING + - MODIFIED_AT_ASCENDING + - MODIFIED_AT_DESCENDING + - NAME_ASCENDING + - NAME_DESCENDING APIKeysType: default: api_keys description: API Keys resource type. enum: - - api_keys + - api_keys example: api_keys type: string x-enum-varnames: - - API_KEYS + - API_KEYS APITrigger: - description: Trigger a workflow from an API request. The workflow must be published. + description: "Trigger a workflow from an API request. The workflow must be published." properties: rateLimit: - $ref: '#/components/schemas/TriggerRateLimit' + $ref: "#/components/schemas/TriggerRateLimit" type: object APITriggerWrapper: - description: Schema for an API-based trigger. + description: "Schema for an API-based trigger." properties: apiTrigger: - $ref: '#/components/schemas/APITrigger' + $ref: "#/components/schemas/APITrigger" startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - apiTrigger + - apiTrigger type: object AWSAccountConfigID: - description: 'Unique Datadog ID of the AWS Account Integration Config. - + description: |- + Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the - [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) - - endpoint and query by AWS Account ID.' - example: 00000000-abcd-0001-0000-000000000000 + endpoint and query by AWS Account ID. + example: "00000000-abcd-0001-0000-000000000000" type: string AWSAccountCreateRequest: description: AWS Account Create Request body. properties: data: - $ref: '#/components/schemas/AWSAccountCreateRequestData' + $ref: "#/components/schemas/AWSAccountCreateRequestData" required: - - data + - data type: object AWSAccountCreateRequestAttributes: description: The AWS Account Integration Config to be created. properties: account_tags: - $ref: '#/components/schemas/AWSAccountTags' + $ref: "#/components/schemas/AWSAccountTags" auth_config: - $ref: '#/components/schemas/AWSAuthConfig' + $ref: "#/components/schemas/AWSAuthConfig" aws_account_id: - $ref: '#/components/schemas/AWSAccountID' + $ref: "#/components/schemas/AWSAccountID" aws_partition: - $ref: '#/components/schemas/AWSAccountPartition' + $ref: "#/components/schemas/AWSAccountPartition" aws_regions: - $ref: '#/components/schemas/AWSRegions' + $ref: "#/components/schemas/AWSRegions" logs_config: - $ref: '#/components/schemas/AWSLogsConfig' + $ref: "#/components/schemas/AWSLogsConfig" metrics_config: - $ref: '#/components/schemas/AWSMetricsConfig' + $ref: "#/components/schemas/AWSMetricsConfig" resources_config: - $ref: '#/components/schemas/AWSResourcesConfig' + $ref: "#/components/schemas/AWSResourcesConfig" traces_config: - $ref: '#/components/schemas/AWSTracesConfig' + $ref: "#/components/schemas/AWSTracesConfig" required: - - aws_account_id - - aws_partition - - auth_config + - aws_account_id + - aws_partition + - auth_config type: object AWSAccountCreateRequestData: description: AWS Account Create Request data. properties: attributes: - $ref: '#/components/schemas/AWSAccountCreateRequestAttributes' + $ref: "#/components/schemas/AWSAccountCreateRequestAttributes" type: - $ref: '#/components/schemas/AWSAccountType' + $ref: "#/components/schemas/AWSAccountType" required: - - attributes - - type + - attributes + - type type: object AWSAccountID: description: AWS Account ID. - example: '123456789012' + example: "123456789012" type: string AWSAccountPartition: - description: 'AWS partition your AWS account is scoped to. Defaults to `aws`. - + description: |- + AWS partition your AWS account is scoped to. Defaults to `aws`. See [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) - - in the AWS documentation for more information.' + in the AWS documentation for more information. enum: - - aws - - aws-cn - - aws-us-gov + - aws + - aws-cn + - aws-us-gov example: aws type: string x-enum-varnames: - - AWS - - AWS_CN - - AWS_US_GOV + - AWS + - AWS_CN + - AWS_US_GOV AWSAccountResponse: description: AWS Account response body. properties: data: - $ref: '#/components/schemas/AWSAccountResponseData' + $ref: "#/components/schemas/AWSAccountResponseData" required: - - data + - data type: object AWSAccountResponseAttributes: description: AWS Account response attributes. properties: account_tags: - $ref: '#/components/schemas/AWSAccountTags' + $ref: "#/components/schemas/AWSAccountTags" auth_config: - $ref: '#/components/schemas/AWSAuthConfig' + $ref: "#/components/schemas/AWSAuthConfig" aws_account_id: - $ref: '#/components/schemas/AWSAccountID' + $ref: "#/components/schemas/AWSAccountID" aws_partition: - $ref: '#/components/schemas/AWSAccountPartition' + $ref: "#/components/schemas/AWSAccountPartition" aws_regions: - $ref: '#/components/schemas/AWSRegions' + $ref: "#/components/schemas/AWSRegions" created_at: description: Timestamp of when the account integration was created. format: date-time readOnly: true type: string logs_config: - $ref: '#/components/schemas/AWSLogsConfig' + $ref: "#/components/schemas/AWSLogsConfig" metrics_config: - $ref: '#/components/schemas/AWSMetricsConfig' + $ref: "#/components/schemas/AWSMetricsConfig" modified_at: description: Timestamp of when the account integration was updated. format: date-time readOnly: true type: string resources_config: - $ref: '#/components/schemas/AWSResourcesConfig' + $ref: "#/components/schemas/AWSResourcesConfig" traces_config: - $ref: '#/components/schemas/AWSTracesConfig' + $ref: "#/components/schemas/AWSTracesConfig" required: - - aws_account_id + - aws_account_id type: object AWSAccountResponseData: description: AWS Account response data. properties: attributes: - $ref: '#/components/schemas/AWSAccountResponseAttributes' + $ref: "#/components/schemas/AWSAccountResponseAttributes" id: - $ref: '#/components/schemas/AWSAccountConfigID' + $ref: "#/components/schemas/AWSAccountConfigID" type: - $ref: '#/components/schemas/AWSAccountType' + $ref: "#/components/schemas/AWSAccountType" required: - - id - - type + - id + - type type: object AWSAccountTags: - description: Tags to apply to all hosts and metrics reporting for this account. - Defaults to `[]`. + description: Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`. items: description: Tag in the form `key:value`. - example: env:prod + example: "env:prod" type: string nullable: true type: array @@ -1765,55 +1734,55 @@ components: default: account description: AWS Account resource type. enum: - - account + - account example: account type: string x-enum-varnames: - - ACCOUNT + - ACCOUNT AWSAccountUpdateRequest: description: AWS Account Update Request body. properties: data: - $ref: '#/components/schemas/AWSAccountUpdateRequestData' + $ref: "#/components/schemas/AWSAccountUpdateRequestData" required: - - data + - data type: object AWSAccountUpdateRequestAttributes: description: The AWS Account Integration Config to be updated. properties: account_tags: - $ref: '#/components/schemas/AWSAccountTags' + $ref: "#/components/schemas/AWSAccountTags" auth_config: - $ref: '#/components/schemas/AWSAuthConfig' + $ref: "#/components/schemas/AWSAuthConfig" aws_account_id: - $ref: '#/components/schemas/AWSAccountID' + $ref: "#/components/schemas/AWSAccountID" aws_partition: - $ref: '#/components/schemas/AWSAccountPartition' + $ref: "#/components/schemas/AWSAccountPartition" aws_regions: - $ref: '#/components/schemas/AWSRegions' + $ref: "#/components/schemas/AWSRegions" logs_config: - $ref: '#/components/schemas/AWSLogsConfig' + $ref: "#/components/schemas/AWSLogsConfig" metrics_config: - $ref: '#/components/schemas/AWSMetricsConfig' + $ref: "#/components/schemas/AWSMetricsConfig" resources_config: - $ref: '#/components/schemas/AWSResourcesConfig' + $ref: "#/components/schemas/AWSResourcesConfig" traces_config: - $ref: '#/components/schemas/AWSTracesConfig' + $ref: "#/components/schemas/AWSTracesConfig" required: - - aws_account_id + - aws_account_id type: object AWSAccountUpdateRequestData: description: AWS Account Update Request data. properties: attributes: - $ref: '#/components/schemas/AWSAccountUpdateRequestAttributes' + $ref: "#/components/schemas/AWSAccountUpdateRequestAttributes" id: - $ref: '#/components/schemas/AWSAccountConfigID' + $ref: "#/components/schemas/AWSAccountConfigID" type: - $ref: '#/components/schemas/AWSAccountType' + $ref: "#/components/schemas/AWSAccountType" required: - - attributes - - type + - attributes + - type type: object AWSAccountsResponse: description: AWS Accounts response body. @@ -1821,28 +1790,27 @@ components: data: description: List of AWS Account Integration Configs. items: - $ref: '#/components/schemas/AWSAccountResponseData' + $ref: "#/components/schemas/AWSAccountResponseData" type: array required: - - data + - data type: object AWSAssumeRole: description: The definition of `AWSAssumeRole` object. properties: account_id: description: AWS account the connection is created for - example: '111222333444' + example: "111222333444" pattern: ^\d{12}$ type: string external_id: - description: External ID used to scope which connection can be used to assume - the role + description: External ID used to scope which connection can be used to assume the role example: 33a1011635c44b38a064cf14e82e1d8f readOnly: true type: string principal_id: description: AWS account that will assume the role - example: '123456789012' + example: "123456789012" readOnly: true type: string role: @@ -1850,26 +1818,26 @@ components: example: my-role type: string type: - $ref: '#/components/schemas/AWSAssumeRoleType' + $ref: "#/components/schemas/AWSAssumeRoleType" required: - - type - - account_id - - role + - type + - account_id + - role type: object AWSAssumeRoleType: description: The definition of `AWSAssumeRoleType` object. enum: - - AWSAssumeRole + - AWSAssumeRole example: AWSAssumeRole type: string x-enum-varnames: - - AWSASSUMEROLE + - AWSASSUMEROLE AWSAssumeRoleUpdate: description: The definition of `AWSAssumeRoleUpdate` object. properties: account_id: description: AWS account the connection is created for - example: '111222333444' + example: "111222333444" pattern: ^\d{12}$ type: string generate_new_external_id: @@ -1880,47 +1848,45 @@ components: example: my-role type: string type: - $ref: '#/components/schemas/AWSAssumeRoleType' + $ref: "#/components/schemas/AWSAssumeRoleType" required: - - type + - type type: object AWSAuthConfig: description: AWS Authentication config. oneOf: - - $ref: '#/components/schemas/AWSAuthConfigKeys' - - $ref: '#/components/schemas/AWSAuthConfigRole' + - $ref: "#/components/schemas/AWSAuthConfigKeys" + - $ref: "#/components/schemas/AWSAuthConfigRole" AWSAuthConfigKeys: - description: AWS Authentication config to integrate your account using an access - key pair. + description: AWS Authentication config to integrate your account using an access key pair. properties: access_key_id: description: AWS Access Key ID. - example: AKIAIOSFODNN7EXAMPLE + example: "AKIAIOSFODNN7EXAMPLE" type: string secret_access_key: description: AWS Secret Access Key. - example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY + example: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" minLength: 1 type: string writeOnly: true required: - - access_key_id + - access_key_id type: object AWSAuthConfigRole: - description: AWS Authentication config to integrate your account using an IAM - role. + description: AWS Authentication config to integrate your account using an IAM role. properties: external_id: description: AWS IAM External ID for associated role. type: string role_name: description: AWS IAM Role name. - example: DatadogIntegrationRole + example: "DatadogIntegrationRole" maxLength: 576 minLength: 1 type: string required: - - role_name + - role_name type: object AWSCcmConfig: description: AWS Cloud Cost Management config. @@ -1928,45 +1894,45 @@ components: data_export_configs: description: List of data export configurations for Cost and Usage Reports. items: - $ref: '#/components/schemas/DataExportConfig' + $ref: "#/components/schemas/DataExportConfig" type: array required: - - data_export_configs + - data_export_configs type: object AWSCcmConfigRequest: description: AWS CCM Config Create/Update Request body. properties: data: - $ref: '#/components/schemas/AWSCcmConfigRequestData' + $ref: "#/components/schemas/AWSCcmConfigRequestData" required: - - data + - data type: object AWSCcmConfigRequestAttributes: description: AWS CCM Config attributes for Create/Update requests. properties: ccm_config: - $ref: '#/components/schemas/AWSCcmConfig' + $ref: "#/components/schemas/AWSCcmConfig" required: - - ccm_config + - ccm_config type: object AWSCcmConfigRequestData: description: AWS CCM Config Create/Update Request data. properties: attributes: - $ref: '#/components/schemas/AWSCcmConfigRequestAttributes' + $ref: "#/components/schemas/AWSCcmConfigRequestAttributes" type: - $ref: '#/components/schemas/AWSCcmConfigType' + $ref: "#/components/schemas/AWSCcmConfigType" required: - - attributes - - type + - attributes + - type type: object AWSCcmConfigResponse: description: AWS CCM Config response body. properties: data: - $ref: '#/components/schemas/AWSCcmConfigResponseData' + $ref: "#/components/schemas/AWSCcmConfigResponseData" required: - - data + - data type: object AWSCcmConfigResponseAttributes: description: AWS CCM Config response attributes. @@ -1974,159 +1940,154 @@ components: data_export_configs: description: List of data export configurations for Cost and Usage Reports. items: - $ref: '#/components/schemas/DataExportConfig' + $ref: "#/components/schemas/DataExportConfig" type: array type: object AWSCcmConfigResponseData: description: AWS CCM Config response data. properties: attributes: - $ref: '#/components/schemas/AWSCcmConfigResponseAttributes' + $ref: "#/components/schemas/AWSCcmConfigResponseAttributes" id: - $ref: '#/components/schemas/AWSAccountConfigID' + $ref: "#/components/schemas/AWSAccountConfigID" type: - $ref: '#/components/schemas/AWSCcmConfigType' + $ref: "#/components/schemas/AWSCcmConfigType" required: - - type + - type type: object AWSCcmConfigType: - default: ccm_config + default: "ccm_config" description: AWS CCM Config resource type. enum: - - ccm_config - example: ccm_config + - ccm_config + example: "ccm_config" type: string x-enum-varnames: - - CCM_CONFIG + - CCM_CONFIG AWSCloudAuthPersonaMappingAttributesResponse: description: Attributes for AWS cloud authentication persona mapping response properties: account_identifier: - description: Datadog account identifier (email or handle) mapped to the - AWS principal - example: test@test.com + description: Datadog account identifier (email or handle) mapped to the AWS principal + example: "test@test.com" type: string account_uuid: description: Datadog account UUID - example: 12bbdc5c-5966-47e0-8733-285f9e44bcf4 + example: "12bbdc5c-5966-47e0-8733-285f9e44bcf4" type: string arn_pattern: description: AWS IAM ARN pattern to match for authentication - example: arn:aws:iam::123456789012:user/testuser + example: "arn:aws:iam::123456789012:user/testuser" type: string required: - - arn_pattern - - account_identifier - - account_uuid + - arn_pattern + - account_identifier + - account_uuid type: object AWSCloudAuthPersonaMappingCreateAttributes: description: Attributes for creating an AWS cloud authentication persona mapping properties: account_identifier: - description: Datadog account identifier (email or handle) mapped to the - AWS principal - example: test@test.com + description: Datadog account identifier (email or handle) mapped to the AWS principal + example: "test@test.com" type: string arn_pattern: description: AWS IAM ARN pattern to match for authentication - example: arn:aws:iam::123456789012:user/testuser + example: "arn:aws:iam::123456789012:user/testuser" type: string required: - - arn_pattern - - account_identifier + - arn_pattern + - account_identifier type: object AWSCloudAuthPersonaMappingCreateData: description: Data for creating an AWS cloud authentication persona mapping properties: attributes: - $ref: '#/components/schemas/AWSCloudAuthPersonaMappingCreateAttributes' + $ref: "#/components/schemas/AWSCloudAuthPersonaMappingCreateAttributes" type: - $ref: '#/components/schemas/AWSCloudAuthPersonaMappingType' + $ref: "#/components/schemas/AWSCloudAuthPersonaMappingType" required: - - type - - attributes + - type + - attributes type: object AWSCloudAuthPersonaMappingCreateRequest: description: Request used to create an AWS cloud authentication persona mapping properties: data: - $ref: '#/components/schemas/AWSCloudAuthPersonaMappingCreateData' + $ref: "#/components/schemas/AWSCloudAuthPersonaMappingCreateData" required: - - data + - data type: object AWSCloudAuthPersonaMappingDataResponse: description: Data for AWS cloud authentication persona mapping response properties: attributes: - $ref: '#/components/schemas/AWSCloudAuthPersonaMappingAttributesResponse' + $ref: "#/components/schemas/AWSCloudAuthPersonaMappingAttributesResponse" id: description: Unique identifier for the persona mapping - example: c5c758c6-18c2-4484-ae3f-46b84128404a + example: "c5c758c6-18c2-4484-ae3f-46b84128404a" type: string type: - $ref: '#/components/schemas/AWSCloudAuthPersonaMappingType' + $ref: "#/components/schemas/AWSCloudAuthPersonaMappingType" required: - - id - - type - - attributes + - id + - type + - attributes type: object AWSCloudAuthPersonaMappingResponse: description: Response containing a single AWS cloud authentication persona mapping properties: data: - $ref: '#/components/schemas/AWSCloudAuthPersonaMappingDataResponse' + $ref: "#/components/schemas/AWSCloudAuthPersonaMappingDataResponse" required: - - data + - data type: object AWSCloudAuthPersonaMappingType: description: Type identifier for AWS cloud authentication persona mapping enum: - - aws_cloud_auth_config + - aws_cloud_auth_config example: aws_cloud_auth_config type: string x-enum-varnames: - - AWS_CLOUD_AUTH_CONFIG + - AWS_CLOUD_AUTH_CONFIG AWSCloudAuthPersonaMappingsData: description: List of AWS cloud authentication persona mappings items: - $ref: '#/components/schemas/AWSCloudAuthPersonaMappingDataResponse' + $ref: "#/components/schemas/AWSCloudAuthPersonaMappingDataResponse" type: array AWSCloudAuthPersonaMappingsResponse: - description: Response containing a list of AWS cloud authentication persona - mappings + description: Response containing a list of AWS cloud authentication persona mappings properties: data: - $ref: '#/components/schemas/AWSCloudAuthPersonaMappingsData' + $ref: "#/components/schemas/AWSCloudAuthPersonaMappingsData" required: - - data + - data type: object AWSCredentials: description: The definition of `AWSCredentials` object. oneOf: - - $ref: '#/components/schemas/AWSAssumeRole' + - $ref: "#/components/schemas/AWSAssumeRole" AWSCredentialsUpdate: description: The definition of `AWSCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/AWSAssumeRoleUpdate' + - $ref: "#/components/schemas/AWSAssumeRoleUpdate" AWSEventBridgeAccountConfiguration: description: The EventBridge configuration for one AWS account. properties: account_id: description: Your AWS Account ID without dashes. - example: '123456789012' + example: "123456789012" type: string event_hubs: description: Array of AWS event sources associated with this account. items: - $ref: '#/components/schemas/AWSEventBridgeSource' + $ref: "#/components/schemas/AWSEventBridgeSource" type: array tags: - description: 'Array of tags (in the form `key:value`) which are added to - all hosts - - and metrics reporting through the main AWS integration.' - example: - - $KEY:$VALUE + description: |- + Array of tags (in the form `key:value`) which are added to all hosts + and metrics reporting through the main AWS integration. + example: ["$KEY:$VALUE"] items: description: The list of the host_tags. type: string @@ -2136,196 +2097,189 @@ components: description: Amazon EventBridge create request body. properties: data: - $ref: '#/components/schemas/AWSEventBridgeCreateRequestData' + $ref: "#/components/schemas/AWSEventBridgeCreateRequestData" required: - - data + - data type: object AWSEventBridgeCreateRequestAttributes: description: The EventBridge source to be created. properties: account_id: - $ref: '#/components/schemas/AWSAccountID' + $ref: "#/components/schemas/AWSAccountID" create_event_bus: - description: 'Set to true if Datadog should create the event bus in addition - to the event - - source. Requires the `events:CreateEventBus` permission.' + description: |- + Set to true if Datadog should create the event bus in addition to the event + source. Requires the `events:CreateEventBus` permission. example: true type: boolean event_generator_name: - description: 'The given part of the event source name, which is then combined - with an - - assigned suffix to form the full name.' - example: app-alerts + description: |- + The given part of the event source name, which is then combined with an + assigned suffix to form the full name. + example: "app-alerts" type: string region: - description: 'The event source''s - - [AWS region](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints).' - example: us-east-1 + description: |- + The event source's + [AWS region](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). + example: "us-east-1" type: string required: - - account_id - - event_generator_name - - region + - account_id + - event_generator_name + - region type: object AWSEventBridgeCreateRequestData: description: Amazon EventBridge create request data. properties: attributes: - $ref: '#/components/schemas/AWSEventBridgeCreateRequestAttributes' + $ref: "#/components/schemas/AWSEventBridgeCreateRequestAttributes" type: - $ref: '#/components/schemas/AWSEventBridgeType' + $ref: "#/components/schemas/AWSEventBridgeType" required: - - attributes - - type + - attributes + - type type: object AWSEventBridgeCreateResponse: description: Amazon EventBridge create response body. properties: data: - $ref: '#/components/schemas/AWSEventBridgeCreateResponseData' + $ref: "#/components/schemas/AWSEventBridgeCreateResponseData" required: - - data + - data type: object AWSEventBridgeCreateResponseAttributes: description: A created EventBridge source. properties: event_source_name: description: The event source name. - example: app-alerts-zyxw3210 + example: "app-alerts-zyxw3210" type: string has_bus: description: True if the event bus was created in addition to the source. example: true type: boolean region: - description: 'The event source''s - - [AWS region](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints).' - example: us-east-1 + description: |- + The event source's + [AWS region](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). + example: "us-east-1" type: string status: - $ref: '#/components/schemas/AWSEventBridgeCreateStatus' + $ref: "#/components/schemas/AWSEventBridgeCreateStatus" type: object AWSEventBridgeCreateResponseData: description: Amazon EventBridge create response data. properties: attributes: - $ref: '#/components/schemas/AWSEventBridgeCreateResponseAttributes' + $ref: "#/components/schemas/AWSEventBridgeCreateResponseAttributes" id: - default: create_event_bridge + default: "create_event_bridge" description: The ID of the Amazon EventBridge create response data. - example: create_event_bridge + example: "create_event_bridge" type: string type: - $ref: '#/components/schemas/AWSEventBridgeType' + $ref: "#/components/schemas/AWSEventBridgeType" required: - - attributes - - type + - attributes + - type type: object AWSEventBridgeCreateStatus: description: The event source status "created". - enum: - - created + enum: ["created"] example: created type: string - x-enum-varnames: - - CREATED + x-enum-varnames: ["CREATED"] AWSEventBridgeDeleteRequest: description: Amazon EventBridge delete request body. properties: data: - $ref: '#/components/schemas/AWSEventBridgeDeleteRequestData' + $ref: "#/components/schemas/AWSEventBridgeDeleteRequestData" required: - - data + - data type: object AWSEventBridgeDeleteRequestAttributes: description: The EventBridge source to be deleted. properties: account_id: - $ref: '#/components/schemas/AWSAccountID' + $ref: "#/components/schemas/AWSAccountID" event_generator_name: description: The event source name. - example: app-alerts-zyxw3210 + example: "app-alerts-zyxw3210" type: string region: - description: 'The event source''s - - [AWS region](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints).' - example: us-east-1 + description: |- + The event source's + [AWS region](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). + example: "us-east-1" type: string required: - - account_id - - event_generator_name - - region + - account_id + - event_generator_name + - region type: object AWSEventBridgeDeleteRequestData: description: Amazon EventBridge delete request data. properties: attributes: - $ref: '#/components/schemas/AWSEventBridgeDeleteRequestAttributes' + $ref: "#/components/schemas/AWSEventBridgeDeleteRequestAttributes" type: - $ref: '#/components/schemas/AWSEventBridgeType' + $ref: "#/components/schemas/AWSEventBridgeType" required: - - attributes - - type + - attributes + - type type: object AWSEventBridgeDeleteResponse: description: Amazon EventBridge delete response body. properties: data: - $ref: '#/components/schemas/AWSEventBridgeDeleteResponseData' + $ref: "#/components/schemas/AWSEventBridgeDeleteResponseData" required: - - data + - data type: object AWSEventBridgeDeleteResponseAttributes: description: The EventBridge source delete response attributes. properties: status: - $ref: '#/components/schemas/AWSEventBridgeDeleteStatus' + $ref: "#/components/schemas/AWSEventBridgeDeleteStatus" type: object AWSEventBridgeDeleteResponseData: description: Amazon EventBridge delete response data. properties: attributes: - $ref: '#/components/schemas/AWSEventBridgeDeleteResponseAttributes' + $ref: "#/components/schemas/AWSEventBridgeDeleteResponseAttributes" id: - default: delete_event_bridge + default: "delete_event_bridge" description: The ID of the Amazon EventBridge list response data. - example: delete_event_bridge + example: "delete_event_bridge" type: string type: - $ref: '#/components/schemas/AWSEventBridgeType' + $ref: "#/components/schemas/AWSEventBridgeType" required: - - attributes - - type + - attributes + - type type: object AWSEventBridgeDeleteStatus: description: The event source status "empty". - enum: - - empty + enum: ["empty"] example: empty type: string - x-enum-varnames: - - EMPTY + x-enum-varnames: ["EMPTY"] AWSEventBridgeListResponse: description: Amazon EventBridge list response body. properties: data: - $ref: '#/components/schemas/AWSEventBridgeListResponseData' + $ref: "#/components/schemas/AWSEventBridgeListResponseData" required: - - data + - data type: object AWSEventBridgeListResponseAttributes: - description: An object describing the EventBridge configuration for multiple - accounts. + description: An object describing the EventBridge configuration for multiple accounts. properties: accounts: description: List of accounts with their event sources. items: - $ref: '#/components/schemas/AWSEventBridgeAccountConfiguration' + $ref: "#/components/schemas/AWSEventBridgeAccountConfiguration" type: array is_installed: description: True if the EventBridge integration is enabled for your organization. @@ -2335,60 +2289,60 @@ components: description: Amazon EventBridge list response data. properties: attributes: - $ref: '#/components/schemas/AWSEventBridgeListResponseAttributes' + $ref: "#/components/schemas/AWSEventBridgeListResponseAttributes" id: - default: get_event_bridge + default: "get_event_bridge" description: The ID of the Amazon EventBridge list response data. - example: get_event_bridge + example: "get_event_bridge" type: string type: - $ref: '#/components/schemas/AWSEventBridgeType' + $ref: "#/components/schemas/AWSEventBridgeType" required: - - attributes - - id - - type + - attributes + - id + - type type: object AWSEventBridgeSource: description: An EventBridge source. properties: name: description: The event source name. - example: app-alerts-zyxw3210 + example: "app-alerts-zyxw3210" type: string region: - description: 'The event source''s - - [AWS region](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints).' - example: us-east-1 + description: |- + The event source's + [AWS region](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). + example: "us-east-1" type: string type: object AWSEventBridgeType: - default: event_bridge + default: "event_bridge" description: Amazon EventBridge resource type. enum: - - event_bridge - example: event_bridge + - event_bridge + example: "event_bridge" type: string x-enum-varnames: - - EVENT_BRIDGE + - EVENT_BRIDGE AWSIntegration: description: The definition of `AWSIntegration` object. properties: credentials: - $ref: '#/components/schemas/AWSCredentials' + $ref: "#/components/schemas/AWSCredentials" type: - $ref: '#/components/schemas/AWSIntegrationType' + $ref: "#/components/schemas/AWSIntegrationType" required: - - type - - credentials + - type + - credentials type: object AWSIntegrationIamPermissionsResponse: description: AWS Integration IAM Permissions response body. properties: data: - $ref: '#/components/schemas/AWSIntegrationIamPermissionsResponseData' + $ref: "#/components/schemas/AWSIntegrationIamPermissionsResponseData" required: - - data + - data type: object AWSIntegrationIamPermissionsResponseAttributes: description: AWS Integration IAM Permissions response attributes. @@ -2396,86 +2350,79 @@ components: permissions: description: List of AWS IAM permissions required for the integration. example: - - account:GetContactInformation - - amplify:ListApps - - amplify:ListArtifacts - - amplify:ListBackendEnvironments - - amplify:ListBranches + - "account:GetContactInformation" + - "amplify:ListApps" + - "amplify:ListArtifacts" + - "amplify:ListBackendEnvironments" + - "amplify:ListBranches" items: - example: account:GetContactInformation + example: "account:GetContactInformation" type: string type: array required: - - permissions + - permissions type: object AWSIntegrationIamPermissionsResponseData: description: AWS Integration IAM Permissions response data. properties: attributes: - $ref: '#/components/schemas/AWSIntegrationIamPermissionsResponseAttributes' + $ref: "#/components/schemas/AWSIntegrationIamPermissionsResponseAttributes" id: - default: permissions + default: "permissions" description: The `AWSIntegrationIamPermissionsResponseData` `id`. - example: permissions + example: "permissions" type: string type: - $ref: '#/components/schemas/AWSIntegrationIamPermissionsResponseDataType' + $ref: "#/components/schemas/AWSIntegrationIamPermissionsResponseDataType" type: object AWSIntegrationIamPermissionsResponseDataType: - default: permissions + default: "permissions" description: The `AWSIntegrationIamPermissionsResponseData` `type`. enum: - - permissions - example: permissions + - permissions + example: "permissions" type: string x-enum-varnames: - - PERMISSIONS + - PERMISSIONS AWSIntegrationType: description: The definition of `AWSIntegrationType` object. enum: - - AWS + - AWS example: AWS type: string x-enum-varnames: - - AWS + - AWS AWSIntegrationUpdate: description: The definition of `AWSIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/AWSCredentialsUpdate' + $ref: "#/components/schemas/AWSCredentialsUpdate" type: - $ref: '#/components/schemas/AWSIntegrationType' + $ref: "#/components/schemas/AWSIntegrationType" required: - - type + - type type: object AWSLambdaForwarderConfig: - description: 'Log Autosubscription configuration for Datadog Forwarder Lambda - functions. - + description: |- + Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing and new logs for some services, - - ensuring no logs from new resources are missed and saving time spent on manual - configuration.' + ensuring no logs from new resources are missed and saving time spent on manual configuration. properties: lambdas: - description: List of Datadog Lambda Log Forwarder ARNs in your AWS account. - Defaults to `[]`. + description: List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`. items: - example: arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder + example: "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder" type: string type: array log_source_config: - $ref: '#/components/schemas/AWSLambdaForwarderConfigLogSourceConfig' + $ref: "#/components/schemas/AWSLambdaForwarderConfigLogSourceConfig" sources: - description: 'List of service IDs set to enable automatic log collection. - + description: |- + List of service IDs set to enable automatic log collection. Discover the list of available services with the - [Get list of AWS log ready - services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) - - endpoint.' + endpoint. items: example: s3 type: string @@ -2487,40 +2434,29 @@ components: tag_filters: description: List of AWS log source tag filters. Defaults to `[]`. items: - $ref: '#/components/schemas/AWSLogSourceTagFilter' + $ref: "#/components/schemas/AWSLogSourceTagFilter" type: array type: object AWSLogSourceTagFilter: - description: 'AWS log source tag filter list. Defaults to `[]`. - - Array of log source to AWS resource tag mappings. Each mapping contains a - log source and its - - associated AWS resource tags (in `key:value` format) used to filter logs submitted - to Datadog. - - Tag filters are applied for tags on the AWS resource emitting logs; tags associated - with the - + description: |- + AWS log source tag filter list. Defaults to `[]`. + Array of log source to AWS resource tag mappings. Each mapping contains a log source and its + associated AWS resource tags (in `key:value` format) used to filter logs submitted to Datadog. + Tag filters are applied for tags on the AWS resource emitting logs; tags associated with the log storage entity (such as a CloudWatch Log Group or S3 Bucket) are not considered. - For more information on resource tag filter syntax, - [see AWS resource exclusion](https://docs.datadoghq.com/account_management/billing/aws/#aws-resource-exclusion) - - in the AWS integration billing page.' + in the AWS integration billing page. properties: source: - description: The AWS log source to which the tag filters defined in `tags` - are applied. - example: s3 + description: The AWS log source to which the tag filters defined in `tags` are applied. + example: "s3" type: string tags: - description: The AWS resource tags to filter on for the log source specified - by `source`. + description: The AWS resource tags to filter on for the log source specified by `source`. items: description: Tag in the form `key:value`. - example: env:prod + example: "env:prod" type: string nullable: true type: array @@ -2529,15 +2465,15 @@ components: description: AWS Logs Collection config. properties: lambda_forwarder: - $ref: '#/components/schemas/AWSLambdaForwarderConfig' + $ref: "#/components/schemas/AWSLambdaForwarderConfig" type: object AWSLogsServicesResponse: description: AWS Logs Services response body properties: data: - $ref: '#/components/schemas/AWSLogsServicesResponseData' + $ref: "#/components/schemas/AWSLogsServicesResponseData" required: - - data + - data type: object AWSLogsServicesResponseAttributes: description: AWS Logs Services response body @@ -2545,39 +2481,39 @@ components: logs_services: description: List of AWS services that can send logs to Datadog example: - - s3 + - "s3" items: - example: s3 + example: "s3" type: string type: array required: - - logs_services + - logs_services type: object AWSLogsServicesResponseData: description: AWS Logs Services response body properties: attributes: - $ref: '#/components/schemas/AWSLogsServicesResponseAttributes' + $ref: "#/components/schemas/AWSLogsServicesResponseAttributes" id: - default: logs_services + default: "logs_services" description: The `AWSLogsServicesResponseData` `id`. - example: logs_services + example: "logs_services" type: string type: - $ref: '#/components/schemas/AWSLogsServicesResponseDataType' + $ref: "#/components/schemas/AWSLogsServicesResponseDataType" required: - - id - - type + - id + - type type: object AWSLogsServicesResponseDataType: - default: logs_services + default: "logs_services" description: The `AWSLogsServicesResponseData` `type`. enum: - - logs_services - example: logs_services + - logs_services + example: "logs_services" type: string x-enum-varnames: - - LOGS_SERVICES + - LOGS_SERVICES AWSMetricsConfig: description: AWS Metrics Collection config. properties: @@ -2598,45 +2534,41 @@ components: example: true type: boolean namespace_filters: - $ref: '#/components/schemas/AWSNamespaceFilters' + $ref: "#/components/schemas/AWSNamespaceFilters" tag_filters: description: AWS Metrics collection tag filters list. Defaults to `[]`. items: - $ref: '#/components/schemas/AWSNamespaceTagFilter' + $ref: "#/components/schemas/AWSNamespaceTagFilter" type: array type: object AWSNamespaceFilters: description: AWS Metrics namespace filters. Defaults to `exclude_only`. oneOf: - - $ref: '#/components/schemas/AWSNamespaceFiltersExcludeOnly' - - $ref: '#/components/schemas/AWSNamespaceFiltersIncludeOnly' + - $ref: "#/components/schemas/AWSNamespaceFiltersExcludeOnly" + - $ref: "#/components/schemas/AWSNamespaceFiltersIncludeOnly" AWSNamespaceFiltersExcludeOnly: - description: 'Exclude only these namespaces from metrics collection. - + description: |- + Exclude only these namespaces from metrics collection. Defaults to `["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"]`. - `AWS/SQS`, `AWS/ElasticMapReduce`, and `AWS/Usage` are excluded by default - - to reduce your AWS CloudWatch costs from `GetMetricData` API calls.' + to reduce your AWS CloudWatch costs from `GetMetricData` API calls. properties: exclude_only: - description: 'Exclude only these namespaces from metrics collection. - + description: |- + Exclude only these namespaces from metrics collection. Defaults to `["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"]`. - `AWS/SQS`, `AWS/ElasticMapReduce`, and `AWS/Usage` are excluded by default - - to reduce your AWS CloudWatch costs from `GetMetricData` API calls.' + to reduce your AWS CloudWatch costs from `GetMetricData` API calls. example: - - AWS/SQS - - AWS/ElasticMapReduce - - AWS/Usage + - "AWS/SQS" + - "AWS/ElasticMapReduce" + - "AWS/Usage" items: - example: AWS/SQS + example: "AWS/SQS" type: string type: array required: - - exclude_only + - exclude_only type: object AWSNamespaceFiltersIncludeOnly: description: Include only these namespaces. @@ -2644,42 +2576,33 @@ components: include_only: description: Include only these namespaces. example: - - AWS/EC2 + - "AWS/EC2" items: - example: AWS/EC2 + example: "AWS/EC2" type: string type: array required: - - include_only + - include_only type: object AWSNamespaceTagFilter: - description: 'AWS Metrics Collection tag filters list. Defaults to `[]`. - - The array of custom AWS resource tags (in the form `key:value`) defines a - filter that Datadog uses - + description: |- + AWS Metrics Collection tag filters list. Defaults to `[]`. + The array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service. - - Wildcards, such as `?` (match a single character) and `*` (match multiple - characters), - + Wildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported. - For EC2, only hosts that match one of the defined tags are imported into Datadog. - - The rest are ignored. For example, `env:production,instance-type:c?.*,!region:us-east-1`.' + The rest are ignored. For example, `env:production,instance-type:c?.*,!region:us-east-1`. properties: namespace: - description: The AWS service for which the tag filters defined in `tags` - will be applied. - example: AWS/EC2 + description: The AWS service for which the tag filters defined in `tags` will be applied. + example: "AWS/EC2" type: string tags: - description: The AWS resource tags to filter on for the service specified - by `namespace`. + description: The AWS resource tags to filter on for the service specified by `namespace`. items: description: Tag in the form `key:value`. - example: datadog:true + example: "datadog:true" type: string nullable: true type: array @@ -2688,9 +2611,9 @@ components: description: AWS Namespaces response body. properties: data: - $ref: '#/components/schemas/AWSNamespacesResponseData' + $ref: "#/components/schemas/AWSNamespacesResponseData" required: - - data + - data type: object AWSNamespacesResponseAttributes: description: AWS Namespaces response attributes. @@ -2698,87 +2621,87 @@ components: namespaces: description: AWS CloudWatch namespace. example: - - AWS/ApiGateway + - "AWS/ApiGateway" items: - example: AWS/ApiGateway + example: "AWS/ApiGateway" type: string type: array required: - - namespaces + - namespaces type: object AWSNamespacesResponseData: description: AWS Namespaces response data. properties: attributes: - $ref: '#/components/schemas/AWSNamespacesResponseAttributes' + $ref: "#/components/schemas/AWSNamespacesResponseAttributes" id: - default: namespaces + default: "namespaces" description: The `AWSNamespacesResponseData` `id`. - example: namespaces + example: "namespaces" type: string type: - $ref: '#/components/schemas/AWSNamespacesResponseDataType' + $ref: "#/components/schemas/AWSNamespacesResponseDataType" required: - - id - - type + - id + - type type: object AWSNamespacesResponseDataType: - default: namespaces + default: "namespaces" description: The `AWSNamespacesResponseData` `type`. enum: - - namespaces - example: namespaces + - namespaces + example: "namespaces" type: string x-enum-varnames: - - NAMESPACES + - NAMESPACES AWSNewExternalIDResponse: description: AWS External ID response body. properties: data: - $ref: '#/components/schemas/AWSNewExternalIDResponseData' + $ref: "#/components/schemas/AWSNewExternalIDResponseData" required: - - data + - data type: object AWSNewExternalIDResponseAttributes: description: AWS External ID response body. properties: external_id: description: AWS IAM External ID for associated role. - example: acb8f6b8a844443dbb726d07dcb1a870 + example: "acb8f6b8a844443dbb726d07dcb1a870" type: string required: - - external_id + - external_id type: object AWSNewExternalIDResponseData: description: AWS External ID response body. properties: attributes: - $ref: '#/components/schemas/AWSNewExternalIDResponseAttributes' + $ref: "#/components/schemas/AWSNewExternalIDResponseAttributes" id: - default: external_id + default: "external_id" description: The `AWSNewExternalIDResponseData` `id`. - example: external_id + example: "external_id" type: string type: - $ref: '#/components/schemas/AWSNewExternalIDResponseDataType' + $ref: "#/components/schemas/AWSNewExternalIDResponseDataType" required: - - id - - type + - id + - type type: object AWSNewExternalIDResponseDataType: - default: external_id + default: "external_id" description: The `AWSNewExternalIDResponseData` `type`. enum: - - external_id - example: external_id + - external_id + example: "external_id" type: string x-enum-varnames: - - EXTERNAL_ID + - EXTERNAL_ID AWSRegions: description: AWS Regions to collect data from. Defaults to `include_all`. oneOf: - - $ref: '#/components/schemas/AWSRegionsIncludeAll' - - $ref: '#/components/schemas/AWSRegionsIncludeOnly' + - $ref: "#/components/schemas/AWSRegionsIncludeAll" + - $ref: "#/components/schemas/AWSRegionsIncludeOnly" AWSRegionsIncludeAll: description: Include all regions. Defaults to `true`. properties: @@ -2787,7 +2710,7 @@ components: example: true type: boolean required: - - include_all + - include_all type: object AWSRegionsIncludeOnly: description: Include only these regions. @@ -2795,31 +2718,28 @@ components: include_only: description: Include only these regions. example: - - us-east-1 + - "us-east-1" items: - example: us-east-1 + example: "us-east-1" type: string type: array required: - - include_only + - include_only type: object AWSResourcesConfig: description: AWS Resources Collection config. properties: cloud_security_posture_management_collection: - description: 'Enable Cloud Security Management to scan AWS resources for - vulnerabilities, misconfigurations, - + description: |- + Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. - - Requires `extended_collection` to be set to `true`.' + Requires `extended_collection` to be set to `true`. example: false type: boolean extended_collection: - description: 'Whether Datadog collects additional attributes and configuration - information about the resources - - in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.' + description: |- + Whether Datadog collects additional attributes and configuration information about the resources + in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`. example: true type: boolean type: object @@ -2827,32 +2747,25 @@ components: description: AWS Traces Collection config. properties: xray_services: - $ref: '#/components/schemas/XRayServicesList' + $ref: "#/components/schemas/XRayServicesList" type: object AccountFilteringConfig: description: The account filtering configuration. properties: excluded_accounts: - description: The AWS account IDs to be excluded from your billing dataset. - This field is used when `include_new_accounts` is `true`. - example: - - '123456789123' - - '123456789143' + description: The AWS account IDs to be excluded from your billing dataset. This field is used when `include_new_accounts` is `true`. + example: ["123456789123", "123456789143"] items: type: string type: array include_new_accounts: - description: Whether or not to automatically include new member accounts - by default in your billing dataset. + description: Whether or not to automatically include new member accounts by default in your billing dataset. example: true nullable: true type: boolean included_accounts: - description: The AWS account IDs to be included in your billing dataset. - This field is used when `include_new_accounts` is `false`. - example: - - '123456789123' - - '123456789143' + description: The AWS account IDs to be included in your billing dataset. This field is used when `include_new_accounts` is `false`. + example: ["123456789123", "123456789143"] items: type: string type: array @@ -2861,20 +2774,20 @@ components: description: The definition of `ActionConnectionAttributes` object. properties: integration: - $ref: '#/components/schemas/ActionConnectionIntegration' + $ref: "#/components/schemas/ActionConnectionIntegration" name: description: Name of the connection example: My AWS Connection type: string required: - - name - - integration + - name + - integration type: object ActionConnectionAttributesUpdate: description: The definition of `ActionConnectionAttributesUpdate` object. properties: integration: - $ref: '#/components/schemas/ActionConnectionIntegrationUpdate' + $ref: "#/components/schemas/ActionConnectionIntegrationUpdate" name: description: Name of the connection example: My AWS Connection @@ -2884,98 +2797,97 @@ components: description: Data related to the connection. properties: attributes: - $ref: '#/components/schemas/ActionConnectionAttributes' + $ref: "#/components/schemas/ActionConnectionAttributes" id: description: The connection identifier readOnly: true type: string type: - $ref: '#/components/schemas/ActionConnectionDataType' + $ref: "#/components/schemas/ActionConnectionDataType" required: - - type - - attributes + - type + - attributes type: object ActionConnectionDataType: description: The definition of `ActionConnectionDataType` object. enum: - - action_connection + - action_connection example: action_connection type: string x-enum-varnames: - - ACTION_CONNECTION + - ACTION_CONNECTION ActionConnectionDataUpdate: description: Data related to the connection update. properties: attributes: - $ref: '#/components/schemas/ActionConnectionAttributesUpdate' + $ref: "#/components/schemas/ActionConnectionAttributesUpdate" type: - $ref: '#/components/schemas/ActionConnectionDataType' + $ref: "#/components/schemas/ActionConnectionDataType" required: - - type - - attributes + - type + - attributes type: object ActionConnectionIntegration: description: The definition of `ActionConnectionIntegration` object. oneOf: - - $ref: '#/components/schemas/AWSIntegration' - - $ref: '#/components/schemas/AnthropicIntegration' - - $ref: '#/components/schemas/AsanaIntegration' - - $ref: '#/components/schemas/AzureIntegration' - - $ref: '#/components/schemas/CircleCIIntegration' - - $ref: '#/components/schemas/ClickupIntegration' - - $ref: '#/components/schemas/CloudflareIntegration' - - $ref: '#/components/schemas/ConfigCatIntegration' - - $ref: '#/components/schemas/DatadogIntegration' - - $ref: '#/components/schemas/FastlyIntegration' - - $ref: '#/components/schemas/FreshserviceIntegration' - - $ref: '#/components/schemas/GCPIntegration' - - $ref: '#/components/schemas/GeminiIntegration' - - $ref: '#/components/schemas/GitlabIntegration' - - $ref: '#/components/schemas/GreyNoiseIntegration' - - $ref: '#/components/schemas/HTTPIntegration' - - $ref: '#/components/schemas/LaunchDarklyIntegration' - - $ref: '#/components/schemas/NotionIntegration' - - $ref: '#/components/schemas/OktaIntegration' - - $ref: '#/components/schemas/OpenAIIntegration' - - $ref: '#/components/schemas/ServiceNowIntegration' - - $ref: '#/components/schemas/SplitIntegration' - - $ref: '#/components/schemas/StatsigIntegration' - - $ref: '#/components/schemas/VirusTotalIntegration' + - $ref: "#/components/schemas/AWSIntegration" + - $ref: "#/components/schemas/AnthropicIntegration" + - $ref: "#/components/schemas/AsanaIntegration" + - $ref: "#/components/schemas/AzureIntegration" + - $ref: "#/components/schemas/CircleCIIntegration" + - $ref: "#/components/schemas/ClickupIntegration" + - $ref: "#/components/schemas/CloudflareIntegration" + - $ref: "#/components/schemas/ConfigCatIntegration" + - $ref: "#/components/schemas/DatadogIntegration" + - $ref: "#/components/schemas/FastlyIntegration" + - $ref: "#/components/schemas/FreshserviceIntegration" + - $ref: "#/components/schemas/GCPIntegration" + - $ref: "#/components/schemas/GeminiIntegration" + - $ref: "#/components/schemas/GitlabIntegration" + - $ref: "#/components/schemas/GreyNoiseIntegration" + - $ref: "#/components/schemas/HTTPIntegration" + - $ref: "#/components/schemas/LaunchDarklyIntegration" + - $ref: "#/components/schemas/NotionIntegration" + - $ref: "#/components/schemas/OktaIntegration" + - $ref: "#/components/schemas/OpenAIIntegration" + - $ref: "#/components/schemas/ServiceNowIntegration" + - $ref: "#/components/schemas/SplitIntegration" + - $ref: "#/components/schemas/StatsigIntegration" + - $ref: "#/components/schemas/VirusTotalIntegration" ActionConnectionIntegrationUpdate: description: The definition of `ActionConnectionIntegrationUpdate` object. oneOf: - - $ref: '#/components/schemas/AWSIntegrationUpdate' - - $ref: '#/components/schemas/AnthropicIntegrationUpdate' - - $ref: '#/components/schemas/AsanaIntegrationUpdate' - - $ref: '#/components/schemas/AzureIntegrationUpdate' - - $ref: '#/components/schemas/CircleCIIntegrationUpdate' - - $ref: '#/components/schemas/ClickupIntegrationUpdate' - - $ref: '#/components/schemas/CloudflareIntegrationUpdate' - - $ref: '#/components/schemas/ConfigCatIntegrationUpdate' - - $ref: '#/components/schemas/DatadogIntegrationUpdate' - - $ref: '#/components/schemas/FastlyIntegrationUpdate' - - $ref: '#/components/schemas/FreshserviceIntegrationUpdate' - - $ref: '#/components/schemas/GCPIntegrationUpdate' - - $ref: '#/components/schemas/GeminiIntegrationUpdate' - - $ref: '#/components/schemas/GitlabIntegrationUpdate' - - $ref: '#/components/schemas/GreyNoiseIntegrationUpdate' - - $ref: '#/components/schemas/HTTPIntegrationUpdate' - - $ref: '#/components/schemas/LaunchDarklyIntegrationUpdate' - - $ref: '#/components/schemas/NotionIntegrationUpdate' - - $ref: '#/components/schemas/OktaIntegrationUpdate' - - $ref: '#/components/schemas/OpenAIIntegrationUpdate' - - $ref: '#/components/schemas/ServiceNowIntegrationUpdate' - - $ref: '#/components/schemas/SplitIntegrationUpdate' - - $ref: '#/components/schemas/StatsigIntegrationUpdate' - - $ref: '#/components/schemas/VirusTotalIntegrationUpdate' + - $ref: "#/components/schemas/AWSIntegrationUpdate" + - $ref: "#/components/schemas/AnthropicIntegrationUpdate" + - $ref: "#/components/schemas/AsanaIntegrationUpdate" + - $ref: "#/components/schemas/AzureIntegrationUpdate" + - $ref: "#/components/schemas/CircleCIIntegrationUpdate" + - $ref: "#/components/schemas/ClickupIntegrationUpdate" + - $ref: "#/components/schemas/CloudflareIntegrationUpdate" + - $ref: "#/components/schemas/ConfigCatIntegrationUpdate" + - $ref: "#/components/schemas/DatadogIntegrationUpdate" + - $ref: "#/components/schemas/FastlyIntegrationUpdate" + - $ref: "#/components/schemas/FreshserviceIntegrationUpdate" + - $ref: "#/components/schemas/GCPIntegrationUpdate" + - $ref: "#/components/schemas/GeminiIntegrationUpdate" + - $ref: "#/components/schemas/GitlabIntegrationUpdate" + - $ref: "#/components/schemas/GreyNoiseIntegrationUpdate" + - $ref: "#/components/schemas/HTTPIntegrationUpdate" + - $ref: "#/components/schemas/LaunchDarklyIntegrationUpdate" + - $ref: "#/components/schemas/NotionIntegrationUpdate" + - $ref: "#/components/schemas/OktaIntegrationUpdate" + - $ref: "#/components/schemas/OpenAIIntegrationUpdate" + - $ref: "#/components/schemas/ServiceNowIntegrationUpdate" + - $ref: "#/components/schemas/SplitIntegrationUpdate" + - $ref: "#/components/schemas/StatsigIntegrationUpdate" + - $ref: "#/components/schemas/VirusTotalIntegrationUpdate" ActionQuery: - description: An action query. This query type is used to trigger an action, - such as sending a HTTP request. + description: An action query. This query type is used to trigger an action, such as sending a HTTP request. properties: events: description: Events to listen for downstream of the action query. items: - $ref: '#/components/schemas/AppBuilderEvent' + $ref: "#/components/schemas/AppBuilderEvent" type: array id: description: The ID of the action query. @@ -2983,142 +2895,122 @@ components: format: uuid type: string name: - description: A unique identifier for this action query. This name is also - used to access the query's result throughout the app. - example: fetchPendingOrders + description: A unique identifier for this action query. This name is also used to access the query's result throughout the app. + example: "fetchPendingOrders" type: string properties: - $ref: '#/components/schemas/ActionQueryProperties' + $ref: "#/components/schemas/ActionQueryProperties" type: - $ref: '#/components/schemas/ActionQueryType' + $ref: "#/components/schemas/ActionQueryType" required: - - id - - name - - type - - properties + - id + - name + - type + - properties type: object ActionQueryCondition: - description: Whether to run this query. If specified, the query will only run - if this condition evaluates to `true` in JavaScript and all other conditions - are also met. + description: Whether to run this query. If specified, the query will only run if this condition evaluates to `true` in JavaScript and all other conditions are also met. oneOf: - - type: boolean - - example: ${true} - type: string + - type: boolean + - example: "${true}" + type: string ActionQueryDebounceInMs: - description: The minimum time in milliseconds that must pass before the query - can be triggered again. This is useful for preventing accidental double-clicks - from triggering the query multiple times. + description: The minimum time in milliseconds that must pass before the query can be triggered again. This is useful for preventing accidental double-clicks from triggering the query multiple times. oneOf: - - example: 310.5 - format: double - type: number - - description: If this is a string, it must be a valid JavaScript expression - that evaluates to a number. - example: ${1000} - type: string + - example: 310.5 + format: double + type: number + - description: "If this is a string, it must be a valid JavaScript expression that evaluates to a number." + example: "${1000}" + type: string ActionQueryMockedOutputs: - description: The mocked outputs of the action query. This is useful for testing - the app without actually running the action. + description: The mocked outputs of the action query. This is useful for testing the app without actually running the action. oneOf: - - type: string - - $ref: '#/components/schemas/ActionQueryMockedOutputsObject' + - type: string + - $ref: "#/components/schemas/ActionQueryMockedOutputsObject" ActionQueryMockedOutputsEnabled: description: Whether to enable the mocked outputs for testing. example: false oneOf: - - type: boolean - - description: If this is a string, it must be a valid JavaScript expression - that evaluates to a boolean. - example: ${true} - type: string + - type: boolean + - description: "If this is a string, it must be a valid JavaScript expression that evaluates to a boolean." + example: "${true}" + type: string ActionQueryMockedOutputsObject: description: The mocked outputs of the action query. properties: enabled: - $ref: '#/components/schemas/ActionQueryMockedOutputsEnabled' + $ref: "#/components/schemas/ActionQueryMockedOutputsEnabled" outputs: description: The mocked outputs of the action query, serialized as JSON. example: '{"status": "success"}' type: string required: - - enabled + - enabled type: object ActionQueryOnlyTriggerManually: - description: Determines when this query is executed. If set to `false`, the - query will run when the app loads and whenever any query arguments change. - If set to `true`, the query will only run when manually triggered from elsewhere - in the app. + description: Determines when this query is executed. If set to `false`, the query will run when the app loads and whenever any query arguments change. If set to `true`, the query will only run when manually triggered from elsewhere in the app. oneOf: - - type: boolean - - description: If this is a string, it must be a valid JavaScript expression - that evaluates to a boolean. - example: ${true} - type: string + - type: boolean + - description: "If this is a string, it must be a valid JavaScript expression that evaluates to a boolean." + example: "${true}" + type: string ActionQueryPollingIntervalInMs: - description: If specified, the app will poll the query at the specified interval - in milliseconds. The minimum polling interval is 15 seconds. The query will - only poll when the app's browser tab is active. + description: If specified, the app will poll the query at the specified interval in milliseconds. The minimum polling interval is 15 seconds. The query will only poll when the app's browser tab is active. oneOf: - - example: 30000.0 - format: double - minimum: 15000.0 - type: number - - description: If this is a string, it must be a valid JavaScript expression - that evaluates to a number. - example: ${15000} - type: string + - example: 30000.0 + format: double + minimum: 15000.0 + type: number + - description: "If this is a string, it must be a valid JavaScript expression that evaluates to a number." + example: "${15000}" + type: string ActionQueryProperties: description: The properties of the action query. properties: condition: - $ref: '#/components/schemas/ActionQueryCondition' + $ref: "#/components/schemas/ActionQueryCondition" debounceInMs: - $ref: '#/components/schemas/ActionQueryDebounceInMs' + $ref: "#/components/schemas/ActionQueryDebounceInMs" mockedOutputs: - $ref: '#/components/schemas/ActionQueryMockedOutputs' + $ref: "#/components/schemas/ActionQueryMockedOutputs" onlyTriggerManually: - $ref: '#/components/schemas/ActionQueryOnlyTriggerManually' + $ref: "#/components/schemas/ActionQueryOnlyTriggerManually" outputs: - description: The post-query transformation function, which is a JavaScript - function that changes the query's `.outputs` property after the query's - execution. - example: ${((outputs) => {return outputs.body.data})(self.rawOutputs)} + description: The post-query transformation function, which is a JavaScript function that changes the query's `.outputs` property after the query's execution. + example: "${((outputs) => {return outputs.body.data})(self.rawOutputs)}" type: string pollingIntervalInMs: - $ref: '#/components/schemas/ActionQueryPollingIntervalInMs' + $ref: "#/components/schemas/ActionQueryPollingIntervalInMs" requiresConfirmation: - $ref: '#/components/schemas/ActionQueryRequiresConfirmation' + $ref: "#/components/schemas/ActionQueryRequiresConfirmation" showToastOnError: - $ref: '#/components/schemas/ActionQueryShowToastOnError' + $ref: "#/components/schemas/ActionQueryShowToastOnError" spec: - $ref: '#/components/schemas/ActionQuerySpec' + $ref: "#/components/schemas/ActionQuerySpec" required: - - spec + - spec type: object ActionQueryRequiresConfirmation: description: Whether to prompt the user to confirm this query before it runs. oneOf: - - type: boolean - - description: If this is a string, it must be a valid JavaScript expression - that evaluates to a boolean. - example: ${true} - type: string + - type: boolean + - description: "If this is a string, it must be a valid JavaScript expression that evaluates to a boolean." + example: "${true}" + type: string ActionQueryShowToastOnError: - description: Whether to display a toast to the user when the query returns an - error. + description: Whether to display a toast to the user when the query returns an error. oneOf: - - type: boolean - - description: If this is a string, it must be a valid JavaScript expression - that evaluates to a boolean. - example: ${true} - type: string + - type: boolean + - description: "If this is a string, it must be a valid JavaScript expression that evaluates to a boolean." + example: "${true}" + type: string ActionQuerySpec: description: The definition of the action query. - example: '' + example: "" oneOf: - - type: string - - $ref: '#/components/schemas/ActionQuerySpecObject' + - type: string + - $ref: "#/components/schemas/ActionQuerySpecObject" ActionQuerySpecConnectionGroup: description: The connection group to use for an action query. properties: @@ -3135,55 +3027,52 @@ components: type: object ActionQuerySpecInput: additionalProperties: {} - description: The inputs to the action query. See the [Actions Catalog](https://docs.datadoghq.com/actions/actions_catalog/) - for more detail on each action and its inputs. + description: The inputs to the action query. See the [Actions Catalog](https://docs.datadoghq.com/actions/actions_catalog/) for more detail on each action and its inputs. type: object ActionQuerySpecInputs: - description: The inputs to the action query. These are the values that are passed - to the action when it is triggered. + description: The inputs to the action query. These are the values that are passed to the action when it is triggered. oneOf: - - type: string - - $ref: '#/components/schemas/ActionQuerySpecInput' + - type: string + - $ref: "#/components/schemas/ActionQuerySpecInput" ActionQuerySpecObject: description: The action query spec object. properties: connectionGroup: - $ref: '#/components/schemas/ActionQuerySpecConnectionGroup' + $ref: "#/components/schemas/ActionQuerySpecConnectionGroup" connectionId: description: The ID of the custom connection to use for this action query. example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 type: string fqn: description: The fully qualified name of the action type. - example: com.datadoghq.http.request + example: "com.datadoghq.http.request" type: string inputs: - $ref: '#/components/schemas/ActionQuerySpecInputs' + $ref: "#/components/schemas/ActionQuerySpecInputs" required: - - fqn + - fqn type: object ActionQueryType: default: action description: The action query type. enum: - - action + - action example: action type: string x-enum-varnames: - - ACTION + - ACTION ActiveBillingDimensionsAttributes: description: List of active billing dimensions. properties: month: - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.' + description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`." format: date-time type: string values: - description: 'List of active billing dimensions. Example: `[infra_host, - apm_host, serverless_infra]`.' + description: "List of active billing dimensions. Example: `[infra_host, apm_host, serverless_infra]`." items: description: A given billing dimension in a list. - example: infra_host + example: "infra_host" type: string type: array type: object @@ -3191,34 +3080,34 @@ components: description: Active billing dimensions data. properties: attributes: - $ref: '#/components/schemas/ActiveBillingDimensionsAttributes' + $ref: "#/components/schemas/ActiveBillingDimensionsAttributes" id: description: Unique ID of the response. type: string type: - $ref: '#/components/schemas/ActiveBillingDimensionsType' + $ref: "#/components/schemas/ActiveBillingDimensionsType" type: object ActiveBillingDimensionsResponse: description: Active billing dimensions response. properties: data: - $ref: '#/components/schemas/ActiveBillingDimensionsBody' + $ref: "#/components/schemas/ActiveBillingDimensionsBody" type: object ActiveBillingDimensionsType: default: billing_dimensions description: Type of active billing dimensions data. enum: - - billing_dimensions + - billing_dimensions type: string x-enum-varnames: - - BILLING_DIMENSIONS + - BILLING_DIMENSIONS AddMemberTeamRequest: description: Request to add a member team to super team's hierarchy properties: data: - $ref: '#/components/schemas/MemberTeam' + $ref: "#/components/schemas/MemberTeam" required: - - data + - data type: object Advisory: description: Advisory. @@ -3236,206 +3125,213 @@ components: example: Medium type: string required: - - id - - base_severity + - id + - base_severity type: object AlertEventAttributes: description: Alert event attributes. properties: aggregation_key: - $ref: '#/components/schemas/V2EventAggregationKey' + $ref: "#/components/schemas/V2EventAggregationKey" custom: description: JSON object of custom attributes. example: {} type: object evt: - $ref: '#/components/schemas/EventSystemAttributes' + $ref: "#/components/schemas/EventSystemAttributes" links: description: The links related to the event. - example: - - category: runbook - title: Runbook Link - url: https://app.datadoghq.com/runbook + example: [{"category": "runbook", "title": "Runbook Link", "url": "https://app.datadoghq.com/runbook"}] items: - $ref: '#/components/schemas/AlertEventAttributesLinksItem' + $ref: "#/components/schemas/AlertEventAttributesLinksItem" type: array priority: - $ref: '#/components/schemas/AlertEventAttributesPriority' + $ref: "#/components/schemas/AlertEventAttributesPriority" service: - $ref: '#/components/schemas/V2EventService' + $ref: "#/components/schemas/V2EventService" status: - $ref: '#/components/schemas/AlertEventAttributesStatus' + $ref: "#/components/schemas/AlertEventAttributesStatus" timestamp: - $ref: '#/components/schemas/V2EventTimestamp' + $ref: "#/components/schemas/V2EventTimestamp" title: - $ref: '#/components/schemas/V2EventTitle' + $ref: "#/components/schemas/V2EventTitle" type: object AlertEventAttributesLinksItem: description: A link. properties: category: - $ref: '#/components/schemas/AlertEventAttributesLinksItemCategory' + $ref: "#/components/schemas/AlertEventAttributesLinksItemCategory" title: - description: The display text of the link. + description: |- + The display text of the link. type: string url: - description: The URL of the link. + description: |- + The URL of the link. type: string type: object AlertEventAttributesLinksItemCategory: - description: The category of the link. + description: |- + The category of the link. enum: - - runbook - - documentation - - dashboard + - runbook + - documentation + - dashboard type: string x-enum-varnames: - - RUNBOOK - - DOCUMENTATION - - DASHBOARD + - RUNBOOK + - DOCUMENTATION + - DASHBOARD AlertEventAttributesPriority: description: The priority of the alert. enum: - - '1' - - '2' - - '3' - - '4' - - '5' - example: '5' + - "1" + - "2" + - "3" + - "4" + - "5" + example: "5" type: string x-enum-varnames: - - PRIORITY_ONE - - PRIORITY_TWO - - PRIORITY_THREE - - PRIORITY_FOUR - - PRIORITY_FIVE + - PRIORITY_ONE + - PRIORITY_TWO + - PRIORITY_THREE + - PRIORITY_FOUR + - PRIORITY_FIVE AlertEventAttributesStatus: description: The status of the alert. enum: - - warn - - error - - ok - example: error + - warn + - error + - ok + example: "error" type: string x-enum-varnames: - - WARN - - ERROR - - OK + - WARN + - ERROR + - OK AlertEventCustomAttributes: additionalProperties: false - description: Alert event attributes. + description: |- + Alert event attributes. properties: custom: - $ref: '#/components/schemas/AlertEventCustomAttributesCustom' + $ref: "#/components/schemas/AlertEventCustomAttributesCustom" links: - $ref: '#/components/schemas/AlertEventCustomAttributesLinks' + $ref: "#/components/schemas/AlertEventCustomAttributesLinks" priority: - $ref: '#/components/schemas/AlertEventCustomAttributesPriority' + $ref: "#/components/schemas/AlertEventCustomAttributesPriority" status: - $ref: '#/components/schemas/AlertEventCustomAttributesStatus' + $ref: "#/components/schemas/AlertEventCustomAttributesStatus" required: - - status + - status type: object AlertEventCustomAttributesCustom: additionalProperties: {} - description: Free form JSON object for arbitrary data. Supports up to 100 properties - per object and a maximum nesting depth of 10 levels. + description: |- + Free form JSON object for arbitrary data. Supports up to 100 properties per object and a maximum nesting depth of 10 levels. example: {} type: object AlertEventCustomAttributesLinks: - description: The links related to the event. Maximum of 20 links allowed. + description: |- + The links related to the event. Maximum of 20 links allowed. items: - $ref: '#/components/schemas/AlertEventCustomAttributesLinksItems' + $ref: "#/components/schemas/AlertEventCustomAttributesLinksItems" maxItems: 20 minItems: 1 type: array AlertEventCustomAttributesLinksItems: additionalProperties: false - description: A link. + description: |- + A link. properties: category: - $ref: '#/components/schemas/AlertEventCustomAttributesLinksItemsCategory' + $ref: "#/components/schemas/AlertEventCustomAttributesLinksItemsCategory" title: - description: The display text of the link. Limited to 300 characters. - example: Runbook Link + description: |- + The display text of the link. Limited to 300 characters. + example: "Runbook Link" maxLength: 300 minLength: 1 type: string url: - description: The URL of the link. Limited to 2048 characters. - example: https://app.datadoghq.com/runbook + description: |- + The URL of the link. Limited to 2048 characters. + example: "https://app.datadoghq.com/runbook" maxLength: 2048 minLength: 1 type: string required: - - url - - category + - url + - category type: object AlertEventCustomAttributesLinksItemsCategory: - description: The category of the link. + description: |- + The category of the link. enum: - - runbook - - documentation - - dashboard - - resource - example: runbook + - runbook + - documentation + - dashboard + - resource + example: "runbook" type: string x-enum-varnames: - - RUNBOOK - - DOCUMENTATION - - DASHBOARD - - RESOURCE + - RUNBOOK + - DOCUMENTATION + - DASHBOARD + - RESOURCE AlertEventCustomAttributesPriority: - default: '5' - description: The priority of the alert. - enum: - - '1' - - '2' - - '3' - - '4' - - '5' - example: '5' - type: string - x-enum-varnames: - - PRIORITY_ONE - - PRIORITY_TWO - - PRIORITY_THREE - - PRIORITY_FOUR - - PRIORITY_FIVE + default: "5" + description: |- + The priority of the alert. + enum: + - "1" + - "2" + - "3" + - "4" + - "5" + example: "5" + type: string + x-enum-varnames: + - PRIORITY_ONE + - PRIORITY_TWO + - PRIORITY_THREE + - PRIORITY_FOUR + - PRIORITY_FIVE AlertEventCustomAttributesStatus: - description: The status of the alert. + description: |- + The status of the alert. enum: - - warn - - error - - ok - example: warn + - warn + - error + - ok + example: "warn" type: string x-enum-varnames: - - WARN - - ERROR - - OK + - WARN + - ERROR + - OK Annotation: - description: A list of annotations used in the workflow. These are like sticky - notes for your workflow! + description: "A list of annotations used in the workflow. These are like sticky notes for your workflow!" properties: display: - $ref: '#/components/schemas/AnnotationDisplay' + $ref: "#/components/schemas/AnnotationDisplay" id: description: The `Annotation` `id`. - example: '' + example: "" type: string markdownTextAnnotation: - $ref: '#/components/schemas/AnnotationMarkdownTextAnnotation' + $ref: "#/components/schemas/AnnotationMarkdownTextAnnotation" required: - - id - - display - - markdownTextAnnotation + - id + - display + - markdownTextAnnotation type: object AnnotationDisplay: description: The definition of `AnnotationDisplay` object. properties: bounds: - $ref: '#/components/schemas/AnnotationDisplayBounds' + $ref: "#/components/schemas/AnnotationDisplayBounds" type: object AnnotationDisplayBounds: description: The definition of `AnnotationDisplayBounds` object. @@ -3469,22 +3365,22 @@ components: properties: api_token: description: The `AnthropicAPIKey` `api_token`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/AnthropicAPIKeyType' + $ref: "#/components/schemas/AnthropicAPIKeyType" required: - - type - - api_token + - type + - api_token type: object AnthropicAPIKeyType: description: The definition of the `AnthropicAPIKey` object. enum: - - AnthropicAPIKey + - AnthropicAPIKey example: AnthropicAPIKey type: string x-enum-varnames: - - ANTHROPICAPIKEY + - ANTHROPICAPIKEY AnthropicAPIKeyUpdate: description: The definition of the `AnthropicAPIKey` object. properties: @@ -3492,69 +3388,69 @@ components: description: The `AnthropicAPIKeyUpdate` `api_token`. type: string type: - $ref: '#/components/schemas/AnthropicAPIKeyType' + $ref: "#/components/schemas/AnthropicAPIKeyType" required: - - type + - type type: object AnthropicCredentials: description: The definition of the `AnthropicCredentials` object. oneOf: - - $ref: '#/components/schemas/AnthropicAPIKey' + - $ref: "#/components/schemas/AnthropicAPIKey" AnthropicCredentialsUpdate: description: The definition of the `AnthropicCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/AnthropicAPIKeyUpdate' + - $ref: "#/components/schemas/AnthropicAPIKeyUpdate" AnthropicIntegration: description: The definition of the `AnthropicIntegration` object. properties: credentials: - $ref: '#/components/schemas/AnthropicCredentials' + $ref: "#/components/schemas/AnthropicCredentials" type: - $ref: '#/components/schemas/AnthropicIntegrationType' + $ref: "#/components/schemas/AnthropicIntegrationType" required: - - type - - credentials + - type + - credentials type: object AnthropicIntegrationType: description: The definition of the `AnthropicIntegrationType` object. enum: - - Anthropic + - Anthropic example: Anthropic type: string x-enum-varnames: - - ANTHROPIC + - ANTHROPIC AnthropicIntegrationUpdate: description: The definition of the `AnthropicIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/AnthropicCredentialsUpdate' + $ref: "#/components/schemas/AnthropicCredentialsUpdate" type: - $ref: '#/components/schemas/AnthropicIntegrationType' + $ref: "#/components/schemas/AnthropicIntegrationType" required: - - type + - type type: object AnyValue: description: Represents any valid JSON value. nullable: true oneOf: - - $ref: '#/components/schemas/AnyValueString' - - $ref: '#/components/schemas/AnyValueNumber' - - $ref: '#/components/schemas/AnyValueObject' - - $ref: '#/components/schemas/AnyValueArray' - - $ref: '#/components/schemas/AnyValueBoolean' + - $ref: "#/components/schemas/AnyValueString" + - $ref: "#/components/schemas/AnyValueNumber" + - $ref: "#/components/schemas/AnyValueObject" + - $ref: "#/components/schemas/AnyValueArray" + - $ref: "#/components/schemas/AnyValueBoolean" type: object AnyValueArray: items: - $ref: '#/components/schemas/AnyValueItem' + $ref: "#/components/schemas/AnyValueItem" type: array AnyValueBoolean: type: boolean AnyValueItem: oneOf: - - $ref: '#/components/schemas/AnyValueString' - - $ref: '#/components/schemas/AnyValueNumber' - - $ref: '#/components/schemas/AnyValueObject' - - $ref: '#/components/schemas/AnyValueBoolean' + - $ref: "#/components/schemas/AnyValueString" + - $ref: "#/components/schemas/AnyValueNumber" + - $ref: "#/components/schemas/AnyValueObject" + - $ref: "#/components/schemas/AnyValueBoolean" AnyValueNumber: format: double type: number @@ -3565,94 +3461,92 @@ components: type: string ApiID: description: API identifier. - example: 90646597-5fdb-4a17-a240-647003f8c028 + example: "90646597-5fdb-4a17-a240-647003f8c028" format: uuid type: string ApmRetentionFilterType: default: apm_retention_filter description: The type of the resource. enum: - - apm_retention_filter + - apm_retention_filter example: apm_retention_filter type: string - x-enum-varnames: - - apm_retention_filter + x-enum-varnames: ["apm_retention_filter"] AppBuilderEvent: additionalProperties: {} - description: An event on a UI component that triggers a response or action in - an app. + description: An event on a UI component that triggers a response or action in an app. properties: name: - $ref: '#/components/schemas/AppBuilderEventName' + $ref: "#/components/schemas/AppBuilderEventName" type: - $ref: '#/components/schemas/AppBuilderEventType' + $ref: "#/components/schemas/AppBuilderEventType" type: object AppBuilderEventName: - description: The triggering action for the event. - enum: - - pageChange - - tableRowClick - - _tableRowButtonClick - - change - - submit - - click - - toggleOpen - - close - - open - - executionFinished + description: "The triggering action for the event." + enum: + - pageChange + - tableRowClick + - _tableRowButtonClick + - change + - submit + - click + - toggleOpen + - close + - open + - executionFinished example: click type: string x-enum-varnames: - - PAGECHANGE - - TABLEROWCLICK - - TABLEROWBUTTONCLICK - - CHANGE - - SUBMIT - - CLICK - - TOGGLEOPEN - - CLOSE - - OPEN - - EXECUTIONFINISHED + - PAGECHANGE + - TABLEROWCLICK + - TABLEROWBUTTONCLICK + - CHANGE + - SUBMIT + - CLICK + - TOGGLEOPEN + - CLOSE + - OPEN + - EXECUTIONFINISHED AppBuilderEventType: description: The response to the event. enum: - - custom - - setComponentState - - triggerQuery - - openModal - - closeModal - - openUrl - - downloadFile - - setStateVariableValue + - custom + - setComponentState + - triggerQuery + - openModal + - closeModal + - openUrl + - downloadFile + - setStateVariableValue example: triggerQuery type: string x-enum-varnames: - - CUSTOM - - SETCOMPONENTSTATE - - TRIGGERQUERY - - OPENMODAL - - CLOSEMODAL - - OPENURL - - DOWNLOADFILE - - SETSTATEVARIABLEVALUE + - CUSTOM + - SETCOMPONENTSTATE + - TRIGGERQUERY + - OPENMODAL + - CLOSEMODAL + - OPENURL + - DOWNLOADFILE + - SETSTATEVARIABLEVALUE AppDefinitionType: default: appDefinitions description: The app definition type. enum: - - appDefinitions + - appDefinitions example: appDefinitions type: string x-enum-varnames: - - APPDEFINITIONS + - APPDEFINITIONS AppDeploymentType: default: deployment description: The deployment type. enum: - - deployment + - deployment example: deployment type: string x-enum-varnames: - - DEPLOYMENT + - DEPLOYMENT AppKeyRegistrationData: description: Data related to the app key registration. properties: @@ -3662,18 +3556,18 @@ components: readOnly: true type: string type: - $ref: '#/components/schemas/AppKeyRegistrationDataType' + $ref: "#/components/schemas/AppKeyRegistrationDataType" required: - - type + - type type: object AppKeyRegistrationDataType: description: The definition of `AppKeyRegistrationDataType` object. enum: - - app_key_registration + - app_key_registration example: app_key_registration type: string x-enum-varnames: - - APP_KEY_REGISTRATION + - APP_KEY_REGISTRATION AppMeta: description: Metadata of an app. properties: @@ -3694,9 +3588,7 @@ components: format: date-time type: string updated_since_deployment: - description: Whether the app was updated since it was last published. Published - apps are pinned to a specific version and do not automatically update - when the app is updated. + description: Whether the app was updated since it was last published. Published apps are pinned to a specific version and do not automatically update when the app is updated. type: boolean user_id: description: The ID of the user who created the app. @@ -3711,8 +3603,7 @@ components: format: uuid type: string version: - description: The version number of the app. This starts at 1 and increments - with each update. + description: The version number of the app. This starts at 1 and increments with each update. format: int64 type: integer type: object @@ -3722,85 +3613,82 @@ components: connections: description: Array of custom connections used by the app. items: - $ref: '#/components/schemas/CustomConnection' + $ref: "#/components/schemas/CustomConnection" type: array deployment: - $ref: '#/components/schemas/DeploymentRelationship' + $ref: "#/components/schemas/DeploymentRelationship" type: object AppTriggerWrapper: - description: Schema for an App-based trigger. + description: "Schema for an App-based trigger." properties: appTrigger: - description: Trigger a workflow from an App. + description: "Trigger a workflow from an App." type: object startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - appTrigger + - appTrigger type: object ApplicationKeyCreateAttributes: description: Attributes used to create an application Key. properties: name: description: Name of the application key. - example: Application Key for managing dashboards + example: "Application Key for managing dashboards" type: string scopes: description: Array of scopes to grant the application key. - example: - - dashboards_read - - dashboards_write - - dashboards_public_share + example: ["dashboards_read", "dashboards_write", "dashboards_public_share"] items: description: Name of scope. type: string nullable: true type: array required: - - name + - name type: object ApplicationKeyCreateData: description: Object used to create an application key. properties: attributes: - $ref: '#/components/schemas/ApplicationKeyCreateAttributes' + $ref: "#/components/schemas/ApplicationKeyCreateAttributes" type: - $ref: '#/components/schemas/ApplicationKeysType' + $ref: "#/components/schemas/ApplicationKeysType" required: - - attributes - - type + - attributes + - type type: object ApplicationKeyCreateRequest: description: Request used to create an application key. properties: data: - $ref: '#/components/schemas/ApplicationKeyCreateData' + $ref: "#/components/schemas/ApplicationKeyCreateData" required: - - data + - data type: object ApplicationKeyRelationships: description: Resources related to the application key. properties: owned_by: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" type: object ApplicationKeyResponse: description: Response for retrieving an application key. properties: data: - $ref: '#/components/schemas/FullApplicationKey' + $ref: "#/components/schemas/FullApplicationKey" included: description: Array of objects related to the application key. items: - $ref: '#/components/schemas/ApplicationKeyResponseIncludedItem' + $ref: "#/components/schemas/ApplicationKeyResponseIncludedItem" type: array type: object ApplicationKeyResponseIncludedItem: description: An object related to an application key. oneOf: - - $ref: '#/components/schemas/User' - - $ref: '#/components/schemas/Role' - - $ref: '#/components/schemas/LeakedKey' + - $ref: "#/components/schemas/User" + - $ref: "#/components/schemas/Role" + - $ref: "#/components/schemas/LeakedKey" ApplicationKeyResponseMeta: description: Additional information related to the application key response. properties: @@ -3809,7 +3697,7 @@ components: format: int64 type: integer page: - $ref: '#/components/schemas/ApplicationKeyResponseMetaPage' + $ref: "#/components/schemas/ApplicationKeyResponseMetaPage" type: object ApplicationKeyResponseMetaPage: description: Additional information related to the application key response. @@ -3824,14 +3712,11 @@ components: properties: name: description: Name of the application key. - example: Application Key for managing dashboards + example: "Application Key for managing dashboards" type: string scopes: description: Array of scopes to grant the application key. - example: - - dashboards_read - - dashboards_write - - dashboards_public_share + example: ["dashboards_read", "dashboards_write", "dashboards_public_share"] items: description: Name of scope. type: string @@ -3842,80 +3727,78 @@ components: description: Object used to update an application key. properties: attributes: - $ref: '#/components/schemas/ApplicationKeyUpdateAttributes' + $ref: "#/components/schemas/ApplicationKeyUpdateAttributes" id: description: ID of the application key. - example: 00112233-4455-6677-8899-aabbccddeeff + example: "00112233-4455-6677-8899-aabbccddeeff" type: string type: - $ref: '#/components/schemas/ApplicationKeysType' + $ref: "#/components/schemas/ApplicationKeysType" required: - - attributes - - id - - type + - attributes + - id + - type type: object ApplicationKeyUpdateRequest: description: Request used to update an application key. properties: data: - $ref: '#/components/schemas/ApplicationKeyUpdateData' + $ref: "#/components/schemas/ApplicationKeyUpdateData" required: - - data + - data type: object ApplicationKeysSort: default: name description: Sorting options enum: - - created_at - - -created_at - - last4 - - -last4 - - name - - -name + - created_at + - -created_at + - last4 + - -last4 + - name + - -name type: string x-enum-varnames: - - CREATED_AT_ASCENDING - - CREATED_AT_DESCENDING - - LAST4_ASCENDING - - LAST4_DESCENDING - - NAME_ASCENDING - - NAME_DESCENDING + - CREATED_AT_ASCENDING + - CREATED_AT_DESCENDING + - LAST4_ASCENDING + - LAST4_DESCENDING + - NAME_ASCENDING + - NAME_DESCENDING ApplicationKeysType: default: application_keys description: Application Keys resource type. enum: - - application_keys + - application_keys example: application_keys type: string x-enum-varnames: - - APPLICATION_KEYS + - APPLICATION_KEYS ApplicationSecurityWafCustomRuleAction: description: The definition of `ApplicationSecurityWafCustomRuleAction` object. properties: action: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleActionAction' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleActionAction" parameters: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleActionParameters' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleActionParameters" type: object ApplicationSecurityWafCustomRuleActionAction: default: block_request - description: Override the default action to take when the WAF custom rule would - block. + description: Override the default action to take when the WAF custom rule would block. enum: - - redirect_request - - block_request + - redirect_request + - block_request example: block_request type: string x-enum-varnames: - - REDIRECT_REQUEST - - BLOCK_REQUEST + - REDIRECT_REQUEST + - BLOCK_REQUEST ApplicationSecurityWafCustomRuleActionParameters: - description: The definition of `ApplicationSecurityWafCustomRuleActionParameters` - object. + description: The definition of `ApplicationSecurityWafCustomRuleActionParameters` object. properties: location: description: The location to redirect to when the WAF custom rule triggers. - example: /blocking + example: "/blocking" type: string status_code: default: 403 @@ -3925,170 +3808,169 @@ components: type: integer type: object ApplicationSecurityWafCustomRuleAttributes: - description: A WAF custom rule. + description: "A WAF custom rule." properties: action: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleAction' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleAction" blocking: description: Indicates whether the WAF custom rule will block the request. example: false type: boolean conditions: - description: 'Conditions for which the WAF Custom Rule will triggers, all - conditions needs to match in order for the WAF - - rule to trigger.' + description: |- + Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF + rule to trigger. items: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCondition' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleCondition" type: array enabled: description: Indicates whether the WAF custom rule is enabled. example: false type: boolean metadata: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleMetadata' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleMetadata" name: description: The Name of the WAF custom rule. - example: Block request from bad useragent + example: "Block request from bad useragent" type: string path_glob: description: The path glob for the WAF custom rule. - example: /api/search/* + example: "/api/search/*" type: string scope: description: The scope of the WAF custom rule. items: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleScope' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleScope" type: array tags: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleTags' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleTags" required: - - enabled - - blocking - - name - - tags - - conditions + - enabled + - blocking + - name + - tags + - conditions type: object ApplicationSecurityWafCustomRuleCondition: description: One condition of the WAF Custom Rule. properties: operator: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionOperator' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleConditionOperator" parameters: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionParameters' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleConditionParameters" required: - - operator - - parameters + - operator + - parameters type: object ApplicationSecurityWafCustomRuleConditionInput: description: Input from the request on which the condition should apply. properties: address: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionInputAddress' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleConditionInputAddress" key_path: description: Specific path for the input. items: type: string type: array required: - - address + - address type: object ApplicationSecurityWafCustomRuleConditionInputAddress: description: Input from the request on which the condition should apply. enum: - - server.db.statement - - server.io.fs.file - - server.io.net.url - - server.sys.shell.cmd - - server.request.method - - server.request.uri.raw - - server.request.path_params - - server.request.query - - server.request.headers - - server.request.headers.no_cookies - - server.request.custom-auth - - server.request.cookies - - server.request.trailers - - server.request.body - - server.request.body.filenames - - server.response.status - - server.response.headers.no_cookies - - server.response.trailers - - server.response.body - - grpc.server.request.metadata - - grpc.server.request.message - - grpc.server.method - - graphql.server.all_resolvers - - usr.id - - http.client_ip - - server.llm.event - - server.llm.guard.verdict - - _dd.appsec.fp.http.header - - _dd.appsec.fp.http.network - - _dd.appsec.fp.session - - _dd.appsec.fp.http.endpoint + - server.db.statement + - server.io.fs.file + - server.io.net.url + - server.sys.shell.cmd + - server.request.method + - server.request.uri.raw + - server.request.path_params + - server.request.query + - server.request.headers + - server.request.headers.no_cookies + - server.request.custom-auth + - server.request.cookies + - server.request.trailers + - server.request.body + - server.request.body.filenames + - server.response.status + - server.response.headers.no_cookies + - server.response.trailers + - server.response.body + - grpc.server.request.metadata + - grpc.server.request.message + - grpc.server.method + - graphql.server.all_resolvers + - usr.id + - http.client_ip + - server.llm.event + - server.llm.guard.verdict + - _dd.appsec.fp.http.header + - _dd.appsec.fp.http.network + - _dd.appsec.fp.session + - _dd.appsec.fp.http.endpoint example: server.db.statement type: string x-enum-varnames: - - SERVER_DB_STATEMENT - - SERVER_IO_FS_FILE - - SERVER_IO_NET_URL - - SERVER_SYS_SHELL_CMD - - SERVER_REQUEST_METHOD - - SERVER_REQUEST_URI_RAW - - SERVER_REQUEST_PATH_PARAMS - - SERVER_REQUEST_QUERY - - SERVER_REQUEST_HEADERS - - SERVER_REQUEST_HEADERS_NO_COOKIES - - SERVER_REQUEST_CUSTOM_AUTH - - SERVER_REQUEST_COOKIES - - SERVER_REQUEST_TRAILERS - - SERVER_REQUEST_BODY - - SERVER_REQUEST_BODY_FILENAMES - - SERVER_RESPONSE_STATUS - - SERVER_RESPONSE_HEADERS_NO_COOKIES - - SERVER_RESPONSE_TRAILERS - - SERVER_RESPONSE_BODY - - GRPC_SERVER_REQUEST_METADATA - - GRPC_SERVER_REQUEST_MESSAGE - - GRPC_SERVER_METHOD - - GRAPHQL_SERVER_ALL_RESOLVERS - - USR_ID - - HTTP_CLIENT_IP - - SERVER_LLM_EVENT - - SERVER_LLM_GUARD_VERDICT - - DD_APPSEC_FP_HTTP_HEADER - - DD_APPSEC_FP_HTTP_NETWORK - - DD_APPSEC_FP_SESSION - - DD_APPSEC_FP_HTTP_ENDPOINT + - SERVER_DB_STATEMENT + - SERVER_IO_FS_FILE + - SERVER_IO_NET_URL + - SERVER_SYS_SHELL_CMD + - SERVER_REQUEST_METHOD + - SERVER_REQUEST_URI_RAW + - SERVER_REQUEST_PATH_PARAMS + - SERVER_REQUEST_QUERY + - SERVER_REQUEST_HEADERS + - SERVER_REQUEST_HEADERS_NO_COOKIES + - SERVER_REQUEST_CUSTOM_AUTH + - SERVER_REQUEST_COOKIES + - SERVER_REQUEST_TRAILERS + - SERVER_REQUEST_BODY + - SERVER_REQUEST_BODY_FILENAMES + - SERVER_RESPONSE_STATUS + - SERVER_RESPONSE_HEADERS_NO_COOKIES + - SERVER_RESPONSE_TRAILERS + - SERVER_RESPONSE_BODY + - GRPC_SERVER_REQUEST_METADATA + - GRPC_SERVER_REQUEST_MESSAGE + - GRPC_SERVER_METHOD + - GRAPHQL_SERVER_ALL_RESOLVERS + - USR_ID + - HTTP_CLIENT_IP + - SERVER_LLM_EVENT + - SERVER_LLM_GUARD_VERDICT + - DD_APPSEC_FP_HTTP_HEADER + - DD_APPSEC_FP_HTTP_NETWORK + - DD_APPSEC_FP_SESSION + - DD_APPSEC_FP_HTTP_ENDPOINT ApplicationSecurityWafCustomRuleConditionOperator: description: Operator to use for the WAF Condition. enum: - - match_regex - - '!match_regex' - - phrase_match - - '!phrase_match' - - is_xss - - is_sqli - - exact_match - - '!exact_match' - - ip_match - - '!ip_match' - - capture_data - example: match_regex - type: string - x-enum-varnames: - - MATCH_REGEX - - NOT_MATCH_REGEX - - PHRASE_MATCH - - NOT_PHRASE_MATCH - - IS_XSS - - IS_SQLI - - EXACT_MATCH - - NOT_EXACT_MATCH - - IP_MATCH - - NOT_IP_MATCH - - CAPTURE_DATA + - match_regex + - "!match_regex" + - phrase_match + - "!phrase_match" + - is_xss + - is_sqli + - exact_match + - "!exact_match" + - ip_match + - "!ip_match" + - capture_data + example: "match_regex" + type: string + x-enum-varnames: + - MATCH_REGEX + - NOT_MATCH_REGEX + - PHRASE_MATCH + - NOT_PHRASE_MATCH + - IS_XSS + - IS_SQLI + - EXACT_MATCH + - NOT_EXACT_MATCH + - IP_MATCH + - NOT_IP_MATCH + - CAPTURE_DATA ApplicationSecurityWafCustomRuleConditionOptions: description: Options for the operator of this condition. properties: @@ -4098,8 +3980,7 @@ components: type: boolean min_length: default: 0 - description: Only evaluate this condition if the value has a minimum amount - of characters. + description: Only evaluate this condition if the value has a minimum amount of characters. format: int64 type: integer type: object @@ -4107,55 +3988,51 @@ components: description: The scope of the WAF custom rule. properties: data: - description: Identifier of a list of data from the denylist. Can only be - used as substitution from the list parameter. - example: blocked_users + description: |- + Identifier of a list of data from the denylist. Can only be used as substitution from the list parameter. + example: "blocked_users" type: string inputs: - description: List of inputs on which at least one should match with the - given operator. + description: List of inputs on which at least one should match with the given operator. items: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionInput' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleConditionInput" type: array list: - description: 'List of value to use with the condition. Only used with the - phrase_match, !phrase_match, exact_match and - - !exact_match operator.' + description: |- + List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and + !exact_match operator. items: type: string type: array options: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionOptions' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleConditionOptions" regex: - description: Regex to use with the condition. Only used with match_regex - and !match_regex operator. - example: path.* + description: "Regex to use with the condition. Only used with match_regex and !match_regex operator." + example: "path.*" type: string value: - description: Store the captured value in the specified tag name. Only used - with the capture_data operator. + description: |- + Store the captured value in the specified tag name. Only used with the capture_data operator. example: custom_tag type: string required: - - inputs + - inputs type: object ApplicationSecurityWafCustomRuleCreateAttributes: - description: Create a new WAF custom rule. + description: "Create a new WAF custom rule." properties: action: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleAction' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleAction" blocking: description: Indicates whether the WAF custom rule will block the request. example: false type: boolean conditions: - description: 'Conditions for which the WAF Custom Rule will triggers, all - conditions needs to match in order for the WAF - - rule to trigger' + description: |- + Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF + rule to trigger items: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCondition' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleCondition" type: array enabled: description: Indicates whether the WAF custom rule is enabled. @@ -4163,57 +4040,57 @@ components: type: boolean name: description: The Name of the WAF custom rule. - example: Block request from a bad useragent + example: "Block request from a bad useragent" type: string path_glob: description: The path glob for the WAF custom rule. - example: /api/search/* + example: "/api/search/*" type: string scope: description: The scope of the WAF custom rule. items: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleScope' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleScope" type: array tags: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleTags' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleTags" required: - - enabled - - blocking - - name - - tags - - conditions + - enabled + - blocking + - name + - tags + - conditions type: object ApplicationSecurityWafCustomRuleCreateData: description: Object for a single WAF custom rule. properties: attributes: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCreateAttributes' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleCreateAttributes" type: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleType' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleType" required: - - attributes - - type + - attributes + - type type: object ApplicationSecurityWafCustomRuleCreateRequest: description: Request object that includes the custom rule to create. properties: data: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCreateData' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleCreateData" required: - - data + - data type: object ApplicationSecurityWafCustomRuleData: description: Object for a single WAF custom rule. properties: attributes: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleAttributes' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleAttributes" id: - description: The ID of the custom rule. - example: 2857c47d-1e3a-4300-8b2f-dc24089c084b + description: "The ID of the custom rule." + example: "2857c47d-1e3a-4300-8b2f-dc24089c084b" readOnly: true type: string type: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleType' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleType" type: object ApplicationSecurityWafCustomRuleListResponse: description: Response object that includes a list of WAF custom rules. @@ -4221,7 +4098,7 @@ components: data: description: The WAF custom rule data. items: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleData' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleData" type: array type: object ApplicationSecurityWafCustomRuleMetadata: @@ -4229,29 +4106,29 @@ components: properties: added_at: description: The date and time the WAF custom rule was created. - example: '2021-01-01T00:00:00Z' + example: "2021-01-01T00:00:00Z" format: date-time type: string added_by: description: The handle of the user who created the WAF custom rule. - example: john.doe@datadoghq.com + example: "john.doe@datadoghq.com" type: string added_by_name: description: The name of the user who created the WAF custom rule. - example: John Doe + example: "John Doe" type: string modified_at: description: The date and time the WAF custom rule was last updated. - example: '2021-01-01T00:00:00Z' + example: "2021-01-01T00:00:00Z" format: date-time type: string modified_by: description: The handle of the user who last updated the WAF custom rule. - example: john.doe@datadoghq.com + example: "john.doe@datadoghq.com" type: string modified_by_name: description: The name of the user who last updated the WAF custom rule. - example: John Doe + example: "John Doe" type: string readOnly: true type: object @@ -4259,81 +4136,77 @@ components: description: Response object that includes a single WAF custom rule. properties: data: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleData' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleData" type: object ApplicationSecurityWafCustomRuleScope: description: The scope of the WAF custom rule. properties: env: description: The environment scope for the WAF custom rule. - example: prod + example: "prod" type: string service: description: The service scope for the WAF custom rule. - example: billing-service + example: "billing-service" type: string required: - - service - - env + - service + - env type: object ApplicationSecurityWafCustomRuleTags: additionalProperties: type: string - description: 'Tags associated with the WAF Custom Rule. The concatenation of - category and type will form the security - - activity field associated with the traces.' + description: |- + Tags associated with the WAF Custom Rule. The concatenation of category and type will form the security + activity field associated with the traces. maxProperties: 32 properties: category: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleTagsCategory' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleTagsCategory" type: - description: The type of the WAF rule, associated with the category will - form the security activity. - example: users.login.success + description: The type of the WAF rule, associated with the category will form the security activity. + example: "users.login.success" type: string required: - - category - - type + - category + - type type: object ApplicationSecurityWafCustomRuleTagsCategory: - description: The category of the WAF Rule, can be either `business_logic`, `attack_attempt` - or `security_response`. + description: The category of the WAF Rule, can be either `business_logic`, `attack_attempt` or `security_response`. enum: - - attack_attempt - - business_logic - - security_response - example: business_logic + - attack_attempt + - business_logic + - security_response + example: "business_logic" type: string x-enum-varnames: - - ATTACK_ATTEMPT - - BUSINESS_LOGIC - - SECURITY_RESPONSE + - ATTACK_ATTEMPT + - BUSINESS_LOGIC + - SECURITY_RESPONSE ApplicationSecurityWafCustomRuleType: default: custom_rule description: The type of the resource. The value should always be `custom_rule`. enum: - - custom_rule + - custom_rule example: custom_rule type: string x-enum-varnames: - - CUSTOM_RULE + - CUSTOM_RULE ApplicationSecurityWafCustomRuleUpdateAttributes: - description: Update a WAF custom rule. + description: "Update a WAF custom rule." properties: action: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleAction' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleAction" blocking: description: Indicates whether the WAF custom rule will block the request. example: false type: boolean conditions: - description: 'Conditions for which the WAF Custom Rule will triggers, all - conditions needs to match in order for the WAF - - rule to trigger.' + description: |- + Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF + rule to trigger. items: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCondition' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleCondition" type: array enabled: description: Indicates whether the WAF custom rule is enabled. @@ -4341,96 +4214,91 @@ components: type: boolean name: description: The Name of the WAF custom rule. - example: Block request from bad useragent + example: "Block request from bad useragent" type: string path_glob: description: The path glob for the WAF custom rule. - example: /api/search/* + example: "/api/search/*" type: string scope: description: The scope of the WAF custom rule. items: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleScope' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleScope" type: array tags: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleTags' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleTags" required: - - enabled - - blocking - - name - - tags - - conditions + - enabled + - blocking + - name + - tags + - conditions type: object ApplicationSecurityWafCustomRuleUpdateData: description: Object for a single WAF Custom Rule. properties: attributes: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleUpdateAttributes' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleUpdateAttributes" type: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleType' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleType" required: - - attributes - - type + - attributes + - type type: object ApplicationSecurityWafCustomRuleUpdateRequest: description: Request object that includes the Custom Rule to update. properties: data: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleUpdateData' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleUpdateData" required: - - data + - data type: object ApplicationSecurityWafExclusionFilterAttributes: description: Attributes describing a WAF exclusion filter. properties: description: description: A description for the exclusion filter. - example: Exclude false positives on a path + example: "Exclude false positives on a path" type: string enabled: description: Indicates whether the exclusion filter is enabled. example: true type: boolean event_query: - description: The event query matched by the legacy exclusion filter. Cannot - be created nor updated. + description: The event query matched by the legacy exclusion filter. Cannot be created nor updated. type: string ip_list: - description: The client IP addresses matched by the exclusion filter (CIDR - notation is supported). + description: The client IP addresses matched by the exclusion filter (CIDR notation is supported). items: - example: 198.51.100.72 + example: "198.51.100.72" type: string type: array metadata: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterMetadata' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterMetadata" on_match: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterOnMatch' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterOnMatch" parameters: - description: A list of parameters matched by the exclusion filter in the - HTTP query string and HTTP request body. Nested parameters can be matched - by joining fields with a dot character. + description: A list of parameters matched by the exclusion filter in the HTTP query string and HTTP request body. Nested parameters can be matched by joining fields with a dot character. items: - example: list.search.query + example: "list.search.query" type: string type: array path_glob: description: The HTTP path glob expression matched by the exclusion filter. - example: /accounts/* + example: "/accounts/*" type: string rules_target: description: The WAF rules targeted by the exclusion filter. items: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTarget' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTarget" type: array scope: description: The services where the exclusion filter is deployed. items: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterScope' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterScope" type: array search_query: - description: Generated event search query for traces matching the exclusion - filter. + description: Generated event search query for traces matching the exclusion filter. readOnly: true type: string type: object @@ -4439,69 +4307,66 @@ components: properties: description: description: A description for the exclusion filter. - example: Exclude false positives on a path + example: "Exclude false positives on a path" type: string enabled: description: Indicates whether the exclusion filter is enabled. example: true type: boolean ip_list: - description: The client IP addresses matched by the exclusion filter (CIDR - notation is supported). + description: The client IP addresses matched by the exclusion filter (CIDR notation is supported). items: - example: 198.51.100.72 + example: "198.51.100.72" type: string type: array on_match: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterOnMatch' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterOnMatch" parameters: - description: A list of parameters matched by the exclusion filter in the - HTTP query string and HTTP request body. Nested parameters can be matched - by joining fields with a dot character. + description: A list of parameters matched by the exclusion filter in the HTTP query string and HTTP request body. Nested parameters can be matched by joining fields with a dot character. items: - example: list.search.query + example: "list.search.query" type: string type: array path_glob: description: The HTTP path glob expression matched by the exclusion filter. - example: /accounts/* + example: "/accounts/*" type: string rules_target: description: The WAF rules targeted by the exclusion filter. items: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTarget' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTarget" type: array scope: description: The services where the exclusion filter is deployed. items: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterScope' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterScope" type: array required: - - description - - enabled + - description + - enabled type: object ApplicationSecurityWafExclusionFilterCreateData: description: Object for creating a single WAF exclusion filter. properties: attributes: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterCreateAttributes' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterCreateAttributes" type: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterType' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterType" required: - - attributes - - type + - attributes + - type type: object ApplicationSecurityWafExclusionFilterCreateRequest: description: Request object for creating a single WAF exclusion filter. properties: data: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterCreateData' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterCreateData" required: - - data + - data type: object ApplicationSecurityWafExclusionFilterID: description: The identifier of the WAF exclusion filter. - example: 3dd-0uc-h1s + example: "3dd-0uc-h1s" readOnly: true type: string ApplicationSecurityWafExclusionFilterMetadata: @@ -4530,29 +4395,27 @@ components: readOnly: true type: object ApplicationSecurityWafExclusionFilterOnMatch: - description: The action taken when the exclusion filter matches. When set to - `monitor`, security traces are emitted but the requests are not blocked. By - default, security traces are not emitted and the requests are not blocked. + description: The action taken when the exclusion filter matches. When set to `monitor`, security traces are emitted but the requests are not blocked. By default, security traces are not emitted and the requests are not blocked. enum: - - monitor + - monitor type: string x-enum-varnames: - - MONITOR + - MONITOR ApplicationSecurityWafExclusionFilterResource: description: A JSON:API resource for an WAF exclusion filter. properties: attributes: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterAttributes' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterAttributes" id: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterID' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterID" type: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterType' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterType" type: object ApplicationSecurityWafExclusionFilterResponse: description: Response object for a single WAF exclusion filter. properties: data: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResource' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterResource" type: object ApplicationSecurityWafExclusionFilterRulesTarget: description: Target WAF rules based either on an identifier or tags. @@ -4562,7 +4425,7 @@ components: example: dog-913-009 type: string tags: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTargetTags' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTargetTags" type: object ApplicationSecurityWafExclusionFilterRulesTargetTags: additionalProperties: @@ -4594,75 +4457,71 @@ components: default: exclusion_filter description: Type of the resource. The value should always be `exclusion_filter`. enum: - - exclusion_filter + - exclusion_filter example: exclusion_filter type: string - x-enum-varnames: - - EXCLUSION_FILTER + x-enum-varnames: ["EXCLUSION_FILTER"] ApplicationSecurityWafExclusionFilterUpdateAttributes: description: Attributes for updating a WAF exclusion filter. properties: description: description: A description for the exclusion filter. - example: Exclude false positives on a path + example: "Exclude false positives on a path" type: string enabled: description: Indicates whether the exclusion filter is enabled. example: true type: boolean ip_list: - description: The client IP addresses matched by the exclusion filter (CIDR - notation is supported). + description: The client IP addresses matched by the exclusion filter (CIDR notation is supported). items: - example: 198.51.100.72 + example: "198.51.100.72" type: string type: array on_match: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterOnMatch' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterOnMatch" parameters: - description: A list of parameters matched by the exclusion filter in the - HTTP query string and HTTP request body. Nested parameters can be matched - by joining fields with a dot character. + description: A list of parameters matched by the exclusion filter in the HTTP query string and HTTP request body. Nested parameters can be matched by joining fields with a dot character. items: - example: list.search.query + example: "list.search.query" type: string type: array path_glob: description: The HTTP path glob expression matched by the exclusion filter. - example: /accounts/* + example: "/accounts/*" type: string rules_target: description: The WAF rules targeted by the exclusion filter. items: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTarget' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTarget" type: array scope: description: The services where the exclusion filter is deployed. items: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterScope' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterScope" type: array required: - - description - - enabled + - description + - enabled type: object ApplicationSecurityWafExclusionFilterUpdateData: description: Object for updating a single WAF exclusion filter. properties: attributes: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateAttributes' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateAttributes" type: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterType' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterType" required: - - attributes - - type + - attributes + - type type: object ApplicationSecurityWafExclusionFilterUpdateRequest: description: Request object for updating a single WAF exclusion filter. properties: data: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateData' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateData" required: - - data + - data type: object ApplicationSecurityWafExclusionFiltersResponse: description: Response object for multiple WAF exclusion filters. @@ -4670,88 +4529,88 @@ components: data: description: A list of WAF exclusion filters. items: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResource' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterResource" type: array type: object AppsSortField: - description: The field and direction to sort apps by - enum: - - name - - created_at - - updated_at - - user_name - - -name - - -created_at - - -updated_at - - -user_name + description: "The field and direction to sort apps by" + enum: + - name + - created_at + - updated_at + - user_name + - -name + - -created_at + - -updated_at + - -user_name example: -created_at type: string x-enum-varnames: - - NAME - - CREATED_AT - - UPDATED_AT - - USER_NAME - - NAME_DESC - - CREATED_AT_DESC - - UPDATED_AT_DESC - - USER_NAME_DESC + - NAME + - CREATED_AT + - UPDATED_AT + - USER_NAME + - NAME_DESC + - CREATED_AT_DESC + - UPDATED_AT_DESC + - USER_NAME_DESC ArbitraryCostUpsertRequest: description: The definition of `ArbitraryCostUpsertRequest` object. example: data: attributes: costs_to_allocate: - - condition: is - tag: account_id - value: '123456789' - values: null - - condition: in - tag: environment - value: '' - values: - - production - - staging + - condition: is + tag: account_id + value: "123456789" + values: + - condition: in + tag: environment + value: "" + values: + - production + - staging enabled: true order_id: 1 provider: - - aws - - gcp + - aws + - gcp rule_name: example-arbitrary-cost-rule strategy: allocated_by_tag_keys: - - team - - environment + - team + - environment based_on_costs: - - condition: is - tag: service - value: web-api - values: null - - condition: not in - tag: team - value: '' - values: - - legacy - - deprecated + - condition: is + tag: service + value: web-api + values: + - condition: not in + tag: team + value: "" + values: + - legacy + - deprecated granularity: daily method: proportional type: shared type: upsert_arbitrary_rule properties: data: - $ref: '#/components/schemas/ArbitraryCostUpsertRequestData' + $ref: "#/components/schemas/ArbitraryCostUpsertRequestData" type: object ArbitraryCostUpsertRequestData: description: The definition of `ArbitraryCostUpsertRequestData` object. properties: attributes: - $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataAttributes' + $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataAttributes" id: description: The `ArbitraryCostUpsertRequestData` `id`. type: string type: - $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataType' + $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataType" required: - - type + - type type: object ArbitraryCostUpsertRequestDataAttributes: description: The definition of `ArbitraryCostUpsertRequestDataAttributes` object. @@ -4759,7 +4618,7 @@ components: costs_to_allocate: description: The `attributes` `costs_to_allocate`. items: - $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataAttributesCostsToAllocateItems' + $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataAttributesCostsToAllocateItems" type: array enabled: description: The `attributes` `enabled`. @@ -4771,7 +4630,7 @@ components: provider: description: The `attributes` `provider`. example: - - '' + - "" items: type: string type: array @@ -4780,32 +4639,31 @@ components: type: boolean rule_name: description: The `attributes` `rule_name`. - example: '' + example: "" type: string strategy: - $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategy' + $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategy" type: description: The `attributes` `type`. - example: '' + example: "" type: string required: - - costs_to_allocate - - provider - - rule_name - - strategy - - type + - costs_to_allocate + - provider + - rule_name + - strategy + - type type: object ArbitraryCostUpsertRequestDataAttributesCostsToAllocateItems: - description: The definition of `ArbitraryCostUpsertRequestDataAttributesCostsToAllocateItems` - object. + description: The definition of `ArbitraryCostUpsertRequestDataAttributesCostsToAllocateItems` object. properties: condition: description: The `items` `condition`. - example: '' + example: "" type: string tag: description: The `items` `tag`. - example: '' + example: "" type: string value: description: The `items` `value`. @@ -4817,22 +4675,21 @@ components: nullable: true type: array required: - - condition - - tag + - condition + - tag type: object ArbitraryCostUpsertRequestDataAttributesStrategy: - description: The definition of `ArbitraryCostUpsertRequestDataAttributesStrategy` - object. + description: The definition of `ArbitraryCostUpsertRequestDataAttributesStrategy` object. properties: allocated_by: description: The `strategy` `allocated_by`. items: - $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItems' + $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItems" type: array allocated_by_filters: description: The `strategy` `allocated_by_filters`. items: - $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByFiltersItems' + $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByFiltersItems" type: array allocated_by_tag_keys: description: The `strategy` `allocated_by_tag_keys`. @@ -4842,7 +4699,7 @@ components: based_on_costs: description: The `strategy` `based_on_costs`. items: - $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyBasedOnCostsItems' + $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyBasedOnCostsItems" type: array based_on_timeseries: additionalProperties: {} @@ -4851,7 +4708,7 @@ components: evaluate_grouped_by_filters: description: The `strategy` `evaluate_grouped_by_filters`. items: - $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyEvaluateGroupedByFiltersItems' + $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyEvaluateGroupedByFiltersItems" type: array evaluate_grouped_by_tag_keys: description: The `strategy` `evaluate_grouped_by_tag_keys`. @@ -4863,22 +4720,21 @@ components: type: string method: description: The `strategy` `method`. - example: '' + example: "" type: string required: - - method + - method type: object ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByFiltersItems: - description: The definition of `ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByFiltersItems` - object. + description: The definition of `ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByFiltersItems` object. properties: condition: description: The `items` `condition`. - example: '' + example: "" type: string tag: description: The `items` `tag`. - example: '' + example: "" type: string value: description: The `items` `value`. @@ -4890,55 +4746,51 @@ components: nullable: true type: array required: - - condition - - tag + - condition + - tag type: object ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItems: - description: The definition of `ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItems` - object. + description: The definition of `ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItems` object. properties: allocated_tags: description: The `items` `allocated_tags`. items: - $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItemsAllocatedTagsItems' + $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItemsAllocatedTagsItems" type: array percentage: - description: The `items` `percentage`. The numeric value format should be - a 32bit float value. + description: The `items` `percentage`. The numeric value format should be a 32bit float value. example: 0.0 format: double type: number required: - - allocated_tags - - percentage + - allocated_tags + - percentage type: object ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItemsAllocatedTagsItems: - description: The definition of `ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItemsAllocatedTagsItems` - object. + description: The definition of `ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItemsAllocatedTagsItems` object. properties: key: description: The `items` `key`. - example: '' + example: "" type: string value: description: The `items` `value`. - example: '' + example: "" type: string required: - - key - - value + - key + - value type: object ArbitraryCostUpsertRequestDataAttributesStrategyBasedOnCostsItems: - description: The definition of `ArbitraryCostUpsertRequestDataAttributesStrategyBasedOnCostsItems` - object. + description: The definition of `ArbitraryCostUpsertRequestDataAttributesStrategyBasedOnCostsItems` object. properties: condition: description: The `items` `condition`. - example: '' + example: "" type: string tag: description: The `items` `tag`. - example: '' + example: "" type: string value: description: The `items` `value`. @@ -4950,20 +4802,19 @@ components: nullable: true type: array required: - - condition - - tag + - condition + - tag type: object ArbitraryCostUpsertRequestDataAttributesStrategyEvaluateGroupedByFiltersItems: - description: The definition of `ArbitraryCostUpsertRequestDataAttributesStrategyEvaluateGroupedByFiltersItems` - object. + description: The definition of `ArbitraryCostUpsertRequestDataAttributesStrategyEvaluateGroupedByFiltersItems` object. properties: condition: description: The `items` `condition`. - example: '' + example: "" type: string tag: description: The `items` `tag`. - example: '' + example: "" type: string value: description: The `items` `value`. @@ -4975,200 +4826,200 @@ components: nullable: true type: array required: - - condition - - tag + - condition + - tag type: object ArbitraryCostUpsertRequestDataType: default: upsert_arbitrary_rule description: Upsert arbitrary rule resource type. enum: - - upsert_arbitrary_rule + - upsert_arbitrary_rule example: upsert_arbitrary_rule type: string x-enum-varnames: - - UPSERT_ARBITRARY_RULE + - UPSERT_ARBITRARY_RULE ArbitraryRuleResponse: description: The definition of `ArbitraryRuleResponse` object. example: data: attributes: costs_to_allocate: - - condition: is - tag: account_id - value: '123456789' - values: null - - condition: in - tag: environment - value: '' - values: - - production - - staging - created: '2023-01-01T12:00:00Z' + - condition: is + tag: account_id + value: "123456789" + values: + - condition: in + tag: environment + value: "" + values: + - production + - staging + created: "2023-01-01T12:00:00Z" enabled: true last_modified_user_uuid: user-123-uuid order_id: 1 provider: - - aws - - gcp + - aws + - gcp rule_name: Example custom allocation rule strategy: allocated_by_tag_keys: - - team - - environment + - team + - environment based_on_costs: - - condition: is - tag: service - value: web-api - values: null - - condition: not in - tag: team - value: '' - values: - - legacy - - deprecated + - condition: is + tag: service + value: web-api + values: + - condition: not in + tag: team + value: "" + values: + - legacy + - deprecated granularity: daily method: proportional type: shared - updated: '2023-01-01T12:00:00Z' + updated: "2023-01-01T12:00:00Z" version: 1 - id: '123' + id: "123" type: arbitrary_rule properties: data: - $ref: '#/components/schemas/ArbitraryRuleResponseData' + $ref: "#/components/schemas/ArbitraryRuleResponseData" type: object ArbitraryRuleResponseArray: description: The definition of `ArbitraryRuleResponseArray` object. example: data: - - attributes: - costs_to_allocate: - - condition: like - tag: service - value: orgstore-csm* - values: null - created: '2024-11-20T03:44:37Z' - enabled: true - last_modified_user_uuid: user-example-uuid - order_id: 1 - processing_status: done - provider: - - gcp - rule_name: gcp-orgstore-csm-team-allocation - strategy: - allocated_by: - - allocated_tags: - - key: team - value: csm-activation - percentage: 0.34 - - allocated_tags: - - key: team - value: csm-agentless - percentage: 0.66 - method: percent - type: shared - updated: '2025-09-02T21:28:32Z' - version: 1 - id: '19' - type: arbitrary_rule - - attributes: - costs_to_allocate: - - condition: is - tag: env - value: staging - values: null - created: '2025-05-27T18:48:05Z' - enabled: true - last_modified_user_uuid: user-example-uuid-2 - order_id: 2 - processing_status: done - provider: - - aws - rule_name: test-even-2 - strategy: - allocated_by_tag_keys: - - team - based_on_costs: - - condition: is - tag: aws_product - value: s3 - values: null - granularity: daily - method: even - type: shared - updated: '2025-09-03T21:00:49Z' - version: 1 - id: '311' - type: arbitrary_rule - - attributes: - costs_to_allocate: - - condition: is - tag: servicename - value: s3 - values: null - created: '2025-03-21T20:42:40Z' - enabled: false - last_modified_user_uuid: user-example-uuid-3 - order_id: 3 - processing_status: done - provider: - - aws - rule_name: test-s3-timeseries - strategy: - granularity: daily - method: proportional_timeseries - type: shared - updated: '2025-09-02T21:16:50Z' - version: 1 - id: '289' - type: arbitrary_rule - - attributes: - costs_to_allocate: - - condition: '=' - tag: aws_product - value: msk - values: null - - condition: is - tag: product - value: 'null' - values: null - created: '2025-08-27T14:39:31Z' - enabled: true - last_modified_user_uuid: user-example-uuid-4 - order_id: 4 - processing_status: done - provider: - - aws - rule_name: azure-unallocated-by-product-2 - strategy: - allocated_by_tag_keys: - - aws_product - based_on_costs: - - condition: '=' - tag: aws_product - value: msk - values: null - - condition: is not - tag: product - value: 'null' - values: null - granularity: daily - method: proportional - type: shared - updated: '2025-09-02T21:28:32Z' - version: 1 - id: '523' - type: arbitrary_rule + - attributes: + costs_to_allocate: + - condition: like + tag: service + value: orgstore-csm* + values: + created: "2024-11-20T03:44:37Z" + enabled: true + last_modified_user_uuid: user-example-uuid + order_id: 1 + processing_status: done + provider: + - gcp + rule_name: gcp-orgstore-csm-team-allocation + strategy: + allocated_by: + - allocated_tags: + - key: team + value: csm-activation + percentage: 0.34 + - allocated_tags: + - key: team + value: csm-agentless + percentage: 0.66 + method: percent + type: shared + updated: "2025-09-02T21:28:32Z" + version: 1 + id: "19" + type: arbitrary_rule + - attributes: + costs_to_allocate: + - condition: is + tag: env + value: staging + values: + created: "2025-05-27T18:48:05Z" + enabled: true + last_modified_user_uuid: user-example-uuid-2 + order_id: 2 + processing_status: done + provider: + - aws + rule_name: test-even-2 + strategy: + allocated_by_tag_keys: + - team + based_on_costs: + - condition: is + tag: aws_product + value: s3 + values: + granularity: daily + method: even + type: shared + updated: "2025-09-03T21:00:49Z" + version: 1 + id: "311" + type: arbitrary_rule + - attributes: + costs_to_allocate: + - condition: is + tag: servicename + value: s3 + values: + created: "2025-03-21T20:42:40Z" + enabled: false + last_modified_user_uuid: user-example-uuid-3 + order_id: 3 + processing_status: done + provider: + - aws + rule_name: test-s3-timeseries + strategy: + granularity: daily + method: proportional_timeseries + type: shared + updated: "2025-09-02T21:16:50Z" + version: 1 + id: "289" + type: arbitrary_rule + - attributes: + costs_to_allocate: + - condition: "=" + tag: aws_product + value: msk + values: + - condition: is + tag: product + value: "null" + values: + created: "2025-08-27T14:39:31Z" + enabled: true + last_modified_user_uuid: user-example-uuid-4 + order_id: 4 + processing_status: done + provider: + - aws + rule_name: azure-unallocated-by-product-2 + strategy: + allocated_by_tag_keys: + - aws_product + based_on_costs: + - condition: "=" + tag: aws_product + value: msk + values: + - condition: is not + tag: product + value: "null" + values: + granularity: daily + method: proportional + type: shared + updated: "2025-09-02T21:28:32Z" + version: 1 + id: "523" + type: arbitrary_rule properties: data: description: The `ArbitraryRuleResponseArray` `data`. items: - $ref: '#/components/schemas/ArbitraryRuleResponseData' + $ref: "#/components/schemas/ArbitraryRuleResponseData" type: array meta: - $ref: '#/components/schemas/ArbitraryRuleResponseArrayMeta' + $ref: "#/components/schemas/ArbitraryRuleResponseArrayMeta" required: - - data + - data type: object ArbitraryRuleResponseArrayMeta: description: The `ArbitraryRuleResponseArray` `meta`. @@ -5182,14 +5033,14 @@ components: description: The definition of `ArbitraryRuleResponseData` object. properties: attributes: - $ref: '#/components/schemas/ArbitraryRuleResponseDataAttributes' + $ref: "#/components/schemas/ArbitraryRuleResponseDataAttributes" id: description: The `ArbitraryRuleResponseData` `id`. type: string type: - $ref: '#/components/schemas/ArbitraryRuleResponseDataType' + $ref: "#/components/schemas/ArbitraryRuleResponseDataType" required: - - type + - type type: object ArbitraryRuleResponseDataAttributes: description: The definition of `ArbitraryRuleResponseDataAttributes` object. @@ -5197,11 +5048,11 @@ components: costs_to_allocate: description: The `attributes` `costs_to_allocate`. items: - $ref: '#/components/schemas/ArbitraryRuleResponseDataAttributesCostsToAllocateItems' + $ref: "#/components/schemas/ArbitraryRuleResponseDataAttributesCostsToAllocateItems" type: array created: description: The `attributes` `created`. - example: '' + example: "" format: date-time type: string enabled: @@ -5210,7 +5061,7 @@ components: type: boolean last_modified_user_uuid: description: The `attributes` `last_modified_user_uuid`. - example: '' + example: "" type: string order_id: description: The `attributes` `order_id`. @@ -5219,12 +5070,12 @@ components: type: integer processing_status: description: The `attributes` `processing_status`. - example: '' + example: "" type: string provider: description: The `attributes` `provider`. example: - - '' + - "" items: type: string type: array @@ -5233,17 +5084,17 @@ components: type: boolean rule_name: description: The `attributes` `rule_name`. - example: '' + example: "" type: string strategy: - $ref: '#/components/schemas/ArbitraryRuleResponseDataAttributesStrategy' + $ref: "#/components/schemas/ArbitraryRuleResponseDataAttributesStrategy" type: description: The `attributes` `type`. - example: '' + example: "" type: string updated: description: The `attributes` `updated`. - example: '' + example: "" format: date-time type: string version: @@ -5253,29 +5104,28 @@ components: maximum: 2147483647 type: integer required: - - costs_to_allocate - - created - - enabled - - last_modified_user_uuid - - order_id - - provider - - rule_name - - strategy - - type - - updated - - version + - costs_to_allocate + - created + - enabled + - last_modified_user_uuid + - order_id + - provider + - rule_name + - strategy + - type + - updated + - version type: object ArbitraryRuleResponseDataAttributesCostsToAllocateItems: - description: The definition of `ArbitraryRuleResponseDataAttributesCostsToAllocateItems` - object. + description: The definition of `ArbitraryRuleResponseDataAttributesCostsToAllocateItems` object. properties: condition: description: The `items` `condition`. - example: '' + example: "" type: string tag: description: The `items` `tag`. - example: '' + example: "" type: string value: description: The `items` `value`. @@ -5287,22 +5137,21 @@ components: nullable: true type: array required: - - condition - - tag + - condition + - tag type: object ArbitraryRuleResponseDataAttributesStrategy: - description: The definition of `ArbitraryRuleResponseDataAttributesStrategy` - object. + description: The definition of `ArbitraryRuleResponseDataAttributesStrategy` object. properties: allocated_by: description: The `strategy` `allocated_by`. items: - $ref: '#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyAllocatedByItems' + $ref: "#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyAllocatedByItems" type: array allocated_by_filters: description: The `strategy` `allocated_by_filters`. items: - $ref: '#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyAllocatedByFiltersItems' + $ref: "#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyAllocatedByFiltersItems" type: array allocated_by_tag_keys: description: The `strategy` `allocated_by_tag_keys`. @@ -5312,7 +5161,7 @@ components: based_on_costs: description: The `strategy` `based_on_costs`. items: - $ref: '#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyBasedOnCostsItems' + $ref: "#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyBasedOnCostsItems" type: array based_on_timeseries: additionalProperties: {} @@ -5321,7 +5170,7 @@ components: evaluate_grouped_by_filters: description: The `strategy` `evaluate_grouped_by_filters`. items: - $ref: '#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyEvaluateGroupedByFiltersItems' + $ref: "#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyEvaluateGroupedByFiltersItems" type: array evaluate_grouped_by_tag_keys: description: The `strategy` `evaluate_grouped_by_tag_keys`. @@ -5333,22 +5182,21 @@ components: type: string method: description: The `strategy` `method`. - example: '' + example: "" type: string required: - - method + - method type: object ArbitraryRuleResponseDataAttributesStrategyAllocatedByFiltersItems: - description: The definition of `ArbitraryRuleResponseDataAttributesStrategyAllocatedByFiltersItems` - object. + description: The definition of `ArbitraryRuleResponseDataAttributesStrategyAllocatedByFiltersItems` object. properties: condition: description: The `items` `condition`. - example: '' + example: "" type: string tag: description: The `items` `tag`. - example: '' + example: "" type: string value: description: The `items` `value`. @@ -5360,55 +5208,51 @@ components: nullable: true type: array required: - - condition - - tag + - condition + - tag type: object ArbitraryRuleResponseDataAttributesStrategyAllocatedByItems: - description: The definition of `ArbitraryRuleResponseDataAttributesStrategyAllocatedByItems` - object. + description: The definition of `ArbitraryRuleResponseDataAttributesStrategyAllocatedByItems` object. properties: allocated_tags: description: The `items` `allocated_tags`. items: - $ref: '#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyAllocatedByItemsAllocatedTagsItems' + $ref: "#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyAllocatedByItemsAllocatedTagsItems" type: array percentage: - description: The `items` `percentage`. The numeric value format should be - a 32bit float value. + description: The `items` `percentage`. The numeric value format should be a 32bit float value. example: 0.0 format: double type: number required: - - allocated_tags - - percentage + - allocated_tags + - percentage type: object ArbitraryRuleResponseDataAttributesStrategyAllocatedByItemsAllocatedTagsItems: - description: The definition of `ArbitraryRuleResponseDataAttributesStrategyAllocatedByItemsAllocatedTagsItems` - object. + description: The definition of `ArbitraryRuleResponseDataAttributesStrategyAllocatedByItemsAllocatedTagsItems` object. properties: key: description: The `items` `key`. - example: '' + example: "" type: string value: description: The `items` `value`. - example: '' + example: "" type: string required: - - key - - value + - key + - value type: object ArbitraryRuleResponseDataAttributesStrategyBasedOnCostsItems: - description: The definition of `ArbitraryRuleResponseDataAttributesStrategyBasedOnCostsItems` - object. + description: The definition of `ArbitraryRuleResponseDataAttributesStrategyBasedOnCostsItems` object. properties: condition: description: The `items` `condition`. - example: '' + example: "" type: string tag: description: The `items` `tag`. - example: '' + example: "" type: string value: description: The `items` `value`. @@ -5420,20 +5264,19 @@ components: nullable: true type: array required: - - condition - - tag + - condition + - tag type: object ArbitraryRuleResponseDataAttributesStrategyEvaluateGroupedByFiltersItems: - description: The definition of `ArbitraryRuleResponseDataAttributesStrategyEvaluateGroupedByFiltersItems` - object. + description: The definition of `ArbitraryRuleResponseDataAttributesStrategyEvaluateGroupedByFiltersItems` object. properties: condition: description: The `items` `condition`. - example: '' + example: "" type: string tag: description: The `items` `tag`. - example: '' + example: "" type: string value: description: The `items` `value`. @@ -5445,18 +5288,18 @@ components: nullable: true type: array required: - - condition - - tag + - condition + - tag type: object ArbitraryRuleResponseDataType: default: arbitrary_rule description: Arbitrary rule resource type. enum: - - arbitrary_rule + - arbitrary_rule example: arbitrary_rule type: string x-enum-varnames: - - ARBITRARY_RULE + - ARBITRARY_RULE Argument: properties: description: @@ -5468,30 +5311,30 @@ components: example: YXJndW1lbnRfbmFtZQ== type: string required: - - name - - description + - name + - description type: object AsanaAccessToken: description: The definition of the `AsanaAccessToken` object. properties: access_token: description: The `AsanaAccessToken` `access_token`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/AsanaAccessTokenType' + $ref: "#/components/schemas/AsanaAccessTokenType" required: - - type - - access_token + - type + - access_token type: object AsanaAccessTokenType: description: The definition of the `AsanaAccessToken` object. enum: - - AsanaAccessToken + - AsanaAccessToken example: AsanaAccessToken type: string x-enum-varnames: - - ASANAACCESSTOKEN + - ASANAACCESSTOKEN AsanaAccessTokenUpdate: description: The definition of the `AsanaAccessToken` object. properties: @@ -5499,62 +5342,62 @@ components: description: The `AsanaAccessTokenUpdate` `access_token`. type: string type: - $ref: '#/components/schemas/AsanaAccessTokenType' + $ref: "#/components/schemas/AsanaAccessTokenType" required: - - type + - type type: object AsanaCredentials: description: The definition of the `AsanaCredentials` object. oneOf: - - $ref: '#/components/schemas/AsanaAccessToken' + - $ref: "#/components/schemas/AsanaAccessToken" AsanaCredentialsUpdate: description: The definition of the `AsanaCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/AsanaAccessTokenUpdate' + - $ref: "#/components/schemas/AsanaAccessTokenUpdate" AsanaIntegration: description: The definition of the `AsanaIntegration` object. properties: credentials: - $ref: '#/components/schemas/AsanaCredentials' + $ref: "#/components/schemas/AsanaCredentials" type: - $ref: '#/components/schemas/AsanaIntegrationType' + $ref: "#/components/schemas/AsanaIntegrationType" required: - - type - - credentials + - type + - credentials type: object AsanaIntegrationType: description: The definition of the `AsanaIntegrationType` object. enum: - - Asana + - Asana example: Asana type: string x-enum-varnames: - - ASANA + - ASANA AsanaIntegrationUpdate: description: The definition of the `AsanaIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/AsanaCredentialsUpdate' + $ref: "#/components/schemas/AsanaCredentialsUpdate" type: - $ref: '#/components/schemas/AsanaIntegrationType' + $ref: "#/components/schemas/AsanaIntegrationType" required: - - type + - type type: object Asset: description: A single vulnerable asset properties: attributes: - $ref: '#/components/schemas/AssetAttributes' + $ref: "#/components/schemas/AssetAttributes" id: description: The unique ID for this asset. example: Repository|github.com/DataDog/datadog-agent.git type: string type: - $ref: '#/components/schemas/AssetEntityType' + $ref: "#/components/schemas/AssetEntityType" required: - - id - - type - - attributes + - id + - type + - attributes type: object AssetAttributes: description: The JSON:API attributes of the asset. @@ -5566,7 +5409,7 @@ components: environments: description: List of environments where the asset is deployed. example: - - staging + - staging items: example: staging type: string @@ -5576,48 +5419,48 @@ components: example: github.com/DataDog/datadog-agent.git type: string operating_system: - $ref: '#/components/schemas/AssetOperatingSystem' + $ref: "#/components/schemas/AssetOperatingSystem" risks: - $ref: '#/components/schemas/AssetRisks' + $ref: "#/components/schemas/AssetRisks" teams: description: List of teams that own the asset. example: - - compute + - compute items: example: compute type: string type: array type: - $ref: '#/components/schemas/AssetType' + $ref: "#/components/schemas/AssetType" version: - $ref: '#/components/schemas/AssetVersion' + $ref: "#/components/schemas/AssetVersion" required: - - name - - type - - risks - - environments + - name + - type + - risks + - environments type: object AssetEntityType: description: The JSON:API type. enum: - - assets + - assets example: assets type: string x-enum-varnames: - - ASSETS + - ASSETS AssetOperatingSystem: description: Asset operating system. properties: description: description: Operating system version. - example: '24.04' + example: "24.04" type: string name: description: Operating system name. example: ubuntu type: string required: - - name + - name type: object AssetRisks: description: Asset risks. @@ -5643,24 +5486,24 @@ components: example: false type: boolean required: - - in_production + - in_production type: object AssetType: description: The asset type enum: - - Repository - - Service - - Host - - HostImage - - Image + - Repository + - Service + - Host + - HostImage + - Image example: Repository type: string x-enum-varnames: - - REPOSITORY - - SERVICE - - HOST - - HOSTIMAGE - - IMAGE + - REPOSITORY + - SERVICE + - HOST + - HOSTIMAGE + - IMAGE AssetVersion: description: Asset version. properties: @@ -5676,57 +5519,57 @@ components: AssignSeatsUserRequest: properties: data: - $ref: '#/components/schemas/AssignSeatsUserRequestData' + $ref: "#/components/schemas/AssignSeatsUserRequestData" description: The data for the assign seats user request. type: object AssignSeatsUserRequestData: properties: attributes: - $ref: '#/components/schemas/AssignSeatsUserRequestDataAttributes' + $ref: "#/components/schemas/AssignSeatsUserRequestDataAttributes" description: The attributes of the assign seats user request. id: description: The ID of the assign seats user request. type: string type: - $ref: '#/components/schemas/SeatAssignmentsDataType' + $ref: "#/components/schemas/SeatAssignmentsDataType" description: The type of the assign seats user request. required: - - type - - attributes + - type + - attributes type: object AssignSeatsUserRequestDataAttributes: properties: product_code: description: The product code for which to assign seats. - example: '' + example: "" type: string user_uuids: description: The list of user IDs to assign seats to. example: - - '' + - "" items: type: string type: array required: - - product_code - - user_uuids + - product_code + - user_uuids type: object AssignSeatsUserResponse: properties: data: - $ref: '#/components/schemas/AssignSeatsUserResponseData' + $ref: "#/components/schemas/AssignSeatsUserResponseData" description: The data for the assign seats user response. type: object AssignSeatsUserResponseData: properties: attributes: - $ref: '#/components/schemas/AssignSeatsUserResponseDataAttributes' + $ref: "#/components/schemas/AssignSeatsUserResponseDataAttributes" description: The attributes of the assign seats user response. id: description: The ID of the assign seats user response. type: string type: - $ref: '#/components/schemas/SeatAssignmentsDataType' + $ref: "#/components/schemas/SeatAssignmentsDataType" type: object AssignSeatsUserResponseDataAttributes: properties: @@ -5743,84 +5586,81 @@ components: description: Request for attaching security findings to a case. properties: data: - $ref: '#/components/schemas/AttachCaseRequestData' + $ref: "#/components/schemas/AttachCaseRequestData" type: object AttachCaseRequestData: description: Data of the case to attach security findings to. properties: id: description: Unique identifier of the case. - example: c1234567-89ab-cdef-0123-456789abcdef + example: "c1234567-89ab-cdef-0123-456789abcdef" type: string relationships: - $ref: '#/components/schemas/AttachCaseRequestDataRelationships' + $ref: "#/components/schemas/AttachCaseRequestDataRelationships" type: - $ref: '#/components/schemas/CaseDataType' + $ref: "#/components/schemas/CaseDataType" required: - - type - - id + - type + - id type: object AttachCaseRequestDataRelationships: description: Relationships of the case to attach security findings to. properties: findings: - $ref: '#/components/schemas/Findings' + $ref: "#/components/schemas/Findings" description: Security findings to attach to the case. required: - - findings + - findings type: object AttachJiraIssueRequest: description: Request for attaching security findings to a Jira issue. properties: data: - $ref: '#/components/schemas/AttachJiraIssueRequestData' + $ref: "#/components/schemas/AttachJiraIssueRequestData" type: object AttachJiraIssueRequestData: description: Data of the Jira issue to attach security findings to. properties: attributes: - $ref: '#/components/schemas/AttachJiraIssueRequestDataAttributes' + $ref: "#/components/schemas/AttachJiraIssueRequestDataAttributes" relationships: - $ref: '#/components/schemas/AttachJiraIssueRequestDataRelationships' + $ref: "#/components/schemas/AttachJiraIssueRequestDataRelationships" type: - $ref: '#/components/schemas/JiraIssuesDataType' + $ref: "#/components/schemas/JiraIssuesDataType" required: - - type + - type type: object AttachJiraIssueRequestDataAttributes: description: Attributes of the Jira issue to attach security findings to. properties: jira_issue_url: description: URL of the Jira issue to attach security findings to. - example: https://domain.atlassian.net/browse/PROJ-123 + example: "https://domain.atlassian.net/browse/PROJ-123" type: string required: - - jira_issue_url + - jira_issue_url type: object AttachJiraIssueRequestDataRelationships: description: Relationships of the Jira issue to attach security findings to. properties: findings: - $ref: '#/components/schemas/Findings' + $ref: "#/components/schemas/Findings" description: Security findings to attach to the Jira issue. project: - $ref: '#/components/schemas/CaseManagementProject' - description: Case management project with Jira integration configured. It - is used to attach security findings to the Jira issue. To configure the - integration, see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira). + $ref: "#/components/schemas/CaseManagementProject" + description: Case management project with Jira integration configured. It is used to attach security findings to the Jira issue. To configure the integration, see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira). required: - - findings - - project + - findings + - project type: object Attachment: - description: An attachment response containing the attachment data and related - objects. + description: An attachment response containing the attachment data and related objects. properties: data: - $ref: '#/components/schemas/AttachmentData' + $ref: "#/components/schemas/AttachmentData" included: items: - $ref: '#/components/schemas/AttachmentIncluded' + $ref: "#/components/schemas/AttachmentIncluded" type: array type: object AttachmentArray: @@ -5828,44 +5668,44 @@ components: properties: data: items: - $ref: '#/components/schemas/AttachmentData' + $ref: "#/components/schemas/AttachmentData" type: array included: items: - $ref: '#/components/schemas/AttachmentIncluded' + $ref: "#/components/schemas/AttachmentIncluded" type: array required: - - data + - data type: object AttachmentData: description: Attachment data from a response. properties: attributes: - $ref: '#/components/schemas/AttachmentDataAttributes' + $ref: "#/components/schemas/AttachmentDataAttributes" id: description: The unique identifier of the attachment. - example: 00000000-abcd-0002-0000-000000000000 + example: "00000000-abcd-0002-0000-000000000000" type: string relationships: - $ref: '#/components/schemas/AttachmentDataRelationships' + $ref: "#/components/schemas/AttachmentDataRelationships" type: - $ref: '#/components/schemas/IncidentAttachmentType' + $ref: "#/components/schemas/IncidentAttachmentType" required: - - type - - attributes - - relationships - - id + - type + - attributes + - relationships + - id type: object AttachmentDataAttributes: description: The attachment's attributes. properties: attachment: - $ref: '#/components/schemas/AttachmentDataAttributesAttachment' + $ref: "#/components/schemas/AttachmentDataAttributesAttachment" attachment_type: - $ref: '#/components/schemas/AttachmentDataAttributesAttachmentType' + $ref: "#/components/schemas/AttachmentDataAttributesAttachmentType" modified: description: Timestamp when the attachment was last modified. - example: '2025-01-01T01:01:01.000000001Z' + example: "2025-01-01T01:01:01.000000001Z" format: date-time type: string type: object @@ -5874,82 +5714,73 @@ components: properties: documentUrl: description: The URL of the attachment. - example: https://app.datadoghq.com/notebook/123/Postmortem-IR-123 + example: "https://app.datadoghq.com/notebook/123/Postmortem-IR-123" type: string title: description: The title of the attachment. - example: Postmortem IR-123 + example: "Postmortem IR-123" type: string type: object AttachmentDataAttributesAttachmentType: description: The type of the attachment. - enum: - - postmortem - - link - example: postmortem + enum: ["postmortem", "link"] + example: "postmortem" type: string x-enum-varnames: - - POSTMORTEM - - LINK + - POSTMORTEM + - LINK AttachmentDataRelationships: description: The attachment's resource relationships. properties: incident: - $ref: '#/components/schemas/RelationshipToIncident' + $ref: "#/components/schemas/RelationshipToIncident" last_modified_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" type: object AttachmentIncluded: description: Objects related to an attachment. oneOf: - - $ref: '#/components/schemas/IncidentUserData' + - $ref: "#/components/schemas/IncidentUserData" AuditLogsEvent: - description: Object description of an Audit Logs event after it is processed - and stored by Datadog. + description: Object description of an Audit Logs event after it is processed and stored by Datadog. properties: attributes: - $ref: '#/components/schemas/AuditLogsEventAttributes' + $ref: "#/components/schemas/AuditLogsEventAttributes" id: description: Unique ID of the event. - example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA" type: string type: - $ref: '#/components/schemas/AuditLogsEventType' + $ref: "#/components/schemas/AuditLogsEventType" type: object AuditLogsEventAttributes: - description: JSON object containing all event attributes and their associated - values. + description: JSON object containing all event attributes and their associated values. properties: attributes: additionalProperties: {} description: JSON object of attributes from Audit Logs events. - example: - customAttribute: 123 - duration: 2345 + example: {"customAttribute": 123, "duration": 2345} type: object message: description: Message of the event. type: string service: - description: 'Name of the application or service generating Audit Logs events. - - This name is used to correlate Audit Logs to APM, so make sure you specify - the same - - value when you use both products.' - example: web-app + description: |- + Name of the application or service generating Audit Logs events. + This name is used to correlate Audit Logs to APM, so make sure you specify the same + value when you use both products. + example: "web-app" type: string tags: description: Array of tags associated with your event. - example: - - team:A + example: ["team:A"] items: description: Tag associated with your event. type: string type: array timestamp: description: Timestamp of your event. - example: '2019-01-02T09:42:36.320Z' + example: "2019-01-02T09:42:36.320Z" format: date-time type: string type: object @@ -5957,70 +5788,66 @@ components: default: audit description: Type of the event. enum: - - audit - example: audit + - audit + example: "audit" type: string x-enum-varnames: - - Audit + - Audit AuditLogsEventsResponse: - description: Response object with all events matching the request and pagination - information. + description: Response object with all events matching the request and pagination information. properties: data: description: Array of events matching the request. items: - $ref: '#/components/schemas/AuditLogsEvent' + $ref: "#/components/schemas/AuditLogsEvent" type: array links: - $ref: '#/components/schemas/AuditLogsResponseLinks' + $ref: "#/components/schemas/AuditLogsResponseLinks" meta: - $ref: '#/components/schemas/AuditLogsResponseMetadata' + $ref: "#/components/schemas/AuditLogsResponseMetadata" type: object AuditLogsQueryFilter: description: Search and filter query settings. properties: from: - default: now-15m - description: Minimum time for the requested events. Supports date, math, - and regular timestamps (in milliseconds). - example: now-15m + default: "now-15m" + description: Minimum time for the requested events. Supports date, math, and regular timestamps (in milliseconds). + example: "now-15m" type: string query: - default: '*' + default: "*" description: Search query following the Audit Logs search syntax. - example: '@type:session AND @session.type:user' + example: "@type:session AND @session.type:user" type: string to: - default: now - description: Maximum time for the requested events. Supports date, math, - and regular timestamps (in milliseconds). - example: now + default: "now" + description: Maximum time for the requested events. Supports date, math, and regular timestamps (in milliseconds). + example: "now" type: string type: object AuditLogsQueryOptions: - description: 'Global query options that are used during the query. - - Note: Specify either timezone or time offset, not both. Otherwise, the query - fails.' + description: |- + Global query options that are used during the query. + Note: Specify either timezone or time offset, not both. Otherwise, the query fails. properties: time_offset: description: Time offset (in seconds) to apply to the query. format: int64 type: integer timezone: - default: UTC - description: The timezone can be specified as GMT, UTC, an offset from UTC - (like UTC+1), or as a Timezone Database identifier (like America/New_York). - example: GMT + default: "UTC" + description: |- + The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York). + example: "GMT" type: string type: object AuditLogsQueryPageOptions: description: Paging attributes for listing events. properties: cursor: - description: List following results with a cursor provided in the previous - query. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + List following results with a cursor provided in the previous query. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string limit: default: 10 @@ -6034,11 +5861,10 @@ components: description: Links attributes. properties: next: - description: 'Link for the next set of results. Note that the request can - also be made using the - - POST endpoint.' - example: https://app.datadoghq.com/api/v2/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + Link for the next set of results. Note that the request can also be made using the + POST endpoint. + example: "https://app.datadoghq.com/api/v2/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string type: object AuditLogsResponseMetadata: @@ -6050,107 +5876,99 @@ components: format: int64 type: integer page: - $ref: '#/components/schemas/AuditLogsResponsePage' + $ref: "#/components/schemas/AuditLogsResponsePage" request_id: description: The identifier of the request. - example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR + example: "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR" type: string status: - $ref: '#/components/schemas/AuditLogsResponseStatus' + $ref: "#/components/schemas/AuditLogsResponseStatus" warnings: - description: 'A list of warnings (non-fatal errors) encountered. Partial - results may return if - - warnings are present in the response.' + description: |- + A list of warnings (non-fatal errors) encountered. Partial results may return if + warnings are present in the response. items: - $ref: '#/components/schemas/AuditLogsWarning' + $ref: "#/components/schemas/AuditLogsWarning" type: array type: object AuditLogsResponsePage: description: Paging attributes. properties: after: - description: The cursor to use to get the next results, if any. To make - the next request, use the same parameters with the addition of `page[cursor]`. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string type: object AuditLogsResponseStatus: description: The status of the response. - enum: - - done - - timeout - example: done + enum: ["done", "timeout"] + example: "done" type: string - x-enum-varnames: - - DONE - - TIMEOUT + x-enum-varnames: ["DONE", "TIMEOUT"] AuditLogsSearchEventsRequest: description: The request for a Audit Logs events list. properties: filter: - $ref: '#/components/schemas/AuditLogsQueryFilter' + $ref: "#/components/schemas/AuditLogsQueryFilter" options: - $ref: '#/components/schemas/AuditLogsQueryOptions' + $ref: "#/components/schemas/AuditLogsQueryOptions" page: - $ref: '#/components/schemas/AuditLogsQueryPageOptions' + $ref: "#/components/schemas/AuditLogsQueryPageOptions" sort: - $ref: '#/components/schemas/AuditLogsSort' + $ref: "#/components/schemas/AuditLogsSort" type: object AuditLogsSort: description: Sort parameters when querying events. enum: - - timestamp - - -timestamp + - timestamp + - -timestamp type: string x-enum-varnames: - - TIMESTAMP_ASCENDING - - TIMESTAMP_DESCENDING + - TIMESTAMP_ASCENDING + - TIMESTAMP_DESCENDING AuditLogsWarning: description: Warning message indicating something that went wrong with the query. properties: code: description: Unique code for this type of warning. - example: unknown_index + example: "unknown_index" type: string detail: description: Detailed explanation of this specific warning. - example: 'indexes: foo, bar' + example: "indexes: foo, bar" type: string title: description: Short human-readable summary of the warning. - example: One or several indexes are missing or invalid, results hold data - from the other indexes + example: "One or several indexes are missing or invalid, results hold data from the other indexes" type: string type: object AuthNMapping: description: The AuthN Mapping object returned by API. properties: attributes: - $ref: '#/components/schemas/AuthNMappingAttributes' + $ref: "#/components/schemas/AuthNMappingAttributes" id: description: ID of the AuthN Mapping. - example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + example: "3653d3c6-0c75-11ea-ad28-fb5701eabc7d" type: string relationships: - $ref: '#/components/schemas/AuthNMappingRelationships' + $ref: "#/components/schemas/AuthNMappingRelationships" type: - $ref: '#/components/schemas/AuthNMappingsType' + $ref: "#/components/schemas/AuthNMappingsType" required: - - id - - type + - id + - type type: object AuthNMappingAttributes: description: Attributes of AuthN Mapping. properties: attribute_key: - description: Key portion of a key/value pair of the attribute sent from - the Identity Provider. + description: Key portion of a key/value pair of the attribute sent from the Identity Provider. example: member-of type: string attribute_value: - description: Value portion of a key/value pair of the attribute sent from - the Identity Provider. + description: Value portion of a key/value pair of the attribute sent from the Identity Provider. example: Development type: string created_at: @@ -6165,20 +5983,18 @@ components: type: string saml_assertion_attribute_id: description: The ID of the SAML assertion attribute. - example: '0' + example: "0" type: string type: object AuthNMappingCreateAttributes: description: Key/Value pair of attributes used for create request. properties: attribute_key: - description: Key portion of a key/value pair of the attribute sent from - the Identity Provider. + description: Key portion of a key/value pair of the attribute sent from the Identity Provider. example: member-of type: string attribute_value: - description: Value portion of a key/value pair of the attribute sent from - the Identity Provider. + description: Value portion of a key/value pair of the attribute sent from the Identity Provider. example: Development type: string type: object @@ -6186,98 +6002,97 @@ components: description: Data for creating an AuthN Mapping. properties: attributes: - $ref: '#/components/schemas/AuthNMappingCreateAttributes' + $ref: "#/components/schemas/AuthNMappingCreateAttributes" relationships: - $ref: '#/components/schemas/AuthNMappingCreateRelationships' + $ref: "#/components/schemas/AuthNMappingCreateRelationships" type: - $ref: '#/components/schemas/AuthNMappingsType' + $ref: "#/components/schemas/AuthNMappingsType" required: - - type + - type type: object AuthNMappingCreateRelationships: description: Relationship of AuthN Mapping create object to a Role or Team. oneOf: - - $ref: '#/components/schemas/AuthNMappingRelationshipToRole' - - $ref: '#/components/schemas/AuthNMappingRelationshipToTeam' + - $ref: "#/components/schemas/AuthNMappingRelationshipToRole" + - $ref: "#/components/schemas/AuthNMappingRelationshipToTeam" AuthNMappingCreateRequest: description: Request for creating an AuthN Mapping. properties: data: - $ref: '#/components/schemas/AuthNMappingCreateData' + $ref: "#/components/schemas/AuthNMappingCreateData" required: - - data + - data type: object AuthNMappingIncluded: description: Included data in the AuthN Mapping response. oneOf: - - $ref: '#/components/schemas/SAMLAssertionAttribute' - - $ref: '#/components/schemas/Role' - - $ref: '#/components/schemas/AuthNMappingTeam' + - $ref: "#/components/schemas/SAMLAssertionAttribute" + - $ref: "#/components/schemas/Role" + - $ref: "#/components/schemas/AuthNMappingTeam" AuthNMappingRelationshipToRole: description: Relationship of AuthN Mapping to a Role. properties: role: - $ref: '#/components/schemas/RelationshipToRole' + $ref: "#/components/schemas/RelationshipToRole" required: - - role + - role type: object AuthNMappingRelationshipToTeam: description: Relationship of AuthN Mapping to a Team. properties: team: - $ref: '#/components/schemas/RelationshipToTeam' + $ref: "#/components/schemas/RelationshipToTeam" required: - - team + - team type: object AuthNMappingRelationships: description: All relationships associated with AuthN Mapping. properties: role: - $ref: '#/components/schemas/RelationshipToRole' + $ref: "#/components/schemas/RelationshipToRole" saml_assertion_attribute: - $ref: '#/components/schemas/RelationshipToSAMLAssertionAttribute' + $ref: "#/components/schemas/RelationshipToSAMLAssertionAttribute" team: - $ref: '#/components/schemas/RelationshipToTeam' + $ref: "#/components/schemas/RelationshipToTeam" type: object AuthNMappingResourceType: description: The type of resource being mapped to. enum: - - role - - team + - role + - team type: string x-enum-varnames: - - ROLE - - TEAM + - ROLE + - TEAM AuthNMappingResponse: description: AuthN Mapping response from the API. properties: data: - $ref: '#/components/schemas/AuthNMapping' + $ref: "#/components/schemas/AuthNMapping" included: description: Included data in the AuthN Mapping response. items: - $ref: '#/components/schemas/AuthNMappingIncluded' + $ref: "#/components/schemas/AuthNMappingIncluded" type: array type: object AuthNMappingTeam: description: Team. properties: attributes: - $ref: '#/components/schemas/AuthNMappingTeamAttributes' + $ref: "#/components/schemas/AuthNMappingTeamAttributes" id: description: The ID of the Team. - example: f9bb8444-af7f-11ec-ac2c-da7ad0900001 + example: "f9bb8444-af7f-11ec-ac2c-da7ad0900001" type: string type: - $ref: '#/components/schemas/TeamType' + $ref: "#/components/schemas/TeamType" type: object AuthNMappingTeamAttributes: description: Team attributes. properties: avatar: - description: Unicode representation of the avatar for the team, limited - to a single grapheme - example: "\U0001F951" + description: Unicode representation of the avatar for the team, limited to a single grapheme + example: "🥑" nullable: true type: string banner: @@ -6317,13 +6132,11 @@ components: description: Key/Value pair of attributes used for update request. properties: attribute_key: - description: Key portion of a key/value pair of the attribute sent from - the Identity Provider. + description: Key portion of a key/value pair of the attribute sent from the Identity Provider. example: member-of type: string attribute_value: - description: Value portion of a key/value pair of the attribute sent from - the Identity Provider. + description: Value portion of a key/value pair of the attribute sent from the Identity Provider. example: Development type: string type: object @@ -6331,31 +6144,31 @@ components: description: Data for updating an AuthN Mapping. properties: attributes: - $ref: '#/components/schemas/AuthNMappingUpdateAttributes' + $ref: "#/components/schemas/AuthNMappingUpdateAttributes" id: description: ID of the AuthN Mapping. - example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + example: "3653d3c6-0c75-11ea-ad28-fb5701eabc7d" type: string relationships: - $ref: '#/components/schemas/AuthNMappingUpdateRelationships' + $ref: "#/components/schemas/AuthNMappingUpdateRelationships" type: - $ref: '#/components/schemas/AuthNMappingsType' + $ref: "#/components/schemas/AuthNMappingsType" required: - - id - - type + - id + - type type: object AuthNMappingUpdateRelationships: description: Relationship of AuthN Mapping update object to a Role or Team. oneOf: - - $ref: '#/components/schemas/AuthNMappingRelationshipToRole' - - $ref: '#/components/schemas/AuthNMappingRelationshipToTeam' + - $ref: "#/components/schemas/AuthNMappingRelationshipToRole" + - $ref: "#/components/schemas/AuthNMappingRelationshipToTeam" AuthNMappingUpdateRequest: description: Request to update an AuthN Mapping. properties: data: - $ref: '#/components/schemas/AuthNMappingUpdateData' + $ref: "#/components/schemas/AuthNMappingUpdateData" required: - - data + - data type: object AuthNMappingsResponse: description: Array of AuthN Mappings response. @@ -6363,54 +6176,54 @@ components: data: description: Array of returned AuthN Mappings. items: - $ref: '#/components/schemas/AuthNMapping' + $ref: "#/components/schemas/AuthNMapping" type: array included: description: Included data in the AuthN Mapping response. items: - $ref: '#/components/schemas/AuthNMappingIncluded' + $ref: "#/components/schemas/AuthNMappingIncluded" type: array meta: - $ref: '#/components/schemas/ResponseMetaAttributes' + $ref: "#/components/schemas/ResponseMetaAttributes" type: object AuthNMappingsSort: description: Sorting options for AuthN Mappings. enum: - - created_at - - -created_at - - role_id - - -role_id - - saml_assertion_attribute_id - - -saml_assertion_attribute_id - - role.name - - -role.name - - saml_assertion_attribute.attribute_key - - -saml_assertion_attribute.attribute_key - - saml_assertion_attribute.attribute_value - - -saml_assertion_attribute.attribute_value - type: string - x-enum-varnames: - - CREATED_AT_ASCENDING - - CREATED_AT_DESCENDING - - ROLE_ID_ASCENDING - - ROLE_ID_DESCENDING - - SAML_ASSERTION_ATTRIBUTE_ID_ASCENDING - - SAML_ASSERTION_ATTRIBUTE_ID_DESCENDING - - ROLE_NAME_ASCENDING - - ROLE_NAME_DESCENDING - - SAML_ASSERTION_ATTRIBUTE_KEY_ASCENDING - - SAML_ASSERTION_ATTRIBUTE_KEY_DESCENDING - - SAML_ASSERTION_ATTRIBUTE_VALUE_ASCENDING - - SAML_ASSERTION_ATTRIBUTE_VALUE_DESCENDING + - created_at + - -created_at + - role_id + - -role_id + - saml_assertion_attribute_id + - -saml_assertion_attribute_id + - role.name + - -role.name + - saml_assertion_attribute.attribute_key + - -saml_assertion_attribute.attribute_key + - saml_assertion_attribute.attribute_value + - -saml_assertion_attribute.attribute_value + type: string + x-enum-varnames: + - CREATED_AT_ASCENDING + - CREATED_AT_DESCENDING + - ROLE_ID_ASCENDING + - ROLE_ID_DESCENDING + - SAML_ASSERTION_ATTRIBUTE_ID_ASCENDING + - SAML_ASSERTION_ATTRIBUTE_ID_DESCENDING + - ROLE_NAME_ASCENDING + - ROLE_NAME_DESCENDING + - SAML_ASSERTION_ATTRIBUTE_KEY_ASCENDING + - SAML_ASSERTION_ATTRIBUTE_KEY_DESCENDING + - SAML_ASSERTION_ATTRIBUTE_VALUE_ASCENDING + - SAML_ASSERTION_ATTRIBUTE_VALUE_DESCENDING AuthNMappingsType: default: authn_mappings description: AuthN Mappings resource type. enum: - - authn_mappings + - authn_mappings example: authn_mappings type: string x-enum-varnames: - - AUTHN_MAPPINGS + - AUTHN_MAPPINGS AutoCloseInactiveCases: description: Auto-close inactive cases settings properties: @@ -6431,38 +6244,38 @@ components: type: object AwsAccountId: description: The ID of the AWS account. - example: '123456789012' + example: "123456789012" type: string AwsCURConfig: description: AWS CUR config. properties: attributes: - $ref: '#/components/schemas/AwsCURConfigAttributes' + $ref: "#/components/schemas/AwsCURConfigAttributes" id: description: The ID of the AWS CUR config. type: string type: - $ref: '#/components/schemas/AwsCURConfigType' + $ref: "#/components/schemas/AwsCURConfigType" required: - - attributes - - type + - attributes + - type type: object AwsCURConfigAttributes: description: Attributes for An AWS CUR config. properties: account_filters: - $ref: '#/components/schemas/AccountFilteringConfig' + $ref: "#/components/schemas/AccountFilteringConfig" account_id: description: The AWS account ID. - example: '123456789123' + example: "123456789123" type: string bucket_name: description: The AWS bucket name used to store the Cost and Usage Report. - example: dd-cost-bucket + example: "dd-cost-bucket" type: string bucket_region: description: The region the bucket is located in. - example: us-east-1 + example: "us-east-1" type: string created_at: description: The timestamp when the AWS CUR config was created. @@ -6482,15 +6295,15 @@ components: type: integer report_name: description: The name of the Cost and Usage Report. - example: dd-report-name + example: "dd-report-name" type: string report_prefix: description: The report prefix used for the Cost and Usage Report. - example: dd-report-prefix + example: "dd-report-prefix" type: string status: description: The status of the AWS CUR. - example: active + example: "active" type: string status_updated_at: description: The timestamp when the AWS CUR config status was updated. @@ -6501,37 +6314,37 @@ components: pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$ type: string required: - - account_id - - bucket_name - - bucket_region - - report_name - - report_prefix - - status + - account_id + - bucket_name + - bucket_region + - report_name + - report_prefix + - status type: object AwsCURConfigPatchData: description: AWS CUR config Patch data. properties: attributes: - $ref: '#/components/schemas/AwsCURConfigPatchRequestAttributes' + $ref: "#/components/schemas/AwsCURConfigPatchRequestAttributes" type: - $ref: '#/components/schemas/AwsCURConfigPatchRequestType' + $ref: "#/components/schemas/AwsCURConfigPatchRequestType" required: - - attributes - - type + - attributes + - type type: object AwsCURConfigPatchRequest: description: AWS CUR config Patch Request. properties: data: - $ref: '#/components/schemas/AwsCURConfigPatchData' + $ref: "#/components/schemas/AwsCURConfigPatchData" required: - - data + - data type: object AwsCURConfigPatchRequestAttributes: description: Attributes for AWS CUR config Patch Request. properties: account_filters: - $ref: '#/components/schemas/AccountFilteringConfig' + $ref: "#/components/schemas/AccountFilteringConfig" is_enabled: description: Whether or not the Cloud Cost Management account is enabled. example: true @@ -6541,45 +6354,45 @@ components: default: aws_cur_config_patch_request description: Type of AWS CUR config Patch Request. enum: - - aws_cur_config_patch_request + - aws_cur_config_patch_request example: aws_cur_config_patch_request type: string x-enum-varnames: - - AWS_CUR_CONFIG_PATCH_REQUEST + - AWS_CUR_CONFIG_PATCH_REQUEST AwsCURConfigPostData: description: AWS CUR config Post data. properties: attributes: - $ref: '#/components/schemas/AwsCURConfigPostRequestAttributes' + $ref: "#/components/schemas/AwsCURConfigPostRequestAttributes" type: - $ref: '#/components/schemas/AwsCURConfigPostRequestType' + $ref: "#/components/schemas/AwsCURConfigPostRequestType" required: - - type + - type type: object AwsCURConfigPostRequest: description: AWS CUR config Post Request. properties: data: - $ref: '#/components/schemas/AwsCURConfigPostData' + $ref: "#/components/schemas/AwsCURConfigPostData" required: - - data + - data type: object AwsCURConfigPostRequestAttributes: description: Attributes for AWS CUR config Post Request. properties: account_filters: - $ref: '#/components/schemas/AccountFilteringConfig' + $ref: "#/components/schemas/AccountFilteringConfig" account_id: description: The AWS account ID. - example: '123456789123' + example: "123456789123" type: string bucket_name: description: The AWS bucket name used to store the Cost and Usage Report. - example: dd-cost-bucket + example: "dd-cost-bucket" type: string bucket_region: description: The region the bucket is located in. - example: us-east-1 + example: "us-east-1" type: string months: description: The month of the report. @@ -6588,46 +6401,46 @@ components: type: integer report_name: description: The name of the Cost and Usage Report. - example: dd-report-name + example: "dd-report-name" type: string report_prefix: description: The report prefix used for the Cost and Usage Report. - example: dd-report-prefix + example: "dd-report-prefix" type: string required: - - account_id - - bucket_name - - report_name - - report_prefix + - account_id + - bucket_name + - report_name + - report_prefix type: object AwsCURConfigPostRequestType: default: aws_cur_config_post_request description: Type of AWS CUR config Post Request. enum: - - aws_cur_config_post_request + - aws_cur_config_post_request example: aws_cur_config_post_request type: string x-enum-varnames: - - AWS_CUR_CONFIG_POST_REQUEST + - AWS_CUR_CONFIG_POST_REQUEST AwsCURConfigType: default: aws_cur_config description: Type of AWS CUR config. enum: - - aws_cur_config + - aws_cur_config example: aws_cur_config type: string x-enum-varnames: - - AWS_CUR_CONFIG + - AWS_CUR_CONFIG AwsCURConfigsResponse: description: List of AWS CUR configs. properties: data: description: An AWS CUR config. items: - $ref: '#/components/schemas/AwsCURConfig' + $ref: "#/components/schemas/AwsCURConfig" type: array required: - - data + - data type: object AwsCurConfigResponse: description: The definition of `AwsCurConfigResponse` object. @@ -6636,10 +6449,10 @@ components: attributes: account_filters: excluded_accounts: - - '123456789124' - - '123456789125' + - "123456789124" + - "123456789125" include_new_accounts: true - account_id: '123456789123' + account_id: "123456789123" bucket_name: dd-cost-bucket bucket_region: us-east-1 created_at: 2023-01-01 12:00:00 @@ -6650,30 +6463,30 @@ components: status: active status_updated_at: 2023-01-01 12:00:00 updated_at: 2023-01-01 12:00:00 - id: '123456789123' + id: "123456789123" type: aws_cur_config properties: data: - $ref: '#/components/schemas/AwsCurConfigResponseData' + $ref: "#/components/schemas/AwsCurConfigResponseData" type: object AwsCurConfigResponseData: description: The definition of `AwsCurConfigResponseData` object. properties: attributes: - $ref: '#/components/schemas/AwsCurConfigResponseDataAttributes' + $ref: "#/components/schemas/AwsCurConfigResponseDataAttributes" id: description: The `AwsCurConfigResponseData` `id`. type: string type: - $ref: '#/components/schemas/AwsCurConfigResponseDataType' + $ref: "#/components/schemas/AwsCurConfigResponseDataType" required: - - type + - type type: object AwsCurConfigResponseDataAttributes: description: The definition of `AwsCurConfigResponseDataAttributes` object. properties: account_filters: - $ref: '#/components/schemas/AwsCurConfigResponseDataAttributesAccountFilters' + $ref: "#/components/schemas/AwsCurConfigResponseDataAttributesAccountFilters" account_id: description: The `attributes` `account_id`. type: string @@ -6713,8 +6526,7 @@ components: type: string type: object AwsCurConfigResponseDataAttributesAccountFilters: - description: The definition of `AwsCurConfigResponseDataAttributesAccountFilters` - object. + description: The definition of `AwsCurConfigResponseDataAttributesAccountFilters` object. properties: excluded_accounts: description: The `account_filters` `excluded_accounts`. @@ -6735,82 +6547,76 @@ components: default: aws_cur_config description: AWS CUR config resource type. enum: - - aws_cur_config + - aws_cur_config example: aws_cur_config type: string x-enum-varnames: - - AWS_CUR_CONFIG + - AWS_CUR_CONFIG AwsOnDemandAttributes: description: Attributes for the AWS on demand task. properties: arn: description: The arn of the resource to scan. - example: arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba + example: "arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba" type: string assigned_at: - description: Specifies the assignment timestamp if the task has been already - assigned to a scanner. - example: '2025-02-11T18:25:04.550564Z' + description: Specifies the assignment timestamp if the task has been already assigned to a scanner. + example: "2025-02-11T18:25:04.550564Z" type: string created_at: description: The task submission timestamp. - example: '2025-02-11T18:13:24.576915Z' + example: "2025-02-11T18:13:24.576915Z" type: string status: - description: 'Indicates the status of the task. - - QUEUED: the task has been submitted successfully and the resource has - not been assigned to a scanner yet. - + description: |- + Indicates the status of the task. + QUEUED: the task has been submitted successfully and the resource has not been assigned to a scanner yet. ASSIGNED: the task has been assigned. - - ABORTED: the scan has been aborted after a period of time due to technical - reasons, such as resource not found, insufficient permissions, or the - absence of a configured scanner.' - example: QUEUED + ABORTED: the scan has been aborted after a period of time due to technical reasons, such as resource not found, insufficient permissions, or the absence of a configured scanner. + example: "QUEUED" type: string type: object AwsOnDemandCreateAttributes: description: Attributes for the AWS on demand task. properties: arn: - description: The arn of the resource to scan. Agentless supports the scan - of EC2 instances, lambda functions, AMI, ECR, RDS and S3 buckets. - example: arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba + description: |- + The arn of the resource to scan. Agentless supports the scan of EC2 instances, lambda functions, AMI, ECR, RDS and S3 buckets. + example: "arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba" type: string required: - - arn + - arn type: object AwsOnDemandCreateData: description: Object for a single AWS on demand task. properties: attributes: - $ref: '#/components/schemas/AwsOnDemandCreateAttributes' + $ref: "#/components/schemas/AwsOnDemandCreateAttributes" type: - $ref: '#/components/schemas/AwsOnDemandType' + $ref: "#/components/schemas/AwsOnDemandType" required: - - type - - attributes + - type + - attributes type: object AwsOnDemandCreateRequest: description: Request object that includes the on demand task to submit. properties: data: - $ref: '#/components/schemas/AwsOnDemandCreateData' + $ref: "#/components/schemas/AwsOnDemandCreateData" required: - - data + - data type: object AwsOnDemandData: description: Single AWS on demand task. properties: attributes: - $ref: '#/components/schemas/AwsOnDemandAttributes' + $ref: "#/components/schemas/AwsOnDemandAttributes" id: description: The UUID of the task. - example: 6d09294c-9ad9-42fd-a759-a0c1599b4828 + example: "6d09294c-9ad9-42fd-a759-a0c1599b4828" type: string type: - $ref: '#/components/schemas/AwsOnDemandType' + $ref: "#/components/schemas/AwsOnDemandType" type: object AwsOnDemandListResponse: description: Response object that includes a list of AWS on demand tasks. @@ -6818,24 +6624,23 @@ components: data: description: A list of on demand tasks. items: - $ref: '#/components/schemas/AwsOnDemandData' + $ref: "#/components/schemas/AwsOnDemandData" type: array type: object AwsOnDemandResponse: description: Response object that includes an AWS on demand task. properties: data: - $ref: '#/components/schemas/AwsOnDemandData' + $ref: "#/components/schemas/AwsOnDemandData" type: object AwsOnDemandType: default: aws_resource description: The type of the on demand task. The value should always be `aws_resource`. enum: - - aws_resource + - aws_resource example: aws_resource type: string - x-enum-varnames: - - AWS_RESOURCE + x-enum-varnames: ["AWS_RESOURCE"] AwsScanOptionsAttributes: description: Attributes for the AWS scan options. properties: @@ -6848,8 +6653,7 @@ components: example: false type: boolean vuln_containers_os: - description: Indicates if scanning for vulnerabilities in containers is - enabled. + description: Indicates if scanning for vulnerabilities in containers is enabled. example: true type: boolean vuln_host_os: @@ -6869,8 +6673,7 @@ components: example: false type: boolean vuln_containers_os: - description: Indicates if scanning for vulnerabilities in containers is - enabled. + description: Indicates if scanning for vulnerabilities in containers is enabled. example: true type: boolean vuln_host_os: @@ -6878,44 +6681,44 @@ components: example: true type: boolean required: - - lambda - - sensitive_data - - vuln_containers_os - - vuln_host_os + - lambda + - sensitive_data + - vuln_containers_os + - vuln_host_os type: object AwsScanOptionsCreateData: description: Object for the scan options of a single AWS account. properties: attributes: - $ref: '#/components/schemas/AwsScanOptionsCreateAttributes' + $ref: "#/components/schemas/AwsScanOptionsCreateAttributes" id: - $ref: '#/components/schemas/AwsAccountId' + $ref: "#/components/schemas/AwsAccountId" type: - $ref: '#/components/schemas/AwsScanOptionsType' + $ref: "#/components/schemas/AwsScanOptionsType" required: - - id - - type - - attributes + - id + - type + - attributes type: object AwsScanOptionsCreateRequest: description: Request object that includes the scan options to create. properties: data: - $ref: '#/components/schemas/AwsScanOptionsCreateData' + $ref: "#/components/schemas/AwsScanOptionsCreateData" required: - - data + - data type: object AwsScanOptionsData: description: Single AWS Scan Options entry. properties: attributes: - $ref: '#/components/schemas/AwsScanOptionsAttributes' + $ref: "#/components/schemas/AwsScanOptionsAttributes" id: description: The ID of the AWS account. - example: '184366314700' + example: "184366314700" type: string type: - $ref: '#/components/schemas/AwsScanOptionsType' + $ref: "#/components/schemas/AwsScanOptionsType" type: object AwsScanOptionsListResponse: description: Response object that includes a list of AWS scan options. @@ -6923,24 +6726,23 @@ components: data: description: A list of AWS scan options. items: - $ref: '#/components/schemas/AwsScanOptionsData' + $ref: "#/components/schemas/AwsScanOptionsData" type: array type: object AwsScanOptionsResponse: description: Response object that includes the scan options of an AWS account. properties: data: - $ref: '#/components/schemas/AwsScanOptionsData' + $ref: "#/components/schemas/AwsScanOptionsData" type: object AwsScanOptionsType: default: aws_scan_options description: The type of the resource. The value should always be `aws_scan_options`. enum: - - aws_scan_options + - aws_scan_options example: aws_scan_options type: string - x-enum-varnames: - - AWS_SCAN_OPTIONS + x-enum-varnames: ["AWS_SCAN_OPTIONS"] AwsScanOptionsUpdateAttributes: description: Attributes for the AWS scan options to update. properties: @@ -6953,8 +6755,7 @@ components: example: false type: boolean vuln_containers_os: - description: Indicates if scanning for vulnerabilities in containers is - enabled. + description: Indicates if scanning for vulnerabilities in containers is enabled. example: true type: boolean vuln_host_os: @@ -6966,60 +6767,60 @@ components: description: Object for the scan options of a single AWS account. properties: attributes: - $ref: '#/components/schemas/AwsScanOptionsUpdateAttributes' + $ref: "#/components/schemas/AwsScanOptionsUpdateAttributes" id: - $ref: '#/components/schemas/AwsAccountId' + $ref: "#/components/schemas/AwsAccountId" type: - $ref: '#/components/schemas/AwsScanOptionsType' + $ref: "#/components/schemas/AwsScanOptionsType" required: - - id - - type - - attributes + - id + - type + - attributes type: object AwsScanOptionsUpdateRequest: description: Request object that includes the scan options to update. properties: data: - $ref: '#/components/schemas/AwsScanOptionsUpdateData' + $ref: "#/components/schemas/AwsScanOptionsUpdateData" required: - - data + - data type: object AzureCredentials: description: The definition of the `AzureCredentials` object. oneOf: - - $ref: '#/components/schemas/AzureTenant' + - $ref: "#/components/schemas/AzureTenant" AzureCredentialsUpdate: description: The definition of the `AzureCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/AzureTenantUpdate' + - $ref: "#/components/schemas/AzureTenantUpdate" AzureIntegration: description: The definition of the `AzureIntegration` object. properties: credentials: - $ref: '#/components/schemas/AzureCredentials' + $ref: "#/components/schemas/AzureCredentials" type: - $ref: '#/components/schemas/AzureIntegrationType' + $ref: "#/components/schemas/AzureIntegrationType" required: - - type - - credentials + - type + - credentials type: object AzureIntegrationType: description: The definition of the `AzureIntegrationType` object. enum: - - Azure + - Azure example: Azure type: string x-enum-varnames: - - AZURE + - AZURE AzureIntegrationUpdate: description: The definition of the `AzureIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/AzureCredentialsUpdate' + $ref: "#/components/schemas/AzureCredentialsUpdate" type: - $ref: '#/components/schemas/AzureIntegrationType' + $ref: "#/components/schemas/AzureIntegrationType" required: - - type + - type type: object AzureScanOptions: description: Response object containing Azure scan options for a single subscription. @@ -7032,47 +6833,46 @@ components: type: azure_scan_options properties: data: - $ref: '#/components/schemas/AzureScanOptionsData' + $ref: "#/components/schemas/AzureScanOptionsData" type: object AzureScanOptionsArray: description: Response object containing a list of Azure scan options. example: data: - - attributes: - vuln_containers_os: true - vuln_host_os: true - id: 12345678-90ab-cdef-1234-567890abcdef - type: azure_scan_options + - attributes: + vuln_containers_os: true + vuln_host_os: true + id: 12345678-90ab-cdef-1234-567890abcdef + type: azure_scan_options properties: data: description: A list of Azure scan options. items: - $ref: '#/components/schemas/AzureScanOptionsData' + $ref: "#/components/schemas/AzureScanOptionsData" type: array required: - - data + - data type: object AzureScanOptionsData: description: Single Azure scan options entry. properties: attributes: - $ref: '#/components/schemas/AzureScanOptionsDataAttributes' + $ref: "#/components/schemas/AzureScanOptionsDataAttributes" id: description: The Azure subscription ID. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/AzureScanOptionsDataType' + $ref: "#/components/schemas/AzureScanOptionsDataType" required: - - type - - id + - type + - id type: object AzureScanOptionsDataAttributes: description: Attributes for Azure scan options configuration. properties: vuln_containers_os: - description: Indicates if scanning for vulnerabilities in containers is - enabled. + description: Indicates if scanning for vulnerabilities in containers is enabled. type: boolean vuln_host_os: description: Indicates if scanning for vulnerabilities in hosts is enabled. @@ -7082,11 +6882,11 @@ components: default: azure_scan_options description: The type of the resource. The value should always be `azure_scan_options`. enum: - - azure_scan_options + - azure_scan_options example: azure_scan_options type: string x-enum-varnames: - - AZURE_SCAN_OPTIONS + - AZURE_SCAN_OPTIONS AzureScanOptionsInputUpdate: description: Request object for updating Azure scan options. example: @@ -7095,29 +6895,28 @@ components: type: azure_scan_options properties: data: - $ref: '#/components/schemas/AzureScanOptionsInputUpdateData' + $ref: "#/components/schemas/AzureScanOptionsInputUpdateData" type: object AzureScanOptionsInputUpdateData: description: Data object for updating the scan options of a single Azure subscription. properties: attributes: - $ref: '#/components/schemas/AzureScanOptionsInputUpdateDataAttributes' + $ref: "#/components/schemas/AzureScanOptionsInputUpdateDataAttributes" id: description: The Azure subscription ID. - example: 12345678-90ab-cdef-1234-567890abcdef + example: "12345678-90ab-cdef-1234-567890abcdef" type: string type: - $ref: '#/components/schemas/AzureScanOptionsInputUpdateDataType' + $ref: "#/components/schemas/AzureScanOptionsInputUpdateDataType" required: - - type - - id + - type + - id type: object AzureScanOptionsInputUpdateDataAttributes: description: Attributes for updating Azure scan options configuration. properties: vuln_containers_os: - description: Indicates if scanning for vulnerabilities in containers is - enabled. + description: Indicates if scanning for vulnerabilities in containers is enabled. type: boolean vuln_host_os: description: Indicates if scanning for vulnerabilities in hosts is enabled. @@ -7127,157 +6926,123 @@ components: default: azure_scan_options description: Azure scan options resource type. enum: - - azure_scan_options + - azure_scan_options example: azure_scan_options type: string x-enum-varnames: - - AZURE_SCAN_OPTIONS + - AZURE_SCAN_OPTIONS AzureStorageDestination: - description: 'The `azure_storage` destination forwards logs to an Azure Blob - Storage container. - + description: |- + The `azure_storage` destination forwards logs to an Azure Blob Storage container. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: blob_prefix: description: Optional prefix for blobs written to the container. - example: logs/ + example: "logs/" type: string buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" connection_string_key: - description: Name of the environment variable or secret that holds the Azure - Storage connection string. + description: Name of the environment variable or secret that holds the Azure Storage connection string. example: AZURE_STORAGE_CONNECTION_STRING type: string container_name: - description: The name of the Azure Blob Storage container to store logs - in. - example: my-log-container + description: The name of the Azure Blob Storage container to store logs in. + example: "my-log-container" type: string id: description: The unique identifier for this component. - example: azure-storage-destination + example: "azure-storage-destination" type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - processor-id + description: A list of component IDs whose output is used as the `input` for this component. + example: ["processor-id"] items: type: string type: array type: - $ref: '#/components/schemas/AzureStorageDestinationType' + $ref: "#/components/schemas/AzureStorageDestinationType" required: - - id - - type - - inputs - - container_name + - id + - type + - inputs + - container_name type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] AzureStorageDestinationType: default: azure_storage description: The destination type. The value should always be `azure_storage`. enum: - - azure_storage + - azure_storage example: azure_storage type: string x-enum-varnames: - - AZURE_STORAGE + - AZURE_STORAGE AzureTenant: description: The definition of the `AzureTenant` object. properties: app_client_id: - description: The Client ID, also known as the Application ID in Azure, is - a unique identifier for an application. It's used to identify the application - during the authentication process. Your Application (client) ID is listed - in the application's overview page. You can navigate to your application - via the Azure Directory. - example: '' + description: "The Client ID, also known as the Application ID in Azure, is a unique identifier for an application. It's used to identify the application during the authentication process. Your Application (client) ID is listed in the application's overview page. You can navigate to your application via the Azure Directory." + example: "" type: string client_secret: - description: "The Client Secret is a confidential piece of information known - only to the application and Azure AD. It's used to prove the application's - identity. Your Client Secret is available from the application\u2019s - secrets page. You can navigate to your application via the Azure Directory." - example: '' + description: The Client Secret is a confidential piece of information known only to the application and Azure AD. It's used to prove the application's identity. Your Client Secret is available from the application’s secrets page. You can navigate to your application via the Azure Directory. + example: "" type: string custom_scopes: - description: If provided, the custom scope to be requested from Microsoft - when acquiring an OAuth 2 access token. This custom scope is used only - in conjunction with the HTTP action. A resource's scope is constructed - by using the identifier URI for the resource and .default, separated by - a forward slash (/) as follows:{identifierURI}/.default. + description: If provided, the custom scope to be requested from Microsoft when acquiring an OAuth 2 access token. This custom scope is used only in conjunction with the HTTP action. A resource's scope is constructed by using the identifier URI for the resource and .default, separated by a forward slash (/) as follows:{identifierURI}/.default. type: string tenant_id: - description: The Tenant ID, also known as the Directory ID in Azure, is - a unique identifier that represents an Azure AD instance. Your Tenant - ID (Directory ID) is listed in your Active Directory overview page under - the 'Tenant information' section. - example: '' + description: The Tenant ID, also known as the Directory ID in Azure, is a unique identifier that represents an Azure AD instance. Your Tenant ID (Directory ID) is listed in your Active Directory overview page under the 'Tenant information' section. + example: "" type: string type: - $ref: '#/components/schemas/AzureTenantType' + $ref: "#/components/schemas/AzureTenantType" required: - - type - - tenant_id - - app_client_id - - client_secret + - type + - tenant_id + - app_client_id + - client_secret type: object AzureTenantType: description: The definition of the `AzureTenant` object. enum: - - AzureTenant + - AzureTenant example: AzureTenant type: string x-enum-varnames: - - AZURETENANT + - AZURETENANT AzureTenantUpdate: description: The definition of the `AzureTenant` object. properties: app_client_id: - description: The Client ID, also known as the Application ID in Azure, is - a unique identifier for an application. It's used to identify the application - during the authentication process. Your Application (client) ID is listed - in the application's overview page. You can navigate to your application - via the Azure Directory. + description: "The Client ID, also known as the Application ID in Azure, is a unique identifier for an application. It's used to identify the application during the authentication process. Your Application (client) ID is listed in the application's overview page. You can navigate to your application via the Azure Directory." type: string client_secret: - description: "The Client Secret is a confidential piece of information known - only to the application and Azure AD. It's used to prove the application's - identity. Your Client Secret is available from the application\u2019s - secrets page. You can navigate to your application via the Azure Directory." + description: The Client Secret is a confidential piece of information known only to the application and Azure AD. It's used to prove the application's identity. Your Client Secret is available from the application’s secrets page. You can navigate to your application via the Azure Directory. type: string custom_scopes: - description: If provided, the custom scope to be requested from Microsoft - when acquiring an OAuth 2 access token. This custom scope is used only - in conjunction with the HTTP action. A resource's scope is constructed - by using the identifier URI for the resource and .default, separated by - a forward slash (/) as follows:{identifierURI}/.default. + description: If provided, the custom scope to be requested from Microsoft when acquiring an OAuth 2 access token. This custom scope is used only in conjunction with the HTTP action. A resource's scope is constructed by using the identifier URI for the resource and .default, separated by a forward slash (/) as follows:{identifierURI}/.default. type: string tenant_id: - description: The Tenant ID, also known as the Directory ID in Azure, is - a unique identifier that represents an Azure AD instance. Your Tenant - ID (Directory ID) is listed in your Active Directory overview page under - the 'Tenant information' section. + description: The Tenant ID, also known as the Directory ID in Azure, is a unique identifier that represents an Azure AD instance. Your Tenant ID (Directory ID) is listed in your Active Directory overview page under the 'Tenant information' section. type: string type: - $ref: '#/components/schemas/AzureTenantType' + $ref: "#/components/schemas/AzureTenantType" required: - - type + - type type: object AzureUCConfig: description: Azure config. properties: account_id: description: The tenant ID of the Azure account. - example: 1234abcd-1234-abcd-1234-1234abcd1234 + example: "1234abcd-1234-abcd-1234-1234abcd1234" type: string client_id: description: The client ID of the Azure account. - example: 1234abcd-1234-abcd-1234-1234abcd1234 + example: "1234abcd-1234-abcd-1234-1234abcd1234" type: string created_at: description: The timestamp when the Azure config was created. @@ -7285,7 +7050,7 @@ components: type: string dataset_type: description: The dataset type of the Azure config. - example: actual + example: "actual" type: string error_messages: description: The error messages for the Azure config. @@ -7295,11 +7060,11 @@ components: type: array export_name: description: The name of the configured Azure Export. - example: dd-actual-export + example: "dd-actual-export" type: string export_path: description: The path where the Azure Export is saved. - example: dd-export-path + example: "dd-export-path" type: string id: description: The ID of the Azure config. @@ -7312,11 +7077,11 @@ components: type: integer scope: description: The scope of your observed subscription. - example: /subscriptions/1234abcd-1234-abcd-1234-1234abcd1234 + example: "/subscriptions/1234abcd-1234-abcd-1234-1234abcd1234" type: string status: description: The status of the Azure config. - example: active + example: "active" type: string status_updated_at: description: The timestamp when the Azure config status was last updated. @@ -7324,41 +7089,40 @@ components: type: string storage_account: description: The name of the storage account where the Azure Export is saved. - example: dd-storage-account + example: "dd-storage-account" type: string storage_container: - description: The name of the storage container where the Azure Export is - saved. - example: dd-storage-container + description: The name of the storage container where the Azure Export is saved. + example: "dd-storage-container" type: string updated_at: description: The timestamp when the Azure config was last updated. pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$ type: string required: - - account_id - - client_id - - dataset_type - - export_name - - export_path - - scope - - status - - storage_account - - storage_container + - account_id + - client_id + - dataset_type + - export_name + - export_path + - scope + - status + - storage_account + - storage_container type: object AzureUCConfigPair: description: Azure config pair. properties: attributes: - $ref: '#/components/schemas/AzureUCConfigPairAttributes' + $ref: "#/components/schemas/AzureUCConfigPairAttributes" id: description: The ID of Cloud Cost Management account. type: string type: - $ref: '#/components/schemas/AzureUCConfigPairType' + $ref: "#/components/schemas/AzureUCConfigPairType" required: - - attributes - - type + - attributes + - type type: object AzureUCConfigPairAttributes: description: Attributes for Azure config pair. @@ -7366,46 +7130,46 @@ components: configs: description: An Azure config. items: - $ref: '#/components/schemas/AzureUCConfig' + $ref: "#/components/schemas/AzureUCConfig" type: array id: description: The ID of the Azure config pair. type: string required: - - configs + - configs type: object AzureUCConfigPairType: default: azure_uc_configs description: Type of Azure config pair. enum: - - azure_uc_configs + - azure_uc_configs example: azure_uc_configs type: string x-enum-varnames: - - AZURE_UC_CONFIGS + - AZURE_UC_CONFIGS AzureUCConfigPairsResponse: description: Response of Azure config pair. properties: data: - $ref: '#/components/schemas/AzureUCConfigPair' + $ref: "#/components/schemas/AzureUCConfigPair" type: object AzureUCConfigPatchData: description: Azure config Patch data. properties: attributes: - $ref: '#/components/schemas/AzureUCConfigPatchRequestAttributes' + $ref: "#/components/schemas/AzureUCConfigPatchRequestAttributes" type: - $ref: '#/components/schemas/AzureUCConfigPatchRequestType' + $ref: "#/components/schemas/AzureUCConfigPatchRequestType" required: - - type + - type type: object AzureUCConfigPatchRequest: description: Azure config Patch Request. properties: data: - $ref: '#/components/schemas/AzureUCConfigPatchData' + $ref: "#/components/schemas/AzureUCConfigPatchData" required: - - data + - data type: object AzureUCConfigPatchRequestAttributes: description: Attributes for Azure config Patch Request. @@ -7415,130 +7179,130 @@ components: example: true type: boolean required: - - is_enabled + - is_enabled type: object AzureUCConfigPatchRequestType: default: azure_uc_config_patch_request description: Type of Azure config Patch Request. enum: - - azure_uc_config_patch_request + - azure_uc_config_patch_request example: azure_uc_config_patch_request type: string x-enum-varnames: - - AZURE_UC_CONFIG_PATCH_REQUEST + - AZURE_UC_CONFIG_PATCH_REQUEST AzureUCConfigPostData: description: Azure config Post data. properties: attributes: - $ref: '#/components/schemas/AzureUCConfigPostRequestAttributes' + $ref: "#/components/schemas/AzureUCConfigPostRequestAttributes" type: - $ref: '#/components/schemas/AzureUCConfigPostRequestType' + $ref: "#/components/schemas/AzureUCConfigPostRequestType" required: - - type + - type type: object AzureUCConfigPostRequest: description: Azure config Post Request. properties: data: - $ref: '#/components/schemas/AzureUCConfigPostData' + $ref: "#/components/schemas/AzureUCConfigPostData" required: - - data + - data type: object AzureUCConfigPostRequestAttributes: description: Attributes for Azure config Post Request. properties: account_id: description: The tenant ID of the Azure account. - example: 1234abcd-1234-abcd-1234-1234abcd1234 + example: "1234abcd-1234-abcd-1234-1234abcd1234" type: string actual_bill_config: - $ref: '#/components/schemas/BillConfig' + $ref: "#/components/schemas/BillConfig" amortized_bill_config: - $ref: '#/components/schemas/BillConfig' + $ref: "#/components/schemas/BillConfig" client_id: description: The client ID of the Azure account. - example: 1234abcd-1234-abcd-1234-1234abcd1234 + example: "1234abcd-1234-abcd-1234-1234abcd1234" type: string scope: description: The scope of your observed subscription. - example: /subscriptions/1234abcd-1234-abcd-1234-1234abcd1234 + example: "/subscriptions/1234abcd-1234-abcd-1234-1234abcd1234" type: string required: - - account_id - - actual_bill_config - - amortized_bill_config - - client_id - - scope + - account_id + - actual_bill_config + - amortized_bill_config + - client_id + - scope type: object AzureUCConfigPostRequestType: default: azure_uc_config_post_request description: Type of Azure config Post Request. enum: - - azure_uc_config_post_request + - azure_uc_config_post_request example: azure_uc_config_post_request type: string x-enum-varnames: - - AZURE_UC_CONFIG_POST_REQUEST + - AZURE_UC_CONFIG_POST_REQUEST AzureUCConfigsResponse: description: List of Azure accounts with configs. properties: data: description: An Azure config pair. items: - $ref: '#/components/schemas/AzureUCConfigPair' + $ref: "#/components/schemas/AzureUCConfigPair" type: array required: - - data + - data type: object BatchDeleteRowsRequestArray: description: The request body for deleting multiple rows from a reference table. properties: data: items: - $ref: '#/components/schemas/TableRowResourceIdentifier' + $ref: "#/components/schemas/TableRowResourceIdentifier" maxItems: 200 type: array required: - - data + - data type: object BatchRowsQueryDataType: default: reference-tables-batch-rows-query description: Resource type identifier for batch queries of reference table rows. enum: - - reference-tables-batch-rows-query + - reference-tables-batch-rows-query example: reference-tables-batch-rows-query type: string x-enum-varnames: - - REFERENCE_TABLES_BATCH_ROWS_QUERY + - REFERENCE_TABLES_BATCH_ROWS_QUERY BatchRowsQueryRequest: properties: data: - $ref: '#/components/schemas/BatchRowsQueryRequestData' + $ref: "#/components/schemas/BatchRowsQueryRequestData" type: object BatchRowsQueryRequestData: properties: attributes: - $ref: '#/components/schemas/BatchRowsQueryRequestDataAttributes' + $ref: "#/components/schemas/BatchRowsQueryRequestDataAttributes" type: - $ref: '#/components/schemas/BatchRowsQueryDataType' + $ref: "#/components/schemas/BatchRowsQueryDataType" required: - - type + - type type: object BatchRowsQueryRequestDataAttributes: properties: row_ids: example: - - row_id_1 - - row_id_2 + - "row_id_1" + - "row_id_2" items: type: string type: array table_id: - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string required: - - row_ids - - table_id + - row_ids + - table_id type: object BatchRowsQueryResponse: example: @@ -7547,146 +7311,141 @@ components: relationships: rows: data: - - id: row_id_1 - type: row - - id: row_id_2 - type: row + - id: row_id_1 + type: row + - id: row_id_2 + type: row type: reference-tables-batch-rows-query properties: data: - $ref: '#/components/schemas/BatchRowsQueryResponseData' + $ref: "#/components/schemas/BatchRowsQueryResponseData" type: object BatchRowsQueryResponseData: properties: id: type: string relationships: - $ref: '#/components/schemas/BatchRowsQueryResponseDataRelationships' + $ref: "#/components/schemas/BatchRowsQueryResponseDataRelationships" type: - $ref: '#/components/schemas/BatchRowsQueryDataType' + $ref: "#/components/schemas/BatchRowsQueryDataType" required: - - type + - type type: object BatchRowsQueryResponseDataRelationships: properties: rows: - $ref: '#/components/schemas/BatchRowsQueryResponseDataRelationshipsRows' + $ref: "#/components/schemas/BatchRowsQueryResponseDataRelationshipsRows" type: object BatchRowsQueryResponseDataRelationshipsRows: properties: data: items: - $ref: '#/components/schemas/TableRowResourceIdentifier' + $ref: "#/components/schemas/TableRowResourceIdentifier" type: array type: object BatchUpsertRowsRequestArray: - description: The request body for creating or updating multiple rows into a - reference table. + description: The request body for creating or updating multiple rows into a reference table. properties: data: items: - $ref: '#/components/schemas/BatchUpsertRowsRequestData' + $ref: "#/components/schemas/BatchUpsertRowsRequestData" maxItems: 200 type: array required: - - data + - data type: object BatchUpsertRowsRequestData: - description: Row resource containing a single row identifier and its column - values. + description: Row resource containing a single row identifier and its column values. properties: attributes: - $ref: '#/components/schemas/BatchUpsertRowsRequestDataAttributes' + $ref: "#/components/schemas/BatchUpsertRowsRequestDataAttributes" id: - example: primary_key_value + example: "primary_key_value" type: string type: - $ref: '#/components/schemas/TableRowResourceDataType' + $ref: "#/components/schemas/TableRowResourceDataType" required: - - type - - id + - type + - id type: object BatchUpsertRowsRequestDataAttributes: - description: Attributes containing row data values for row creation or update - operations. + description: Attributes containing row data values for row creation or update operations. example: values: {} properties: values: additionalProperties: - $ref: '#/components/schemas/BatchUpsertRowsRequestDataAttributesValue' - description: Key-value pairs representing row data, where keys are schema - field names and values match the corresponding column types. + $ref: "#/components/schemas/BatchUpsertRowsRequestDataAttributesValue" + description: >- + Key-value pairs representing row data, where keys are schema field names and values match the corresponding column types. type: object required: - - values + - values type: object BatchUpsertRowsRequestDataAttributesValue: description: Types allowed for Reference Table row values. oneOf: - - example: row_name - type: string - - example: 25 - format: int32 - maximum: 2147483647 - type: integer + - example: "row_name" + type: string + - example: 25 + format: int32 + maximum: 2147483647 + type: integer BillConfig: description: Bill config. properties: export_name: description: The name of the configured Azure Export. - example: dd-actual-export + example: "dd-actual-export" type: string export_path: description: The path where the Azure Export is saved. - example: dd-export-path + example: "dd-export-path" type: string storage_account: description: The name of the storage account where the Azure Export is saved. - example: dd-storage-account + example: "dd-storage-account" type: string storage_container: - description: The name of the storage container where the Azure Export is - saved. - example: dd-storage-container + description: The name of the storage container where the Azure Export is saved. + example: "dd-storage-container" type: string required: - - export_name - - export_path - - storage_account - - storage_container + - export_name + - export_path + - storage_account + - storage_container type: object BillingDimensionsMappingBody: description: Billing dimensions mapping data. items: - $ref: '#/components/schemas/BillingDimensionsMappingBodyItem' + $ref: "#/components/schemas/BillingDimensionsMappingBodyItem" type: array BillingDimensionsMappingBodyItem: description: The mapping data for each billing dimension. properties: attributes: - $ref: '#/components/schemas/BillingDimensionsMappingBodyItemAttributes' + $ref: "#/components/schemas/BillingDimensionsMappingBodyItemAttributes" id: description: ID of the billing dimension. type: string type: - $ref: '#/components/schemas/ActiveBillingDimensionsType' + $ref: "#/components/schemas/ActiveBillingDimensionsType" type: object BillingDimensionsMappingBodyItemAttributes: description: Mapping of billing dimensions to endpoint keys. properties: endpoints: - description: List of supported endpoints with their keys mapped to the billing_dimension. + description: "List of supported endpoints with their keys mapped to the billing_dimension." items: - $ref: '#/components/schemas/BillingDimensionsMappingBodyItemAttributesEndpointsItems' + $ref: "#/components/schemas/BillingDimensionsMappingBodyItemAttributesEndpointsItems" type: array in_app_label: - description: Label used for the billing dimension in the Plan & Usage charts. + description: "Label used for the billing dimension in the Plan & Usage charts." example: APM Hosts type: string timestamp: - description: 'Month in ISO-8601 format, UTC, and precise to the second: - `[YYYY-MM-DDThh:mm:ss]`.' + description: "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`." format: date-time type: string type: object @@ -7695,42 +7454,42 @@ components: properties: id: description: The URL for the endpoint. - example: api/v1/usage/billable-summary + example: "api/v1/usage/billable-summary" type: string keys: description: The billing dimension. example: - - apm_host_top99p - - apm_host_sum + - "apm_host_top99p" + - "apm_host_sum" items: example: apm_host_top99p type: string type: array status: - $ref: '#/components/schemas/BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus' + $ref: "#/components/schemas/BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus" type: object BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus: description: Denotes whether mapping keys were available for this endpoint. enum: - - OK - - NOT_FOUND + - OK + - NOT_FOUND type: string x-enum-varnames: - - OK - - NOT_FOUND + - OK + - NOT_FOUND BillingDimensionsMappingResponse: description: Billing dimensions mapping response. properties: data: - $ref: '#/components/schemas/BillingDimensionsMappingBody' + $ref: "#/components/schemas/BillingDimensionsMappingBody" type: object BranchCoverageSummaryRequest: description: Request object for getting code coverage summary for a branch. properties: data: - $ref: '#/components/schemas/BranchCoverageSummaryRequestData' + $ref: "#/components/schemas/BranchCoverageSummaryRequestData" required: - - data + - data type: object BranchCoverageSummaryRequestAttributes: description: Attributes for requesting code coverage summary for a branch. @@ -7746,69 +7505,68 @@ components: minLength: 1 type: string required: - - repository_id - - branch + - repository_id + - branch type: object BranchCoverageSummaryRequestData: description: Data object for branch summary request. properties: attributes: - $ref: '#/components/schemas/BranchCoverageSummaryRequestAttributes' + $ref: "#/components/schemas/BranchCoverageSummaryRequestAttributes" type: - $ref: '#/components/schemas/BranchCoverageSummaryRequestType' + $ref: "#/components/schemas/BranchCoverageSummaryRequestType" required: - - type - - attributes + - type + - attributes type: object BranchCoverageSummaryRequestType: - description: JSON:API type for branch coverage summary request. The value must - always be `ci_app_coverage_branch_summary_request`. + description: JSON:API type for branch coverage summary request. The value must always be `ci_app_coverage_branch_summary_request`. enum: - - ci_app_coverage_branch_summary_request + - ci_app_coverage_branch_summary_request example: ci_app_coverage_branch_summary_request type: string x-enum-varnames: - - CI_APP_COVERAGE_BRANCH_SUMMARY_REQUEST + - CI_APP_COVERAGE_BRANCH_SUMMARY_REQUEST Budget: description: A budget. properties: attributes: - $ref: '#/components/schemas/BudgetAttributes' + $ref: "#/components/schemas/BudgetAttributes" id: description: The id of the budget. type: string type: description: The type of the object, must be `budget`. - example: '' + example: "" type: string required: - - type + - type type: object BudgetArray: description: An array of budgets. example: data: - - attributes: - created_at: 1741011342772 - created_by: user1 - end_month: 202502 - metrics_query: aws.cost.amortized{service:ec2} by {service} - name: my budget - org_id: 123 - start_month: 202501 - total_amount: 1000 - updated_at: 1741011342772 - updated_by: user2 - id: 00000000-0a0a-0a0a-aaa0-00000000000a - type: budget + - attributes: + created_at: 1741011342772 + created_by: user1 + end_month: 202502 + metrics_query: aws.cost.amortized{service:ec2} by {service} + name: my budget + org_id: 123 + start_month: 202501 + total_amount: 1000 + updated_at: 1741011342772 + updated_by: user2 + id: "00000000-0a0a-0a0a-aaa0-00000000000a" + type: budget properties: data: description: The `BudgetArray` `data`. items: - $ref: '#/components/schemas/Budget' + $ref: "#/components/schemas/Budget" type: array required: - - data + - data type: object BudgetAttributes: description: The attributes of a budget. @@ -7829,7 +7587,7 @@ components: type: integer entries: items: - $ref: '#/components/schemas/BudgetWithEntriesDataAttributesEntriesItems' + $ref: "#/components/schemas/BudgetWithEntriesDataAttributesEntriesItems" type: array metrics_query: description: The cost query used to track against the budget. @@ -7872,16 +7630,16 @@ components: created_by: 00000000-0a0a-0a0a-aaa0-00000000000a end_month: 202502 entries: - - amount: 500 - month: 202501 - tag_filters: - - tag_key: service - tag_value: ec2 - - amount: 500 - month: 202502 - tag_filters: - - tag_key: service - tag_value: ec2 + - amount: 500 + month: 202501 + tag_filters: + - tag_key: service + tag_value: ec2 + - amount: 500 + month: 202502 + tag_filters: + - tag_key: service + tag_value: ec2 metrics_query: aws.cost.amortized{service:ec2} by {service} name: my budget org_id: 123 @@ -7889,22 +7647,22 @@ components: total_amount: 1000 updated_at: 1738258683590 updated_by: 00000000-0a0a-0a0a-aaa0-00000000000a - id: '1' + id: "1" type: budget properties: data: - $ref: '#/components/schemas/BudgetValidationRequestData' + $ref: "#/components/schemas/BudgetValidationRequestData" type: object BudgetValidationRequestData: properties: attributes: - $ref: '#/components/schemas/BudgetWithEntriesDataAttributes' + $ref: "#/components/schemas/BudgetWithEntriesDataAttributes" id: type: string type: - $ref: '#/components/schemas/BudgetWithEntriesDataType' + $ref: "#/components/schemas/BudgetWithEntriesDataType" required: - - type + - type type: object BudgetValidationResponse: example: @@ -7916,18 +7674,18 @@ components: type: budget_validation properties: data: - $ref: '#/components/schemas/BudgetValidationResponseData' + $ref: "#/components/schemas/BudgetValidationResponseData" type: object BudgetValidationResponseData: properties: attributes: - $ref: '#/components/schemas/BudgetValidationResponseDataAttributes' + $ref: "#/components/schemas/BudgetValidationResponseDataAttributes" id: type: string type: - $ref: '#/components/schemas/BudgetValidationResponseDataType' + $ref: "#/components/schemas/BudgetValidationResponseDataType" required: - - type + - type type: object BudgetValidationResponseDataAttributes: properties: @@ -7942,29 +7700,29 @@ components: default: budget_validation description: Budget validation resource type. enum: - - budget_validation + - budget_validation example: budget_validation type: string x-enum-varnames: - - BUDGET_VALIDATION + - BUDGET_VALIDATION BudgetWithEntries: description: The definition of the `BudgetWithEntries` object. properties: data: - $ref: '#/components/schemas/BudgetWithEntriesData' + $ref: "#/components/schemas/BudgetWithEntriesData" type: object BudgetWithEntriesData: description: A budget and all its entries. properties: attributes: - $ref: '#/components/schemas/BudgetAttributes' + $ref: "#/components/schemas/BudgetAttributes" id: description: The `BudgetWithEntriesData` `id`. example: 00000000-0a0a-0a0a-aaa0-00000000000a type: string type: description: The type of the object, must be `budget`. - example: '' + example: "" type: string type: object BudgetWithEntriesDataAttributes: @@ -7979,7 +7737,7 @@ components: type: integer entries: items: - $ref: '#/components/schemas/BudgetWithEntriesDataAttributesEntriesItems' + $ref: "#/components/schemas/BudgetWithEntriesDataAttributesEntriesItems" type: array metrics_query: type: string @@ -8010,7 +7768,7 @@ components: type: integer tag_filters: items: - $ref: '#/components/schemas/BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems' + $ref: "#/components/schemas/BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems" type: array type: object BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems: @@ -8024,37 +7782,35 @@ components: default: budget description: Budget resource type. enum: - - budget + - budget example: budget type: string x-enum-varnames: - - BUDGET + - BUDGET BulkDeleteAppsDatastoreItemsRequest: description: Request to delete items from a datastore. properties: data: - $ref: '#/components/schemas/BulkDeleteAppsDatastoreItemsRequestData' + $ref: "#/components/schemas/BulkDeleteAppsDatastoreItemsRequestData" type: object BulkDeleteAppsDatastoreItemsRequestData: - description: Data wrapper containing the data needed to delete items from a - datastore. + description: Data wrapper containing the data needed to delete items from a datastore. properties: attributes: - $ref: '#/components/schemas/BulkDeleteAppsDatastoreItemsRequestDataAttributes' + $ref: "#/components/schemas/BulkDeleteAppsDatastoreItemsRequestDataAttributes" id: description: ID for the datastore of the items to delete. type: string type: - $ref: '#/components/schemas/BulkDeleteAppsDatastoreItemsRequestDataType' + $ref: "#/components/schemas/BulkDeleteAppsDatastoreItemsRequestDataType" required: - - type + - type type: object BulkDeleteAppsDatastoreItemsRequestDataAttributes: description: Attributes of request data to delete items from a datastore. properties: item_keys: - description: List of primary keys identifying items to delete from datastore. - Up to 100 items can be deleted in a single request. + description: List of primary keys identifying items to delete from datastore. Up to 100 items can be deleted in a single request. items: type: string maxItems: 100 @@ -8064,46 +7820,46 @@ components: default: items description: Items resource type. enum: - - items + - items example: items type: string x-enum-varnames: - - ITEMS + - ITEMS BulkMuteFindingsRequest: description: The new bulk mute finding request. properties: data: - $ref: '#/components/schemas/BulkMuteFindingsRequestData' + $ref: "#/components/schemas/BulkMuteFindingsRequestData" required: - - data + - data type: object BulkMuteFindingsRequestAttributes: additionalProperties: false description: The mute properties to be updated. properties: mute: - $ref: '#/components/schemas/BulkMuteFindingsRequestProperties' + $ref: "#/components/schemas/BulkMuteFindingsRequestProperties" required: - - mute + - mute type: object BulkMuteFindingsRequestData: description: Data object containing the new bulk mute properties of the finding. properties: attributes: - $ref: '#/components/schemas/BulkMuteFindingsRequestAttributes' + $ref: "#/components/schemas/BulkMuteFindingsRequestAttributes" id: description: UUID to identify the request example: dbe5f567-192b-4404-b908-29b70e1c9f76 type: string meta: - $ref: '#/components/schemas/BulkMuteFindingsRequestMeta' + $ref: "#/components/schemas/BulkMuteFindingsRequestMeta" type: - $ref: '#/components/schemas/FindingType' + $ref: "#/components/schemas/FindingType" required: - - id - - type - - attributes - - meta + - id + - type + - attributes + - meta type: object BulkMuteFindingsRequestMeta: description: Meta object containing the findings to be updated. @@ -8111,29 +7867,26 @@ components: findings: description: Array of findings. items: - $ref: '#/components/schemas/BulkMuteFindingsRequestMetaFindings' + $ref: "#/components/schemas/BulkMuteFindingsRequestMetaFindings" type: array type: object BulkMuteFindingsRequestMetaFindings: description: Finding object containing the finding information. properties: finding_id: - $ref: '#/components/schemas/FindingID' + $ref: "#/components/schemas/FindingID" type: object BulkMuteFindingsRequestProperties: additionalProperties: false description: Object containing the new mute properties of the findings. properties: description: - description: Additional information about the reason why those findings - are muted or unmuted. This field has a maximum limit of 280 characters. + description: Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters. type: string expiration_date: - description: 'The expiration date of the mute or unmute action (Unix ms). - It must be set to a value greater than the current timestamp. - - If this field is not provided, the finding will be muted or unmuted indefinitely, - which is equivalent to setting the expiration date to 9999999999999.' + description: |- + The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp. + If this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999. example: 1778721573794 format: int64 type: integer @@ -8142,18 +7895,18 @@ components: example: true type: boolean reason: - $ref: '#/components/schemas/FindingMuteReason' + $ref: "#/components/schemas/FindingMuteReason" required: - - muted - - reason + - muted + - reason type: object BulkMuteFindingsResponse: description: The expected response schema. properties: data: - $ref: '#/components/schemas/BulkMuteFindingsResponseData' + $ref: "#/components/schemas/BulkMuteFindingsResponseData" required: - - data + - data type: object BulkMuteFindingsResponseData: description: Data object containing the ID of the request that was updated. @@ -8163,41 +7916,40 @@ components: example: 93bfeb70-af47-424d-908a-948d3f08e37f type: string type: - $ref: '#/components/schemas/FindingType' + $ref: "#/components/schemas/FindingType" type: object BulkPutAppsDatastoreItemsRequest: description: Request to insert multiple items into a datastore in a single operation. properties: data: - $ref: '#/components/schemas/BulkPutAppsDatastoreItemsRequestData' + $ref: "#/components/schemas/BulkPutAppsDatastoreItemsRequestData" type: object BulkPutAppsDatastoreItemsRequestData: - description: Data wrapper containing the items to insert and their configuration - for the bulk insert operation. + description: Data wrapper containing the items to insert and their configuration for the bulk insert operation. properties: attributes: - $ref: '#/components/schemas/BulkPutAppsDatastoreItemsRequestDataAttributes' + $ref: "#/components/schemas/BulkPutAppsDatastoreItemsRequestDataAttributes" type: - $ref: '#/components/schemas/DatastoreItemsDataType' + $ref: "#/components/schemas/DatastoreItemsDataType" required: - - type + - type type: object BulkPutAppsDatastoreItemsRequestDataAttributes: description: Configuration for bulk inserting multiple items into a datastore. properties: conflict_mode: - $ref: '#/components/schemas/DatastoreItemConflictMode' + $ref: "#/components/schemas/DatastoreItemConflictMode" values: - $ref: '#/components/schemas/DatastoreItemValues' + $ref: "#/components/schemas/DatastoreItemValues" required: - - values + - values type: object CIAppAggregateBucketValue: description: A bucket value, can either be a timeseries or a single value. oneOf: - - $ref: '#/components/schemas/CIAppAggregateBucketValueSingleString' - - $ref: '#/components/schemas/CIAppAggregateBucketValueSingleNumber' - - $ref: '#/components/schemas/CIAppAggregateBucketValueTimeseries' + - $ref: "#/components/schemas/CIAppAggregateBucketValueSingleString" + - $ref: "#/components/schemas/CIAppAggregateBucketValueSingleNumber" + - $ref: "#/components/schemas/CIAppAggregateBucketValueTimeseries" CIAppAggregateBucketValueSingleNumber: description: A single number value. format: double @@ -8208,7 +7960,7 @@ components: CIAppAggregateBucketValueTimeseries: description: A timeseries array. items: - $ref: '#/components/schemas/CIAppAggregateBucketValueTimeseriesPoint' + $ref: "#/components/schemas/CIAppAggregateBucketValueTimeseriesPoint" type: array x-generate-alias-as-model: true CIAppAggregateBucketValueTimeseriesPoint: @@ -8216,7 +7968,7 @@ components: properties: time: description: The time value for this point. - example: '2020-06-08T11:55:00.123Z' + example: "2020-06-08T11:55:00.123Z" format: date-time type: string value: @@ -8226,77 +7978,39 @@ components: type: number type: object CIAppAggregateSort: - description: A sort rule. The `aggregation` field is required when `type` is - `measure`. - example: - aggregation: count - order: asc + description: |- + A sort rule. The `aggregation` field is required when `type` is `measure`. + example: {"aggregation": "count", "order": "asc"} properties: aggregation: - $ref: '#/components/schemas/CIAppAggregationFunction' + $ref: "#/components/schemas/CIAppAggregationFunction" metric: description: The metric to sort by (only used for `type=measure`). - example: '@duration' + example: "@duration" type: string order: - $ref: '#/components/schemas/CIAppSortOrder' + $ref: "#/components/schemas/CIAppSortOrder" type: - $ref: '#/components/schemas/CIAppAggregateSortType' + $ref: "#/components/schemas/CIAppAggregateSortType" type: object CIAppAggregateSortType: - default: alphabetical + default: "alphabetical" description: The type of sorting algorithm. - enum: - - alphabetical - - measure + enum: ["alphabetical", "measure"] type: string - x-enum-varnames: - - ALPHABETICAL - - MEASURE + x-enum-varnames: ["ALPHABETICAL", "MEASURE"] CIAppAggregationFunction: description: An aggregation function. - enum: - - count - - cardinality - - pc75 - - pc90 - - pc95 - - pc98 - - pc99 - - sum - - min - - max - - avg - - median - - latest - - earliest - - most_frequent - - delta - example: pc90 - type: string - x-enum-varnames: - - COUNT - - CARDINALITY - - PERCENTILE_75 - - PERCENTILE_90 - - PERCENTILE_95 - - PERCENTILE_98 - - PERCENTILE_99 - - SUM - - MIN - - MAX - - AVG - - MEDIAN - - LATEST - - EARLIEST - - MOST_FREQUENT - - DELTA + enum: ["count", "cardinality", "pc75", "pc90", "pc95", "pc98", "pc99", "sum", "min", "max", "avg", "median", "latest", "earliest", "most_frequent", "delta"] + example: "pc90" + type: string + x-enum-varnames: ["COUNT", "CARDINALITY", "PERCENTILE_75", "PERCENTILE_90", "PERCENTILE_95", "PERCENTILE_98", "PERCENTILE_99", "SUM", "MIN", "MAX", "AVG", "MEDIAN", "LATEST", "EARLIEST", "MOST_FREQUENT", "DELTA"] CIAppCIError: description: Contains information of the CI error. nullable: true properties: domain: - $ref: '#/components/schemas/CIAppCIErrorDomain' + $ref: "#/components/schemas/CIAppCIErrorDomain" message: description: Error message. maxLength: 5000 @@ -8313,58 +8027,46 @@ components: type: string type: object CIAppCIErrorDomain: - description: Error category used to differentiate between issues related to - the developer or provider environments. - enum: - - provider - - user - - unknown + description: Error category used to differentiate between issues related to the developer or provider environments. + enum: [provider, user, unknown] type: string - x-enum-varnames: - - PROVIDER - - USER - - UNKNOWN + x-enum-varnames: ["PROVIDER", "USER", "UNKNOWN"] CIAppCompute: description: A compute rule to compute metrics or timeseries. properties: aggregation: - $ref: '#/components/schemas/CIAppAggregationFunction' + $ref: "#/components/schemas/CIAppAggregationFunction" interval: - description: 'The time buckets'' size (only used for type=timeseries) - - Defaults to a resolution of 150 points.' - example: 5m + description: |- + The time buckets' size (only used for type=timeseries) + Defaults to a resolution of 150 points. + example: "5m" type: string metric: description: The metric to use. - example: '@duration' + example: "@duration" type: string type: - $ref: '#/components/schemas/CIAppComputeType' + $ref: "#/components/schemas/CIAppComputeType" required: - - aggregation + - aggregation type: object CIAppComputeType: - default: total + default: "total" description: The type of compute. - enum: - - timeseries - - total + enum: ["timeseries", "total"] type: string - x-enum-varnames: - - TIMESERIES - - TOTAL + x-enum-varnames: ["TIMESERIES", "TOTAL"] CIAppComputes: additionalProperties: - $ref: '#/components/schemas/CIAppAggregateBucketValue' - description: A map of the metric name to value for regular compute, or a list - of values for a timeseries. + $ref: "#/components/schemas/CIAppAggregateBucketValue" + description: A map of the metric name to value for regular compute, or a list of values for a timeseries. type: object CIAppCreatePipelineEventRequest: description: Request object. properties: data: - $ref: '#/components/schemas/CIAppCreatePipelineEventRequestDataSingleOrArray' + $ref: "#/components/schemas/CIAppCreatePipelineEventRequestDataSingleOrArray" type: object CIAppCreatePipelineEventRequestAttributes: description: Attributes of the pipeline event to create. @@ -8376,70 +8078,63 @@ components: description: The name of the CI provider. By default, this is "custom". type: string resource: - $ref: '#/components/schemas/CIAppCreatePipelineEventRequestAttributesResource' + $ref: "#/components/schemas/CIAppCreatePipelineEventRequestAttributesResource" service: - description: If the CI provider is SaaS, use this to differentiate between - instances. + description: If the CI provider is SaaS, use this to differentiate between instances. type: string required: - - resource + - resource type: object CIAppCreatePipelineEventRequestAttributesResource: description: Details of the CI pipeline event. - example: Details TBD + example: "Details TBD" oneOf: - - $ref: '#/components/schemas/CIAppPipelineEventPipeline' - - $ref: '#/components/schemas/CIAppPipelineEventStage' - - $ref: '#/components/schemas/CIAppPipelineEventJob' - - $ref: '#/components/schemas/CIAppPipelineEventStep' + - $ref: "#/components/schemas/CIAppPipelineEventPipeline" + - $ref: "#/components/schemas/CIAppPipelineEventStage" + - $ref: "#/components/schemas/CIAppPipelineEventJob" + - $ref: "#/components/schemas/CIAppPipelineEventStep" CIAppCreatePipelineEventRequestData: description: Data of the pipeline event to create. properties: attributes: - $ref: '#/components/schemas/CIAppCreatePipelineEventRequestAttributes' + $ref: "#/components/schemas/CIAppCreatePipelineEventRequestAttributes" type: - $ref: '#/components/schemas/CIAppCreatePipelineEventRequestDataType' + $ref: "#/components/schemas/CIAppCreatePipelineEventRequestDataType" type: object CIAppCreatePipelineEventRequestDataArray: description: Array of pipeline events to create in batch. items: - $ref: '#/components/schemas/CIAppCreatePipelineEventRequestData' + $ref: "#/components/schemas/CIAppCreatePipelineEventRequestData" type: array CIAppCreatePipelineEventRequestDataSingleOrArray: description: Data of the pipeline events to create. oneOf: - - $ref: '#/components/schemas/CIAppCreatePipelineEventRequestData' - - $ref: '#/components/schemas/CIAppCreatePipelineEventRequestDataArray' + - $ref: "#/components/schemas/CIAppCreatePipelineEventRequestData" + - $ref: "#/components/schemas/CIAppCreatePipelineEventRequestDataArray" CIAppCreatePipelineEventRequestDataType: default: cipipeline_resource_request description: Type of the event. - enum: - - cipipeline_resource_request - example: cipipeline_resource_request + enum: ["cipipeline_resource_request"] + example: "cipipeline_resource_request" type: string - x-enum-varnames: - - CIPIPELINE_RESOURCE_REQUEST + x-enum-varnames: ["CIPIPELINE_RESOURCE_REQUEST"] CIAppEventAttributes: - description: JSON object containing all event attributes and their associated - values. + description: JSON object containing all event attributes and their associated values. properties: attributes: additionalProperties: {} description: JSON object of attributes from CI Visibility test events. - example: - customAttribute: 123 - duration: 2345 + example: {"customAttribute": 123, "duration": 2345} type: object tags: - $ref: '#/components/schemas/TagsEventAttribute' + $ref: "#/components/schemas/TagsEventAttribute" test_level: - $ref: '#/components/schemas/CIAppTestLevel' + $ref: "#/components/schemas/CIAppTestLevel" type: object CIAppGitInfo: - description: 'If pipelines are triggered due to actions to a Git repository, - then all payloads must contain this. - - Note that either `tag` or `branch` has to be provided, but not both.' + description: |- + If pipelines are triggered due to actions to a Git repository, then all payloads must contain this. + Note that either `tag` or `branch` has to be provided, but not both. nullable: true properties: author_email: @@ -8453,7 +8148,7 @@ components: type: string author_time: description: The commit author timestamp in RFC3339 format. - example: '2023-05-31T15:30:00Z' + example: "2023-05-31T15:30:00Z" nullable: true type: string branch: @@ -8463,7 +8158,7 @@ components: type: string commit_time: description: The commit timestamp in RFC3339 format. - example: '2023-05-31T15:30:00Z' + example: "2023-05-31T15:30:00Z" nullable: true type: string committer_email: @@ -8492,7 +8187,7 @@ components: sha: description: The git commit SHA. example: da39a3ee5e6b4b0d3255bfef95601890afd80709 - pattern: ^[a-fA-F0-9]{40}$ + pattern: "^[a-fA-F0-9]{40}$" type: string tag: description: The tag name (if a branch use the branch parameter). @@ -8500,14 +8195,14 @@ components: nullable: true type: string required: - - repository_url - - sha - - author_email + - repository_url + - sha + - author_email type: object CIAppGroupByHistogram: - description: 'Used to perform a histogram computation (only for measure facets). - - At most, 100 buckets are allowed, the number of buckets is `(max - min)/interval`.' + description: |- + Used to perform a histogram computation (only for measure facets). + At most, 100 buckets are allowed, the number of buckets is `(max - min)/interval`. properties: interval: description: The bin size of the histogram buckets. @@ -8515,29 +8210,29 @@ components: format: double type: number max: - description: 'The maximum value for the measure used in the histogram - - (values greater than this one are filtered out).' + description: |- + The maximum value for the measure used in the histogram + (values greater than this one are filtered out). example: 100 format: double type: number min: - description: 'The minimum value for the measure used in the histogram - - (values smaller than this one are filtered out).' + description: |- + The minimum value for the measure used in the histogram + (values smaller than this one are filtered out). example: 50 format: double type: number required: - - interval - - min - - max + - interval + - min + - max type: object CIAppGroupByMissing: description: The value to use for logs that don't have the facet used to group-by. oneOf: - - $ref: '#/components/schemas/CIAppGroupByMissingString' - - $ref: '#/components/schemas/CIAppGroupByMissingNumber' + - $ref: "#/components/schemas/CIAppGroupByMissingString" + - $ref: "#/components/schemas/CIAppGroupByMissingNumber" CIAppGroupByMissingNumber: description: The missing value to use if there is a number valued facet. format: double @@ -8547,12 +8242,12 @@ components: type: string CIAppGroupByTotal: default: false - description: A resulting object to put the given computes in over all the matching - records. + description: |- + A resulting object to put the given computes in over all the matching records. oneOf: - - $ref: '#/components/schemas/CIAppGroupByTotalBoolean' - - $ref: '#/components/schemas/CIAppGroupByTotalString' - - $ref: '#/components/schemas/CIAppGroupByTotalNumber' + - $ref: "#/components/schemas/CIAppGroupByTotalBoolean" + - $ref: "#/components/schemas/CIAppGroupByTotalString" + - $ref: "#/components/schemas/CIAppGroupByTotalNumber" CIAppGroupByTotalBoolean: description: If set to true, creates an additional bucket labeled "$facet_total". type: boolean @@ -8564,8 +8259,7 @@ components: description: A string to use as the key value for the total bucket. type: string CIAppHostInfo: - description: Contains information of the host running the pipeline, stage, job, - or step. + description: Contains information of the host running the pipeline, stage, job, or step. nullable: true properties: hostname: @@ -8575,8 +8269,8 @@ components: labels: description: A list of labels used to select or identify the node. example: - - ubuntu-18.04 - - n2.large + - ubuntu-18.04 + - n2.large items: type: string type: array @@ -8589,47 +8283,42 @@ components: type: string type: object CIAppPipelineEvent: - description: Object description of a pipeline event after being processed and - stored by Datadog. + description: Object description of a pipeline event after being processed and stored by Datadog. properties: attributes: - $ref: '#/components/schemas/CIAppPipelineEventAttributes' + $ref: "#/components/schemas/CIAppPipelineEventAttributes" id: description: Unique ID of the event. - example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA" type: string type: - $ref: '#/components/schemas/CIAppPipelineEventTypeName' + $ref: "#/components/schemas/CIAppPipelineEventTypeName" type: object CIAppPipelineEventAttributes: - description: JSON object containing all event attributes and their associated - values. + description: JSON object containing all event attributes and their associated values. properties: attributes: additionalProperties: {} description: JSON object of attributes from CI Visibility pipeline events. - example: - customAttribute: 123 - duration: 2345 + example: {"customAttribute": 123, "duration": 2345} type: object ci_level: - $ref: '#/components/schemas/CIAppPipelineLevel' + $ref: "#/components/schemas/CIAppPipelineLevel" tags: - $ref: '#/components/schemas/TagsEventAttribute' + $ref: "#/components/schemas/TagsEventAttribute" type: object CIAppPipelineEventFinishedPipeline: description: Details of a finished pipeline. properties: end: - description: Time when the pipeline run finished. It cannot be older than - 18 hours in the past from the current time. The time format must be RFC3339. - example: '2023-05-31T15:30:00Z' + description: Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339. + example: "2023-05-31T15:30:00Z" format: date-time type: string error: - $ref: '#/components/schemas/CIAppCIError' + $ref: "#/components/schemas/CIAppCIError" git: - $ref: '#/components/schemas/CIAppGitInfo' + $ref: "#/components/schemas/CIAppGitInfo" is_manual: description: Whether or not the pipeline was triggered manually by the user. example: false @@ -8641,37 +8330,33 @@ components: nullable: true type: boolean level: - $ref: '#/components/schemas/CIAppPipelineEventPipelineLevel' + $ref: "#/components/schemas/CIAppPipelineEventPipelineLevel" metrics: - $ref: '#/components/schemas/CIAppPipelineEventMetrics' + $ref: "#/components/schemas/CIAppPipelineEventMetrics" name: - description: Name of the pipeline. All pipeline runs for the builds should - have the same name. + description: Name of the pipeline. All pipeline runs for the builds should have the same name. example: Deploy to AWS type: string node: - $ref: '#/components/schemas/CIAppHostInfo' + $ref: "#/components/schemas/CIAppHostInfo" parameters: - $ref: '#/components/schemas/CIAppPipelineEventParameters' + $ref: "#/components/schemas/CIAppPipelineEventParameters" parent_pipeline: - $ref: '#/components/schemas/CIAppPipelineEventParentPipeline' + $ref: "#/components/schemas/CIAppPipelineEventParentPipeline" partial_retry: - description: 'Whether or not the pipeline was a partial retry of a previous - attempt. A partial retry is one - - which only runs a subset of the original jobs.' + description: |- + Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one + which only runs a subset of the original jobs. example: false type: boolean pipeline_id: - description: 'Any ID used in the provider to identify the pipeline run even - if it is not unique across retries. - - If the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` - can be set to the same value.' - example: '#023' + description: |- + Any ID used in the provider to identify the pipeline run even if it is not unique across retries. + If the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value. + example: "#023" type: string previous_attempt: - $ref: '#/components/schemas/CIAppPipelineEventPreviousPipeline' + $ref: "#/components/schemas/CIAppPipelineEventPreviousPipeline" queue_time: description: The queue time in milliseconds, if applicable. example: 1004 @@ -8680,43 +8365,41 @@ components: nullable: true type: integer start: - description: Time when the pipeline run started (it should not include any - queue time). The time format must be RFC3339. - example: '2023-05-31T15:30:00Z' + description: Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339. + example: "2023-05-31T15:30:00Z" format: date-time type: string status: - $ref: '#/components/schemas/CIAppPipelineEventPipelineStatus' + $ref: "#/components/schemas/CIAppPipelineEventPipelineStatus" tags: - $ref: '#/components/schemas/CIAppPipelineEventTags' + $ref: "#/components/schemas/CIAppPipelineEventTags" unique_id: - description: 'UUID of the pipeline run. The ID has to be unique across retries - and pipelines, - - including partial retries.' - example: 3eacb6f3-ff04-4e10-8a9c-46e6d054024a + description: |- + UUID of the pipeline run. The ID has to be unique across retries and pipelines, + including partial retries. + example: "3eacb6f3-ff04-4e10-8a9c-46e6d054024a" type: string url: description: The URL to look at the pipeline in the CI provider UI. example: https://my-ci-provider.example/pipelines/my-pipeline/run/1 type: string required: - - level - - unique_id - - name - - url - - start - - end - - status - - partial_retry + - level + - unique_id + - name + - url + - start + - end + - status + - partial_retry type: object CIAppPipelineEventInProgressPipeline: description: Details of a running pipeline. properties: error: - $ref: '#/components/schemas/CIAppCIError' + $ref: "#/components/schemas/CIAppCIError" git: - $ref: '#/components/schemas/CIAppGitInfo' + $ref: "#/components/schemas/CIAppGitInfo" is_manual: description: Whether or not the pipeline was triggered manually by the user. example: false @@ -8728,37 +8411,33 @@ components: nullable: true type: boolean level: - $ref: '#/components/schemas/CIAppPipelineEventPipelineLevel' + $ref: "#/components/schemas/CIAppPipelineEventPipelineLevel" metrics: - $ref: '#/components/schemas/CIAppPipelineEventMetrics' + $ref: "#/components/schemas/CIAppPipelineEventMetrics" name: - description: Name of the pipeline. All pipeline runs for the builds should - have the same name. + description: Name of the pipeline. All pipeline runs for the builds should have the same name. example: Deploy to AWS type: string node: - $ref: '#/components/schemas/CIAppHostInfo' + $ref: "#/components/schemas/CIAppHostInfo" parameters: - $ref: '#/components/schemas/CIAppPipelineEventParameters' + $ref: "#/components/schemas/CIAppPipelineEventParameters" parent_pipeline: - $ref: '#/components/schemas/CIAppPipelineEventParentPipeline' + $ref: "#/components/schemas/CIAppPipelineEventParentPipeline" partial_retry: - description: 'Whether or not the pipeline was a partial retry of a previous - attempt. A partial retry is one - - which only runs a subset of the original jobs.' + description: |- + Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one + which only runs a subset of the original jobs. example: false type: boolean pipeline_id: - description: 'Any ID used in the provider to identify the pipeline run even - if it is not unique across retries. - - If the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` - can be set to the same value.' - example: '#023' + description: |- + Any ID used in the provider to identify the pipeline run even if it is not unique across retries. + If the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value. + example: "#023" type: string previous_attempt: - $ref: '#/components/schemas/CIAppPipelineEventPreviousPipeline' + $ref: "#/components/schemas/CIAppPipelineEventPreviousPipeline" queue_time: description: The queue time in milliseconds, if applicable. example: 1004 @@ -8767,41 +8446,38 @@ components: nullable: true type: integer start: - description: Time when the pipeline run started (it should not include any - queue time). The time format must be RFC3339. - example: '2023-05-31T15:30:00Z' + description: Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339. + example: "2023-05-31T15:30:00Z" format: date-time type: string status: - $ref: '#/components/schemas/CIAppPipelineEventPipelineInProgressStatus' + $ref: "#/components/schemas/CIAppPipelineEventPipelineInProgressStatus" tags: - $ref: '#/components/schemas/CIAppPipelineEventTags' + $ref: "#/components/schemas/CIAppPipelineEventTags" unique_id: - description: UUID of the pipeline run. The ID has to be the same as the - finished pipeline. - example: 3eacb6f3-ff04-4e10-8a9c-46e6d054024a + description: |- + UUID of the pipeline run. The ID has to be the same as the finished pipeline. + example: "3eacb6f3-ff04-4e10-8a9c-46e6d054024a" type: string url: description: The URL to look at the pipeline in the CI provider UI. example: https://my-ci-provider.example/pipelines/my-pipeline/run/1 type: string required: - - level - - unique_id - - name - - url - - start - - status - - partial_retry + - level + - unique_id + - name + - url + - start + - status + - partial_retry type: object CIAppPipelineEventJob: description: Details of a CI job. properties: dependencies: description: A list of job IDs that this job depends on. - example: - - f7e6a006-a029-46c3-b0cc-742c9d7d363b - - c8a69849-3c3b-4721-8b33-3e8ec2df1ebe + example: ["f7e6a006-a029-46c3-b0cc-742c9d7d363b", "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe"] items: description: A list of job IDs. type: string @@ -8809,37 +8485,36 @@ components: type: array end: description: Time when the job run finished. The time format must be RFC3339. - example: '2023-05-31T15:30:00Z' + example: "2023-05-31T15:30:00Z" format: date-time type: string error: - $ref: '#/components/schemas/CIAppCIError' + $ref: "#/components/schemas/CIAppCIError" git: - $ref: '#/components/schemas/CIAppGitInfo' + $ref: "#/components/schemas/CIAppGitInfo" id: - description: The UUID for the job. It has to be unique within each pipeline - execution. + description: The UUID for the job. It has to be unique within each pipeline execution. example: c865bad4-de82-44b8-ade7-2c987528eb54 type: string level: - $ref: '#/components/schemas/CIAppPipelineEventJobLevel' + $ref: "#/components/schemas/CIAppPipelineEventJobLevel" metrics: - $ref: '#/components/schemas/CIAppPipelineEventMetrics' + $ref: "#/components/schemas/CIAppPipelineEventMetrics" name: description: The name for the job. example: test type: string node: - $ref: '#/components/schemas/CIAppHostInfo' + $ref: "#/components/schemas/CIAppHostInfo" parameters: - $ref: '#/components/schemas/CIAppPipelineEventParameters' + $ref: "#/components/schemas/CIAppPipelineEventParameters" pipeline_name: description: The parent pipeline name. example: Build type: string pipeline_unique_id: description: The parent pipeline UUID. - example: 76b572af-a078-42b2-a08a-cc28f98b944f + example: "76b572af-a078-42b2-a08a-cc28f98b944f" type: string queue_time: description: The queue time in milliseconds, if applicable. @@ -8857,59 +8532,47 @@ components: nullable: true type: string start: - description: Time when the job run instance started (it should not include - any queue time). The time format must be RFC3339. - example: '2023-05-31T15:30:00Z' + description: Time when the job run instance started (it should not include any queue time). The time format must be RFC3339. + example: "2023-05-31T15:30:00Z" format: date-time type: string status: - $ref: '#/components/schemas/CIAppPipelineEventJobStatus' + $ref: "#/components/schemas/CIAppPipelineEventJobStatus" tags: - $ref: '#/components/schemas/CIAppPipelineEventTags' + $ref: "#/components/schemas/CIAppPipelineEventTags" url: description: The URL to look at the job in the CI provider UI. example: https://ci-platform.com/job/your-job-name/build/123 type: string required: - - level - - id - - name - - pipeline_unique_id - - pipeline_name - - start - - end - - status - - url + - level + - id + - name + - pipeline_unique_id + - pipeline_name + - start + - end + - status + - url type: object CIAppPipelineEventJobLevel: default: job description: Used to distinguish between pipelines, stages, jobs, and steps. - enum: - - job - example: job + enum: ["job"] + example: "job" type: string - x-enum-varnames: - - JOB + x-enum-varnames: ["JOB"] CIAppPipelineEventJobStatus: description: The final status of the job. - enum: - - success - - error - - canceled - - skipped + enum: ["success", "error", "canceled", "skipped"] example: success type: string - x-enum-varnames: - - SUCCESS - - ERROR - - CANCELED - - SKIPPED + x-enum-varnames: ["SUCCESS", "ERROR", "CANCELED", "SKIPPED"] CIAppPipelineEventMetrics: - description: A list of user-defined metrics. The metrics must follow the `key:value` - pattern and the value must be numeric. + description: A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric. example: - - bundle_size:370 - - build_time:50021 + - bundle_size:370 + - build_time:50021 items: description: Metrics in the form of `key:value`. The value needs to be numeric. type: string @@ -8918,15 +8581,13 @@ components: CIAppPipelineEventParameters: additionalProperties: type: string - description: A map of key-value parameters or environment variables that were - defined for the pipeline. + description: A map of key-value parameters or environment variables that were defined for the pipeline. example: LOG_LEVEL: debug nullable: true type: object CIAppPipelineEventParentPipeline: - description: If the pipeline is triggered as child of another pipeline, this - should contain the details of the parent pipeline. + description: If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline. nullable: true properties: id: @@ -8938,49 +8599,34 @@ components: example: https://ci-platform.com/pipelines/123456789 type: string required: - - id + - id type: object CIAppPipelineEventPipeline: description: Details of the top level pipeline, build, or workflow of your CI. oneOf: - - $ref: '#/components/schemas/CIAppPipelineEventFinishedPipeline' - - $ref: '#/components/schemas/CIAppPipelineEventInProgressPipeline' + - $ref: "#/components/schemas/CIAppPipelineEventFinishedPipeline" + - $ref: "#/components/schemas/CIAppPipelineEventInProgressPipeline" CIAppPipelineEventPipelineInProgressStatus: description: The in progress status of the pipeline. - enum: - - running + enum: ["running"] example: running type: string - x-enum-varnames: - - RUNNING + x-enum-varnames: ["RUNNING"] CIAppPipelineEventPipelineLevel: default: pipeline description: Used to distinguish between pipelines, stages, jobs, and steps. - enum: - - pipeline - example: pipeline + enum: ["pipeline"] + example: "pipeline" type: string - x-enum-varnames: - - PIPELINE + x-enum-varnames: ["PIPELINE"] CIAppPipelineEventPipelineStatus: description: The final status of the pipeline. - enum: - - success - - error - - canceled - - skipped - - blocked + enum: ["success", "error", "canceled", "skipped", "blocked"] example: success type: string - x-enum-varnames: - - SUCCESS - - ERROR - - CANCELED - - SKIPPED - - BLOCKED + x-enum-varnames: ["SUCCESS", "ERROR", "CANCELED", "SKIPPED", "BLOCKED"] CIAppPipelineEventPreviousPipeline: - description: If the pipeline is a retry, this should contain the details of - the previous attempt. + description: If the pipeline is a retry, this should contain the details of the previous attempt. nullable: true properties: id: @@ -8992,16 +8638,14 @@ components: example: https://ci-platform.com/pipelines/123456789 type: string required: - - id + - id type: object CIAppPipelineEventStage: description: Details of a CI stage. properties: dependencies: description: A list of stage IDs that this stage depends on. - example: - - f7e6a006-a029-46c3-b0cc-742c9d7d363b - - c8a69849-3c3b-4721-8b33-3e8ec2df1ebe + example: ["f7e6a006-a029-46c3-b0cc-742c9d7d363b", "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe"] items: description: A list of stage IDs. type: string @@ -9009,37 +8653,36 @@ components: type: array end: description: Time when the stage run finished. The time format must be RFC3339. - example: '2023-05-31T15:30:00Z' + example: "2023-05-31T15:30:00Z" format: date-time type: string error: - $ref: '#/components/schemas/CIAppCIError' + $ref: "#/components/schemas/CIAppCIError" git: - $ref: '#/components/schemas/CIAppGitInfo' + $ref: "#/components/schemas/CIAppGitInfo" id: - description: UUID for the stage. It has to be unique at least in the pipeline - scope. + description: UUID for the stage. It has to be unique at least in the pipeline scope. example: 562bdbbb-7cab-48c8-851c-b24ca14628bf type: string level: - $ref: '#/components/schemas/CIAppPipelineEventStageLevel' + $ref: "#/components/schemas/CIAppPipelineEventStageLevel" metrics: - $ref: '#/components/schemas/CIAppPipelineEventMetrics' + $ref: "#/components/schemas/CIAppPipelineEventMetrics" name: description: The name for the stage. example: build type: string node: - $ref: '#/components/schemas/CIAppHostInfo' + $ref: "#/components/schemas/CIAppHostInfo" parameters: - $ref: '#/components/schemas/CIAppPipelineEventParameters' + $ref: "#/components/schemas/CIAppPipelineEventParameters" pipeline_name: description: The parent pipeline name. example: Build type: string pipeline_unique_id: description: The parent pipeline UUID. - example: 76b572af-a078-42b2-a08a-cc28f98b944f + example: "76b572af-a078-42b2-a08a-cc28f98b944f" type: string queue_time: description: The queue time in milliseconds, if applicable. @@ -9049,63 +8692,51 @@ components: nullable: true type: integer start: - description: Time when the stage run started (it should not include any - queue time). The time format must be RFC3339. - example: '2023-05-31T15:30:00Z' + description: Time when the stage run started (it should not include any queue time). The time format must be RFC3339. + example: "2023-05-31T15:30:00Z" format: date-time type: string status: - $ref: '#/components/schemas/CIAppPipelineEventStageStatus' + $ref: "#/components/schemas/CIAppPipelineEventStageStatus" tags: - $ref: '#/components/schemas/CIAppPipelineEventTags' + $ref: "#/components/schemas/CIAppPipelineEventTags" required: - - level - - id - - name - - pipeline_unique_id - - pipeline_name - - start - - end - - status + - level + - id + - name + - pipeline_unique_id + - pipeline_name + - start + - end + - status type: object CIAppPipelineEventStageLevel: default: stage description: Used to distinguish between pipelines, stages, jobs and steps. - enum: - - stage - example: stage + enum: ["stage"] + example: "stage" type: string - x-enum-varnames: - - STAGE + x-enum-varnames: ["STAGE"] CIAppPipelineEventStageStatus: description: The final status of the stage. - enum: - - success - - error - - canceled - - skipped + enum: ["success", "error", "canceled", "skipped"] example: success type: string - x-enum-varnames: - - SUCCESS - - ERROR - - CANCELED - - SKIPPED + x-enum-varnames: ["SUCCESS", "ERROR", "CANCELED", "SKIPPED"] CIAppPipelineEventStep: description: Details of a CI step. properties: end: description: Time when the step run finished. The time format must be RFC3339. - example: '2023-05-31T15:30:00Z' + example: "2023-05-31T15:30:00Z" format: date-time type: string error: - $ref: '#/components/schemas/CIAppCIError' + $ref: "#/components/schemas/CIAppCIError" git: - $ref: '#/components/schemas/CIAppGitInfo' + $ref: "#/components/schemas/CIAppGitInfo" id: - description: UUID for the step. It has to be unique within each pipeline - execution. + description: UUID for the step. It has to be unique within each pipeline execution. example: c2d517a8-4f3a-4b41-b4ae-69df0c864c79 type: string job_id: @@ -9117,24 +8748,24 @@ components: nullable: true type: string level: - $ref: '#/components/schemas/CIAppPipelineEventStepLevel' + $ref: "#/components/schemas/CIAppPipelineEventStepLevel" metrics: - $ref: '#/components/schemas/CIAppPipelineEventMetrics' + $ref: "#/components/schemas/CIAppPipelineEventMetrics" name: description: The name for the step. example: test-server type: string node: - $ref: '#/components/schemas/CIAppHostInfo' + $ref: "#/components/schemas/CIAppHostInfo" parameters: - $ref: '#/components/schemas/CIAppPipelineEventParameters' + $ref: "#/components/schemas/CIAppPipelineEventParameters" pipeline_name: description: The parent pipeline name. example: Build type: string pipeline_unique_id: description: The parent pipeline UUID. - example: 76b572af-a078-42b2-a08a-cc28f98b944f + example: "76b572af-a078-42b2-a08a-cc28f98b944f" type: string stage_id: description: The parent stage UUID (if applicable). @@ -9146,52 +8777,45 @@ components: type: string start: description: Time when the step run started. The time format must be RFC3339. - example: '2023-05-31T15:30:00Z' + example: "2023-05-31T15:30:00Z" format: date-time type: string status: - $ref: '#/components/schemas/CIAppPipelineEventStepStatus' + $ref: "#/components/schemas/CIAppPipelineEventStepStatus" tags: - $ref: '#/components/schemas/CIAppPipelineEventTags' + $ref: "#/components/schemas/CIAppPipelineEventTags" url: description: The URL to look at the step in the CI provider UI. nullable: true type: string required: - - level - - id - - name - - pipeline_unique_id - - pipeline_name - - start - - end - - status + - level + - id + - name + - pipeline_unique_id + - pipeline_name + - start + - end + - status type: object CIAppPipelineEventStepLevel: default: step description: Used to distinguish between pipelines, stages, jobs and steps. - enum: - - step - example: step + enum: ["step"] + example: "step" type: string - x-enum-varnames: - - STEP + x-enum-varnames: ["STEP"] CIAppPipelineEventStepStatus: description: The final status of the step. - enum: - - success - - error + enum: ["success", "error"] example: success type: string - x-enum-varnames: - - SUCCESS - - ERROR + x-enum-varnames: ["SUCCESS", "ERROR"] CIAppPipelineEventTags: - description: A list of user-defined tags. The tags must follow the `key:value` - pattern. + description: A list of user-defined tags. The tags must follow the `key:value` pattern. example: - - team:backend - - type:deployment + - team:backend + - type:deployment items: description: Tags in the form of `key:value`. type: string @@ -9199,73 +8823,58 @@ components: type: array CIAppPipelineEventTypeName: description: Type of the event. - enum: - - cipipeline - example: cipipeline + enum: ["cipipeline"] + example: "cipipeline" type: string - x-enum-varnames: - - CIPIPELINE + x-enum-varnames: ["CIPIPELINE"] CIAppPipelineEventsRequest: description: The request for a pipelines search. properties: filter: - $ref: '#/components/schemas/CIAppPipelinesQueryFilter' + $ref: "#/components/schemas/CIAppPipelinesQueryFilter" options: - $ref: '#/components/schemas/CIAppQueryOptions' + $ref: "#/components/schemas/CIAppQueryOptions" page: - $ref: '#/components/schemas/CIAppQueryPageOptions' + $ref: "#/components/schemas/CIAppQueryPageOptions" sort: - $ref: '#/components/schemas/CIAppSort' + $ref: "#/components/schemas/CIAppSort" type: object CIAppPipelineEventsResponse: - description: Response object with all pipeline events matching the request and - pagination information. + description: Response object with all pipeline events matching the request and pagination information. properties: data: description: Array of events matching the request. items: - $ref: '#/components/schemas/CIAppPipelineEvent' + $ref: "#/components/schemas/CIAppPipelineEvent" type: array links: - $ref: '#/components/schemas/CIAppResponseLinks' + $ref: "#/components/schemas/CIAppResponseLinks" meta: - $ref: '#/components/schemas/CIAppResponseMetadataWithPagination' + $ref: "#/components/schemas/CIAppResponseMetadataWithPagination" type: object CIAppPipelineLevel: description: Pipeline execution level. - enum: - - pipeline - - stage - - job - - step - - custom + enum: [pipeline, stage, job, step, custom] example: pipeline type: string - x-enum-varnames: - - PIPELINE - - STAGE - - JOB - - STEP - - CUSTOM + x-enum-varnames: ["PIPELINE", "STAGE", "JOB", "STEP", "CUSTOM"] CIAppPipelinesAggregateRequest: - description: The object sent with the request to retrieve aggregation buckets - of pipeline events from your organization. + description: The object sent with the request to retrieve aggregation buckets of pipeline events from your organization. properties: compute: - description: The list of metrics or timeseries to compute for the retrieved - buckets. + description: The list of metrics or timeseries to compute for the retrieved buckets. items: - $ref: '#/components/schemas/CIAppCompute' + $ref: "#/components/schemas/CIAppCompute" type: array filter: - $ref: '#/components/schemas/CIAppPipelinesQueryFilter' + $ref: "#/components/schemas/CIAppPipelinesQueryFilter" group_by: description: The rules for the group-by. items: - $ref: '#/components/schemas/CIAppPipelinesGroupBy' + $ref: "#/components/schemas/CIAppPipelinesGroupBy" type: array options: - $ref: '#/components/schemas/CIAppQueryOptions' + $ref: "#/components/schemas/CIAppQueryOptions" type: object CIAppPipelinesAggregationBucketsResponse: description: The query results. @@ -9273,18 +8882,18 @@ components: buckets: description: The list of matching buckets, one item per bucket. items: - $ref: '#/components/schemas/CIAppPipelinesBucketResponse' + $ref: "#/components/schemas/CIAppPipelinesBucketResponse" type: array type: object CIAppPipelinesAnalyticsAggregateResponse: description: The response object for the pipeline events aggregate API endpoint. properties: data: - $ref: '#/components/schemas/CIAppPipelinesAggregationBucketsResponse' + $ref: "#/components/schemas/CIAppPipelinesAggregationBucketsResponse" links: - $ref: '#/components/schemas/CIAppResponseLinks' + $ref: "#/components/schemas/CIAppResponseLinks" meta: - $ref: '#/components/schemas/CIAppResponseMetadata' + $ref: "#/components/schemas/CIAppResponseMetadata" type: object CIAppPipelinesBucketResponse: description: Bucket values. @@ -9293,81 +8902,76 @@ components: additionalProperties: description: The values for each group-by. description: The key-value pairs for each group-by. - example: - '@ci.provider.name': gitlab - '@ci.status': success + example: {"@ci.provider.name": "gitlab", "@ci.status": "success"} type: object computes: - $ref: '#/components/schemas/CIAppComputes' + $ref: "#/components/schemas/CIAppComputes" type: object CIAppPipelinesGroupBy: description: A group-by rule. properties: facet: description: The name of the facet to use (required). - example: '@ci.status' + example: "@ci.status" type: string histogram: - $ref: '#/components/schemas/CIAppGroupByHistogram' + $ref: "#/components/schemas/CIAppGroupByHistogram" limit: default: 10 description: The maximum buckets to return for this group-by. format: int64 type: integer missing: - $ref: '#/components/schemas/CIAppGroupByMissing' + $ref: "#/components/schemas/CIAppGroupByMissing" sort: - $ref: '#/components/schemas/CIAppAggregateSort' + $ref: "#/components/schemas/CIAppAggregateSort" total: - $ref: '#/components/schemas/CIAppGroupByTotal' + $ref: "#/components/schemas/CIAppGroupByTotal" required: - - facet + - facet type: object CIAppPipelinesQueryFilter: description: The search and filter query settings. properties: from: - default: now-15m - description: The minimum time for the requested events; supports date, math, - and regular timestamps (in milliseconds). - example: now-15m + default: "now-15m" + description: The minimum time for the requested events; supports date, math, and regular timestamps (in milliseconds). + example: "now-15m" type: string query: - default: '*' - description: The search query following the CI Visibility Explorer search - syntax. - example: '@ci.provider.name:github AND @ci.status:error' + default: "*" + description: The search query following the CI Visibility Explorer search syntax. + example: "@ci.provider.name:github AND @ci.status:error" type: string to: - default: now - description: The maximum time for the requested events, supports date, math, - and regular timestamps (in milliseconds). - example: now + default: "now" + description: The maximum time for the requested events, supports date, math, and regular timestamps (in milliseconds). + example: "now" type: string type: object CIAppQueryOptions: - description: 'Global query options that are used during the query. - - Only supply timezone or time offset, not both. Otherwise, the query fails.' + description: |- + Global query options that are used during the query. + Only supply timezone or time offset, not both. Otherwise, the query fails. properties: time_offset: description: The time offset (in seconds) to apply to the query. format: int64 type: integer timezone: - default: UTC - description: The timezone can be specified as GMT, UTC, an offset from UTC - (like UTC+1), or as a Timezone Database identifier (like America/New_York). - example: GMT + default: "UTC" + description: |- + The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York). + example: "GMT" type: string type: object CIAppQueryPageOptions: description: Paging attributes for listing events. properties: cursor: - description: List following results with a cursor provided in the previous - query. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + List following results with a cursor provided in the previous query. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string limit: default: 10 @@ -9381,11 +8985,10 @@ components: description: Links attributes. properties: next: - description: 'Link for the next set of results. The request can also be - made using the - - POST endpoint.' - example: https://app.datadoghq.com/api/v2/ci/tests/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + Link for the next set of results. The request can also be made using the + POST endpoint. + example: "https://app.datadoghq.com/api/v2/ci/tests/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string type: object CIAppResponseMetadata: @@ -9398,17 +9001,16 @@ components: type: integer request_id: description: The identifier of the request. - example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR + example: "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR" type: string status: - $ref: '#/components/schemas/CIAppResponseStatus' + $ref: "#/components/schemas/CIAppResponseStatus" warnings: - description: 'A list of warnings (non-fatal errors) encountered. Partial - results may return if - - warnings are present in the response.' + description: |- + A list of warnings (non-fatal errors) encountered. Partial results may return if + warnings are present in the response. items: - $ref: '#/components/schemas/CIAppWarning' + $ref: "#/components/schemas/CIAppWarning" type: array type: object CIAppResponseMetadataWithPagination: @@ -9420,140 +9022,121 @@ components: format: int64 type: integer page: - $ref: '#/components/schemas/CIAppResponsePage' + $ref: "#/components/schemas/CIAppResponsePage" request_id: description: The identifier of the request. - example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR + example: "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR" type: string status: - $ref: '#/components/schemas/CIAppResponseStatus' + $ref: "#/components/schemas/CIAppResponseStatus" warnings: - description: 'A list of warnings (non-fatal errors) encountered. Partial - results may return if - - warnings are present in the response.' + description: |- + A list of warnings (non-fatal errors) encountered. Partial results may return if + warnings are present in the response. items: - $ref: '#/components/schemas/CIAppWarning' + $ref: "#/components/schemas/CIAppWarning" type: array type: object CIAppResponsePage: description: Paging attributes. properties: after: - description: The cursor to use to get the next results, if any. To make - the next request, use the same parameters with the addition of `page[cursor]`. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string type: object CIAppResponseStatus: description: The status of the response. - enum: - - done - - timeout - example: done + enum: ["done", "timeout"] + example: "done" type: string - x-enum-varnames: - - DONE - - TIMEOUT + x-enum-varnames: ["DONE", "TIMEOUT"] CIAppSort: description: Sort parameters when querying events. enum: - - timestamp - - -timestamp + - timestamp + - -timestamp type: string x-enum-varnames: - - TIMESTAMP_ASCENDING - - TIMESTAMP_DESCENDING + - TIMESTAMP_ASCENDING + - TIMESTAMP_DESCENDING CIAppSortOrder: description: The order to use, ascending or descending. enum: - - asc - - desc - example: asc + - "asc" + - "desc" + example: "asc" type: string x-enum-varnames: - - ASCENDING - - DESCENDING + - "ASCENDING" + - "DESCENDING" CIAppTestEvent: - description: Object description of test event after being processed and stored - by Datadog. + description: Object description of test event after being processed and stored by Datadog. properties: attributes: - $ref: '#/components/schemas/CIAppEventAttributes' + $ref: "#/components/schemas/CIAppEventAttributes" id: description: Unique ID of the event. - example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA" type: string type: - $ref: '#/components/schemas/CIAppTestEventTypeName' + $ref: "#/components/schemas/CIAppTestEventTypeName" type: object CIAppTestEventTypeName: description: Type of the event. - enum: - - citest - example: citest + enum: ["citest"] + example: "citest" type: string - x-enum-varnames: - - CITEST + x-enum-varnames: ["CITEST"] CIAppTestEventsRequest: description: The request for a tests search. properties: filter: - $ref: '#/components/schemas/CIAppTestsQueryFilter' + $ref: "#/components/schemas/CIAppTestsQueryFilter" options: - $ref: '#/components/schemas/CIAppQueryOptions' + $ref: "#/components/schemas/CIAppQueryOptions" page: - $ref: '#/components/schemas/CIAppQueryPageOptions' + $ref: "#/components/schemas/CIAppQueryPageOptions" sort: - $ref: '#/components/schemas/CIAppSort' + $ref: "#/components/schemas/CIAppSort" type: object CIAppTestEventsResponse: - description: Response object with all test events matching the request and pagination - information. + description: Response object with all test events matching the request and pagination information. properties: data: description: Array of events matching the request. items: - $ref: '#/components/schemas/CIAppTestEvent' + $ref: "#/components/schemas/CIAppTestEvent" type: array links: - $ref: '#/components/schemas/CIAppResponseLinks' + $ref: "#/components/schemas/CIAppResponseLinks" meta: - $ref: '#/components/schemas/CIAppResponseMetadataWithPagination' + $ref: "#/components/schemas/CIAppResponseMetadataWithPagination" type: object CIAppTestLevel: description: Test run level. - enum: - - session - - module - - suite - - test + enum: [session, module, suite, test] example: test type: string - x-enum-varnames: - - SESSION - - MODULE - - SUITE - - TEST + x-enum-varnames: ["SESSION", "MODULE", "SUITE", "TEST"] CIAppTestsAggregateRequest: - description: The object sent with the request to retrieve aggregation buckets - of test events from your organization. + description: The object sent with the request to retrieve aggregation buckets of test events from your organization. properties: compute: - description: The list of metrics or timeseries to compute for the retrieved - buckets. + description: The list of metrics or timeseries to compute for the retrieved buckets. items: - $ref: '#/components/schemas/CIAppCompute' + $ref: "#/components/schemas/CIAppCompute" type: array filter: - $ref: '#/components/schemas/CIAppTestsQueryFilter' + $ref: "#/components/schemas/CIAppTestsQueryFilter" group_by: description: The rules for the group-by. items: - $ref: '#/components/schemas/CIAppTestsGroupBy' + $ref: "#/components/schemas/CIAppTestsGroupBy" type: array options: - $ref: '#/components/schemas/CIAppQueryOptions' + $ref: "#/components/schemas/CIAppQueryOptions" type: object CIAppTestsAggregationBucketsResponse: description: The query results. @@ -9561,18 +9144,18 @@ components: buckets: description: The list of matching buckets, one item per bucket. items: - $ref: '#/components/schemas/CIAppTestsBucketResponse' + $ref: "#/components/schemas/CIAppTestsBucketResponse" type: array type: object CIAppTestsAnalyticsAggregateResponse: description: The response object for the test events aggregate API endpoint. properties: data: - $ref: '#/components/schemas/CIAppTestsAggregationBucketsResponse' + $ref: "#/components/schemas/CIAppTestsAggregationBucketsResponse" links: - $ref: '#/components/schemas/CIAppResponseLinks' + $ref: "#/components/schemas/CIAppResponseLinks" meta: - $ref: '#/components/schemas/CIAppResponseMetadataWithPagination' + $ref: "#/components/schemas/CIAppResponseMetadataWithPagination" type: object CIAppTestsBucketResponse: description: Bucket values. @@ -9581,74 +9164,67 @@ components: additionalProperties: description: The values for each group-by. description: The key-value pairs for each group-by. - example: - '@test.service': web-ui-tests - '@test.status': skip + example: {"@test.service": "web-ui-tests", "@test.status": "skip"} type: object computes: - $ref: '#/components/schemas/CIAppComputes' + $ref: "#/components/schemas/CIAppComputes" type: object CIAppTestsGroupBy: description: A group-by rule. properties: facet: description: The name of the facet to use (required). - example: '@test.service' + example: "@test.service" type: string histogram: - $ref: '#/components/schemas/CIAppGroupByHistogram' + $ref: "#/components/schemas/CIAppGroupByHistogram" limit: default: 10 description: The maximum buckets to return for this group-by. format: int64 type: integer missing: - $ref: '#/components/schemas/CIAppGroupByMissing' + $ref: "#/components/schemas/CIAppGroupByMissing" sort: - $ref: '#/components/schemas/CIAppAggregateSort' + $ref: "#/components/schemas/CIAppAggregateSort" total: - $ref: '#/components/schemas/CIAppGroupByTotal' + $ref: "#/components/schemas/CIAppGroupByTotal" required: - - facet + - facet type: object CIAppTestsQueryFilter: description: The search and filter query settings. properties: from: - default: now-15m - description: The minimum time for the requested events; supports date, math, - and regular timestamps (in milliseconds). - example: now-15m + default: "now-15m" + description: The minimum time for the requested events; supports date, math, and regular timestamps (in milliseconds). + example: "now-15m" type: string query: - default: '*' - description: The search query following the CI Visibility Explorer search - syntax. - example: '@test.service:web-ui-tests AND @test.status:fail' + default: "*" + description: The search query following the CI Visibility Explorer search syntax. + example: "@test.service:web-ui-tests AND @test.status:fail" type: string to: - default: now - description: The maximum time for the requested events, supports date, math, - and regular timestamps (in milliseconds). - example: now + default: "now" + description: The maximum time for the requested events, supports date, math, and regular timestamps (in milliseconds). + example: "now" type: string type: object CIAppWarning: - description: A warning message indicating something that went wrong with the - query. + description: A warning message indicating something that went wrong with the query. properties: code: description: A unique code for this type of warning. - example: unknown_index + example: "unknown_index" type: string detail: description: A detailed explanation of this specific warning. - example: 'indexes: foo, bar' + example: "indexes: foo, bar" type: string title: description: A short human-readable summary of the warning. - example: One or several indexes are missing or invalid, results hold data - from the other indexes + example: "One or several indexes are missing or invalid, results hold data from the other indexes" type: string type: object CSMAgentsMetadata: @@ -9674,11 +9250,10 @@ components: default: datadog_agent description: The type of the resource. The value should always be `datadog_agent`. enum: - - datadog_agent + - datadog_agent example: datadog_agent type: string - x-enum-varnames: - - DATADOG_AGENT + x-enum-varnames: ["DATADOG_AGENT"] CVSS: description: Vulnerability severity. properties: @@ -9688,99 +9263,99 @@ components: format: double type: number severity: - $ref: '#/components/schemas/VulnerabilitySeverity' + $ref: "#/components/schemas/VulnerabilitySeverity" vector: description: Vulnerability CVSS vector. - example: CVSS:3.0/AV:L/AC:L/PR:L/UI:N/S:U/C:N/I:N/A:H + example: "CVSS:3.0/AV:L/AC:L/PR:L/UI:N/S:U/C:N/I:N/A:H" type: string required: - - score - - severity - - vector + - score + - severity + - vector type: object CalculatedField: description: Calculated field. properties: expression: description: Expression. - example: '@request_end_timestamp - @request_start_timestamp' + example: "@request_end_timestamp - @request_start_timestamp" type: string name: description: Field name. example: response_time type: string required: - - name - - expression + - name + - expression type: object CancelDataDeletionResponseBody: description: The response from the cancel data deletion request endpoint. properties: data: - $ref: '#/components/schemas/DataDeletionResponseItem' + $ref: "#/components/schemas/DataDeletionResponseItem" meta: - $ref: '#/components/schemas/DataDeletionResponseMeta' + $ref: "#/components/schemas/DataDeletionResponseMeta" type: object Case: description: A case properties: attributes: - $ref: '#/components/schemas/CaseAttributes' + $ref: "#/components/schemas/CaseAttributes" id: description: Case's identifier - example: aeadc05e-98a8-11ec-ac2c-da7ad0900001 + example: "aeadc05e-98a8-11ec-ac2c-da7ad0900001" type: string relationships: - $ref: '#/components/schemas/CaseRelationships' + $ref: "#/components/schemas/CaseRelationships" type: - $ref: '#/components/schemas/CaseResourceType' + $ref: "#/components/schemas/CaseResourceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object Case3rdPartyTicketStatus: default: IN_PROGRESS description: Case status enum: - - IN_PROGRESS - - COMPLETED - - FAILED + - IN_PROGRESS + - COMPLETED + - FAILED example: COMPLETED readOnly: true type: string x-enum-varnames: - - IN_PROGRESS - - COMPLETED - - FAILED + - IN_PROGRESS + - COMPLETED + - FAILED CaseAssign: description: Case assign properties: attributes: - $ref: '#/components/schemas/CaseAssignAttributes' + $ref: "#/components/schemas/CaseAssignAttributes" type: - $ref: '#/components/schemas/CaseResourceType' + $ref: "#/components/schemas/CaseResourceType" required: - - attributes - - type + - attributes + - type type: object CaseAssignAttributes: description: Case assign attributes properties: assignee_id: description: Assignee's UUID - example: f98a5a5b-e0ff-45d4-b2f5-afe6e74de504 + example: "f98a5a5b-e0ff-45d4-b2f5-afe6e74de504" type: string required: - - assignee_id + - assignee_id type: object CaseAssignRequest: description: Case assign request properties: data: - $ref: '#/components/schemas/CaseAssign' + $ref: "#/components/schemas/CaseAssign" required: - - data + - data type: object CaseAttributes: description: Case resource attributes @@ -9792,7 +9367,7 @@ components: readOnly: true type: string attributes: - $ref: '#/components/schemas/CaseObjectAttributes' + $ref: "#/components/schemas/CaseObjectAttributes" closed_at: description: Timestamp of when the case was closed format: date-time @@ -9806,17 +9381,17 @@ components: type: string custom_attributes: additionalProperties: - $ref: '#/components/schemas/CustomAttributeValue' + $ref: "#/components/schemas/CustomAttributeValue" description: Case custom attributes type: object description: description: Description type: string jira_issue: - $ref: '#/components/schemas/JiraIssue' + $ref: "#/components/schemas/JiraIssue" key: description: Key - example: CASEM-4523 + example: "CASEM-4523" type: string modified_at: description: Timestamp of when the case was last modified @@ -9825,200 +9400,198 @@ components: readOnly: true type: string priority: - $ref: '#/components/schemas/CasePriority' + $ref: "#/components/schemas/CasePriority" service_now_ticket: - $ref: '#/components/schemas/ServiceNowTicket' + $ref: "#/components/schemas/ServiceNowTicket" status: - $ref: '#/components/schemas/CaseStatus' + $ref: "#/components/schemas/CaseStatus" status_group: - $ref: '#/components/schemas/CaseStatusGroup' + $ref: "#/components/schemas/CaseStatusGroup" status_name: - $ref: '#/components/schemas/CaseStatusName' + $ref: "#/components/schemas/CaseStatusName" title: description: Title - example: Memory leak investigation on API + example: "Memory leak investigation on API" type: string type: - $ref: '#/components/schemas/CaseType' + $ref: "#/components/schemas/CaseType" type_id: description: Case type UUID - example: 3b010bde-09ce-4449-b745-71dd5f861963 + example: "3b010bde-09ce-4449-b745-71dd5f861963" type: string type: object CaseComment: description: Case comment properties: attributes: - $ref: '#/components/schemas/CaseCommentAttributes' + $ref: "#/components/schemas/CaseCommentAttributes" type: - $ref: '#/components/schemas/CaseResourceType' + $ref: "#/components/schemas/CaseResourceType" required: - - attributes - - type + - attributes + - type type: object CaseCommentAttributes: description: Case comment attributes properties: comment: description: The `CaseCommentAttributes` `message`. - example: This is my comment ! + example: "This is my comment !" type: string required: - - comment + - comment type: object CaseCommentRequest: description: Case comment request properties: data: - $ref: '#/components/schemas/CaseComment' + $ref: "#/components/schemas/CaseComment" required: - - data + - data type: object CaseCreate: description: Case creation data properties: attributes: - $ref: '#/components/schemas/CaseCreateAttributes' + $ref: "#/components/schemas/CaseCreateAttributes" relationships: - $ref: '#/components/schemas/CaseCreateRelationships' + $ref: "#/components/schemas/CaseCreateRelationships" type: - $ref: '#/components/schemas/CaseResourceType' + $ref: "#/components/schemas/CaseResourceType" required: - - attributes - - type + - attributes + - type type: object CaseCreateAttributes: description: Case creation attributes properties: custom_attributes: additionalProperties: - $ref: '#/components/schemas/CustomAttributeValue' + $ref: "#/components/schemas/CustomAttributeValue" description: Case custom attributes type: object description: description: Description type: string priority: - $ref: '#/components/schemas/CasePriority' + $ref: "#/components/schemas/CasePriority" status_name: - $ref: '#/components/schemas/CaseStatusName' + $ref: "#/components/schemas/CaseStatusName" title: description: Title - example: Security breach investigation + example: "Security breach investigation" type: string type_id: description: Case type UUID - example: 3b010bde-09ce-4449-b745-71dd5f861963 + example: "3b010bde-09ce-4449-b745-71dd5f861963" type: string required: - - title - - type_id + - title + - type_id type: object CaseCreateRelationships: description: Relationships formed with the case on creation properties: assignee: - $ref: '#/components/schemas/NullableUserRelationship' + $ref: "#/components/schemas/NullableUserRelationship" project: - $ref: '#/components/schemas/ProjectRelationship' + $ref: "#/components/schemas/ProjectRelationship" required: - - project + - project type: object CaseCreateRequest: description: Case create request properties: data: - $ref: '#/components/schemas/CaseCreate' + $ref: "#/components/schemas/CaseCreate" required: - - data + - data type: object CaseDataType: default: cases description: Cases resource type. enum: - - cases + - cases example: cases type: string x-enum-varnames: - - CASES + - CASES CaseEmpty: description: Case empty request data properties: type: - $ref: '#/components/schemas/CaseResourceType' + $ref: "#/components/schemas/CaseResourceType" required: - - type + - type type: object CaseEmptyRequest: description: Case empty request properties: data: - $ref: '#/components/schemas/CaseEmpty' + $ref: "#/components/schemas/CaseEmpty" required: - - data + - data type: object CaseInsightsItems: description: An insight of the case. properties: ref: description: Reference of the insight. - example: /security/appsec/vm/library/vulnerability/dfa027f7c037b2f77159adc027fecb56?detection=static + example: "/security/appsec/vm/library/vulnerability/dfa027f7c037b2f77159adc027fecb56?detection=static" type: string resource_id: - description: Unique identifier of the resource. For example, the unique - identifier of a security finding. - example: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw== + description: Unique identifier of the resource. For example, the unique identifier of a security finding. + example: "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==" type: string type: - description: Type of the resource. For example, the type of a security finding - is "SECURITY_FINDING". - example: SECURITY_FINDING + description: Type of the resource. For example, the type of a security finding is "SECURITY_FINDING". + example: "SECURITY_FINDING" type: string type: object CaseManagementProject: description: Case management project. properties: data: - $ref: '#/components/schemas/CaseManagementProjectData' + $ref: "#/components/schemas/CaseManagementProjectData" required: - - data + - data type: object CaseManagementProjectData: properties: id: description: Unique identifier of the case management project. - example: aeadc05e-98a8-11ec-ac2c-da7ad0900001 + example: "aeadc05e-98a8-11ec-ac2c-da7ad0900001" type: string type: - $ref: '#/components/schemas/CaseManagementProjectDataType' + $ref: "#/components/schemas/CaseManagementProjectDataType" required: - - type - - id + - type + - id type: object CaseManagementProjectDataType: default: projects description: Projects resource type. enum: - - projects + - projects example: projects type: string x-enum-varnames: - - PROJECTS + - PROJECTS CaseNotificationRule: description: A notification rule for case management properties: attributes: - $ref: '#/components/schemas/CaseNotificationRuleAttributes' + $ref: "#/components/schemas/CaseNotificationRuleAttributes" id: description: The notification rule's identifier - example: aeadc05e-98a8-11ec-ac2c-da7ad0900001 + example: "aeadc05e-98a8-11ec-ac2c-da7ad0900001" type: string type: - $ref: '#/components/schemas/CaseNotificationRuleResourceType' + $ref: "#/components/schemas/CaseNotificationRuleResourceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object CaseNotificationRuleAttributes: description: Notification rule attributes @@ -10032,24 +9605,24 @@ components: recipients: description: List of notification recipients items: - $ref: '#/components/schemas/CaseNotificationRuleRecipient' + $ref: "#/components/schemas/CaseNotificationRuleRecipient" type: array triggers: description: List of triggers for this notification rule items: - $ref: '#/components/schemas/CaseNotificationRuleTrigger' + $ref: "#/components/schemas/CaseNotificationRuleTrigger" type: array type: object CaseNotificationRuleCreate: description: Notification rule create properties: attributes: - $ref: '#/components/schemas/CaseNotificationRuleCreateAttributes' + $ref: "#/components/schemas/CaseNotificationRuleCreateAttributes" type: - $ref: '#/components/schemas/CaseNotificationRuleResourceType' + $ref: "#/components/schemas/CaseNotificationRuleResourceType" required: - - attributes - - type + - attributes + - type type: object CaseNotificationRuleCreateAttributes: description: Notification rule creation attributes @@ -10064,33 +9637,32 @@ components: recipients: description: List of notification recipients items: - $ref: '#/components/schemas/CaseNotificationRuleRecipient' + $ref: "#/components/schemas/CaseNotificationRuleRecipient" type: array triggers: description: List of triggers for this notification rule items: - $ref: '#/components/schemas/CaseNotificationRuleTrigger' + $ref: "#/components/schemas/CaseNotificationRuleTrigger" type: array required: - - recipients - - triggers + - recipients + - triggers type: object CaseNotificationRuleCreateRequest: description: Notification rule create request properties: data: - $ref: '#/components/schemas/CaseNotificationRuleCreate' + $ref: "#/components/schemas/CaseNotificationRuleCreate" required: - - data + - data type: object CaseNotificationRuleRecipient: description: Notification rule recipient properties: data: - $ref: '#/components/schemas/CaseNotificationRuleRecipientData' + $ref: "#/components/schemas/CaseNotificationRuleRecipientData" type: - description: Type of recipient (SLACK_CHANNEL, EMAIL, HTTP, PAGERDUTY_SERVICE, - MS_TEAMS_CHANNEL) + description: Type of recipient (SLACK_CHANNEL, EMAIL, HTTP, PAGERDUTY_SERVICE, MS_TEAMS_CHANNEL) example: EMAIL type: string type: object @@ -10141,25 +9713,24 @@ components: default: notification_rule description: Notification rule resource type enum: - - notification_rule + - notification_rule example: notification_rule type: string x-enum-varnames: - - NOTIFICATION_RULE + - NOTIFICATION_RULE CaseNotificationRuleResponse: description: Notification rule response properties: data: - $ref: '#/components/schemas/CaseNotificationRule' + $ref: "#/components/schemas/CaseNotificationRule" type: object CaseNotificationRuleTrigger: description: Notification rule trigger properties: data: - $ref: '#/components/schemas/CaseNotificationRuleTriggerData' + $ref: "#/components/schemas/CaseNotificationRuleTriggerData" type: - description: Type of trigger (CASE_CREATED, STATUS_TRANSITIONED, ATTRIBUTE_VALUE_CHANGED, - EVENT_CORRELATION_SIGNAL_CORRELATED) + description: Type of trigger (CASE_CREATED, STATUS_TRANSITIONED, ATTRIBUTE_VALUE_CHANGED, EVENT_CORRELATION_SIGNAL_CORRELATED) example: CASE_CREATED type: string type: object @@ -10189,19 +9760,19 @@ components: description: Notification rule update properties: attributes: - $ref: '#/components/schemas/CaseNotificationRuleAttributes' + $ref: "#/components/schemas/CaseNotificationRuleAttributes" type: - $ref: '#/components/schemas/CaseNotificationRuleResourceType' + $ref: "#/components/schemas/CaseNotificationRuleResourceType" required: - - type + - type type: object CaseNotificationRuleUpdateRequest: description: Notification rule update request properties: data: - $ref: '#/components/schemas/CaseNotificationRuleUpdate' + $ref: "#/components/schemas/CaseNotificationRuleUpdate" required: - - data + - data type: object CaseNotificationRulesResponse: description: Response with notification rules @@ -10209,7 +9780,7 @@ components: data: description: Notification rules data items: - $ref: '#/components/schemas/CaseNotificationRule' + $ref: "#/components/schemas/CaseNotificationRule" type: array type: object CaseObjectAttributes: @@ -10223,147 +9794,144 @@ components: default: NOT_DEFINED description: Case priority enum: - - NOT_DEFINED - - P1 - - P2 - - P3 - - P4 - - P5 + - NOT_DEFINED + - P1 + - P2 + - P3 + - P4 + - P5 example: NOT_DEFINED type: string x-enum-varnames: - - NOT_DEFINED - - P1 - - P2 - - P3 - - P4 - - P5 + - NOT_DEFINED + - P1 + - P2 + - P3 + - P4 + - P5 CaseRelationships: description: Resources related to a case properties: assignee: - $ref: '#/components/schemas/NullableUserRelationship' + $ref: "#/components/schemas/NullableUserRelationship" created_by: - $ref: '#/components/schemas/NullableUserRelationship' + $ref: "#/components/schemas/NullableUserRelationship" modified_by: - $ref: '#/components/schemas/NullableUserRelationship' + $ref: "#/components/schemas/NullableUserRelationship" project: - $ref: '#/components/schemas/ProjectRelationship' + $ref: "#/components/schemas/ProjectRelationship" type: object CaseResourceType: default: case description: Case resource type enum: - - case + - case example: case type: string x-enum-varnames: - - CASE + - CASE CaseResponse: description: Case response properties: data: - $ref: '#/components/schemas/Case' + $ref: "#/components/schemas/Case" type: object CaseSortableField: description: Case field that can be sorted on enum: - - created_at - - priority - - status + - created_at + - priority + - status example: created_at type: string x-enum-varnames: - - CREATED_AT - - PRIORITY - - STATUS + - CREATED_AT + - PRIORITY + - STATUS CaseStatus: deprecated: true - description: Deprecated way of representing the case status, which only supports - OPEN, IN_PROGRESS, and CLOSED statuses. Use `status_name` instead. + description: Deprecated way of representing the case status, which only supports OPEN, IN_PROGRESS, and CLOSED statuses. Use `status_name` instead. enum: - - OPEN - - IN_PROGRESS - - CLOSED + - OPEN + - IN_PROGRESS + - CLOSED example: OPEN type: string x-enum-varnames: - - OPEN - - IN_PROGRESS - - CLOSED + - OPEN + - IN_PROGRESS + - CLOSED CaseStatusGroup: description: Status group of the case. enum: - - SG_OPEN - - SG_IN_PROGRESS - - SG_CLOSED + - SG_OPEN + - SG_IN_PROGRESS + - SG_CLOSED example: SG_OPEN type: string x-enum-varnames: - - SG_OPEN - - SG_IN_PROGRESS - - SG_CLOSED + - SG_OPEN + - SG_IN_PROGRESS + - SG_CLOSED CaseStatusName: - description: Status of the case. Must be one of the existing statuses for the - case's type. - example: Open + description: Status of the case. Must be one of the existing statuses for the case's type. + example: "Open" type: string CaseTrigger: - description: Trigger a workflow from a Case. For automatic triggering a handle - must be configured and the workflow must be published. + description: "Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published." properties: rateLimit: - $ref: '#/components/schemas/TriggerRateLimit' + $ref: "#/components/schemas/TriggerRateLimit" type: object CaseTriggerWrapper: - description: Schema for a Case-based trigger. + description: "Schema for a Case-based trigger." properties: caseTrigger: - $ref: '#/components/schemas/CaseTrigger' + $ref: "#/components/schemas/CaseTrigger" startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - caseTrigger + - caseTrigger type: object CaseType: deprecated: true description: Case type enum: - - STANDARD + - STANDARD example: STANDARD type: string x-enum-varnames: - - STANDARD + - STANDARD CaseTypeCreate: description: Case type properties: attributes: - $ref: '#/components/schemas/CaseTypeResourceAttributes' + $ref: "#/components/schemas/CaseTypeResourceAttributes" type: - $ref: '#/components/schemas/CaseTypeResourceType' + $ref: "#/components/schemas/CaseTypeResourceType" required: - - attributes - - type + - attributes + - type type: object CaseTypeCreateRequest: description: Case type create request properties: data: - $ref: '#/components/schemas/CaseTypeCreate' + $ref: "#/components/schemas/CaseTypeCreate" required: - - data + - data type: object CaseTypeResource: description: The definition of `CaseType` object. properties: attributes: - $ref: '#/components/schemas/CaseTypeResourceAttributes' + $ref: "#/components/schemas/CaseTypeResourceAttributes" id: description: Case type's identifier - example: aeadc05e-98a8-11ec-ac2c-da7ad0900001 + example: "aeadc05e-98a8-11ec-ac2c-da7ad0900001" type: string type: - $ref: '#/components/schemas/CaseTypeResourceType' + $ref: "#/components/schemas/CaseTypeResourceType" type: object CaseTypeResourceAttributes: description: Case Type resource attributes @@ -10376,33 +9944,33 @@ components: type: string description: description: Case type description. - example: Investigations done in case management + example: "Investigations done in case management" type: string emoji: description: Case type emoji. - example: "\U0001F575\U0001F3FB\u200D\u2642\uFE0F" + example: "🕵🏻‍♂️" type: string name: description: Case type name. - example: Investigation + example: "Investigation" type: string required: - - name + - name type: object CaseTypeResourceType: default: case_type description: Case type resource type enum: - - case_type + - case_type example: case_type type: string x-enum-varnames: - - CASE_TYPE + - CASE_TYPE CaseTypeResponse: description: Case type response properties: data: - $ref: '#/components/schemas/CaseTypeResource' + $ref: "#/components/schemas/CaseTypeResource" type: object CaseTypesResponse: description: Case types response. @@ -10410,167 +9978,167 @@ components: data: description: List of case types items: - $ref: '#/components/schemas/CaseTypeResource' + $ref: "#/components/schemas/CaseTypeResource" type: array type: object CaseUpdateAttributes: description: Case update attributes properties: attributes: - $ref: '#/components/schemas/CaseUpdateAttributesAttributes' + $ref: "#/components/schemas/CaseUpdateAttributesAttributes" type: - $ref: '#/components/schemas/CaseResourceType' + $ref: "#/components/schemas/CaseResourceType" required: - - attributes - - type + - attributes + - type type: object CaseUpdateAttributesAttributes: description: Case update attributes attributes properties: attributes: - $ref: '#/components/schemas/CaseObjectAttributes' + $ref: "#/components/schemas/CaseObjectAttributes" required: - - attributes + - attributes type: object CaseUpdateAttributesRequest: description: Case update attributes request properties: data: - $ref: '#/components/schemas/CaseUpdateAttributes' + $ref: "#/components/schemas/CaseUpdateAttributes" required: - - data + - data type: object CaseUpdateCustomAttribute: description: Case update custom attribute properties: attributes: - $ref: '#/components/schemas/CustomAttributeValue' + $ref: "#/components/schemas/CustomAttributeValue" type: - $ref: '#/components/schemas/CaseResourceType' + $ref: "#/components/schemas/CaseResourceType" required: - - attributes - - type + - attributes + - type type: object CaseUpdateCustomAttributeRequest: description: Case update custom attribute request properties: data: - $ref: '#/components/schemas/CaseUpdateCustomAttribute' + $ref: "#/components/schemas/CaseUpdateCustomAttribute" required: - - data + - data type: object CaseUpdateDescription: description: Case update description properties: attributes: - $ref: '#/components/schemas/CaseUpdateDescriptionAttributes' + $ref: "#/components/schemas/CaseUpdateDescriptionAttributes" type: - $ref: '#/components/schemas/CaseResourceType' + $ref: "#/components/schemas/CaseResourceType" required: - - attributes - - type + - attributes + - type type: object CaseUpdateDescriptionAttributes: description: Case update description attributes properties: description: description: Case new description - example: Seeing some weird memory increase... We shouldn't ignore this + example: "Seeing some weird memory increase... We shouldn't ignore this" type: string required: - - description + - description type: object CaseUpdateDescriptionRequest: description: Case update description request properties: data: - $ref: '#/components/schemas/CaseUpdateDescription' + $ref: "#/components/schemas/CaseUpdateDescription" required: - - data + - data type: object CaseUpdatePriority: description: Case priority status properties: attributes: - $ref: '#/components/schemas/CaseUpdatePriorityAttributes' + $ref: "#/components/schemas/CaseUpdatePriorityAttributes" type: - $ref: '#/components/schemas/CaseResourceType' + $ref: "#/components/schemas/CaseResourceType" required: - - attributes - - type + - attributes + - type type: object CaseUpdatePriorityAttributes: description: Case update priority attributes properties: priority: - $ref: '#/components/schemas/CasePriority' + $ref: "#/components/schemas/CasePriority" required: - - priority + - priority type: object CaseUpdatePriorityRequest: description: Case update priority request properties: data: - $ref: '#/components/schemas/CaseUpdatePriority' + $ref: "#/components/schemas/CaseUpdatePriority" required: - - data + - data type: object CaseUpdateStatus: description: Case update status properties: attributes: - $ref: '#/components/schemas/CaseUpdateStatusAttributes' + $ref: "#/components/schemas/CaseUpdateStatusAttributes" type: - $ref: '#/components/schemas/CaseResourceType' + $ref: "#/components/schemas/CaseResourceType" required: - - attributes - - type + - attributes + - type type: object CaseUpdateStatusAttributes: description: Case update status attributes properties: status: - $ref: '#/components/schemas/CaseStatus' + $ref: "#/components/schemas/CaseStatus" deprecated: true status_name: - $ref: '#/components/schemas/CaseStatusName' + $ref: "#/components/schemas/CaseStatusName" type: object CaseUpdateStatusRequest: description: Case update status request properties: data: - $ref: '#/components/schemas/CaseUpdateStatus' + $ref: "#/components/schemas/CaseUpdateStatus" required: - - data + - data type: object CaseUpdateTitle: description: Case update title properties: attributes: - $ref: '#/components/schemas/CaseUpdateTitleAttributes' + $ref: "#/components/schemas/CaseUpdateTitleAttributes" type: - $ref: '#/components/schemas/CaseResourceType' + $ref: "#/components/schemas/CaseResourceType" required: - - attributes - - type + - attributes + - type type: object CaseUpdateTitleAttributes: description: Case update title attributes properties: title: description: Case new title - example: Memory leak investigation on API + example: "Memory leak investigation on API" type: string required: - - title + - title type: object CaseUpdateTitleRequest: description: Case update title request properties: data: - $ref: '#/components/schemas/CaseUpdateTitle' + $ref: "#/components/schemas/CaseUpdateTitle" required: - - data + - data type: object CasesResponse: description: Response with cases @@ -10578,16 +10146,16 @@ components: data: description: Cases response data items: - $ref: '#/components/schemas/Case' + $ref: "#/components/schemas/Case" type: array meta: - $ref: '#/components/schemas/CasesResponseMeta' + $ref: "#/components/schemas/CasesResponseMeta" type: object CasesResponseMeta: description: Cases response metadata properties: page: - $ref: '#/components/schemas/CasesResponseMetaPagination' + $ref: "#/components/schemas/CasesResponseMetaPagination" type: object CasesResponseMetaPagination: description: Pagination metadata @@ -10609,77 +10177,75 @@ components: description: Change event attributes. properties: aggregation_key: - $ref: '#/components/schemas/V2EventAggregationKey' + $ref: "#/components/schemas/V2EventAggregationKey" author: - $ref: '#/components/schemas/ChangeEventAttributesAuthor' + $ref: "#/components/schemas/ChangeEventAttributesAuthor" change_metadata: description: JSON object of change metadata. example: dd: - team: datadog_team - user_email: datadog@datadog.com - user_id: datadog_user_id - user_name: datadog_username + team: "datadog_team" + user_email: "datadog@datadog.com" + user_id: "datadog_user_id" + user_name: "datadog_username" type: object changed_resource: - $ref: '#/components/schemas/ChangeEventAttributesChangedResource' + $ref: "#/components/schemas/ChangeEventAttributesChangedResource" evt: - $ref: '#/components/schemas/EventSystemAttributes' + $ref: "#/components/schemas/EventSystemAttributes" impacted_resources: description: A list of resources impacted by this change. - example: - - name: service-name - type: service + example: [{"name": "service-name", "type": "service"}] items: - $ref: '#/components/schemas/ChangeEventAttributesImpactedResourcesItem' + $ref: "#/components/schemas/ChangeEventAttributesImpactedResourcesItem" type: array new_value: description: The new state of the changed resource. example: enabled: true - percentage: 50% + percentage: "50%" rule: - datacenter: devcycle.us1.prod + datacenter: "devcycle.us1.prod" type: object prev_value: description: The previous state of the changed resource. example: enabled: true - percentage: 10% + percentage: "10%" rule: - datacenter: devcycle.us1.prod + datacenter: "devcycle.us1.prod" type: object service: - $ref: '#/components/schemas/V2EventService' + $ref: "#/components/schemas/V2EventService" timestamp: - $ref: '#/components/schemas/V2EventTimestamp' + $ref: "#/components/schemas/V2EventTimestamp" title: - $ref: '#/components/schemas/V2EventTitle' + $ref: "#/components/schemas/V2EventTitle" type: object ChangeEventAttributesAuthor: description: The entity that made the change. properties: name: description: The name of the user or system that made the change. - example: example@datadog.com + example: "example@datadog.com" type: string type: - $ref: '#/components/schemas/ChangeEventAttributesAuthorType' + $ref: "#/components/schemas/ChangeEventAttributesAuthorType" type: object ChangeEventAttributesAuthorType: description: The type of the author. enum: - - user - - system - - api - - automation - example: user + - user + - system + - api + - automation + example: "user" type: string x-enum-varnames: - - USER - - SYSTEM - - API - - AUTOMATION + - USER + - SYSTEM + - API + - AUTOMATION ChangeEventAttributesChangedResource: description: A uniquely identified resource. properties: @@ -10687,18 +10253,18 @@ components: description: The name of the changed resource. type: string type: - $ref: '#/components/schemas/ChangeEventAttributesChangedResourceType' + $ref: "#/components/schemas/ChangeEventAttributesChangedResourceType" type: object ChangeEventAttributesChangedResourceType: description: The type of the changed resource. enum: - - feature_flag - - configuration - example: feature_flag + - feature_flag + - configuration + example: "feature_flag" type: string x-enum-varnames: - - FEATURE_FLAG - - CONFIGURATION + - FEATURE_FLAG + - CONFIGURATION ChangeEventAttributesImpactedResourcesItem: description: A uniquely identified resource. properties: @@ -10706,444 +10272,442 @@ components: description: The name of the impacted resource. type: string type: - $ref: '#/components/schemas/ChangeEventAttributesImpactedResourcesItemType' + $ref: "#/components/schemas/ChangeEventAttributesImpactedResourcesItemType" type: object ChangeEventAttributesImpactedResourcesItemType: description: The type of the impacted resource. enum: - - service + - service type: string x-enum-varnames: - - SERVICE + - SERVICE ChangeEventCustomAttributes: additionalProperties: false - description: Change event attributes. + description: |- + Change event attributes. properties: author: - $ref: '#/components/schemas/ChangeEventCustomAttributesAuthor' + $ref: "#/components/schemas/ChangeEventCustomAttributesAuthor" change_metadata: additionalProperties: {} - description: Free form JSON object with information related to the `change` - event. Supports up to 100 properties per object and a maximum nesting - depth of 10 levels. + description: |- + Free form JSON object with information related to the `change` event. Supports up to 100 properties per object and a maximum nesting depth of 10 levels. example: dd: - team: datadog_team - user_email: datadog@datadog.com - user_id: datadog_user_id - user_name: datadog_username - resource_link: datadog.com/feature/fallback_payments_test + team: "datadog_team" + user_email: "datadog@datadog.com" + user_id: "datadog_user_id" + user_name: "datadog_username" + resource_link: "datadog.com/feature/fallback_payments_test" type: object changed_resource: - $ref: '#/components/schemas/ChangeEventCustomAttributesChangedResource' + $ref: "#/components/schemas/ChangeEventCustomAttributesChangedResource" impacted_resources: - description: 'A list of resources impacted by this change. It is recommended - to provide an impacted resource to display - - the change event at the correct location. Only resources of type `service` - are supported. Maximum of 100 impacted resources allowed.' + description: |- + A list of resources impacted by this change. It is recommended to provide an impacted resource to display + the change event at the correct location. Only resources of type `service` are supported. Maximum of 100 impacted resources allowed. example: - - name: payments_api - type: service + - name: payments_api + type: service items: - $ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItems' + $ref: "#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItems" maxItems: 100 type: array new_value: additionalProperties: {} - description: Free form JSON object representing the new state of the changed - resource. + description: |- + Free form JSON object representing the new state of the changed resource. example: enabled: true - percentage: 50% + percentage: "50%" rule: - datacenter: devcycle.us1.prod + datacenter: "devcycle.us1.prod" type: object prev_value: additionalProperties: {} - description: Free form JSON object representing the previous state of the - changed resource. + description: |- + Free form JSON object representing the previous state of the changed resource. example: enabled: true - percentage: 10% + percentage: "10%" rule: - datacenter: devcycle.us1.prod + datacenter: "devcycle.us1.prod" type: object required: - - changed_resource + - changed_resource type: object ChangeEventCustomAttributesAuthor: additionalProperties: false - description: The entity that made the change. Optional, if provided it must - include `type` and `name`. + description: |- + The entity that made the change. Optional, if provided it must include `type` and `name`. properties: name: - description: The name of the user or system that made the change. Limited - to 128 characters. - example: example@datadog.com + description: The name of the user or system that made the change. Limited to 128 characters. + example: "example@datadog.com" maxLength: 128 minLength: 1 type: string type: - $ref: '#/components/schemas/ChangeEventCustomAttributesAuthorType' + $ref: "#/components/schemas/ChangeEventCustomAttributesAuthorType" required: - - name - - type + - name + - type type: object ChangeEventCustomAttributesAuthorType: description: Author's type. enum: - - user - - system - - api - - automation + - user + - system + - api + - automation example: user type: string x-enum-varnames: - - USER - - SYSTEM - - API - - AUTOMATION + - USER + - SYSTEM + - API + - AUTOMATION ChangeEventCustomAttributesChangedResource: additionalProperties: false - description: A uniquely identified resource. + description: |- + A uniquely identified resource. properties: name: - description: The name of the resource that was changed. Limited to 128 characters. - Must contain at least one non-whitespace character. - example: fallback_payments_test + description: The name of the resource that was changed. Limited to 128 characters. Must contain at least one non-whitespace character. + example: "fallback_payments_test" maxLength: 128 minLength: 1 - pattern: .*\S.* + pattern: ".*\\S.*" type: string type: - $ref: '#/components/schemas/ChangeEventCustomAttributesChangedResourceType' + $ref: "#/components/schemas/ChangeEventCustomAttributesChangedResourceType" required: - - type - - name + - type + - name type: object ChangeEventCustomAttributesChangedResourceType: description: The type of the resource that was changed. enum: - - feature_flag - - configuration - example: feature_flag + - feature_flag + - configuration + example: "feature_flag" type: string x-enum-varnames: - - FEATURE_FLAG - - CONFIGURATION + - FEATURE_FLAG + - CONFIGURATION ChangeEventCustomAttributesImpactedResourcesItems: additionalProperties: false - description: Object representing a uniquely identified resource. + description: |- + Object representing a uniquely identified resource. properties: name: description: The name of the impacted resource. Limited to 128 characters. - example: payments_api + example: "payments_api" maxLength: 128 minLength: 1 type: string type: - $ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItemsType' + $ref: "#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItemsType" required: - - type - - name + - type + - name type: object ChangeEventCustomAttributesImpactedResourcesItemsType: description: The type of the impacted resource. enum: - - service - example: service + - service + example: "service" type: string x-enum-varnames: - - SERVICE + - SERVICE ChangeEventTriggerWrapper: - description: Schema for a Change Event-based trigger. + description: "Schema for a Change Event-based trigger." properties: changeEventTrigger: - description: Trigger a workflow from a Change Event. + description: "Trigger a workflow from a Change Event." type: object startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - changeEventTrigger + - changeEventTrigger type: object ChangeRequestBranchCreateAttributes: description: Attributes for creating a change request branch. properties: branch_name: description: The name of the branch to create. - example: chm/CHM-1234 + example: "chm/CHM-1234" type: string repo_id: description: The repository identifier in the format owner/repository. - example: DataDog/dd-source + example: "DataDog/dd-source" type: string required: - - repo_id - - branch_name + - repo_id + - branch_name type: object ChangeRequestBranchCreateData: description: Data object to create a change request branch. properties: attributes: - $ref: '#/components/schemas/ChangeRequestBranchCreateAttributes' + $ref: "#/components/schemas/ChangeRequestBranchCreateAttributes" type: - $ref: '#/components/schemas/ChangeRequestBranchResourceType' + $ref: "#/components/schemas/ChangeRequestBranchResourceType" required: - - type - - attributes + - type + - attributes type: object ChangeRequestBranchCreateRequest: description: Request object to create a branch for a change request. properties: data: - $ref: '#/components/schemas/ChangeRequestBranchCreateData' + $ref: "#/components/schemas/ChangeRequestBranchCreateData" required: - - data + - data type: object ChangeRequestBranchResourceType: description: Change request branch resource type. enum: - - change_request_branch + - change_request_branch example: change_request_branch type: string x-enum-varnames: - - CHANGE_REQUEST_BRANCH + - CHANGE_REQUEST_BRANCH ChangeRequestChangeType: description: The type of the change request. enum: - - NORMAL - - STANDARD - - EMERGENCY + - NORMAL + - STANDARD + - EMERGENCY example: NORMAL type: string x-enum-varnames: - - NORMAL - - STANDARD - - EMERGENCY + - NORMAL + - STANDARD + - EMERGENCY ChangeRequestCreateAttributes: description: Attributes for creating a change request. properties: change_request_linked_incident_uuid: description: The UUID of an incident to link to the change request. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string change_request_maintenance_window_query: description: The maintenance window query for the change request. - example: '' + example: "" type: string change_request_plan: description: The plan associated with the change request. - example: 1. Deploy to staging 2. Run tests 3. Deploy to production + example: "1. Deploy to staging 2. Run tests 3. Deploy to production" type: string change_request_risk: - $ref: '#/components/schemas/ChangeRequestRiskLevel' + $ref: "#/components/schemas/ChangeRequestRiskLevel" change_request_type: - $ref: '#/components/schemas/ChangeRequestChangeType' + $ref: "#/components/schemas/ChangeRequestChangeType" description: description: The description of the change request. - example: Deploying new payment service v2.1 + example: "Deploying new payment service v2.1" type: string end_date: description: The planned end date of the change request. - example: '2024-01-02T15:00:00Z' + example: "2024-01-02T15:00:00Z" format: date-time type: string project_id: description: The project UUID to associate with the change request. - example: d4bbe1af-f36e-42f1-87c1-493ca35c320e + example: "d4bbe1af-f36e-42f1-87c1-493ca35c320e" type: string requested_teams: description: A list of team handles to request decisions from. example: - - team-handle-1 + - "team-handle-1" items: type: string type: array start_date: description: The planned start date of the change request. - example: '2024-01-01T03:00:00Z' + example: "2024-01-01T03:00:00Z" format: date-time type: string title: description: The title of the change request. - example: Deploy new payment service + example: "Deploy new payment service" type: string required: - - title + - title type: object ChangeRequestCreateData: description: Data object to create a change request. properties: attributes: - $ref: '#/components/schemas/ChangeRequestCreateAttributes' + $ref: "#/components/schemas/ChangeRequestCreateAttributes" type: - $ref: '#/components/schemas/ChangeRequestResourceType' + $ref: "#/components/schemas/ChangeRequestResourceType" required: - - type - - attributes + - type + - attributes type: object ChangeRequestCreateRequest: description: Request object to create a change request. properties: data: - $ref: '#/components/schemas/ChangeRequestCreateData' + $ref: "#/components/schemas/ChangeRequestCreateData" required: - - data + - data type: object ChangeRequestDecisionCreateAttributes: description: Attributes for creating a change request decision. properties: change_request_status: - $ref: '#/components/schemas/ChangeRequestDecisionStatusType' + $ref: "#/components/schemas/ChangeRequestDecisionStatusType" request_reason: description: The reason for requesting the decision. - example: Please review and approve this change + example: "Please review and approve this change" type: string type: object ChangeRequestDecisionCreateItem: description: An included change request decision for a create or update operation. properties: attributes: - $ref: '#/components/schemas/ChangeRequestDecisionCreateAttributes' + $ref: "#/components/schemas/ChangeRequestDecisionCreateAttributes" id: description: The decision identifier. - example: decision-id-0 + example: "decision-id-0" type: string relationships: - $ref: '#/components/schemas/ChangeRequestDecisionCreateRelationships' + $ref: "#/components/schemas/ChangeRequestDecisionCreateRelationships" type: - $ref: '#/components/schemas/ChangeRequestDecisionResourceType' + $ref: "#/components/schemas/ChangeRequestDecisionResourceType" required: - - type - - id + - type + - id type: object ChangeRequestDecisionCreateRelationships: description: Relationships for creating a change request decision. properties: requested_user: - $ref: '#/components/schemas/ChangeRequestUserRelationship' + $ref: "#/components/schemas/ChangeRequestUserRelationship" type: object ChangeRequestDecisionRelationshipData: description: Change request decision relationship data. properties: id: description: The decision UUID. - example: decision-id-0 + example: "decision-id-0" type: string type: - $ref: '#/components/schemas/ChangeRequestDecisionResourceType' + $ref: "#/components/schemas/ChangeRequestDecisionResourceType" required: - - id - - type + - id + - type type: object ChangeRequestDecisionRelationships: description: Relationships of a change request decision. properties: modified_by: - $ref: '#/components/schemas/ChangeRequestUserRelationship' + $ref: "#/components/schemas/ChangeRequestUserRelationship" requested_by_user: - $ref: '#/components/schemas/ChangeRequestUserRelationship' + $ref: "#/components/schemas/ChangeRequestUserRelationship" requested_user: - $ref: '#/components/schemas/ChangeRequestUserRelationship' + $ref: "#/components/schemas/ChangeRequestUserRelationship" required: - - requested_user - - requested_by_user - - modified_by + - requested_user + - requested_by_user + - modified_by type: object ChangeRequestDecisionResourceType: description: Change request decision resource type. enum: - - change_request_decision + - change_request_decision example: change_request_decision type: string x-enum-varnames: - - CHANGE_REQUEST_DECISION + - CHANGE_REQUEST_DECISION ChangeRequestDecisionResponseAttributes: description: Attributes of a change request decision in a response. properties: change_request_status: - $ref: '#/components/schemas/ChangeRequestDecisionStatusType' + $ref: "#/components/schemas/ChangeRequestDecisionStatusType" decided_at: description: Timestamp of when the decision was made. - example: '2024-01-02T00:00:00Z' + example: "2024-01-02T00:00:00Z" format: date-time type: string decision_reason: description: The reason for the decision. - example: LGTM + example: "LGTM" type: string deleted_at: description: Timestamp of when the decision was deleted. - example: '0001-01-01T00:00:00Z' + example: "0001-01-01T00:00:00Z" format: date-time type: string request_reason: description: The reason for requesting the decision. - example: Please review this change + example: "Please review this change" type: string requested_at: description: Timestamp of when the decision was requested. - example: '2024-01-01T00:00:00Z' + example: "2024-01-01T00:00:00Z" format: date-time type: string required: - - change_request_status - - request_reason - - decision_reason - - requested_at - - decided_at - - deleted_at + - change_request_status + - request_reason + - decision_reason + - requested_at + - decided_at + - deleted_at type: object ChangeRequestDecisionStatusType: description: The status of a change request decision. enum: - - REQUESTED - - APPROVED - - DECLINED + - REQUESTED + - APPROVED + - DECLINED example: REQUESTED type: string x-enum-varnames: - - REQUESTED - - APPROVED - - DECLINED + - REQUESTED + - APPROVED + - DECLINED ChangeRequestDecisionUpdateData: description: Data object to update a change request decision. properties: attributes: - $ref: '#/components/schemas/ChangeRequestDecisionUpdateDataAttributes' + $ref: "#/components/schemas/ChangeRequestDecisionUpdateDataAttributes" relationships: - $ref: '#/components/schemas/ChangeRequestDecisionUpdateDataRelationships' + $ref: "#/components/schemas/ChangeRequestDecisionUpdateDataRelationships" type: - $ref: '#/components/schemas/ChangeRequestResourceType' + $ref: "#/components/schemas/ChangeRequestResourceType" required: - - type + - type type: object ChangeRequestDecisionUpdateDataAttributes: description: Attributes of the parent change request for a decision update. properties: id: description: The identifier of the change request. - example: CHM-1234 + example: "CHM-1234" type: string type: object ChangeRequestDecisionUpdateDataRelationships: description: Relationships for updating a change request decision. properties: change_request_decisions: - $ref: '#/components/schemas/ChangeRequestDecisionsRelationship' + $ref: "#/components/schemas/ChangeRequestDecisionsRelationship" required: - - change_request_decisions + - change_request_decisions type: object ChangeRequestDecisionUpdateRequest: description: Request object to update a change request decision. properties: data: - $ref: '#/components/schemas/ChangeRequestDecisionUpdateData' + $ref: "#/components/schemas/ChangeRequestDecisionUpdateData" included: - $ref: '#/components/schemas/ChangeRequestUpdateIncluded' + $ref: "#/components/schemas/ChangeRequestUpdateIncluded" required: - - data + - data type: object ChangeRequestDecisionsRelationship: description: Relationship to change request decisions. @@ -11151,76 +10715,76 @@ components: data: description: Array of decision relationship data. items: - $ref: '#/components/schemas/ChangeRequestDecisionRelationshipData' + $ref: "#/components/schemas/ChangeRequestDecisionRelationshipData" type: array required: - - data + - data type: object ChangeRequestIncluded: description: Included resources related to the change request. items: - $ref: '#/components/schemas/ChangeRequestIncludedItem' + $ref: "#/components/schemas/ChangeRequestIncludedItem" type: array ChangeRequestIncludedDecision: description: An included change request decision resource. properties: attributes: - $ref: '#/components/schemas/ChangeRequestDecisionResponseAttributes' + $ref: "#/components/schemas/ChangeRequestDecisionResponseAttributes" id: description: The decision UUID. - example: decision-id-0 + example: "decision-id-0" type: string relationships: - $ref: '#/components/schemas/ChangeRequestDecisionRelationships' + $ref: "#/components/schemas/ChangeRequestDecisionRelationships" type: - $ref: '#/components/schemas/ChangeRequestDecisionResourceType' + $ref: "#/components/schemas/ChangeRequestDecisionResourceType" required: - - type - - id - - attributes + - type + - id + - attributes type: object ChangeRequestIncludedItem: description: An included resource item in the change request response. oneOf: - - $ref: '#/components/schemas/ChangeRequestIncludedUser' - - $ref: '#/components/schemas/ChangeRequestIncludedDecision' + - $ref: "#/components/schemas/ChangeRequestIncludedUser" + - $ref: "#/components/schemas/ChangeRequestIncludedDecision" ChangeRequestIncludedUser: description: An included user resource. properties: attributes: - $ref: '#/components/schemas/ChangeRequestIncludedUserAttributes' + $ref: "#/components/schemas/ChangeRequestIncludedUserAttributes" id: description: The user UUID. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string type: description: The resource type. - example: user + example: "user" type: string required: - - type - - id - - attributes + - type + - id + - attributes type: object ChangeRequestIncludedUserAttributes: description: Attributes of an included user. properties: email: description: The email of the user. - example: john.doe@example.com + example: "john.doe@example.com" type: string handle: description: The handle of the user. - example: john.doe@example.com + example: "john.doe@example.com" type: string name: description: The name of the user. - example: John Doe + example: "John Doe" type: string required: - - name - - email - - handle + - name + - email + - handle type: object ChangeRequestObjectAttributes: additionalProperties: @@ -11233,33 +10797,33 @@ components: description: Relationships of a change request. properties: change_request_decisions: - $ref: '#/components/schemas/ChangeRequestDecisionsRelationship' + $ref: "#/components/schemas/ChangeRequestDecisionsRelationship" created_by: - $ref: '#/components/schemas/ChangeRequestUserRelationship' + $ref: "#/components/schemas/ChangeRequestUserRelationship" modified_by: - $ref: '#/components/schemas/ChangeRequestUserRelationship' + $ref: "#/components/schemas/ChangeRequestUserRelationship" required: - - created_by - - modified_by - - change_request_decisions + - created_by + - modified_by + - change_request_decisions type: object ChangeRequestResourceType: description: Change request resource type. enum: - - change_request + - change_request example: change_request type: string x-enum-varnames: - - CHANGE_REQUEST + - CHANGE_REQUEST ChangeRequestResponse: description: Response object for a change request. properties: data: - $ref: '#/components/schemas/ChangeRequestResponseData' + $ref: "#/components/schemas/ChangeRequestResponseData" included: - $ref: '#/components/schemas/ChangeRequestIncluded' + $ref: "#/components/schemas/ChangeRequestIncluded" required: - - data + - data type: object ChangeRequestResponseAttributes: description: Attributes of a change request response. @@ -11271,23 +10835,23 @@ components: readOnly: true type: string attributes: - $ref: '#/components/schemas/ChangeRequestObjectAttributes' + $ref: "#/components/schemas/ChangeRequestObjectAttributes" change_request_linked_incident_uuid: description: The UUID of the linked incident. - example: '' + example: "" type: string change_request_maintenance_window_query: description: The maintenance window query for the change request. - example: '' + example: "" type: string change_request_plan: description: The plan associated with the change request. - example: '' + example: "" type: string change_request_risk: - $ref: '#/components/schemas/ChangeRequestRiskLevel' + $ref: "#/components/schemas/ChangeRequestRiskLevel" change_request_type: - $ref: '#/components/schemas/ChangeRequestChangeType' + $ref: "#/components/schemas/ChangeRequestChangeType" closed_at: description: Timestamp of when the change request was closed. format: date-time @@ -11296,30 +10860,30 @@ components: type: string created_at: description: Timestamp of when the change request was created. - example: '2024-01-01T00:00:00Z' + example: "2024-01-01T00:00:00Z" format: date-time readOnly: true type: string creation_source: description: The source from which the change request was created. - example: CS_MANUAL + example: "CS_MANUAL" type: string description: description: The description of the change request. - example: Deploying new payment service v2.1 + example: "Deploying new payment service v2.1" type: string end_date: description: The planned end date of the change request. - example: '2024-01-02T15:00:00Z' + example: "2024-01-02T15:00:00Z" format: date-time type: string key: description: The human-readable key of the change request. - example: CHM-1234 + example: "CHM-1234" type: string modified_at: description: Timestamp of when the change request was last modified. - example: '2024-01-01T00:00:00Z' + example: "2024-01-01T00:00:00Z" format: date-time readOnly: true type: string @@ -11330,103 +10894,103 @@ components: type: integer priority: description: The priority of the change request. - example: NOT_DEFINED + example: "NOT_DEFINED" type: string project_id: description: The project UUID associated with the change request. - example: d4bbe1af-f36e-42f1-87c1-493ca35c320e + example: "d4bbe1af-f36e-42f1-87c1-493ca35c320e" type: string start_date: description: The planned start date of the change request. - example: '2024-01-01T03:00:00Z' + example: "2024-01-01T03:00:00Z" format: date-time type: string status: description: The current status of the change request. - example: OPEN + example: "OPEN" type: string title: description: The title of the change request. - example: Deploy new payment service + example: "Deploy new payment service" type: string type: description: The case type. - example: CHANGE_REQUEST - type: string - required: - - key - - title - - type - - priority - - status - - description - - creation_source - - plan_notebook_id - - project_id - - attributes - - created_at - - modified_at - - change_request_type - - change_request_risk - - change_request_plan - - change_request_linked_incident_uuid - - change_request_maintenance_window_query + example: "CHANGE_REQUEST" + type: string + required: + - key + - title + - type + - priority + - status + - description + - creation_source + - plan_notebook_id + - project_id + - attributes + - created_at + - modified_at + - change_request_type + - change_request_risk + - change_request_plan + - change_request_linked_incident_uuid + - change_request_maintenance_window_query type: object ChangeRequestResponseData: description: Data object for a change request response. properties: attributes: - $ref: '#/components/schemas/ChangeRequestResponseAttributes' + $ref: "#/components/schemas/ChangeRequestResponseAttributes" id: description: The identifier of the change request. - example: CHM-1234 + example: "CHM-1234" type: string relationships: - $ref: '#/components/schemas/ChangeRequestRelationships' + $ref: "#/components/schemas/ChangeRequestRelationships" type: - $ref: '#/components/schemas/ChangeRequestResourceType' + $ref: "#/components/schemas/ChangeRequestResourceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object ChangeRequestRiskLevel: description: The risk level of the change request. enum: - - UNDEFINED - - LOW - - MEDIUM - - HIGH + - UNDEFINED + - LOW + - MEDIUM + - HIGH example: LOW type: string x-enum-varnames: - - UNDEFINED - - LOW - - MEDIUM - - HIGH + - UNDEFINED + - LOW + - MEDIUM + - HIGH ChangeRequestUpdateAttributes: description: Attributes for updating a change request. properties: change_request_plan: description: The plan associated with the change request. - example: Updated deployment plan + example: "Updated deployment plan" type: string change_request_risk: - $ref: '#/components/schemas/ChangeRequestRiskLevel' + $ref: "#/components/schemas/ChangeRequestRiskLevel" change_request_type: - $ref: '#/components/schemas/ChangeRequestChangeType' + $ref: "#/components/schemas/ChangeRequestChangeType" end_date: description: The planned end date of the change request. - example: '2024-01-02T15:00:00Z' + example: "2024-01-02T15:00:00Z" format: date-time type: string id: description: The identifier of the change request to update. - example: CHM-1234 + example: "CHM-1234" type: string start_date: description: The planned start date of the change request. - example: '2024-01-01T03:00:00Z' + example: "2024-01-01T03:00:00Z" format: date-time type: string type: object @@ -11434,42 +10998,42 @@ components: description: Data object to update a change request. properties: attributes: - $ref: '#/components/schemas/ChangeRequestUpdateAttributes' + $ref: "#/components/schemas/ChangeRequestUpdateAttributes" relationships: - $ref: '#/components/schemas/ChangeRequestUpdateRelationships' + $ref: "#/components/schemas/ChangeRequestUpdateRelationships" type: - $ref: '#/components/schemas/ChangeRequestResourceType' + $ref: "#/components/schemas/ChangeRequestResourceType" required: - - type + - type type: object ChangeRequestUpdateIncluded: description: Included resources for the change request update. items: - $ref: '#/components/schemas/ChangeRequestDecisionCreateItem' + $ref: "#/components/schemas/ChangeRequestDecisionCreateItem" type: array ChangeRequestUpdateRelationships: description: Relationships for updating a change request. properties: change_request_decisions: - $ref: '#/components/schemas/ChangeRequestDecisionsRelationship' + $ref: "#/components/schemas/ChangeRequestDecisionsRelationship" type: object ChangeRequestUpdateRequest: description: Request object to update a change request. properties: data: - $ref: '#/components/schemas/ChangeRequestUpdateData' + $ref: "#/components/schemas/ChangeRequestUpdateData" included: - $ref: '#/components/schemas/ChangeRequestUpdateIncluded' + $ref: "#/components/schemas/ChangeRequestUpdateIncluded" required: - - data + - data type: object ChangeRequestUserRelationship: description: Relationship to a user. properties: data: - $ref: '#/components/schemas/ChangeRequestUserRelationshipData' + $ref: "#/components/schemas/ChangeRequestUserRelationshipData" required: - - data + - data type: object ChangeRequestUserRelationshipData: description: User relationship data. @@ -11477,15 +11041,15 @@ components: properties: id: description: The user UUID. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string type: description: The user resource type. - example: user + example: "user" type: string required: - - id - - type + - id + - type type: object ChargebackBreakdown: description: Charges breakdown. @@ -11495,8 +11059,7 @@ components: example: on_demand type: string cost: - description: The cost for a particular product and charge type during a - given month. + description: The cost for a particular product and charge type during a given month. format: double type: number product_name: @@ -11509,22 +11072,22 @@ components: properties: api_token: description: The `CircleCIAPIKey` `api_token`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/CircleCIAPIKeyType' + $ref: "#/components/schemas/CircleCIAPIKeyType" required: - - type - - api_token + - type + - api_token type: object CircleCIAPIKeyType: description: The definition of the `CircleCIAPIKey` object. enum: - - CircleCIAPIKey + - CircleCIAPIKey example: CircleCIAPIKey type: string x-enum-varnames: - - CIRCLECIAPIKEY + - CIRCLECIAPIKEY CircleCIAPIKeyUpdate: description: The definition of the `CircleCIAPIKey` object. properties: @@ -11532,68 +11095,68 @@ components: description: The `CircleCIAPIKeyUpdate` `api_token`. type: string type: - $ref: '#/components/schemas/CircleCIAPIKeyType' + $ref: "#/components/schemas/CircleCIAPIKeyType" required: - - type + - type type: object CircleCICredentials: description: The definition of the `CircleCICredentials` object. oneOf: - - $ref: '#/components/schemas/CircleCIAPIKey' + - $ref: "#/components/schemas/CircleCIAPIKey" CircleCICredentialsUpdate: description: The definition of the `CircleCICredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/CircleCIAPIKeyUpdate' + - $ref: "#/components/schemas/CircleCIAPIKeyUpdate" CircleCIIntegration: description: The definition of the `CircleCIIntegration` object. properties: credentials: - $ref: '#/components/schemas/CircleCICredentials' + $ref: "#/components/schemas/CircleCICredentials" type: - $ref: '#/components/schemas/CircleCIIntegrationType' + $ref: "#/components/schemas/CircleCIIntegrationType" required: - - type - - credentials + - type + - credentials type: object CircleCIIntegrationType: description: The definition of the `CircleCIIntegrationType` object. enum: - - CircleCI + - CircleCI example: CircleCI type: string x-enum-varnames: - - CIRCLECI + - CIRCLECI CircleCIIntegrationUpdate: description: The definition of the `CircleCIIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/CircleCICredentialsUpdate' + $ref: "#/components/schemas/CircleCICredentialsUpdate" type: - $ref: '#/components/schemas/CircleCIIntegrationType' + $ref: "#/components/schemas/CircleCIIntegrationType" required: - - type + - type type: object ClickupAPIKey: description: The definition of the `ClickupAPIKey` object. properties: api_token: description: The `ClickupAPIKey` `api_token`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/ClickupAPIKeyType' + $ref: "#/components/schemas/ClickupAPIKeyType" required: - - type - - api_token + - type + - api_token type: object ClickupAPIKeyType: description: The definition of the `ClickupAPIKey` object. enum: - - ClickupAPIKey + - ClickupAPIKey example: ClickupAPIKey type: string x-enum-varnames: - - CLICKUPAPIKEY + - CLICKUPAPIKEY ClickupAPIKeyUpdate: description: The definition of the `ClickupAPIKey` object. properties: @@ -11601,77 +11164,70 @@ components: description: The `ClickupAPIKeyUpdate` `api_token`. type: string type: - $ref: '#/components/schemas/ClickupAPIKeyType' + $ref: "#/components/schemas/ClickupAPIKeyType" required: - - type + - type type: object ClickupCredentials: description: The definition of the `ClickupCredentials` object. oneOf: - - $ref: '#/components/schemas/ClickupAPIKey' + - $ref: "#/components/schemas/ClickupAPIKey" ClickupCredentialsUpdate: description: The definition of the `ClickupCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/ClickupAPIKeyUpdate' + - $ref: "#/components/schemas/ClickupAPIKeyUpdate" ClickupIntegration: description: The definition of the `ClickupIntegration` object. properties: credentials: - $ref: '#/components/schemas/ClickupCredentials' + $ref: "#/components/schemas/ClickupCredentials" type: - $ref: '#/components/schemas/ClickupIntegrationType' + $ref: "#/components/schemas/ClickupIntegrationType" required: - - type - - credentials + - type + - credentials type: object ClickupIntegrationType: description: The definition of the `ClickupIntegrationType` object. enum: - - Clickup + - Clickup example: Clickup type: string x-enum-varnames: - - CLICKUP + - CLICKUP ClickupIntegrationUpdate: description: The definition of the `ClickupIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/ClickupCredentialsUpdate' + $ref: "#/components/schemas/ClickupCredentialsUpdate" type: - $ref: '#/components/schemas/ClickupIntegrationType' + $ref: "#/components/schemas/ClickupIntegrationType" required: - - type + - type type: object CloudAssetType: description: The cloud asset type enum: - - Host - - HostImage - - Image + - Host + - HostImage + - Image example: Host type: string x-enum-varnames: - - HOST - - HOST_IMAGE - - IMAGE + - HOST + - HOST_IMAGE + - IMAGE CloudConfigurationComplianceRuleOptions: additionalProperties: {} - description: 'Options for cloud_configuration rules. - - Fields `resourceType` and `regoRule` are mandatory when managing custom `cloud_configuration` - rules.' + description: "Options for cloud_configuration rules.\nFields `resourceType` and `regoRule` are mandatory when managing custom `cloud_configuration` rules." properties: complexRule: - description: 'Whether the rule is a complex one. - - Must be set to true if `regoRule.resourceTypes` contains more than one - item. Defaults to false.' + description: "Whether the rule is a complex one.\nMust be set to true if `regoRule.resourceTypes` contains more than one item. Defaults to false." type: boolean regoRule: - $ref: '#/components/schemas/CloudConfigurationRegoRule' + $ref: "#/components/schemas/CloudConfigurationRegoRule" resourceType: - description: Main resource type to be checked by the rule. It should be - specified again in `regoRule.resourceTypes`. + description: "Main resource type to be checked by the rule. It should be specified again in `regoRule.resourceTypes`." example: aws_acm type: string type: object @@ -11679,29 +11235,20 @@ components: description: Rule details. properties: policy: - description: 'The policy written in `rego`, see: https://www.openpolicyagent.org/docs/latest/policy-language/' - example: "package datadog\n\nimport data.datadog.output as dd_output\nimport - future.keywords.contains\nimport future.keywords.if\nimport future.keywords.in\n\neval(resource) - = \"skip\" if {\n # Logic that evaluates to true if the resource should - be skipped\n true\n} else = \"pass\" {\n # Logic that evaluates to true - if the resource is compliant\n true\n} else = \"fail\" {\n # Logic that - evaluates to true if the resource is not compliant\n true\n}\n\n# This - part remains unchanged for all rules\nresults contains result if {\n some - resource in input.resources[input.main_resource_type]\n result := dd_output.format(resource, - eval(resource))\n}" + description: "The policy written in `rego`, see: https://www.openpolicyagent.org/docs/latest/policy-language/" + example: "package datadog\n\nimport data.datadog.output as dd_output\nimport future.keywords.contains\nimport future.keywords.if\nimport future.keywords.in\n\neval(resource) = \"skip\" if {\n # Logic that evaluates to true if the resource should be skipped\n true\n} else = \"pass\" {\n # Logic that evaluates to true if the resource is compliant\n true\n} else = \"fail\" {\n # Logic that evaluates to true if the resource is not compliant\n true\n}\n\n# This part remains unchanged for all rules\nresults contains result if {\n some resource in input.resources[input.main_resource_type]\n result := dd_output.format(resource, eval(resource))\n}" type: string resourceTypes: - description: List of resource types that will be evaluated upon. Must have - at least one element. + description: List of resource types that will be evaluated upon. Must have at least one element. example: - - gcp_iam_service_account - - gcp_iam_policy + - gcp_iam_service_account + - gcp_iam_policy items: type: string type: array required: - - policy - - resourceTypes + - policy + - resourceTypes type: object CloudConfigurationRuleCaseCreate: description: Description of signals. @@ -11713,13 +11260,12 @@ components: type: string type: array status: - $ref: '#/components/schemas/SecurityMonitoringRuleSeverity' + $ref: "#/components/schemas/SecurityMonitoringRuleSeverity" required: - - status + - status type: object CloudConfigurationRuleComplianceSignalOptions: - description: How to generate compliance signals. Useful for cloud_configuration - rules only. + description: How to generate compliance signals. Useful for cloud_configuration rules only. properties: defaultActivationStatus: description: The default activation status. @@ -11746,19 +11292,16 @@ components: description: Create a new cloud configuration rule. properties: cases: - description: Description of generated findings and signals (severity and - channels to be notified in case of a signal). Must contain exactly one - item. + description: "Description of generated findings and signals (severity and channels to be notified in case of a signal). Must contain exactly one item." items: - $ref: '#/components/schemas/CloudConfigurationRuleCaseCreate' + $ref: "#/components/schemas/CloudConfigurationRuleCaseCreate" type: array complianceSignalOptions: - $ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions' + $ref: "#/components/schemas/CloudConfigurationRuleComplianceSignalOptions" filters: - description: Additional queries to filter matched events before they are - processed. + description: Additional queries to filter matched events before they are processed. items: - $ref: '#/components/schemas/SecurityMonitoringFilter' + $ref: "#/components/schemas/SecurityMonitoringFilter" type: array isEnabled: description: Whether the rule is enabled. @@ -11766,73 +11309,61 @@ components: type: boolean message: description: Message in markdown format for generated findings and signals. - example: '#Description - - Explanation of the rule. - - - #Remediation - - How to fix the security issue.' + example: "#Description\nExplanation of the rule.\n\n#Remediation\nHow to fix the security issue." type: string name: description: The name of the rule. example: My security monitoring rule. type: string options: - $ref: '#/components/schemas/CloudConfigurationRuleOptions' + $ref: "#/components/schemas/CloudConfigurationRuleOptions" tags: description: Tags for generated findings and signals. example: - - env:prod - - team:security + - env:prod + - team:security items: description: Tag. type: string type: array type: - $ref: '#/components/schemas/CloudConfigurationRuleType' + $ref: "#/components/schemas/CloudConfigurationRuleType" required: - - name - - isEnabled - - options - - complianceSignalOptions - - cases - - message + - name + - isEnabled + - options + - complianceSignalOptions + - cases + - message type: object CloudConfigurationRuleOptions: description: Options on cloud configuration rules. properties: complianceRuleOptions: - $ref: '#/components/schemas/CloudConfigurationComplianceRuleOptions' + $ref: "#/components/schemas/CloudConfigurationComplianceRuleOptions" required: - - complianceRuleOptions + - complianceRuleOptions type: object CloudConfigurationRulePayload: description: The payload of a cloud configuration rule. properties: cases: - description: Description of generated findings and signals (severity and - channels to be notified in case of a signal). Must contain exactly one - item. + description: "Description of generated findings and signals (severity and channels to be notified in case of a signal). Must contain exactly one item." items: - $ref: '#/components/schemas/CloudConfigurationRuleCaseCreate' + $ref: "#/components/schemas/CloudConfigurationRuleCaseCreate" type: array complianceSignalOptions: - $ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions' + $ref: "#/components/schemas/CloudConfigurationRuleComplianceSignalOptions" customMessage: - description: Custom/Overridden message for generated signals (used in case - of Default rule update). + description: Custom/Overridden message for generated signals (used in case of Default rule update). type: string customName: - description: Custom/Overridden name of the rule (used in case of Default - rule update). + description: Custom/Overridden name of the rule (used in case of Default rule update). type: string filters: - description: Additional queries to filter matched events before they are - processed. + description: Additional queries to filter matched events before they are processed. items: - $ref: '#/components/schemas/SecurityMonitoringFilter' + $ref: "#/components/schemas/SecurityMonitoringFilter" type: array isEnabled: description: Whether the rule is enabled. @@ -11840,705 +11371,690 @@ components: type: boolean message: description: Message in markdown format for generated findings and signals. - example: '#Description - - Explanation of the rule. - - - #Remediation - - How to fix the security issue.' + example: "#Description\nExplanation of the rule.\n\n#Remediation\nHow to fix the security issue." type: string name: description: The name of the rule. example: My security monitoring rule. type: string options: - $ref: '#/components/schemas/CloudConfigurationRuleOptions' + $ref: "#/components/schemas/CloudConfigurationRuleOptions" tags: description: Tags for generated findings and signals. example: - - env:prod - - team:security + - env:prod + - team:security items: description: Tag. type: string type: array type: - $ref: '#/components/schemas/CloudConfigurationRuleType' + $ref: "#/components/schemas/CloudConfigurationRuleType" required: - - name - - isEnabled - - options - - complianceSignalOptions - - cases - - message + - name + - isEnabled + - options + - complianceSignalOptions + - cases + - message type: object CloudConfigurationRuleType: description: The rule type. enum: - - cloud_configuration + - cloud_configuration type: string x-enum-varnames: - - CLOUD_CONFIGURATION + - CLOUD_CONFIGURATION CloudWorkloadSecurityAgentPoliciesListResponse: - description: Response object that includes a list of Agent policies + description: "Response object that includes a list of Agent policies" properties: data: - description: A list of Agent policy objects + description: "A list of Agent policy objects" items: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyData' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyData" type: array type: object CloudWorkloadSecurityAgentPolicyAttributes: - description: A Cloud Workload Security Agent policy returned by the API + description: "A Cloud Workload Security Agent policy returned by the API" properties: blockingRulesCount: - description: The number of rules with the blocking feature in this policy + description: "The number of rules with the blocking feature in this policy" example: 100 format: int32 maximum: 2147483647 type: integer datadogManaged: - description: Whether the policy is managed by Datadog + description: "Whether the policy is managed by Datadog" example: false type: boolean description: - description: The description of the policy - example: My agent policy + description: "The description of the policy" + example: "My agent policy" type: string disabledRulesCount: - description: The number of rules that are disabled in this policy + description: "The number of rules that are disabled in this policy" example: 100 format: int32 maximum: 2147483647 type: integer enabled: - description: Whether the Agent policy is enabled + description: "Whether the Agent policy is enabled" example: true type: boolean hostTags: - description: The host tags defining where this policy is deployed + description: "The host tags defining where this policy is deployed" items: type: string type: array hostTagsLists: - description: The host tags defining where this policy is deployed, the inner - values are linked with AND, the outer values are linked with OR + description: "The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR" items: items: type: string type: array type: array monitoringRulesCount: - description: The number of rules in the monitoring state in this policy + description: "The number of rules in the monitoring state in this policy" example: 100 format: int32 maximum: 2147483647 type: integer name: - description: The name of the policy - example: my_agent_policy + description: "The name of the policy" + example: "my_agent_policy" type: string pinned: - description: Whether the policy is pinned + description: "Whether the policy is pinned" example: false type: boolean policyType: - description: The type of the policy - example: policy + description: "The type of the policy" + example: "policy" type: string policyVersion: - description: The version of the policy - example: '1' + description: "The version of the policy" + example: "1" type: string priority: - description: The priority of the policy + description: "The priority of the policy" example: 10 format: int64 type: integer ruleCount: - description: The number of rules in this policy + description: "The number of rules in this policy" example: 100 format: int32 maximum: 2147483647 type: integer updateDate: - description: Timestamp in milliseconds when the policy was last updated + description: "Timestamp in milliseconds when the policy was last updated" example: 1624366480320 format: int64 type: integer updatedAt: - description: When the policy was last updated, timestamp in milliseconds + description: "When the policy was last updated, timestamp in milliseconds" example: 1624366480320 format: int64 type: integer updater: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdaterAttributes' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdaterAttributes" versions: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyVersions' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyVersions" type: object CloudWorkloadSecurityAgentPolicyCreateAttributes: - description: Create a new Cloud Workload Security Agent policy + description: "Create a new Cloud Workload Security Agent policy" properties: description: - description: The description of the policy - example: My agent policy + description: "The description of the policy" + example: "My agent policy" type: string enabled: - description: Whether the policy is enabled + description: "Whether the policy is enabled" example: true type: boolean hostTags: - description: The host tags defining where this policy is deployed + description: "The host tags defining where this policy is deployed" items: type: string type: array hostTagsLists: - description: The host tags defining where this policy is deployed, the inner - values are linked with AND, the outer values are linked with OR + description: "The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR" items: items: type: string type: array type: array name: - description: The name of the policy - example: my_agent_policy + description: "The name of the policy" + example: "my_agent_policy" type: string required: - - name + - name type: object CloudWorkloadSecurityAgentPolicyCreateData: - description: Object for a single Agent rule + description: "Object for a single Agent rule" properties: attributes: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateAttributes' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateAttributes" type: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyType' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyType" required: - - attributes - - type + - attributes + - type type: object CloudWorkloadSecurityAgentPolicyCreateRequest: - description: Request object that includes the Agent policy to create + description: "Request object that includes the Agent policy to create" properties: data: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateData' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateData" required: - - data + - data type: object CloudWorkloadSecurityAgentPolicyData: - description: Object for a single Agent policy + description: "Object for a single Agent policy" properties: attributes: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyAttributes' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyAttributes" id: - description: The ID of the Agent policy - example: 6517fcc1-cec7-4394-a655-8d6e9d085255 + description: "The ID of the Agent policy" + example: "6517fcc1-cec7-4394-a655-8d6e9d085255" type: string type: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyType' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyType" type: object CloudWorkloadSecurityAgentPolicyID: - description: The ID of the Agent policy - example: 6517fcc1-cec7-4394-a655-8d6e9d085255 + description: "The ID of the Agent policy" + example: "6517fcc1-cec7-4394-a655-8d6e9d085255" type: string CloudWorkloadSecurityAgentPolicyResponse: - description: Response object that includes an Agent policy + description: "Response object that includes an Agent policy" properties: data: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyData' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyData" type: object CloudWorkloadSecurityAgentPolicyType: default: policy - description: The type of the resource, must always be `policy` + description: "The type of the resource, must always be `policy`" enum: - - policy + - policy example: policy type: string - x-enum-varnames: - - POLICY + x-enum-varnames: ["POLICY"] CloudWorkloadSecurityAgentPolicyUpdateAttributes: - description: Update an existing Cloud Workload Security Agent policy + description: "Update an existing Cloud Workload Security Agent policy" properties: description: - description: The description of the policy - example: My agent policy + description: "The description of the policy" + example: "My agent policy" type: string enabled: - description: Whether the policy is enabled + description: "Whether the policy is enabled" example: true type: boolean hostTags: - description: The host tags defining where this policy is deployed + description: "The host tags defining where this policy is deployed" items: type: string type: array hostTagsLists: - description: The host tags defining where this policy is deployed, the inner - values are linked with AND, the outer values are linked with OR + description: "The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR" items: items: type: string type: array type: array name: - description: The name of the policy - example: my_agent_policy + description: "The name of the policy" + example: "my_agent_policy" type: string type: object CloudWorkloadSecurityAgentPolicyUpdateData: - description: Object for a single Agent policy + description: "Object for a single Agent policy" properties: attributes: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateAttributes' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateAttributes" id: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyID' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyID" type: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyType' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyType" required: - - attributes - - type + - attributes + - type type: object CloudWorkloadSecurityAgentPolicyUpdateRequest: - description: Request object that includes the Agent policy with the attributes - to update + description: "Request object that includes the Agent policy with the attributes to update" properties: data: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateData' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateData" required: - - data + - data type: object CloudWorkloadSecurityAgentPolicyUpdaterAttributes: - description: The attributes of the user who last updated the policy + description: "The attributes of the user who last updated the policy" properties: handle: - description: The handle of the user - example: datadog.user@example.com + description: "The handle of the user" + example: "datadog.user@example.com" type: string name: - description: The name of the user - example: Datadog User + description: "The name of the user" + example: "Datadog User" nullable: true type: string type: object CloudWorkloadSecurityAgentPolicyVersion: - description: The versions of the policy + description: "The versions of the policy" properties: date: - description: The date and time the version was created + description: "The date and time the version was created" nullable: true type: string name: - description: The version of the policy - example: 1.47.0-rc2 + description: "The version of the policy" + example: "1.47.0-rc2" type: string type: object CloudWorkloadSecurityAgentPolicyVersions: - description: The versions of the policy + description: "The versions of the policy" items: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyVersion' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyVersion" type: array CloudWorkloadSecurityAgentRuleAction: - description: The action the rule can perform if triggered + description: "The action the rule can perform if triggered" properties: filter: - description: SECL expression used to target the container to apply the action - on + description: "SECL expression used to target the container to apply the action on" type: string hash: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionHash' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleActionHash" kill: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleKill' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleKill" metadata: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionMetadata' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleActionMetadata" set: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionSet' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleActionSet" type: object CloudWorkloadSecurityAgentRuleActionHash: - description: Hash file specified by the field attribute + description: "Hash file specified by the field attribute" properties: field: - description: The field of the hash action + description: "The field of the hash action" type: string type: object CloudWorkloadSecurityAgentRuleActionMetadata: - description: The metadata action applied on the scope matching the rule + description: "The metadata action applied on the scope matching the rule" properties: image_tag: - description: The image tag of the metadata action + description: "The image tag of the metadata action" type: string service: - description: The service of the metadata action + description: "The service of the metadata action" type: string short_image: - description: The short image of the metadata action + description: "The short image of the metadata action" type: string type: object CloudWorkloadSecurityAgentRuleActionSet: - description: The set action applied on the scope matching the rule + description: "The set action applied on the scope matching the rule" properties: append: - description: Whether the value should be appended to the field. + description: "Whether the value should be appended to the field." type: boolean default_value: - description: The default value of the set action + description: "The default value of the set action" type: string expression: - description: The expression of the set action. + description: "The expression of the set action." type: string field: - description: The field of the set action + description: "The field of the set action" type: string inherited: - description: Whether the value should be inherited. + description: "Whether the value should be inherited." type: boolean name: - description: The name of the set action + description: "The name of the set action" type: string scope: - description: The scope of the set action. + description: "The scope of the set action." type: string size: - description: The size of the set action. + description: "The size of the set action." format: int64 type: integer ttl: - description: The time to live of the set action. + description: "The time to live of the set action." format: int64 type: integer value: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionSetValue' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleActionSetValue" type: object CloudWorkloadSecurityAgentRuleActionSetValue: - description: The value of the set action + description: "The value of the set action" oneOf: - - type: string - - type: integer - - type: boolean + - type: string + - type: integer + - type: boolean CloudWorkloadSecurityAgentRuleActions: - description: The array of actions the rule can perform if triggered + description: "The array of actions the rule can perform if triggered" items: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleAction' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleAction" nullable: true type: array CloudWorkloadSecurityAgentRuleAttributes: - description: A Cloud Workload Security Agent rule returned by the API + description: "A Cloud Workload Security Agent rule returned by the API" properties: actions: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActions' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleActions" agentConstraint: - description: The version of the Agent + description: "The version of the Agent" type: string blocking: - description: The blocking policies that the rule belongs to + description: "The blocking policies that the rule belongs to" items: type: string type: array category: - description: The category of the Agent rule - example: Process Activity + description: "The category of the Agent rule" + example: "Process Activity" type: string creationAuthorUuId: - description: The ID of the user who created the rule + description: "The ID of the user who created the rule" example: e51c9744-d158-11ec-ad23-da7ad0900002 type: string creationDate: - description: When the Agent rule was created, timestamp in milliseconds + description: "When the Agent rule was created, timestamp in milliseconds" example: 1624366480320 format: int64 type: integer creator: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreatorAttributes' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleCreatorAttributes" defaultRule: - description: Whether the rule is included by default + description: "Whether the rule is included by default" example: false type: boolean description: - description: The description of the Agent rule - example: My Agent rule + description: "The description of the Agent rule" + example: "My Agent rule" type: string disabled: - description: The disabled policies that the rule belongs to + description: "The disabled policies that the rule belongs to" items: type: string type: array enabled: - description: Whether the Agent rule is enabled + description: "Whether the Agent rule is enabled" example: true type: boolean expression: - description: The SECL expression of the Agent rule - example: exec.file.name == "sh" + description: "The SECL expression of the Agent rule" + example: 'exec.file.name == "sh"' type: string filters: - description: The platforms the Agent rule is supported on + description: "The platforms the Agent rule is supported on" items: type: string type: array monitoring: - description: The monitoring policies that the rule belongs to + description: "The monitoring policies that the rule belongs to" items: type: string type: array name: - description: The name of the Agent rule - example: my_agent_rule + description: "The name of the Agent rule" + example: "my_agent_rule" type: string product_tags: - description: The list of product tags associated with the rule + description: "The list of product tags associated with the rule" items: type: string type: array silent: - description: Whether the rule is silent. + description: "Whether the rule is silent." example: false type: boolean updateAuthorUuId: - description: The ID of the user who updated the rule + description: "The ID of the user who updated the rule" example: e51c9744-d158-11ec-ad23-da7ad0900002 type: string updateDate: - description: Timestamp in milliseconds when the Agent rule was last updated + description: "Timestamp in milliseconds when the Agent rule was last updated" example: 1624366480320 format: int64 type: integer updatedAt: - description: When the Agent rule was last updated, timestamp in milliseconds + description: "When the Agent rule was last updated, timestamp in milliseconds" example: 1624366480320 format: int64 type: integer updater: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdaterAttributes' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleUpdaterAttributes" version: - description: The version of the Agent rule + description: "The version of the Agent rule" example: 23 format: int64 type: integer type: object CloudWorkloadSecurityAgentRuleCreateAttributes: - description: Create a new Cloud Workload Security Agent rule. + description: "Create a new Cloud Workload Security Agent rule." properties: actions: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActions' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleActions" agent_version: - description: Constrain the rule to specific versions of the Datadog Agent. + description: "Constrain the rule to specific versions of the Datadog Agent." type: string blocking: - description: The blocking policies that the rule belongs to. + description: "The blocking policies that the rule belongs to." items: type: string type: array description: - description: The description of the Agent rule. - example: My Agent rule + description: "The description of the Agent rule." + example: "My Agent rule" type: string disabled: - description: The disabled policies that the rule belongs to. + description: "The disabled policies that the rule belongs to." items: type: string type: array enabled: - description: Whether the Agent rule is enabled. + description: "Whether the Agent rule is enabled." example: true type: boolean expression: - description: The SECL expression of the Agent rule. - example: exec.file.name == "sh" + description: "The SECL expression of the Agent rule." + example: 'exec.file.name == "sh"' type: string filters: - description: The platforms the Agent rule is supported on. + description: "The platforms the Agent rule is supported on." items: type: string type: array monitoring: - description: The monitoring policies that the rule belongs to. + description: "The monitoring policies that the rule belongs to." items: type: string type: array name: - description: The name of the Agent rule. - example: my_agent_rule + description: "The name of the Agent rule." + example: "my_agent_rule" type: string policy_id: - description: The ID of the policy where the Agent rule is saved. - example: a8c8e364-6556-434d-b798-a4c23de29c0b + description: "The ID of the policy where the Agent rule is saved." + example: "a8c8e364-6556-434d-b798-a4c23de29c0b" type: string product_tags: - description: The list of product tags associated with the rule. + description: "The list of product tags associated with the rule." items: type: string type: array silent: - description: Whether the rule is silent. + description: "Whether the rule is silent." example: false type: boolean required: - - name - - expression + - name + - expression type: object CloudWorkloadSecurityAgentRuleCreateData: - description: Object for a single Agent rule + description: "Object for a single Agent rule" properties: attributes: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateAttributes' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleCreateAttributes" type: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleType" required: - - attributes - - type + - attributes + - type type: object CloudWorkloadSecurityAgentRuleCreateRequest: - description: Request object that includes the Agent rule to create + description: "Request object that includes the Agent rule to create" properties: data: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateData' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleCreateData" required: - - data + - data type: object CloudWorkloadSecurityAgentRuleCreatorAttributes: - description: The attributes of the user who created the Agent rule + description: "The attributes of the user who created the Agent rule" properties: handle: - description: The handle of the user - example: datadog.user@example.com + description: "The handle of the user" + example: "datadog.user@example.com" type: string name: - description: The name of the user - example: Datadog User + description: "The name of the user" + example: "Datadog User" nullable: true type: string type: object CloudWorkloadSecurityAgentRuleData: - description: Object for a single Agent rule + description: "Object for a single Agent rule" properties: attributes: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleAttributes' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleAttributes" id: - description: The ID of the Agent rule - example: 3dd-0uc-h1s + description: "The ID of the Agent rule" + example: "3dd-0uc-h1s" type: string type: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleType" type: object CloudWorkloadSecurityAgentRuleID: - description: The ID of the Agent rule - example: 3dd-0uc-h1s + description: "The ID of the Agent rule" + example: "3dd-0uc-h1s" type: string CloudWorkloadSecurityAgentRuleKill: - description: Kill system call applied on the container matching the rule + description: "Kill system call applied on the container matching the rule" properties: signal: - description: Supported signals for the kill system call + description: "Supported signals for the kill system call" type: string type: object CloudWorkloadSecurityAgentRuleResponse: - description: Response object that includes an Agent rule + description: "Response object that includes an Agent rule" properties: data: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleData' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleData" type: object CloudWorkloadSecurityAgentRuleType: default: agent_rule - description: The type of the resource, must always be `agent_rule` + description: "The type of the resource, must always be `agent_rule`" enum: - - agent_rule + - agent_rule example: agent_rule type: string - x-enum-varnames: - - AGENT_RULE + x-enum-varnames: ["AGENT_RULE"] CloudWorkloadSecurityAgentRuleUpdateAttributes: - description: Update an existing Cloud Workload Security Agent rule + description: "Update an existing Cloud Workload Security Agent rule" properties: actions: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActions' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleActions" agent_version: - description: Constrain the rule to specific versions of the Datadog Agent + description: "Constrain the rule to specific versions of the Datadog Agent" type: string blocking: - description: The blocking policies that the rule belongs to + description: "The blocking policies that the rule belongs to" items: type: string type: array description: - description: The description of the Agent rule - example: My Agent rule + description: "The description of the Agent rule" + example: "My Agent rule" type: string disabled: - description: The disabled policies that the rule belongs to + description: "The disabled policies that the rule belongs to" items: type: string type: array enabled: - description: Whether the Agent rule is enabled + description: "Whether the Agent rule is enabled" example: true type: boolean expression: - description: The SECL expression of the Agent rule - example: exec.file.name == "sh" + description: "The SECL expression of the Agent rule" + example: 'exec.file.name == "sh"' type: string monitoring: - description: The monitoring policies that the rule belongs to + description: "The monitoring policies that the rule belongs to" items: type: string type: array policy_id: - description: The ID of the policy where the Agent rule is saved - example: a8c8e364-6556-434d-b798-a4c23de29c0b + description: "The ID of the policy where the Agent rule is saved" + example: "a8c8e364-6556-434d-b798-a4c23de29c0b" type: string product_tags: - description: The list of product tags associated with the rule + description: "The list of product tags associated with the rule" items: type: string type: array silent: - description: Whether the rule is silent. + description: "Whether the rule is silent." example: false type: boolean type: object CloudWorkloadSecurityAgentRuleUpdateData: - description: Object for a single Agent rule + description: "Object for a single Agent rule" properties: attributes: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateAttributes' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateAttributes" id: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleID' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleID" type: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleType" required: - - attributes - - type + - attributes + - type type: object CloudWorkloadSecurityAgentRuleUpdateRequest: - description: Request object that includes the Agent rule with the attributes - to update + description: "Request object that includes the Agent rule with the attributes to update" properties: data: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateData' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateData" required: - - data + - data type: object CloudWorkloadSecurityAgentRuleUpdaterAttributes: - description: The attributes of the user who last updated the Agent rule + description: "The attributes of the user who last updated the Agent rule" properties: handle: - description: The handle of the user - example: datadog.user@example.com + description: "The handle of the user" + example: "datadog.user@example.com" type: string name: - description: The name of the user - example: Datadog User + description: "The name of the user" + example: "Datadog User" nullable: true type: string type: object CloudWorkloadSecurityAgentRulesListResponse: - description: Response object that includes a list of Agent rule + description: "Response object that includes a list of Agent rule" properties: data: - description: A list of Agent rules objects + description: "A list of Agent rules objects" items: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleData' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleData" type: array type: object CloudflareAPIToken: @@ -12546,22 +12062,22 @@ components: properties: api_token: description: The `CloudflareAPIToken` `api_token`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/CloudflareAPITokenType' + $ref: "#/components/schemas/CloudflareAPITokenType" required: - - type - - api_token + - type + - api_token type: object CloudflareAPITokenType: description: The definition of the `CloudflareAPIToken` object. enum: - - CloudflareAPIToken + - CloudflareAPIToken example: CloudflareAPIToken type: string x-enum-varnames: - - CLOUDFLAREAPITOKEN + - CLOUDFLAREAPITOKEN CloudflareAPITokenUpdate: description: The definition of the `CloudflareAPIToken` object. properties: @@ -12569,184 +12085,161 @@ components: description: The `CloudflareAPITokenUpdate` `api_token`. type: string type: - $ref: '#/components/schemas/CloudflareAPITokenType' + $ref: "#/components/schemas/CloudflareAPITokenType" required: - - type + - type type: object CloudflareAccountCreateRequest: description: Payload schema when adding a Cloudflare account. properties: data: - $ref: '#/components/schemas/CloudflareAccountCreateRequestData' + $ref: "#/components/schemas/CloudflareAccountCreateRequestData" required: - - data + - data type: object CloudflareAccountCreateRequestAttributes: description: Attributes object for creating a Cloudflare account. properties: api_key: description: The API key (or token) for the Cloudflare account. - example: a94a8fe5ccb19ba61c4c0873d391e987982fbbd3 + example: "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3" type: string email: - description: The email associated with the Cloudflare account. If an API - key is provided (and not a token), this field is also required. - example: test-email@example.com + description: The email associated with the Cloudflare account. If an API key is provided (and not a token), this field is also required. + example: "test-email@example.com" type: string name: description: The name of the Cloudflare account. - example: test-name + example: "test-name" type: string resources: - description: An allowlist of resources to restrict pulling metrics for including - `'web', 'dns', 'lb' (load balancer), 'worker'`. - example: - - web - - dns - - lb - - worker + description: An allowlist of resources to restrict pulling metrics for including `'web', 'dns', 'lb' (load balancer), 'worker'`. + example: ["web", "dns", "lb", "worker"] items: type: string type: array zones: description: An allowlist of zones to restrict pulling metrics for. - example: - - zone_id_1 - - zone_id_2 + example: ["zone_id_1", "zone_id_2"] items: type: string type: array required: - - api_key - - name + - api_key + - name type: object CloudflareAccountCreateRequestData: description: Data object for creating a Cloudflare account. properties: attributes: - $ref: '#/components/schemas/CloudflareAccountCreateRequestAttributes' + $ref: "#/components/schemas/CloudflareAccountCreateRequestAttributes" type: - $ref: '#/components/schemas/CloudflareAccountType' + $ref: "#/components/schemas/CloudflareAccountType" required: - - attributes - - type + - attributes + - type type: object CloudflareAccountResponse: description: The expected response schema when getting a Cloudflare account. properties: data: - $ref: '#/components/schemas/CloudflareAccountResponseData' + $ref: "#/components/schemas/CloudflareAccountResponseData" type: object CloudflareAccountResponseAttributes: description: Attributes object of a Cloudflare account. properties: email: description: The email associated with the Cloudflare account. - example: test-email@example.com + example: "test-email@example.com" type: string name: description: The name of the Cloudflare account. - example: test-name + example: "test-name" type: string resources: - description: An allowlist of resources, such as `web`, `dns`, `lb` (load - balancer), `worker`, that restricts pulling metrics from those resources. - example: - - web - - dns - - lb - - worker + description: An allowlist of resources, such as `web`, `dns`, `lb` (load balancer), `worker`, that restricts pulling metrics from those resources. + example: ["web", "dns", "lb", "worker"] items: type: string type: array zones: description: An allowlist of zones to restrict pulling metrics for. - example: - - zone_id_1 - - zone_id_2 + example: ["zone_id_1", "zone_id_2"] items: type: string type: array required: - - name + - name type: object CloudflareAccountResponseData: description: Data object of a Cloudflare account. properties: attributes: - $ref: '#/components/schemas/CloudflareAccountResponseAttributes' + $ref: "#/components/schemas/CloudflareAccountResponseAttributes" id: description: The ID of the Cloudflare account, a hash of the account name. - example: c1a8e059bfd1e911cf10b626340c9a54 + example: "c1a8e059bfd1e911cf10b626340c9a54" type: string type: - $ref: '#/components/schemas/CloudflareAccountType' + $ref: "#/components/schemas/CloudflareAccountType" required: - - attributes - - id - - type + - attributes + - id + - type type: object CloudflareAccountType: default: cloudflare-accounts description: The JSON:API type for this API. Should always be `cloudflare-accounts`. enum: - - cloudflare-accounts + - cloudflare-accounts example: cloudflare-accounts type: string x-enum-varnames: - - CLOUDFLARE_ACCOUNTS + - CLOUDFLARE_ACCOUNTS CloudflareAccountUpdateRequest: description: Payload schema when updating a Cloudflare account. properties: data: - $ref: '#/components/schemas/CloudflareAccountUpdateRequestData' + $ref: "#/components/schemas/CloudflareAccountUpdateRequestData" required: - - data + - data type: object CloudflareAccountUpdateRequestAttributes: description: Attributes object for updating a Cloudflare account. properties: api_key: description: The API key of the Cloudflare account. - example: a94a8fe5ccb19ba61c4c0873d391e987982fbbd3 + example: "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3" type: string email: - description: The email associated with the Cloudflare account. If an API - key is provided (and not a token), this field is also required. - example: test-email@example.com + description: The email associated with the Cloudflare account. If an API key is provided (and not a token), this field is also required. + example: "test-email@example.com" type: string name: description: The name of the Cloudflare account. type: string resources: - description: An allowlist of resources to restrict pulling metrics for including - `'web', 'dns', 'lb' (load balancer), 'worker'`. - example: - - web - - dns - - lb - - worker + description: An allowlist of resources to restrict pulling metrics for including `'web', 'dns', 'lb' (load balancer), 'worker'`. + example: ["web", "dns", "lb", "worker"] items: type: string type: array zones: description: An allowlist of zones to restrict pulling metrics for. - example: - - zone_id_1 - - zone_id_2 + example: ["zone_id_1", "zone_id_2"] items: type: string type: array required: - - api_key + - api_key type: object CloudflareAccountUpdateRequestData: description: Data object for updating a Cloudflare account. properties: attributes: - $ref: '#/components/schemas/CloudflareAccountUpdateRequestAttributes' + $ref: "#/components/schemas/CloudflareAccountUpdateRequestAttributes" type: - $ref: '#/components/schemas/CloudflareAccountType' + $ref: "#/components/schemas/CloudflareAccountType" type: object CloudflareAccountsResponse: description: The expected response schema when getting Cloudflare accounts. @@ -12754,45 +12247,45 @@ components: data: description: The JSON:API data schema. items: - $ref: '#/components/schemas/CloudflareAccountResponseData' + $ref: "#/components/schemas/CloudflareAccountResponseData" type: array type: object CloudflareCredentials: description: The definition of the `CloudflareCredentials` object. oneOf: - - $ref: '#/components/schemas/CloudflareAPIToken' - - $ref: '#/components/schemas/CloudflareGlobalAPIToken' + - $ref: "#/components/schemas/CloudflareAPIToken" + - $ref: "#/components/schemas/CloudflareGlobalAPIToken" CloudflareCredentialsUpdate: description: The definition of the `CloudflareCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/CloudflareAPITokenUpdate' - - $ref: '#/components/schemas/CloudflareGlobalAPITokenUpdate' + - $ref: "#/components/schemas/CloudflareAPITokenUpdate" + - $ref: "#/components/schemas/CloudflareGlobalAPITokenUpdate" CloudflareGlobalAPIToken: description: The definition of the `CloudflareGlobalAPIToken` object. properties: auth_email: description: The `CloudflareGlobalAPIToken` `auth_email`. - example: '' + example: "" type: string global_api_key: description: The `CloudflareGlobalAPIToken` `global_api_key`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/CloudflareGlobalAPITokenType' + $ref: "#/components/schemas/CloudflareGlobalAPITokenType" required: - - type - - auth_email - - global_api_key + - type + - auth_email + - global_api_key type: object CloudflareGlobalAPITokenType: description: The definition of the `CloudflareGlobalAPIToken` object. enum: - - CloudflareGlobalAPIToken + - CloudflareGlobalAPIToken example: CloudflareGlobalAPIToken type: string x-enum-varnames: - - CLOUDFLAREGLOBALAPITOKEN + - CLOUDFLAREGLOBALAPITOKEN CloudflareGlobalAPITokenUpdate: description: The definition of the `CloudflareGlobalAPIToken` object. properties: @@ -12803,64 +12296,64 @@ components: description: The `CloudflareGlobalAPITokenUpdate` `global_api_key`. type: string type: - $ref: '#/components/schemas/CloudflareGlobalAPITokenType' + $ref: "#/components/schemas/CloudflareGlobalAPITokenType" required: - - type + - type type: object CloudflareIntegration: description: The definition of the `CloudflareIntegration` object. properties: credentials: - $ref: '#/components/schemas/CloudflareCredentials' + $ref: "#/components/schemas/CloudflareCredentials" type: - $ref: '#/components/schemas/CloudflareIntegrationType' + $ref: "#/components/schemas/CloudflareIntegrationType" required: - - type - - credentials + - type + - credentials type: object CloudflareIntegrationType: description: The definition of the `CloudflareIntegrationType` object. enum: - - Cloudflare + - Cloudflare example: Cloudflare type: string x-enum-varnames: - - CLOUDFLARE + - CLOUDFLARE CloudflareIntegrationUpdate: description: The definition of the `CloudflareIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/CloudflareCredentialsUpdate' + $ref: "#/components/schemas/CloudflareCredentialsUpdate" type: - $ref: '#/components/schemas/CloudflareIntegrationType' + $ref: "#/components/schemas/CloudflareIntegrationType" required: - - type + - type type: object CodeLocation: description: Code vulnerability location. properties: file_path: description: Vulnerability location file path. - example: src/Class.java:100 + example: "src/Class.java:100" type: string location: description: Vulnerability extracted location. - example: com.example.Class:100 + example: "com.example.Class:100" type: string method: description: Vulnerability location method. example: FooBar type: string required: - - location + - location type: object CommitCoverageSummaryRequest: description: Request object for getting code coverage summary for a commit. properties: data: - $ref: '#/components/schemas/CommitCoverageSummaryRequestData' + $ref: "#/components/schemas/CommitCoverageSummaryRequestData" required: - - data + - data type: object CommitCoverageSummaryRequestAttributes: description: Attributes for requesting code coverage summary for a commit. @@ -12868,7 +12361,7 @@ components: commit_sha: description: The commit SHA (40-character hexadecimal string). example: 66adc9350f2cc9b250b69abddab733dd55e1a588 - pattern: ^[a-fA-F0-9]{40}$ + pattern: "^[a-fA-F0-9]{40}$" type: string repository_id: description: The repository identifier. @@ -12876,29 +12369,28 @@ components: minLength: 1 type: string required: - - repository_id - - commit_sha + - repository_id + - commit_sha type: object CommitCoverageSummaryRequestData: description: Data object for commit summary request. properties: attributes: - $ref: '#/components/schemas/CommitCoverageSummaryRequestAttributes' + $ref: "#/components/schemas/CommitCoverageSummaryRequestAttributes" type: - $ref: '#/components/schemas/CommitCoverageSummaryRequestType' + $ref: "#/components/schemas/CommitCoverageSummaryRequestType" required: - - type - - attributes + - type + - attributes type: object CommitCoverageSummaryRequestType: - description: JSON:API type for commit coverage summary request. The value must - always be `ci_app_coverage_commit_summary_request`. + description: JSON:API type for commit coverage summary request. The value must always be `ci_app_coverage_commit_summary_request`. enum: - - ci_app_coverage_commit_summary_request + - ci_app_coverage_commit_summary_request example: ci_app_coverage_commit_summary_request type: string x-enum-varnames: - - CI_APP_COVERAGE_COMMIT_SUMMARY_REQUEST + - CI_APP_COVERAGE_COMMIT_SUMMARY_REQUEST CompletionCondition: description: The definition of `CompletionCondition` object. properties: @@ -12907,105 +12399,100 @@ components: operand2: description: The `CompletionCondition` `operand2`. operator: - $ref: '#/components/schemas/CompletionConditionOperator' + $ref: "#/components/schemas/CompletionConditionOperator" required: - - operand1 - - operator + - operand1 + - operator type: object CompletionConditionOperator: description: The definition of `CompletionConditionOperator` object. enum: - - OPERATOR_EQUAL - - OPERATOR_NOT_EQUAL - - OPERATOR_GREATER_THAN - - OPERATOR_LESS_THAN - - OPERATOR_GREATER_THAN_OR_EQUAL_TO - - OPERATOR_LESS_THAN_OR_EQUAL_TO - - OPERATOR_CONTAINS - - OPERATOR_DOES_NOT_CONTAIN - - OPERATOR_IS_NULL - - OPERATOR_IS_NOT_NULL - - OPERATOR_IS_EMPTY - - OPERATOR_IS_NOT_EMPTY + - OPERATOR_EQUAL + - OPERATOR_NOT_EQUAL + - OPERATOR_GREATER_THAN + - OPERATOR_LESS_THAN + - OPERATOR_GREATER_THAN_OR_EQUAL_TO + - OPERATOR_LESS_THAN_OR_EQUAL_TO + - OPERATOR_CONTAINS + - OPERATOR_DOES_NOT_CONTAIN + - OPERATOR_IS_NULL + - OPERATOR_IS_NOT_NULL + - OPERATOR_IS_EMPTY + - OPERATOR_IS_NOT_EMPTY example: OPERATOR_EQUAL type: string x-enum-varnames: - - OPERATOR_EQUAL - - OPERATOR_NOT_EQUAL - - OPERATOR_GREATER_THAN - - OPERATOR_LESS_THAN - - OPERATOR_GREATER_THAN_OR_EQUAL_TO - - OPERATOR_LESS_THAN_OR_EQUAL_TO - - OPERATOR_CONTAINS - - OPERATOR_DOES_NOT_CONTAIN - - OPERATOR_IS_NULL - - OPERATOR_IS_NOT_NULL - - OPERATOR_IS_EMPTY - - OPERATOR_IS_NOT_EMPTY + - OPERATOR_EQUAL + - OPERATOR_NOT_EQUAL + - OPERATOR_GREATER_THAN + - OPERATOR_LESS_THAN + - OPERATOR_GREATER_THAN_OR_EQUAL_TO + - OPERATOR_LESS_THAN_OR_EQUAL_TO + - OPERATOR_CONTAINS + - OPERATOR_DOES_NOT_CONTAIN + - OPERATOR_IS_NULL + - OPERATOR_IS_NOT_NULL + - OPERATOR_IS_EMPTY + - OPERATOR_IS_NOT_EMPTY CompletionGate: description: Used to create conditions before running subsequent actions. properties: completionCondition: - $ref: '#/components/schemas/CompletionCondition' + $ref: "#/components/schemas/CompletionCondition" retryStrategy: - $ref: '#/components/schemas/RetryStrategy' + $ref: "#/components/schemas/RetryStrategy" required: - - completionCondition - - retryStrategy + - completionCondition + - retryStrategy type: object Component: - description: '[Definition of a UI component in the app](https://docs.datadoghq.com/service_management/app_builder/components/)' + description: "[Definition of a UI component in the app](https://docs.datadoghq.com/service_management/app_builder/components/)" properties: events: description: Events to listen for on the UI component. items: - $ref: '#/components/schemas/AppBuilderEvent' + $ref: "#/components/schemas/AppBuilderEvent" type: array id: - description: The ID of the UI component. This property is deprecated; use - `name` to identify individual components instead. + description: The ID of the UI component. This property is deprecated; use `name` to identify individual components instead. nullable: true type: string name: - description: A unique identifier for this UI component. This name is also - visible in the app editor. - example: '' + description: A unique identifier for this UI component. This name is also visible in the app editor. + example: "" type: string properties: - $ref: '#/components/schemas/ComponentProperties' + $ref: "#/components/schemas/ComponentProperties" type: - $ref: '#/components/schemas/ComponentType' + $ref: "#/components/schemas/ComponentType" required: - - name - - type - - properties + - name + - type + - properties type: object ComponentGrid: - description: A grid component. The grid component is the root canvas for an - app and contains all other components. + description: A grid component. The grid component is the root canvas for an app and contains all other components. properties: events: description: Events to listen for on the grid component. items: - $ref: '#/components/schemas/AppBuilderEvent' + $ref: "#/components/schemas/AppBuilderEvent" type: array id: - description: The ID of the grid component. This property is deprecated; - use `name` to identify individual components instead. + description: The ID of the grid component. This property is deprecated; use `name` to identify individual components instead. type: string name: - description: A unique identifier for this grid component. This name is also - visible in the app editor. - example: '' + description: A unique identifier for this grid component. This name is also visible in the app editor. + example: "" type: string properties: - $ref: '#/components/schemas/ComponentGridProperties' + $ref: "#/components/schemas/ComponentGridProperties" type: - $ref: '#/components/schemas/ComponentGridType' + $ref: "#/components/schemas/ComponentGridType" required: - - name - - type - - properties + - name + - type + - properties type: object ComponentGridProperties: description: Properties of a grid component. @@ -13017,173 +12504,166 @@ components: children: description: The child components of the grid. items: - $ref: '#/components/schemas/Component' + $ref: "#/components/schemas/Component" type: array isVisible: - $ref: '#/components/schemas/ComponentGridPropertiesIsVisible' + $ref: "#/components/schemas/ComponentGridPropertiesIsVisible" type: object ComponentGridPropertiesIsVisible: - description: Whether the grid component and its children are visible. If a string, - it must be a valid JavaScript expression that evaluates to a boolean. + description: Whether the grid component and its children are visible. If a string, it must be a valid JavaScript expression that evaluates to a boolean. oneOf: - - type: string - - default: true - type: boolean + - type: string + - default: true + type: boolean ComponentGridType: default: grid description: The grid component type. enum: - - grid + - grid example: grid type: string x-enum-varnames: - - GRID + - GRID ComponentProperties: additionalProperties: {} - description: Properties of a UI component. Different component types can have - their own additional unique properties. See the [components documentation](https://docs.datadoghq.com/service_management/app_builder/components/) - for more detail on each component type and its properties. + description: Properties of a UI component. Different component types can have their own additional unique properties. See the [components documentation](https://docs.datadoghq.com/service_management/app_builder/components/) for more detail on each component type and its properties. properties: children: description: The child components of the UI component. items: - $ref: '#/components/schemas/Component' + $ref: "#/components/schemas/Component" type: array isVisible: - $ref: '#/components/schemas/ComponentPropertiesIsVisible' + $ref: "#/components/schemas/ComponentPropertiesIsVisible" type: object ComponentPropertiesIsVisible: - description: Whether the UI component is visible. If this is a string, it must - be a valid JavaScript expression that evaluates to a boolean. + description: Whether the UI component is visible. If this is a string, it must be a valid JavaScript expression that evaluates to a boolean. oneOf: - - type: boolean - - description: If this is a string, it must be a valid JavaScript expression - that evaluates to a boolean. - example: ${true} - type: string + - type: boolean + - description: "If this is a string, it must be a valid JavaScript expression that evaluates to a boolean." + example: "${true}" + type: string ComponentRecommendation: - description: Resource recommendation for a single Spark component (driver or - executor). Contains estimation data used to patch Spark job specs. + description: Resource recommendation for a single Spark component (driver or executor). Contains estimation data used to patch Spark job specs. properties: estimation: - $ref: '#/components/schemas/Estimation' - required: - - estimation + $ref: "#/components/schemas/Estimation" + required: [estimation] type: object ComponentType: description: The UI component type. enum: - - table - - textInput - - textArea - - button - - text - - select - - modal - - schemaForm - - checkbox - - tabs - - vegaChart - - radioButtons - - numberInput - - fileInput - - jsonInput - - gridCell - - dateRangePicker - - search - - container - - calloutValue + - table + - textInput + - textArea + - button + - text + - select + - modal + - schemaForm + - checkbox + - tabs + - vegaChart + - radioButtons + - numberInput + - fileInput + - jsonInput + - gridCell + - dateRangePicker + - search + - container + - calloutValue example: text type: string x-enum-varnames: - - TABLE - - TEXTINPUT - - TEXTAREA - - BUTTON - - TEXT - - SELECT - - MODAL - - SCHEMAFORM - - CHECKBOX - - TABS - - VEGACHART - - RADIOBUTTONS - - NUMBERINPUT - - FILEINPUT - - JSONINPUT - - GRIDCELL - - DATERANGEPICKER - - SEARCH - - CONTAINER - - CALLOUTVALUE + - TABLE + - TEXTINPUT + - TEXTAREA + - BUTTON + - TEXT + - SELECT + - MODAL + - SCHEMAFORM + - CHECKBOX + - TABS + - VEGACHART + - RADIOBUTTONS + - NUMBERINPUT + - FILEINPUT + - JSONINPUT + - GRIDCELL + - DATERANGEPICKER + - SEARCH + - CONTAINER + - CALLOUTVALUE ConfigCatCredentials: description: The definition of the `ConfigCatCredentials` object. oneOf: - - $ref: '#/components/schemas/ConfigCatSDKKey' + - $ref: "#/components/schemas/ConfigCatSDKKey" ConfigCatCredentialsUpdate: description: The definition of the `ConfigCatCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/ConfigCatSDKKeyUpdate' + - $ref: "#/components/schemas/ConfigCatSDKKeyUpdate" ConfigCatIntegration: description: The definition of the `ConfigCatIntegration` object. properties: credentials: - $ref: '#/components/schemas/ConfigCatCredentials' + $ref: "#/components/schemas/ConfigCatCredentials" type: - $ref: '#/components/schemas/ConfigCatIntegrationType' + $ref: "#/components/schemas/ConfigCatIntegrationType" required: - - type - - credentials + - type + - credentials type: object ConfigCatIntegrationType: description: The definition of the `ConfigCatIntegrationType` object. enum: - - ConfigCat + - ConfigCat example: ConfigCat type: string x-enum-varnames: - - CONFIGCAT + - CONFIGCAT ConfigCatIntegrationUpdate: description: The definition of the `ConfigCatIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/ConfigCatCredentialsUpdate' + $ref: "#/components/schemas/ConfigCatCredentialsUpdate" type: - $ref: '#/components/schemas/ConfigCatIntegrationType' + $ref: "#/components/schemas/ConfigCatIntegrationType" required: - - type + - type type: object ConfigCatSDKKey: description: The definition of the `ConfigCatSDKKey` object. properties: api_password: description: The `ConfigCatSDKKey` `api_password`. - example: '' + example: "" type: string api_username: description: The `ConfigCatSDKKey` `api_username`. - example: '' + example: "" type: string sdk_key: description: The `ConfigCatSDKKey` `sdk_key`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/ConfigCatSDKKeyType' + $ref: "#/components/schemas/ConfigCatSDKKeyType" required: - - type - - sdk_key - - api_username - - api_password + - type + - sdk_key + - api_username + - api_password type: object ConfigCatSDKKeyType: description: The definition of the `ConfigCatSDKKey` object. enum: - - ConfigCatSDKKey + - ConfigCatSDKKey example: ConfigCatSDKKey type: string x-enum-varnames: - - CONFIGCATSDKKEY + - CONFIGCATSDKKEY ConfigCatSDKKeyUpdate: description: The definition of the `ConfigCatSDKKey` object. properties: @@ -13197,257 +12677,246 @@ components: description: The `ConfigCatSDKKeyUpdate` `sdk_key`. type: string type: - $ref: '#/components/schemas/ConfigCatSDKKeyType' + $ref: "#/components/schemas/ConfigCatSDKKeyType" required: - - type + - type type: object ConfiguredSchedule: - description: Full resource representation of a configured schedule target with - position (previous, current, or next). + description: "Full resource representation of a configured schedule target with position (previous, current, or next)." properties: attributes: - $ref: '#/components/schemas/ConfiguredScheduleTargetAttributes' + $ref: "#/components/schemas/ConfiguredScheduleTargetAttributes" id: - description: Specifies the unique identifier of the configured schedule - target. - example: 00000000-aba1-0000-0000-000000000000_previous + description: "Specifies the unique identifier of the configured schedule target." + example: "00000000-aba1-0000-0000-000000000000_previous" type: string relationships: - $ref: '#/components/schemas/ConfiguredScheduleTargetRelationships' + $ref: "#/components/schemas/ConfiguredScheduleTargetRelationships" type: - $ref: '#/components/schemas/ConfiguredScheduleTargetType' + $ref: "#/components/schemas/ConfiguredScheduleTargetType" required: - - type - - id - - attributes - - relationships + - type + - id + - attributes + - relationships type: object ConfiguredScheduleTarget: - description: Relationship reference to a configured schedule target. + description: "Relationship reference to a configured schedule target." properties: id: - description: Specifies the unique identifier of the configured schedule - target. - example: 00000000-aba1-0000-0000-000000000000_previous + description: "Specifies the unique identifier of the configured schedule target." + example: "00000000-aba1-0000-0000-000000000000_previous" type: string type: - $ref: '#/components/schemas/ConfiguredScheduleTargetType' + $ref: "#/components/schemas/ConfiguredScheduleTargetType" required: - - type - - id + - type + - id type: object ConfiguredScheduleTargetAttributes: - description: Attributes for a configured schedule target, including position. + description: "Attributes for a configured schedule target, including position." example: position: previous properties: position: - $ref: '#/components/schemas/ScheduleTargetPosition' + $ref: "#/components/schemas/ScheduleTargetPosition" required: - - position + - position type: object ConfiguredScheduleTargetRelationships: - description: Represents the relationships of a configured schedule target. + description: "Represents the relationships of a configured schedule target." properties: schedule: - $ref: '#/components/schemas/ConfiguredScheduleTargetRelationshipsSchedule' + $ref: "#/components/schemas/ConfiguredScheduleTargetRelationshipsSchedule" required: - - schedule + - schedule type: object ConfiguredScheduleTargetRelationshipsSchedule: - description: Holds the schedule reference for a configured schedule target. + description: "Holds the schedule reference for a configured schedule target." properties: data: - $ref: '#/components/schemas/ScheduleTarget' + $ref: "#/components/schemas/ScheduleTarget" required: - - data + - data type: object ConfiguredScheduleTargetType: default: schedule_target - description: Indicates that the resource is of type `schedule_target`. + description: "Indicates that the resource is of type `schedule_target`." enum: - - schedule_target + - schedule_target example: schedule_target type: string x-enum-varnames: - - SCHEDULE_TARGET + - SCHEDULE_TARGET ConfluentAccountCreateRequest: description: Payload schema when adding a Confluent account. properties: data: - $ref: '#/components/schemas/ConfluentAccountCreateRequestData' + $ref: "#/components/schemas/ConfluentAccountCreateRequestData" required: - - data + - data type: object ConfluentAccountCreateRequestAttributes: description: Attributes associated with the account creation request. properties: api_key: description: The API key associated with your Confluent account. - example: TESTAPIKEY123 + example: "TESTAPIKEY123" type: string api_secret: description: The API secret associated with your Confluent account. - example: test-api-secret-123 + example: "test-api-secret-123" type: string resources: - description: A list of Confluent resources associated with the Confluent - account. + description: A list of Confluent resources associated with the Confluent account. items: - $ref: '#/components/schemas/ConfluentAccountResourceAttributes' + $ref: "#/components/schemas/ConfluentAccountResourceAttributes" type: array tags: - description: A list of strings representing tags. Can be a single key, or - key-value pairs separated by a colon. + description: A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon. example: - - myTag - - myTag2:myValue + - myTag + - myTag2:myValue items: type: string type: array required: - - api_key - - api_secret + - api_key + - api_secret type: object ConfluentAccountCreateRequestData: description: The data body for adding a Confluent account. properties: attributes: - $ref: '#/components/schemas/ConfluentAccountCreateRequestAttributes' + $ref: "#/components/schemas/ConfluentAccountCreateRequestAttributes" type: - $ref: '#/components/schemas/ConfluentAccountType' + $ref: "#/components/schemas/ConfluentAccountType" required: - - attributes - - type + - attributes + - type type: object ConfluentAccountResourceAttributes: description: Attributes object for updating a Confluent resource. properties: enable_custom_metrics: default: false - description: Enable the `custom.consumer_lag_offset` metric, which contains - extra metric tags. + description: Enable the `custom.consumer_lag_offset` metric, which contains extra metric tags. example: false type: boolean id: description: The ID associated with a Confluent resource. - example: resource-id-123 + example: "resource-id-123" type: string resource_type: - description: The resource type of the Resource. Can be `kafka`, `connector`, - `ksql`, or `schema_registry`. + description: The resource type of the Resource. Can be `kafka`, `connector`, `ksql`, or `schema_registry`. example: kafka type: string tags: - description: A list of strings representing tags. Can be a single key, or - key-value pairs separated by a colon. + description: A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon. example: - - myTag - - myTag2:myValue + - myTag + - myTag2:myValue items: type: string type: array required: - - resource_type + - resource_type type: object ConfluentAccountResponse: description: The expected response schema when getting a Confluent account. properties: data: - $ref: '#/components/schemas/ConfluentAccountResponseData' + $ref: "#/components/schemas/ConfluentAccountResponseData" type: object ConfluentAccountResponseAttributes: description: The attributes of a Confluent account. properties: api_key: description: The API key associated with your Confluent account. - example: TESTAPIKEY123 + example: "TESTAPIKEY123" type: string resources: - description: A list of Confluent resources associated with the Confluent - account. + description: A list of Confluent resources associated with the Confluent account. items: - $ref: '#/components/schemas/ConfluentResourceResponseAttributes' + $ref: "#/components/schemas/ConfluentResourceResponseAttributes" type: array tags: - description: A list of strings representing tags. Can be a single key, or - key-value pairs separated by a colon. + description: A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon. example: - - myTag - - myTag2:myValue + - myTag + - myTag2:myValue items: type: string type: array required: - - api_key + - api_key type: object ConfluentAccountResponseData: description: An API key and API secret pair that represents a Confluent account. properties: attributes: - $ref: '#/components/schemas/ConfluentAccountResponseAttributes' + $ref: "#/components/schemas/ConfluentAccountResponseAttributes" id: description: A randomly generated ID associated with a Confluent account. - example: account_id_abc123 + example: "account_id_abc123" type: string type: - $ref: '#/components/schemas/ConfluentAccountType' + $ref: "#/components/schemas/ConfluentAccountType" required: - - attributes - - id - - type + - attributes + - id + - type type: object ConfluentAccountType: default: confluent-cloud-accounts description: The JSON:API type for this API. Should always be `confluent-cloud-accounts`. enum: - - confluent-cloud-accounts + - confluent-cloud-accounts example: confluent-cloud-accounts type: string x-enum-varnames: - - CONFLUENT_CLOUD_ACCOUNTS + - "CONFLUENT_CLOUD_ACCOUNTS" ConfluentAccountUpdateRequest: description: The JSON:API request for updating a Confluent account. properties: data: - $ref: '#/components/schemas/ConfluentAccountUpdateRequestData' + $ref: "#/components/schemas/ConfluentAccountUpdateRequestData" required: - - data + - data type: object ConfluentAccountUpdateRequestAttributes: description: Attributes object for updating a Confluent account. properties: api_key: description: The API key associated with your Confluent account. - example: TESTAPIKEY123 + example: "TESTAPIKEY123" type: string api_secret: description: The API secret associated with your Confluent account. - example: test-api-secret-123 + example: "test-api-secret-123" type: string tags: - description: A list of strings representing tags. Can be a single key, or - key-value pairs separated by a colon. + description: A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon. example: - - myTag - - myTag2:myValue + - myTag + - myTag2:myValue items: type: string type: array required: - - api_key - - api_secret + - api_key + - api_secret type: object ConfluentAccountUpdateRequestData: description: Data object for updating a Confluent account. properties: attributes: - $ref: '#/components/schemas/ConfluentAccountUpdateRequestAttributes' + $ref: "#/components/schemas/ConfluentAccountUpdateRequestAttributes" type: - $ref: '#/components/schemas/ConfluentAccountType' + $ref: "#/components/schemas/ConfluentAccountType" required: - - attributes - - type + - attributes + - type type: object ConfluentAccountsResponse: description: Confluent account returned by the API. @@ -13455,221 +12924,214 @@ components: data: description: The Confluent account. items: - $ref: '#/components/schemas/ConfluentAccountResponseData' + $ref: "#/components/schemas/ConfluentAccountResponseData" type: array type: object ConfluentResourceRequest: description: The JSON:API request for updating a Confluent resource. properties: data: - $ref: '#/components/schemas/ConfluentResourceRequestData' + $ref: "#/components/schemas/ConfluentResourceRequestData" required: - - data + - data type: object ConfluentResourceRequestAttributes: description: Attributes object for updating a Confluent resource. properties: enable_custom_metrics: default: false - description: Enable the `custom.consumer_lag_offset` metric, which contains - extra metric tags. + description: Enable the `custom.consumer_lag_offset` metric, which contains extra metric tags. example: false type: boolean resource_type: - description: The resource type of the Resource. Can be `kafka`, `connector`, - `ksql`, or `schema_registry`. + description: The resource type of the Resource. Can be `kafka`, `connector`, `ksql`, or `schema_registry`. example: kafka type: string tags: - description: A list of strings representing tags. Can be a single key, or - key-value pairs separated by a colon. + description: A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon. example: - - myTag - - myTag2:myValue + - myTag + - myTag2:myValue items: type: string type: array required: - - resource_type + - resource_type type: object ConfluentResourceRequestData: description: JSON:API request for updating a Confluent resource. properties: attributes: - $ref: '#/components/schemas/ConfluentResourceRequestAttributes' + $ref: "#/components/schemas/ConfluentResourceRequestAttributes" id: description: The ID associated with a Confluent resource. - example: resource-id-123 + example: "resource-id-123" type: string type: - $ref: '#/components/schemas/ConfluentResourceType' + $ref: "#/components/schemas/ConfluentResourceType" required: - - attributes - - type - - id + - attributes + - type + - id type: object ConfluentResourceResponse: description: Response schema when interacting with a Confluent resource. properties: data: - $ref: '#/components/schemas/ConfluentResourceResponseData' + $ref: "#/components/schemas/ConfluentResourceResponseData" type: object ConfluentResourceResponseAttributes: description: Model representation of a Confluent Cloud resource. properties: enable_custom_metrics: default: false - description: Enable the `custom.consumer_lag_offset` metric, which contains - extra metric tags. + description: Enable the `custom.consumer_lag_offset` metric, which contains extra metric tags. example: false type: boolean id: description: The ID associated with the Confluent resource. - example: resource_id_abc123 + example: "resource_id_abc123" type: string resource_type: - description: The resource type of the Resource. Can be `kafka`, `connector`, - `ksql`, or `schema_registry`. + description: The resource type of the Resource. Can be `kafka`, `connector`, `ksql`, or `schema_registry`. example: kafka type: string tags: - description: A list of strings representing tags. Can be a single key, or - key-value pairs separated by a colon. + description: A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon. example: - - myTag - - myTag2:myValue + - myTag + - myTag2:myValue items: type: string type: array required: - - resource_type + - resource_type type: object ConfluentResourceResponseData: description: Confluent Cloud resource data. properties: attributes: - $ref: '#/components/schemas/ConfluentResourceResponseAttributes' + $ref: "#/components/schemas/ConfluentResourceResponseAttributes" id: description: The ID associated with the Confluent resource. - example: resource_id_abc123 + example: "resource_id_abc123" type: string type: - $ref: '#/components/schemas/ConfluentResourceType' + $ref: "#/components/schemas/ConfluentResourceType" required: - - attributes - - type - - id + - attributes + - type + - id type: object ConfluentResourceType: default: confluent-cloud-resources description: The JSON:API type for this request. enum: - - confluent-cloud-resources - example: confluent-cloud-resources + - confluent-cloud-resources + example: "confluent-cloud-resources" type: string x-enum-varnames: - - CONFLUENT_CLOUD_RESOURCES + - "CONFLUENT_CLOUD_RESOURCES" ConfluentResourcesResponse: description: Response schema when interacting with a list of Confluent resources. properties: data: description: The JSON:API data attribute. items: - $ref: '#/components/schemas/ConfluentResourceResponseData' + $ref: "#/components/schemas/ConfluentResourceResponseData" type: array type: object ConnectedTeamRef: description: Reference to a team from an external system. properties: data: - $ref: '#/components/schemas/ConnectedTeamRefData' + $ref: "#/components/schemas/ConnectedTeamRefData" type: object ConnectedTeamRefData: description: Reference to connected external team. properties: id: - description: The connected team ID as it is referenced throughout the Datadog - ecosystem. - example: '@GitHubOrg/team-handle' + description: The connected team ID as it is referenced throughout the Datadog ecosystem. + example: "@GitHubOrg/team-handle" type: string type: - $ref: '#/components/schemas/ConnectedTeamRefDataType' + $ref: "#/components/schemas/ConnectedTeamRefDataType" required: - - id - - type + - id + - type type: object ConnectedTeamRefDataType: - default: github_team + default: "github_team" description: External team resource type. enum: - - github_team - example: github_team + - github_team + example: "github_team" type: string x-enum-varnames: - - GITHUB_TEAM + - GITHUB_TEAM Connection: description: The definition of `Connection` object. properties: connectionId: description: The `Connection` `connectionId`. - example: '' + example: "" type: string label: description: The `Connection` `label`. - example: '' + example: "" type: string required: - - connectionId - - label + - connectionId + - label type: object ConnectionEnv: - description: A list of connections or connection groups used in the workflow. + description: "A list of connections or connection groups used in the workflow." properties: connectionGroups: description: The `ConnectionEnv` `connectionGroups`. items: - $ref: '#/components/schemas/ConnectionGroup' + $ref: "#/components/schemas/ConnectionGroup" type: array connections: description: The `ConnectionEnv` `connections`. items: - $ref: '#/components/schemas/Connection' + $ref: "#/components/schemas/Connection" type: array env: - $ref: '#/components/schemas/ConnectionEnvEnv' + $ref: "#/components/schemas/ConnectionEnvEnv" required: - - env + - env type: object ConnectionEnvEnv: description: The definition of `ConnectionEnvEnv` object. enum: - - default + - default example: default type: string x-enum-varnames: - - DEFAULT + - DEFAULT ConnectionGroup: description: The definition of `ConnectionGroup` object. properties: connectionGroupId: description: The `ConnectionGroup` `connectionGroupId`. - example: '' + example: "" type: string label: description: The `ConnectionGroup` `label`. - example: '' + example: "" type: string tags: description: The `ConnectionGroup` `tags`. example: - - '' + - "" items: type: string type: array required: - - connectionGroupId - - label - - tags + - connectionGroupId + - label + - tags type: object ConnectionsPagePagination: description: Page-based pagination metadata. @@ -13706,25 +13168,25 @@ components: type: integer type: description: Pagination type. - example: number_size + example: "number_size" type: string type: object ConnectionsResponseMeta: description: Connections response metadata. properties: page: - $ref: '#/components/schemas/ConnectionsPagePagination' + $ref: "#/components/schemas/ConnectionsPagePagination" type: object Container: description: Container object. properties: attributes: - $ref: '#/components/schemas/ContainerAttributes' + $ref: "#/components/schemas/ContainerAttributes" id: description: Container ID. type: string type: - $ref: '#/components/schemas/ContainerType' + $ref: "#/components/schemas/ContainerType" type: object ContainerAttributes: description: Attributes for a container. @@ -13770,14 +13232,14 @@ components: description: Container group object. properties: attributes: - $ref: '#/components/schemas/ContainerGroupAttributes' + $ref: "#/components/schemas/ContainerGroupAttributes" id: description: Container Group ID. type: string relationships: - $ref: '#/components/schemas/ContainerGroupRelationships' + $ref: "#/components/schemas/ContainerGroupRelationships" type: - $ref: '#/components/schemas/ContainerGroupType' + $ref: "#/components/schemas/ContainerGroupType" type: object ContainerGroupAttributes: description: Attributes for a container group. @@ -13794,7 +13256,7 @@ components: description: Relationships to containers inside a container group. properties: containers: - $ref: '#/components/schemas/ContainerGroupRelationshipsLink' + $ref: "#/components/schemas/ContainerGroupRelationshipsLink" type: object ContainerGroupRelationshipsData: description: Links data. @@ -13806,9 +13268,9 @@ components: description: Relationships to Containers inside a Container Group. properties: data: - $ref: '#/components/schemas/ContainerGroupRelationshipsData' + $ref: "#/components/schemas/ContainerGroupRelationshipsData" links: - $ref: '#/components/schemas/ContainerGroupRelationshipsLinks' + $ref: "#/components/schemas/ContainerGroupRelationshipsLinks" type: object ContainerGroupRelationshipsLinks: description: Links attributes. @@ -13821,21 +13283,21 @@ components: default: container_group description: Type of container group. enum: - - container_group + - container_group example: container_group type: string x-enum-varnames: - - CONTAINER_GROUP + - CONTAINER_GROUP ContainerImage: description: Container Image object. properties: attributes: - $ref: '#/components/schemas/ContainerImageAttributes' + $ref: "#/components/schemas/ContainerImageAttributes" id: description: Container Image ID. type: string type: - $ref: '#/components/schemas/ContainerImageType' + $ref: "#/components/schemas/ContainerImageType" type: object ContainerImageAttributes: description: Attributes for a Container Image. @@ -13845,12 +13307,11 @@ components: format: int64 type: integer image_flavors: - description: 'List of platform-specific images associated with the image - record. - - The list contains more than 1 entry for multi-architecture images.' + description: |- + List of platform-specific images associated with the image record. + The list contains more than 1 entry for multi-architecture images. items: - $ref: '#/components/schemas/ContainerImageFlavor' + $ref: "#/components/schemas/ContainerImageFlavor" type: array image_tags: description: List of image tags associated with the Container Image. @@ -13859,9 +13320,9 @@ components: type: string type: array images_built_at: - description: 'List of build times associated with the Container Image. - - The list contains more than 1 entry for multi-architecture images.' + description: |- + List of build times associated with the Container Image. + The list contains more than 1 entry for multi-architecture images. items: description: Time the platform-specific Container Image was built. type: string @@ -13870,11 +13331,9 @@ components: description: Name of the Container Image. type: string os_architectures: - description: List of Operating System architectures supported by the Container - Image. + description: List of Operating System architectures supported by the Container Image. items: - description: Operating System architecture supported by the Container - Image. + description: Operating System architecture supported by the Container Image. example: amd64 type: string type: array @@ -13886,8 +13345,7 @@ components: type: string type: array os_versions: - description: List of Operating System versions supported by the Container - Image. + description: List of Operating System versions supported by the Container Image. items: description: Operating System version supported by the Container Image. type: string @@ -13908,10 +13366,9 @@ components: description: Short version of the Container Image name. type: string sizes: - description: 'List of size for each platform-specific image associated with - the image record. - - The list contains more than 1 entry for multi-architecture images.' + description: |- + List of size for each platform-specific image associated with the image record. + The list contains more than 1 entry for multi-architecture images. items: description: Size of the platform-specific Container Image. format: int64 @@ -13930,7 +13387,7 @@ components: type: string type: array vulnerability_count: - $ref: '#/components/schemas/ContainerImageVulnerabilities' + $ref: "#/components/schemas/ContainerImageVulnerabilities" type: object ContainerImageFlavor: description: Container Image breakdown by supported platform. @@ -13956,14 +13413,14 @@ components: description: Container Image Group object. properties: attributes: - $ref: '#/components/schemas/ContainerImageGroupAttributes' + $ref: "#/components/schemas/ContainerImageGroupAttributes" id: description: Container Image Group ID. type: string relationships: - $ref: '#/components/schemas/ContainerImageGroupRelationships' + $ref: "#/components/schemas/ContainerImageGroupRelationships" type: - $ref: '#/components/schemas/ContainerImageGroupType' + $ref: "#/components/schemas/ContainerImageGroupType" type: object ContainerImageGroupAttributes: description: Attributes for a Container Image Group. @@ -13983,15 +13440,15 @@ components: description: Relationships to Container Images inside a Container Image Group. properties: data: - $ref: '#/components/schemas/ContainerImageGroupRelationshipsData' + $ref: "#/components/schemas/ContainerImageGroupRelationshipsData" links: - $ref: '#/components/schemas/ContainerImageGroupRelationshipsLinks' + $ref: "#/components/schemas/ContainerImageGroupRelationshipsLinks" type: object ContainerImageGroupRelationships: description: Relationships inside a Container Image Group. properties: container_images: - $ref: '#/components/schemas/ContainerImageGroupImagesRelationshipsLink' + $ref: "#/components/schemas/ContainerImageGroupImagesRelationshipsLink" type: object ContainerImageGroupRelationshipsData: description: Links data. @@ -14010,21 +13467,21 @@ components: default: container_image_group description: Type of Container Image Group. enum: - - container_image_group + - container_image_group example: container_image_group type: string x-enum-varnames: - - CONTAINER_IMAGE_GROUP + - CONTAINER_IMAGE_GROUP ContainerImageItem: description: Possible Container Image models. oneOf: - - $ref: '#/components/schemas/ContainerImage' - - $ref: '#/components/schemas/ContainerImageGroup' + - $ref: "#/components/schemas/ContainerImage" + - $ref: "#/components/schemas/ContainerImageGroup" ContainerImageMeta: description: Response metadata object. properties: pagination: - $ref: '#/components/schemas/ContainerImageMetaPage' + $ref: "#/components/schemas/ContainerImageMetaPage" type: object ContainerImageMetaPage: description: Paging attributes. @@ -14050,26 +13507,26 @@ components: format: int64 type: integer type: - $ref: '#/components/schemas/ContainerImageMetaPageType' + $ref: "#/components/schemas/ContainerImageMetaPageType" type: object ContainerImageMetaPageType: default: cursor_limit description: Type of Container Image pagination. enum: - - cursor_limit + - cursor_limit example: cursor_limit type: string x-enum-varnames: - - CURSOR_LIMIT + - CURSOR_LIMIT ContainerImageType: default: container_image description: Type of Container Image. enum: - - container_image + - container_image example: container_image type: string x-enum-varnames: - - CONTAINER_IMAGE + - CONTAINER_IMAGE ContainerImageVulnerabilities: description: Vulnerability counts associated with the Container Image. properties: @@ -14107,12 +13564,12 @@ components: data: description: Array of Container Image objects. items: - $ref: '#/components/schemas/ContainerImageItem' + $ref: "#/components/schemas/ContainerImageItem" type: array links: - $ref: '#/components/schemas/ContainerImagesResponseLinks' + $ref: "#/components/schemas/ContainerImagesResponseLinks" meta: - $ref: '#/components/schemas/ContainerImageMeta' + $ref: "#/components/schemas/ContainerImageMeta" type: object ContainerImagesResponseLinks: description: Pagination links. @@ -14139,13 +13596,13 @@ components: ContainerItem: description: Possible Container models. oneOf: - - $ref: '#/components/schemas/Container' - - $ref: '#/components/schemas/ContainerGroup' + - $ref: "#/components/schemas/Container" + - $ref: "#/components/schemas/ContainerGroup" ContainerMeta: description: Response metadata object. properties: pagination: - $ref: '#/components/schemas/ContainerMetaPage' + $ref: "#/components/schemas/ContainerMetaPage" type: object ContainerMetaPage: description: Paging attributes. @@ -14171,38 +13628,38 @@ components: format: int64 type: integer type: - $ref: '#/components/schemas/ContainerMetaPageType' + $ref: "#/components/schemas/ContainerMetaPageType" type: object ContainerMetaPageType: default: cursor_limit description: Type of Container pagination. enum: - - cursor_limit + - cursor_limit example: cursor_limit type: string x-enum-varnames: - - CURSOR_LIMIT + - CURSOR_LIMIT ContainerType: default: container description: Type of container. enum: - - container + - container example: container type: string x-enum-varnames: - - CONTAINER + - CONTAINER ContainersResponse: description: List of containers. properties: data: description: Array of Container objects. items: - $ref: '#/components/schemas/ContainerItem' + $ref: "#/components/schemas/ContainerItem" type: array links: - $ref: '#/components/schemas/ContainersResponseLinks' + $ref: "#/components/schemas/ContainersResponseLinks" meta: - $ref: '#/components/schemas/ContainerMeta' + $ref: "#/components/schemas/ContainerMeta" type: object ContainersResponseLinks: description: Pagination links. @@ -14229,14 +13686,14 @@ components: ContentEncoding: description: HTTP header used to compress the media-type. enum: - - identity - - gzip - - deflate + - identity + - gzip + - deflate type: string x-enum-varnames: - - IDENTITY - - GZIP - - DEFLATE + - IDENTITY + - GZIP + - DEFLATE ConvertJobResultsToSignalsAttributes: description: Attributes for converting threat hunting job results to signals. properties: @@ -14246,14 +13703,14 @@ components: jobResultIds: description: Job result IDs. example: - - '' + - "" items: type: string type: array notifications: description: Notifications sent. example: - - '' + - "" items: type: string type: array @@ -14262,49 +13719,49 @@ components: example: A large number of failed login attempts. type: string signalSeverity: - $ref: '#/components/schemas/SecurityMonitoringRuleSeverity' + $ref: "#/components/schemas/SecurityMonitoringRuleSeverity" required: - - jobResultIds - - signalSeverity - - signalMessage - - notifications + - jobResultIds + - signalSeverity + - signalMessage + - notifications type: object ConvertJobResultsToSignalsData: description: Data for converting threat hunting job results to signals. properties: attributes: - $ref: '#/components/schemas/ConvertJobResultsToSignalsAttributes' + $ref: "#/components/schemas/ConvertJobResultsToSignalsAttributes" type: - $ref: '#/components/schemas/ConvertJobResultsToSignalsDataType' + $ref: "#/components/schemas/ConvertJobResultsToSignalsDataType" type: object ConvertJobResultsToSignalsDataType: description: Type of payload. enum: - - historicalDetectionsJobResultSignalConversion + - historicalDetectionsJobResultSignalConversion type: string x-enum-varnames: - - HISTORICALDETECTIONSJOBRESULTSIGNALCONVERSION + - HISTORICALDETECTIONSJOBRESULTSIGNALCONVERSION ConvertJobResultsToSignalsRequest: description: Request for converting threat hunting job results to signals. properties: data: - $ref: '#/components/schemas/ConvertJobResultsToSignalsData' + $ref: "#/components/schemas/ConvertJobResultsToSignalsData" type: object CostAttributionAggregates: description: An array of available aggregates. items: - $ref: '#/components/schemas/CostAttributionAggregatesBody' + $ref: "#/components/schemas/CostAttributionAggregatesBody" type: array CostAttributionAggregatesBody: description: The object containing the aggregates. properties: agg_type: description: The aggregate type. - example: sum + example: "sum" type: string field: description: The field. - example: infra_host_committed_cost + example: "infra_host_committed_cost" type: string value: description: The value for a given field. @@ -14313,50 +13770,42 @@ components: type: object CostAttributionTagNames: additionalProperties: - description: 'A list of values that are associated with each tag key. - - - An empty list means the resource use wasn''t tagged with the respective - tag. - - - Multiple values means the respective tag was applied multiple times on - the resource. - - - An `` value means the resource was tagged with the respective tag - but did not have a value.' + description: |- + A list of values that are associated with each tag key. + - An empty list means the resource use wasn't tagged with the respective tag. + - Multiple values means the respective tag was applied multiple times on the resource. + - An `` value means the resource was tagged with the respective tag but did not have a value. items: description: A given tag in a list. - example: datadog-integrations-lab + example: "datadog-integrations-lab" type: string type: array - description: 'Tag keys and values. - - A `null` value here means that the requested tag breakdown cannot be applied - because it does not match the [tags - + description: |- + Tag keys and values. + A `null` value here means that the requested tag breakdown cannot be applied because it does not match the [tags configured for usage attribution](https://docs.datadoghq.com/account_management/billing/usage_attribution/#getting-started). - - In this scenario the API returns the total cost, not broken down by tags.' + In this scenario the API returns the total cost, not broken down by tags. nullable: true type: object CostAttributionType: default: cost_by_tag description: Type of cost attribution data. enum: - - cost_by_tag + - cost_by_tag example: cost_by_tag type: string x-enum-varnames: - - COST_BY_TAG + - COST_BY_TAG CostByOrg: description: Cost data. properties: attributes: - $ref: '#/components/schemas/CostByOrgAttributes' + $ref: "#/components/schemas/CostByOrgAttributes" id: description: Unique ID of the response. type: string type: - $ref: '#/components/schemas/CostByOrgType' + $ref: "#/components/schemas/CostByOrgType" type: object CostByOrgAttributes: description: Cost attributes data. @@ -14370,7 +13819,7 @@ components: charges: description: List of charges data reported for the requested month. items: - $ref: '#/components/schemas/ChargebackBreakdown' + $ref: "#/components/schemas/ChargebackBreakdown" type: array date: description: The month requested. @@ -14383,8 +13832,7 @@ components: description: The organization public ID. type: string region: - description: The region of the Datadog instance that the organization belongs - to. + description: The region of the Datadog instance that the organization belongs to. type: string total_cost: description: The total cost of products for the month. @@ -14397,24 +13845,24 @@ components: data: description: Response containing Chargeback Summary. items: - $ref: '#/components/schemas/CostByOrg' + $ref: "#/components/schemas/CostByOrg" type: array type: object CostByOrgType: default: cost_by_org description: Type of cost data. enum: - - cost_by_org + - cost_by_org example: cost_by_org type: string x-enum-varnames: - - COST_BY_ORG + - COST_BY_ORG CoverageSummaryAttributes: description: Attributes object for code coverage summary response. properties: codeowners: additionalProperties: - $ref: '#/components/schemas/CoverageSummaryCodeownerStats' + $ref: "#/components/schemas/CoverageSummaryCodeownerStats" description: Coverage statistics broken down by code owner. nullable: true type: object @@ -14436,7 +13884,7 @@ components: type: number services: additionalProperties: - $ref: '#/components/schemas/CoverageSummaryServiceStats' + $ref: "#/components/schemas/CoverageSummaryServiceStats" description: Coverage statistics broken down by service. nullable: true type: object @@ -14477,19 +13925,19 @@ components: description: Data object for coverage summary response. properties: attributes: - $ref: '#/components/schemas/CoverageSummaryAttributes' + $ref: "#/components/schemas/CoverageSummaryAttributes" id: description: Unique identifier for the coverage summary (base64-hashed). example: ZGQxMjM0NV9tYWluXzE3MDk1NjQwMDA= type: string type: - $ref: '#/components/schemas/CoverageSummaryType' + $ref: "#/components/schemas/CoverageSummaryType" type: object CoverageSummaryResponse: description: Response object containing code coverage summary. properties: data: - $ref: '#/components/schemas/CoverageSummaryData' + $ref: "#/components/schemas/CoverageSummaryData" type: object CoverageSummaryServiceStats: description: Coverage statistics for a specific service. @@ -14518,32 +13966,26 @@ components: type: number type: object CoverageSummaryType: - description: JSON:API type for coverage summary response. The value must always - be `ci_app_coverage_summary`. + description: JSON:API type for coverage summary response. The value must always be `ci_app_coverage_summary`. enum: - - ci_app_coverage_summary + - ci_app_coverage_summary example: ci_app_coverage_summary type: string x-enum-varnames: - - CI_APP_COVERAGE_SUMMARY + - CI_APP_COVERAGE_SUMMARY Cpu: - description: CPU usage statistics derived from historical Spark job metrics. - Provides multiple estimates so users can choose between conservative and cost-saving - risk profiles. + description: CPU usage statistics derived from historical Spark job metrics. Provides multiple estimates so users can choose between conservative and cost-saving risk profiles. properties: max: - description: Maximum CPU usage observed for the job, expressed in millicores. - This represents the upper bound of usage. + description: Maximum CPU usage observed for the job, expressed in millicores. This represents the upper bound of usage. format: int64 type: integer p75: - description: 75th percentile of CPU usage (millicores). Represents a cost-saving - configuration while covering most workloads. + description: 75th percentile of CPU usage (millicores). Represents a cost-saving configuration while covering most workloads. format: int64 type: integer p95: - description: 95th percentile of CPU usage (millicores). Balances performance - and cost, providing a safer margin than p75. + description: 95th percentile of CPU usage (millicores). Balances performance and cost, providing a safer margin than p75. format: int64 type: integer type: object @@ -14552,15 +13994,15 @@ components: description: Request used to create an action connection. properties: data: - $ref: '#/components/schemas/ActionConnectionData' + $ref: "#/components/schemas/ActionConnectionData" required: - - data + - data type: object CreateActionConnectionResponse: description: The response for a created connection properties: data: - $ref: '#/components/schemas/ActionConnectionData' + $ref: "#/components/schemas/ActionConnectionData" type: object CreateAppRequest: description: A request object for creating a new app. @@ -14568,53 +14010,53 @@ components: data: attributes: components: - - events: [] - name: grid0 - properties: - children: - - events: [] - name: gridCell0 - properties: - children: + - events: [] + name: grid0 + properties: + children: - events: [] - name: calloutValue0 + name: gridCell0 properties: - isDisabled: false - isLoading: false - isVisible: true - label: CPU Usage - size: sm - style: vivid_yellow - unit: kB - value: '42' - type: calloutValue - isVisible: 'true' - layout: - default: - height: 8 - width: 2 - x: 0 - y: 0 - type: gridCell - type: grid - description: This is a simple example app - name: Example App + children: + - events: [] + name: calloutValue0 + properties: + isDisabled: false + isLoading: false + isVisible: true + label: CPU Usage + size: sm + style: vivid_yellow + unit: kB + value: "42" + type: calloutValue + isVisible: "true" + layout: + default: + height: 8 + width: 2 + x: 0 + "y": 0 + type: gridCell + type: grid + description: "This is a simple example app" + name: "Example App" queries: [] rootInstanceName: grid0 type: appDefinitions properties: data: - $ref: '#/components/schemas/CreateAppRequestData' + $ref: "#/components/schemas/CreateAppRequestData" type: object CreateAppRequestData: description: The data object containing the app definition. properties: attributes: - $ref: '#/components/schemas/CreateAppRequestDataAttributes' + $ref: "#/components/schemas/CreateAppRequestDataAttributes" type: - $ref: '#/components/schemas/AppDefinitionType' + $ref: "#/components/schemas/AppDefinitionType" required: - - type + - type type: object CreateAppRequestDataAttributes: description: App definition attributes such as name, description, and components. @@ -14622,7 +14064,7 @@ components: components: description: The UI components that make up the app. items: - $ref: '#/components/schemas/ComponentGrid' + $ref: "#/components/schemas/ComponentGrid" type: array description: description: A human-readable description for the app. @@ -14631,31 +14073,28 @@ components: description: The name of the app. type: string queries: - description: An array of queries, such as external actions and state variables, - that the app uses. + description: An array of queries, such as external actions and state variables, that the app uses. items: - $ref: '#/components/schemas/Query' + $ref: "#/components/schemas/Query" type: array rootInstanceName: - description: The name of the root component of the app. This must be a `grid` - component that contains all other components. + description: The name of the root component of the app. This must be a `grid` component that contains all other components. type: string tags: description: A list of tags for the app, which can be used to filter apps. example: - - service:webshop-backend - - team:webshop + - "service:webshop-backend" + - "team:webshop" items: description: An individual tag for the app. type: string type: array type: object CreateAppResponse: - description: The response object after a new app is successfully created, with - the app ID. + description: The response object after a new app is successfully created, with the app ID. properties: data: - $ref: '#/components/schemas/CreateAppResponseData' + $ref: "#/components/schemas/CreateAppResponseData" type: object CreateAppResponseData: description: The data object containing the app ID. @@ -14666,32 +14105,29 @@ components: format: uuid type: string type: - $ref: '#/components/schemas/AppDefinitionType' + $ref: "#/components/schemas/AppDefinitionType" required: - - id - - type + - id + - type type: object CreateAppsDatastoreRequest: - description: Request to create a new datastore with specified configuration - and metadata. + description: Request to create a new datastore with specified configuration and metadata. properties: data: - $ref: '#/components/schemas/CreateAppsDatastoreRequestData' + $ref: "#/components/schemas/CreateAppsDatastoreRequestData" type: object CreateAppsDatastoreRequestData: - description: Data wrapper containing the configuration needed to create a new - datastore. + description: Data wrapper containing the configuration needed to create a new datastore. properties: attributes: - $ref: '#/components/schemas/CreateAppsDatastoreRequestDataAttributes' + $ref: "#/components/schemas/CreateAppsDatastoreRequestDataAttributes" id: - description: Optional ID for the new datastore. If not provided, one will - be generated automatically. + description: Optional ID for the new datastore. If not provided, one will be generated automatically. type: string type: - $ref: '#/components/schemas/DatastoreDataType' + $ref: "#/components/schemas/DatastoreDataType" required: - - type + - type type: object CreateAppsDatastoreRequestDataAttributes: description: Configuration and metadata to create a new datastore. @@ -14701,35 +14137,34 @@ components: type: string name: description: The display name for the new datastore. - example: datastore-name + example: "datastore-name" type: string org_access: - $ref: '#/components/schemas/CreateAppsDatastoreRequestDataAttributesOrgAccess' + $ref: "#/components/schemas/CreateAppsDatastoreRequestDataAttributesOrgAccess" primary_column_name: - $ref: '#/components/schemas/DatastoreAttributesPrimaryColumnName' + $ref: "#/components/schemas/DatastoreAttributesPrimaryColumnName" primary_key_generation_strategy: - $ref: '#/components/schemas/DatastorePrimaryKeyGenerationStrategy' + $ref: "#/components/schemas/DatastorePrimaryKeyGenerationStrategy" required: - - name - - primary_column_name + - name + - primary_column_name type: object CreateAppsDatastoreRequestDataAttributesOrgAccess: description: The organization access level for the datastore. For example, 'contributor'. enum: - - contributor - - viewer - - manager + - contributor + - viewer + - manager type: string x-enum-varnames: - - CONTRIBUTOR - - VIEWER - - MANAGER + - CONTRIBUTOR + - VIEWER + - MANAGER CreateAppsDatastoreResponse: - description: Response after successfully creating a new datastore, containing - the datastore's assigned ID. + description: Response after successfully creating a new datastore, containing the datastore's assigned ID. properties: data: - $ref: '#/components/schemas/CreateAppsDatastoreResponseData' + $ref: "#/components/schemas/CreateAppsDatastoreResponseData" type: object CreateAppsDatastoreResponseData: description: The newly created datastore's data. @@ -14738,35 +14173,35 @@ components: description: The unique identifier assigned to the newly created datastore. type: string type: - $ref: '#/components/schemas/DatastoreDataType' + $ref: "#/components/schemas/DatastoreDataType" required: - - type + - type type: object CreateAttachmentRequest: description: Create request for an attachment. properties: data: - $ref: '#/components/schemas/CreateAttachmentRequestData' + $ref: "#/components/schemas/CreateAttachmentRequestData" type: object CreateAttachmentRequestData: description: Attachment data for a create request. properties: attributes: - $ref: '#/components/schemas/CreateAttachmentRequestDataAttributes' + $ref: "#/components/schemas/CreateAttachmentRequestDataAttributes" id: type: string type: - $ref: '#/components/schemas/IncidentAttachmentType' + $ref: "#/components/schemas/IncidentAttachmentType" required: - - type + - type type: object CreateAttachmentRequestDataAttributes: description: The attributes for creating an attachment. properties: attachment: - $ref: '#/components/schemas/CreateAttachmentRequestDataAttributesAttachment' + $ref: "#/components/schemas/CreateAttachmentRequestDataAttributesAttachment" attachment_type: - $ref: '#/components/schemas/AttachmentDataAttributesAttachmentType' + $ref: "#/components/schemas/AttachmentDataAttributesAttachmentType" type: object CreateAttachmentRequestDataAttributesAttachment: description: The attachment object for creating an attachment. @@ -14785,58 +14220,55 @@ components: properties: data: items: - $ref: '#/components/schemas/CreateCaseRequestData' + $ref: "#/components/schemas/CreateCaseRequestData" type: array required: - - data + - data type: object CreateCaseRequestData: description: Data of the case to create. properties: attributes: - $ref: '#/components/schemas/CreateCaseRequestDataAttributes' + $ref: "#/components/schemas/CreateCaseRequestDataAttributes" relationships: - $ref: '#/components/schemas/CreateCaseRequestDataRelationships' + $ref: "#/components/schemas/CreateCaseRequestDataRelationships" type: - $ref: '#/components/schemas/CaseDataType' + $ref: "#/components/schemas/CaseDataType" required: - - type + - type type: object CreateCaseRequestDataAttributes: description: Attributes of the case to create. properties: assignee_id: description: Unique identifier of the user assigned to the case. - example: f315bdaf-9ee7-4808-a9c1-99c15bf0f4d0 + example: "f315bdaf-9ee7-4808-a9c1-99c15bf0f4d0" type: string description: - description: Description of the case. If not provided, the description will - be automatically generated. - example: A description of the case. + description: Description of the case. If not provided, the description will be automatically generated. + example: "A description of the case." type: string priority: - $ref: '#/components/schemas/CasePriority' - description: Priority of the case. If not provided, the priority will be - automatically set to "NOT_DEFINED". - example: P4 + $ref: "#/components/schemas/CasePriority" + description: Priority of the case. If not provided, the priority will be automatically set to "NOT_DEFINED". + example: "P4" title: - description: Title of the case. If not provided, the title will be automatically - generated. - example: A title for the case. + description: Title of the case. If not provided, the title will be automatically generated. + example: "A title for the case." type: string type: object CreateCaseRequestDataRelationships: description: Relationships of the case to create. properties: findings: - $ref: '#/components/schemas/Findings' + $ref: "#/components/schemas/Findings" description: Security findings to create a case for. project: - $ref: '#/components/schemas/CaseManagementProject' + $ref: "#/components/schemas/CaseManagementProject" description: Case management project in which the case will be created. required: - - findings - - project + - findings + - project type: object CreateComponentRequest: example: @@ -14847,39 +14279,38 @@ components: type: component relationships: group: - data: null + data: type: components properties: data: - $ref: '#/components/schemas/CreateComponentRequestData' + $ref: "#/components/schemas/CreateComponentRequestData" type: object CreateComponentRequestData: properties: attributes: - $ref: '#/components/schemas/CreateComponentRequestDataAttributes' + $ref: "#/components/schemas/CreateComponentRequestDataAttributes" relationships: - $ref: '#/components/schemas/CreateComponentRequestDataRelationships' + $ref: "#/components/schemas/CreateComponentRequestDataRelationships" type: - $ref: '#/components/schemas/StatusPagesComponentGroupType' + $ref: "#/components/schemas/StatusPagesComponentGroupType" required: - - attributes - - type + - attributes + - type type: object CreateComponentRequestDataAttributes: description: The supported attributes for creating a component. properties: components: - description: If creating a component of type `group`, the components to - create within the group. + description: If creating a component of type `group`, the components to create within the group. example: - - name: Login - position: 0 - type: component - - name: Settings - position: 1 - type: component + - name: Login + position: 0 + type: component + - name: Settings + position: 1 + type: component items: - $ref: '#/components/schemas/CreateComponentRequestDataAttributesComponentsItems' + $ref: "#/components/schemas/CreateComponentRequestDataAttributesComponentsItems" type: array name: description: The name of the component. @@ -14891,86 +14322,85 @@ components: format: int64 type: integer type: - $ref: '#/components/schemas/CreateComponentRequestDataAttributesType' + $ref: "#/components/schemas/CreateComponentRequestDataAttributesType" description: The type of the component. example: group required: - - name - - position - - type + - name + - position + - type type: object CreateComponentRequestDataAttributesComponentsItems: properties: name: description: The name of the grouped component. - example: '' + example: "" type: string position: - description: The zero-indexed position of the grouped component relative - to the other components in the group. + description: The zero-indexed position of the grouped component relative to the other components in the group. example: 0 format: int64 type: integer type: - $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType' + $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType" required: - - name - - position - - type + - name + - position + - type type: object CreateComponentRequestDataAttributesType: description: The type of the component. enum: - - component - - group + - component + - group example: component type: string x-enum-varnames: - - COMPONENT - - GROUP + - COMPONENT + - GROUP CreateComponentRequestDataRelationships: description: The supported relationships for creating a component. properties: group: - $ref: '#/components/schemas/CreateComponentRequestDataRelationshipsGroup' + $ref: "#/components/schemas/CreateComponentRequestDataRelationshipsGroup" description: The group to create the component within. type: object CreateComponentRequestDataRelationshipsGroup: properties: data: - $ref: '#/components/schemas/CreateComponentRequestDataRelationshipsGroupData' + $ref: "#/components/schemas/CreateComponentRequestDataRelationshipsGroupData" required: - - data + - data type: object CreateComponentRequestDataRelationshipsGroupData: nullable: true properties: id: description: The ID of the group. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string type: - $ref: '#/components/schemas/StatusPagesComponentGroupType' + $ref: "#/components/schemas/StatusPagesComponentGroupType" required: - - type - - id + - type + - id type: object CreateConnectionRequest: example: data: attributes: fields: - - description: Customer subscription tier from `CRM` - display_name: Customer Tier - id: customer_tier - source_name: subscription_tier - type: string - - description: Customer lifetime value in `USD` - display_name: Lifetime Value - id: lifetime_value - source_name: ltv - type: number + - description: Customer subscription tier from `CRM` + display_name: Customer Tier + id: customer_tier + source_name: subscription_tier + type: string + - description: Customer lifetime value in `USD` + display_name: Lifetime Value + id: lifetime_value + source_name: ltv + type: number join_attribute: user_email join_type: email type: ref_table @@ -14978,42 +14408,42 @@ components: type: connection_id properties: data: - $ref: '#/components/schemas/CreateConnectionRequestData' + $ref: "#/components/schemas/CreateConnectionRequestData" type: object CreateConnectionRequestData: properties: attributes: - $ref: '#/components/schemas/CreateConnectionRequestDataAttributes' + $ref: "#/components/schemas/CreateConnectionRequestDataAttributes" id: type: string type: - $ref: '#/components/schemas/UpdateConnectionRequestDataType' + $ref: "#/components/schemas/UpdateConnectionRequestDataType" required: - - type + - type type: object CreateConnectionRequestDataAttributes: properties: fields: items: - $ref: '#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems' + $ref: "#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems" type: array join_attribute: - example: '' + example: "" type: string join_type: - example: '' + example: "" type: string metadata: additionalProperties: type: string type: object type: - example: '' + example: "" type: string required: - - join_attribute - - join_type - - type + - join_attribute + - join_type + - type type: object CreateConnectionRequestDataAttributesFieldsItems: properties: @@ -15026,42 +14456,42 @@ components: type: string type: array id: - example: '' + example: "" type: string source_name: - example: '' + example: "" type: string type: - example: '' + example: "" type: string required: - - id - - source_name - - type + - id + - source_name + - type type: object CreateCustomFrameworkRequest: description: Request object to create a custom framework. properties: data: - $ref: '#/components/schemas/CustomFrameworkData' + $ref: "#/components/schemas/CustomFrameworkData" required: - - data + - data type: object CreateCustomFrameworkResponse: description: Response object to create a custom framework. properties: data: - $ref: '#/components/schemas/FrameworkHandleAndVersionResponseData' + $ref: "#/components/schemas/FrameworkHandleAndVersionResponseData" required: - - data + - data type: object CreateDataDeletionRequestBody: description: Object needed to create a data deletion request. properties: data: - $ref: '#/components/schemas/CreateDataDeletionRequestBodyData' + $ref: "#/components/schemas/CreateDataDeletionRequestBodyData" required: - - data + - data type: object CreateDataDeletionRequestBodyAttributes: description: Attributes for creating a data deletion request. @@ -15072,11 +14502,8 @@ components: format: int64 type: integer indexes: - description: List of indexes for the search. If not provided, the search - is performed in all indexes. - example: - - test-index - - test-index-2 + description: List of indexes for the search. If not provided, the search is performed in all indexes. + example: ["test-index", "test-index-2"] items: description: Individual index. type: string @@ -15085,9 +14512,7 @@ components: additionalProperties: type: string description: Query for creating a data deletion request. - example: - host: abc - service: xyz + example: {"host": "abc", "service": "xyz"} type: object to: description: End of requested time window, milliseconds since Unix epoch. @@ -15095,62 +14520,61 @@ components: format: int64 type: integer required: - - query - - from - - to + - query + - from + - to type: object CreateDataDeletionRequestBodyData: description: Data needed to create a data deletion request. properties: attributes: - $ref: '#/components/schemas/CreateDataDeletionRequestBodyAttributes' + $ref: "#/components/schemas/CreateDataDeletionRequestBodyAttributes" type: - $ref: '#/components/schemas/CreateDataDeletionRequestBodyDataType' + $ref: "#/components/schemas/CreateDataDeletionRequestBodyDataType" required: - - attributes - - type + - attributes + - type type: object CreateDataDeletionRequestBodyDataType: description: The deletion request type. enum: - - create_deletion_req - example: create_deletion_req + - create_deletion_req + example: "create_deletion_req" type: string x-enum-varnames: - - CREATE_DELETION_REQ + - CREATE_DELETION_REQ CreateDataDeletionResponseBody: description: The response from the create data deletion request endpoint. properties: data: - $ref: '#/components/schemas/DataDeletionResponseItem' + $ref: "#/components/schemas/DataDeletionResponseItem" meta: - $ref: '#/components/schemas/DataDeletionResponseMeta' + $ref: "#/components/schemas/DataDeletionResponseMeta" type: object CreateDegradationRequest: example: data: attributes: components_affected: - - id: 1234abcd-12ab-34cd-56ef-123456abcdef - status: degraded - description: Our API is experiencing elevated latency. We are investigating - the issue. + - id: 1234abcd-12ab-34cd-56ef-123456abcdef + status: degraded + description: Our API is experiencing elevated latency. We are investigating the issue. status: investigating title: Elevated API Latency type: degradations properties: data: - $ref: '#/components/schemas/CreateDegradationRequestData' + $ref: "#/components/schemas/CreateDegradationRequestData" type: object CreateDegradationRequestData: properties: attributes: - $ref: '#/components/schemas/CreateDegradationRequestDataAttributes' + $ref: "#/components/schemas/CreateDegradationRequestDataAttributes" type: - $ref: '#/components/schemas/PatchDegradationRequestDataType' + $ref: "#/components/schemas/PatchDegradationRequestDataType" required: - - attributes - - type + - attributes + - type type: object CreateDegradationRequestDataAttributes: description: The supported attributes for creating a degradation. @@ -15158,18 +14582,17 @@ components: components_affected: description: The components affected by the degradation. example: - - id: 1234abcd-12ab-34cd-56ef-123456abcdef - status: degraded + - id: 1234abcd-12ab-34cd-56ef-123456abcdef + status: degraded items: - $ref: '#/components/schemas/CreateDegradationRequestDataAttributesComponentsAffectedItems' + $ref: "#/components/schemas/CreateDegradationRequestDataAttributesComponentsAffectedItems" type: array description: description: The description of the degradation. - example: Our API is experiencing elevated latency. We are investigating - the issue. + example: Our API is experiencing elevated latency. We are investigating the issue. type: string status: - $ref: '#/components/schemas/CreateDegradationRequestDataAttributesStatus' + $ref: "#/components/schemas/CreateDegradationRequestDataAttributesStatus" description: The status of the degradation. example: investigating title: @@ -15177,58 +14600,58 @@ components: example: Elevated API Latency type: string required: - - components_affected - - status - - title + - components_affected + - status + - title type: object CreateDegradationRequestDataAttributesComponentsAffectedItems: properties: id: description: The ID of the component. Must be a component of type `component`. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string name: readOnly: true type: string status: - $ref: '#/components/schemas/StatusPagesComponentDataAttributesStatus' + $ref: "#/components/schemas/StatusPagesComponentDataAttributesStatus" required: - - id - - status + - id + - status type: object CreateDegradationRequestDataAttributesStatus: description: The status of the degradation. enum: - - investigating - - identified - - monitoring - - resolved + - investigating + - identified + - monitoring + - resolved example: investigating type: string x-enum-varnames: - - INVESTIGATING - - IDENTIFIED - - MONITORING - - RESOLVED + - INVESTIGATING + - IDENTIFIED + - MONITORING + - RESOLVED CreateDeploymentGateParams: description: Parameters for creating a deployment gate. properties: data: - $ref: '#/components/schemas/CreateDeploymentGateParamsData' + $ref: "#/components/schemas/CreateDeploymentGateParamsData" required: - - data + - data type: object CreateDeploymentGateParamsData: description: Parameters for creating a deployment gate. properties: attributes: - $ref: '#/components/schemas/CreateDeploymentGateParamsDataAttributes' + $ref: "#/components/schemas/CreateDeploymentGateParamsDataAttributes" type: - $ref: '#/components/schemas/DeploymentGateDataType' + $ref: "#/components/schemas/DeploymentGateDataType" required: - - type - - attributes + - type + - attributes type: object CreateDeploymentGateParamsDataAttributes: description: Parameters for creating a deployment gate. @@ -15240,37 +14663,37 @@ components: type: boolean env: description: The environment of the deployment gate. - example: production + example: "production" type: string identifier: default: default description: The identifier of the deployment gate. - example: pre + example: "pre" type: string service: description: The service of the deployment gate. - example: my-service + example: "my-service" type: string required: - - env - - service + - env + - service type: object CreateDeploymentRuleParams: description: Parameters for creating a deployment rule. properties: data: - $ref: '#/components/schemas/CreateDeploymentRuleParamsData' + $ref: "#/components/schemas/CreateDeploymentRuleParamsData" type: object CreateDeploymentRuleParamsData: description: Parameters for creating a deployment rule. properties: attributes: - $ref: '#/components/schemas/CreateDeploymentRuleParamsDataAttributes' + $ref: "#/components/schemas/CreateDeploymentRuleParamsDataAttributes" type: - $ref: '#/components/schemas/DeploymentRuleDataType' + $ref: "#/components/schemas/DeploymentRuleDataType" required: - - type - - attributes + - type + - attributes type: object CreateDeploymentRuleParamsDataAttributes: description: Parameters for creating a deployment rule. @@ -15282,160 +14705,143 @@ components: type: boolean name: description: The name of the deployment rule. - example: My deployment rule + example: "My deployment rule" type: string options: - $ref: '#/components/schemas/DeploymentRulesOptions' + $ref: "#/components/schemas/DeploymentRulesOptions" type: - description: The type of the deployment rule (faulty_deployment_detection - or monitor). - example: faulty_deployment_detection + description: The type of the deployment rule (faulty_deployment_detection or monitor). + example: "faulty_deployment_detection" type: string required: - - name - - options - - type + - name + - options + - type type: object CreateEmailNotificationChannelConfig: - description: Configuration to create an e-mail notification channel + description: "Configuration to create an e-mail notification channel" properties: address: - description: The e-mail address to be notified - example: '' + description: "The e-mail address to be notified" + example: "" type: string formats: description: Preferred content formats for notifications. example: - - html + - html items: - $ref: '#/components/schemas/NotificationChannelEmailFormatType' + $ref: "#/components/schemas/NotificationChannelEmailFormatType" type: array type: - $ref: '#/components/schemas/NotificationChannelEmailConfigType' + $ref: "#/components/schemas/NotificationChannelEmailConfigType" required: - - type - - address - - formats + - type + - address + - formats type: object CreateIncidentNotificationRuleRequest: description: Create request for a notification rule. properties: data: - $ref: '#/components/schemas/IncidentNotificationRuleCreateData' + $ref: "#/components/schemas/IncidentNotificationRuleCreateData" required: - - data + - data type: object CreateIncidentNotificationTemplateRequest: description: Create request for a notification template. properties: data: - $ref: '#/components/schemas/IncidentNotificationTemplateCreateData' + $ref: "#/components/schemas/IncidentNotificationTemplateCreateData" required: - - data + - data type: object CreateJiraIssueRequestArray: description: List of requests to create Jira issues for security findings. properties: data: items: - $ref: '#/components/schemas/CreateJiraIssueRequestData' + $ref: "#/components/schemas/CreateJiraIssueRequestData" type: array required: - - data + - data type: object CreateJiraIssueRequestData: description: Data of the Jira issue to create. properties: attributes: - $ref: '#/components/schemas/CreateJiraIssueRequestDataAttributes' + $ref: "#/components/schemas/CreateJiraIssueRequestDataAttributes" relationships: - $ref: '#/components/schemas/CreateJiraIssueRequestDataRelationships' + $ref: "#/components/schemas/CreateJiraIssueRequestDataRelationships" type: - $ref: '#/components/schemas/JiraIssuesDataType' + $ref: "#/components/schemas/JiraIssuesDataType" required: - - type + - type type: object CreateJiraIssueRequestDataAttributes: description: Attributes of the Jira issue to create. properties: assignee_id: - description: Unique identifier of the Datadog user assigned to the Jira - issue. - example: f315bdaf-9ee7-4808-a9c1-99c15bf0f4d0 + description: Unique identifier of the Datadog user assigned to the Jira issue. + example: "f315bdaf-9ee7-4808-a9c1-99c15bf0f4d0" type: string description: - description: Description of the Jira issue. If not provided, the description - will be automatically generated. - example: A description of the Jira issue. + description: Description of the Jira issue. If not provided, the description will be automatically generated. + example: "A description of the Jira issue." type: string fields: additionalProperties: {} - description: Custom fields of the Jira issue to create. For the list of - available fields, see [Jira documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-createmeta-projectidorkey-issuetypes-issuetypeid-get). - example: - key1: value - key2: - - value - key3: - key4: value + description: Custom fields of the Jira issue to create. For the list of available fields, see [Jira documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-createmeta-projectidorkey-issuetypes-issuetypeid-get). + example: {"key1": "value", "key2": ["value"], "key3": {"key4": "value"}} type: object priority: - $ref: '#/components/schemas/CasePriority' - description: Datadog case priority mapped to the Jira issue priority. If - not provided, the priority will be automatically set to "NOT_DEFINED". - To configure the mapping, see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira). - example: P4 + $ref: "#/components/schemas/CasePriority" + description: Datadog case priority mapped to the Jira issue priority. If not provided, the priority will be automatically set to "NOT_DEFINED". To configure the mapping, see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira). + example: "P4" title: - description: Title of the Jira issue. If not provided, the title will be - automatically generated. - example: A title for the Jira issue. + description: Title of the Jira issue. If not provided, the title will be automatically generated. + example: "A title for the Jira issue." type: string type: object CreateJiraIssueRequestDataRelationships: description: Relationships of the Jira issue to create. properties: findings: - $ref: '#/components/schemas/Findings' + $ref: "#/components/schemas/Findings" description: Security findings to create a Jira issue for. project: - $ref: '#/components/schemas/CaseManagementProject' - description: Case management project configured with the Jira integration. - It is used to create the Jira issue. To configure the Jira integration, - see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira). + $ref: "#/components/schemas/CaseManagementProject" + description: Case management project configured with the Jira integration. It is used to create the Jira issue. To configure the Jira integration, see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira). required: - - findings - - project + - findings + - project type: object CreateMaintenanceRequest: example: data: attributes: - completed_date: '2026-02-18T19:51:13.332360075Z' - completed_description: We have completed maintenance on the API to improve - performance. + completed_date: "2026-02-18T19:51:13.332360075Z" + completed_description: We have completed maintenance on the API to improve performance. components_affected: - - id: 1234abcd-12ab-34cd-56ef-123456abcdef - status: operational - in_progress_description: We are currently performing maintenance on the - API to improve performance. - scheduled_description: We will be performing maintenance on the API to - improve performance. - start_date: '2026-02-18T19:21:13.332360075Z' + - id: 1234abcd-12ab-34cd-56ef-123456abcdef + status: operational + in_progress_description: We are currently performing maintenance on the API to improve performance. + scheduled_description: We will be performing maintenance on the API to improve performance. + start_date: "2026-02-18T19:21:13.332360075Z" title: API Maintenance type: maintenances properties: data: - $ref: '#/components/schemas/CreateMaintenanceRequestData' + $ref: "#/components/schemas/CreateMaintenanceRequestData" type: object CreateMaintenanceRequestData: properties: attributes: - $ref: '#/components/schemas/CreateMaintenanceRequestDataAttributes' + $ref: "#/components/schemas/CreateMaintenanceRequestDataAttributes" type: - $ref: '#/components/schemas/PatchMaintenanceRequestDataType' + $ref: "#/components/schemas/PatchMaintenanceRequestDataType" required: - - attributes - - type + - attributes + - type type: object CreateMaintenanceRequestDataAttributes: description: The supported attributes for creating a maintenance. @@ -15450,7 +14856,7 @@ components: components_affected: description: The components affected by the maintenance. items: - $ref: '#/components/schemas/CreateMaintenanceRequestDataAttributesComponentsAffectedItems' + $ref: "#/components/schemas/CreateMaintenanceRequestDataAttributesComponentsAffectedItems" type: array in_progress_description: description: The description shown while the maintenance is in progress. @@ -15464,17 +14870,17 @@ components: type: string title: description: The title of the maintenance. - example: API Maintenance + example: "API Maintenance" type: string required: - - components_affected - - title + - components_affected + - title type: object CreateMaintenanceRequestDataAttributesComponentsAffectedItems: properties: id: description: The ID of the component. Must be a component of type `component`. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string name: @@ -15482,80 +14888,80 @@ components: readOnly: true type: string status: - $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus' + $ref: "#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus" required: - - id - - status + - id + - status type: object CreateNotificationChannelAttributes: description: Attributes for creating an on-call notification channel. properties: config: - $ref: '#/components/schemas/CreateNotificationChannelConfig' + $ref: "#/components/schemas/CreateNotificationChannelConfig" description: Notification channel configuration type: object CreateNotificationChannelConfig: - description: Defines the configuration for creating an On-Call notification - channel + description: "Defines the configuration for creating an On-Call notification channel" oneOf: - - $ref: '#/components/schemas/CreatePhoneNotificationChannelConfig' - - $ref: '#/components/schemas/CreateEmailNotificationChannelConfig' + - $ref: "#/components/schemas/CreatePhoneNotificationChannelConfig" + - $ref: "#/components/schemas/CreateEmailNotificationChannelConfig" CreateNotificationChannelData: description: Data for creating an on-call notification channel properties: attributes: - $ref: '#/components/schemas/CreateNotificationChannelAttributes' + $ref: "#/components/schemas/CreateNotificationChannelAttributes" type: - $ref: '#/components/schemas/NotificationChannelType' + $ref: "#/components/schemas/NotificationChannelType" required: - - type + - type type: object CreateNotificationRuleParameters: description: Body of the notification rule create request. properties: data: - $ref: '#/components/schemas/CreateNotificationRuleParametersData' + $ref: "#/components/schemas/CreateNotificationRuleParametersData" type: object CreateNotificationRuleParametersData: - description: 'Data of the notification rule create request: the rule type, and - the rule attributes. All fields are required.' + description: |- + Data of the notification rule create request: the rule type, and the rule attributes. All fields are required. properties: attributes: - $ref: '#/components/schemas/CreateNotificationRuleParametersDataAttributes' + $ref: "#/components/schemas/CreateNotificationRuleParametersDataAttributes" type: - $ref: '#/components/schemas/NotificationRulesType' + $ref: "#/components/schemas/NotificationRulesType" required: - - attributes - - type + - attributes + - type type: object CreateNotificationRuleParametersDataAttributes: - description: Attributes of the notification rule create request. + description: |- + Attributes of the notification rule create request. properties: enabled: - $ref: '#/components/schemas/Enabled' + $ref: "#/components/schemas/Enabled" name: - $ref: '#/components/schemas/RuleName' + $ref: "#/components/schemas/RuleName" selectors: - $ref: '#/components/schemas/Selectors' + $ref: "#/components/schemas/Selectors" targets: - $ref: '#/components/schemas/Targets' + $ref: "#/components/schemas/Targets" time_aggregation: - $ref: '#/components/schemas/TimeAggregation' + $ref: "#/components/schemas/TimeAggregation" required: - - selectors - - name - - targets + - selectors + - name + - targets type: object CreateOnCallNotificationRuleRequest: description: A top-level wrapper for creating a notification rule for a user example: data: attributes: - category: high_urgency + "category": "high_urgency" channel_settings: - method: sms - type: phone - delay_minutes: 1 + method: "sms" + type: "phone" + "delay_minutes": 1 relationships: channel: data: @@ -15564,27 +14970,27 @@ components: type: notification_rules properties: data: - $ref: '#/components/schemas/CreateOnCallNotificationRuleRequestData' + $ref: "#/components/schemas/CreateOnCallNotificationRuleRequestData" required: - - data + - data type: object CreateOnCallNotificationRuleRequestData: description: Data for creating an on-call notification rule properties: attributes: - $ref: '#/components/schemas/OnCallNotificationRuleRequestAttributes' + $ref: "#/components/schemas/OnCallNotificationRuleRequestAttributes" relationships: - $ref: '#/components/schemas/OnCallNotificationRuleRelationships' + $ref: "#/components/schemas/OnCallNotificationRuleRelationships" type: - $ref: '#/components/schemas/OnCallNotificationRuleType' + $ref: "#/components/schemas/OnCallNotificationRuleType" required: - - type + - type type: object CreateOpenAPIResponse: description: Response for `CreateOpenAPI` operation. properties: data: - $ref: '#/components/schemas/CreateOpenAPIResponseData' + $ref: "#/components/schemas/CreateOpenAPIResponseData" type: object CreateOpenAPIResponseAttributes: description: Attributes for `CreateOpenAPI`. @@ -15592,16 +14998,16 @@ components: failed_endpoints: description: List of endpoints which couldn't be parsed. items: - $ref: '#/components/schemas/OpenAPIEndpoint' + $ref: "#/components/schemas/OpenAPIEndpoint" type: array type: object CreateOpenAPIResponseData: description: Data envelope for `CreateOpenAPIResponse`. properties: attributes: - $ref: '#/components/schemas/CreateOpenAPIResponseAttributes' + $ref: "#/components/schemas/CreateOpenAPIResponseAttributes" id: - $ref: '#/components/schemas/ApiID' + $ref: "#/components/schemas/ApiID" type: object CreatePageRequest: description: Full request to trigger an On-Call Page. @@ -15610,7 +15016,7 @@ components: attributes: description: Page details. tags: - - service:test + - service:test target: identifier: my-team type: team_handle @@ -15619,17 +15025,17 @@ components: type: pages properties: data: - $ref: '#/components/schemas/CreatePageRequestData' + $ref: "#/components/schemas/CreatePageRequestData" type: object CreatePageRequestData: description: The main request body, including attributes and resource type. properties: attributes: - $ref: '#/components/schemas/CreatePageRequestDataAttributes' + $ref: "#/components/schemas/CreatePageRequestDataAttributes" type: - $ref: '#/components/schemas/CreatePageRequestDataType' + $ref: "#/components/schemas/CreatePageRequestDataType" required: - - type + - type type: object CreatePageRequestDataAttributes: description: Details about the On-Call Page you want to create. @@ -15643,37 +15049,36 @@ components: type: string type: array target: - $ref: '#/components/schemas/CreatePageRequestDataAttributesTarget' + $ref: "#/components/schemas/CreatePageRequestDataAttributesTarget" title: description: The title of the page. - example: 'Service: Test is down' + example: "Service: Test is down" type: string urgency: - $ref: '#/components/schemas/PageUrgency' + $ref: "#/components/schemas/PageUrgency" required: - - target - - title - - urgency + - target + - title + - urgency type: object CreatePageRequestDataAttributesTarget: description: Information about the target to notify (such as a team or user). properties: identifier: - description: Identifier for the target (for example, team handle or user - ID). + description: Identifier for the target (for example, team handle or user ID). type: string type: - $ref: '#/components/schemas/OnCallPageTargetType' + $ref: "#/components/schemas/OnCallPageTargetType" type: object CreatePageRequestDataType: default: pages description: The type of resource used when creating an On-Call Page. enum: - - pages + - pages example: pages type: string x-enum-varnames: - - PAGES + - PAGES CreatePageResponse: description: The full response object after creating a new On-Call Page. example: @@ -15682,7 +15087,7 @@ components: type: pages properties: data: - $ref: '#/components/schemas/CreatePageResponseData' + $ref: "#/components/schemas/CreatePageResponseData" type: object CreatePageResponseData: description: The information returned after successfully creating a page. @@ -15691,63 +15096,63 @@ components: description: The unique ID of the created page. type: string type: - $ref: '#/components/schemas/CreatePageResponseDataType' + $ref: "#/components/schemas/CreatePageResponseDataType" required: - - type + - type type: object CreatePageResponseDataType: default: pages description: The type of resource used when creating an On-Call Page. enum: - - pages + - pages example: pages type: string x-enum-varnames: - - PAGES + - PAGES CreatePhoneNotificationChannelConfig: - description: Configuration to create a phone notification channel + description: "Configuration to create a phone notification channel" properties: number: - description: The E-164 formatted phone number (e.g. +3371234567) - example: '' + description: "The E-164 formatted phone number (e.g. +3371234567)" + example: "" type: string type: - $ref: '#/components/schemas/NotificationChannelPhoneConfigType' + $ref: "#/components/schemas/NotificationChannelPhoneConfigType" required: - - type - - number + - type + - number type: object CreateRuleRequest: description: Scorecard create rule request. properties: data: - $ref: '#/components/schemas/CreateRuleRequestData' + $ref: "#/components/schemas/CreateRuleRequestData" type: object CreateRuleRequestData: description: Scorecard create rule request data. properties: attributes: - $ref: '#/components/schemas/RuleAttributes' + $ref: "#/components/schemas/RuleAttributes" type: - $ref: '#/components/schemas/RuleType' + $ref: "#/components/schemas/RuleType" type: object CreateRuleResponse: description: Created rule in response. properties: data: - $ref: '#/components/schemas/CreateRuleResponseData' + $ref: "#/components/schemas/CreateRuleResponseData" type: object CreateRuleResponseData: description: Create rule response data. properties: attributes: - $ref: '#/components/schemas/RuleAttributes' + $ref: "#/components/schemas/RuleAttributes" id: - $ref: '#/components/schemas/RuleId' + $ref: "#/components/schemas/RuleId" relationships: - $ref: '#/components/schemas/RelationshipToRule' + $ref: "#/components/schemas/RelationshipToRule" type: - $ref: '#/components/schemas/RuleType' + $ref: "#/components/schemas/RuleType" type: object CreateRulesetRequest: description: The definition of `CreateRulesetRequest` object. @@ -15756,36 +15161,36 @@ components: attributes: enabled: true rules: - - enabled: true - mapping: null - metadata: null - name: Add Cost Center Tag - query: - addition: - key: cost_center - value: engineering - case_insensitivity: false - if_tag_exists: do_not_apply - query: account_id:"123456789" AND service:"web-api" - reference_table: null + - enabled: true + mapping: + metadata: + name: Add Cost Center Tag + query: + addition: + key: cost_center + value: engineering + case_insensitivity: false + if_tag_exists: do_not_apply + query: account_id:"123456789" AND service:"web-api" + reference_table: id: New Ruleset type: create_ruleset properties: data: - $ref: '#/components/schemas/CreateRulesetRequestData' + $ref: "#/components/schemas/CreateRulesetRequestData" type: object CreateRulesetRequestData: description: The definition of `CreateRulesetRequestData` object. properties: attributes: - $ref: '#/components/schemas/CreateRulesetRequestDataAttributes' + $ref: "#/components/schemas/CreateRulesetRequestDataAttributes" id: description: The `CreateRulesetRequestData` `id`. type: string type: - $ref: '#/components/schemas/CreateRulesetRequestDataType' + $ref: "#/components/schemas/CreateRulesetRequestDataType" required: - - type + - type type: object CreateRulesetRequestDataAttributes: description: The definition of `CreateRulesetRequestDataAttributes` object. @@ -15796,42 +15201,40 @@ components: rules: description: The `attributes` `rules`. items: - $ref: '#/components/schemas/CreateRulesetRequestDataAttributesRulesItems' + $ref: "#/components/schemas/CreateRulesetRequestDataAttributesRulesItems" type: array required: - - rules + - rules type: object CreateRulesetRequestDataAttributesRulesItems: - description: The definition of `CreateRulesetRequestDataAttributesRulesItems` - object. + description: The definition of `CreateRulesetRequestDataAttributesRulesItems` object. properties: enabled: description: The `items` `enabled`. example: false type: boolean mapping: - $ref: '#/components/schemas/DataAttributesRulesItemsMapping' + $ref: "#/components/schemas/DataAttributesRulesItemsMapping" metadata: - $ref: '#/components/schemas/RulesetItemMetadata' + $ref: "#/components/schemas/RulesetItemMetadata" name: description: The `items` `name`. - example: '' + example: "" type: string query: - $ref: '#/components/schemas/CreateRulesetRequestDataAttributesRulesItemsQuery' + $ref: "#/components/schemas/CreateRulesetRequestDataAttributesRulesItemsQuery" reference_table: - $ref: '#/components/schemas/CreateRulesetRequestDataAttributesRulesItemsReferenceTable' + $ref: "#/components/schemas/CreateRulesetRequestDataAttributesRulesItemsReferenceTable" required: - - enabled - - name + - enabled + - name type: object CreateRulesetRequestDataAttributesRulesItemsQuery: - description: The definition of `CreateRulesetRequestDataAttributesRulesItemsQuery` - object. + description: The definition of `CreateRulesetRequestDataAttributesRulesItemsQuery` object. nullable: true properties: addition: - $ref: '#/components/schemas/CreateRulesetRequestDataAttributesRulesItemsQueryAddition' + $ref: "#/components/schemas/CreateRulesetRequestDataAttributesRulesItemsQueryAddition" case_insensitivity: description: The `query` `case_insensitivity`. type: boolean @@ -15840,35 +15243,33 @@ components: description: Deprecated. Use `if_tag_exists` instead. The `query` `if_not_exists`. type: boolean if_tag_exists: - $ref: '#/components/schemas/DataAttributesRulesItemsIfTagExists' + $ref: "#/components/schemas/DataAttributesRulesItemsIfTagExists" query: description: The `query` `query`. - example: '' + example: "" type: string required: - - addition - - query + - addition + - query type: object CreateRulesetRequestDataAttributesRulesItemsQueryAddition: - description: The definition of `CreateRulesetRequestDataAttributesRulesItemsQueryAddition` - object. + description: The definition of `CreateRulesetRequestDataAttributesRulesItemsQueryAddition` object. nullable: true properties: key: description: The `addition` `key`. - example: '' + example: "" type: string value: description: The `addition` `value`. - example: '' + example: "" type: string required: - - key - - value + - key + - value type: object CreateRulesetRequestDataAttributesRulesItemsReferenceTable: - description: The definition of `CreateRulesetRequestDataAttributesRulesItemsReferenceTable` - object. + description: The definition of `CreateRulesetRequestDataAttributesRulesItemsReferenceTable` object. nullable: true properties: case_insensitivity: @@ -15877,78 +15278,76 @@ components: field_pairs: description: The `reference_table` `field_pairs`. items: - $ref: '#/components/schemas/CreateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems' + $ref: "#/components/schemas/CreateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems" type: array if_not_exists: deprecated: true - description: Deprecated. Use `if_tag_exists` instead. The `reference_table` - `if_not_exists`. + description: Deprecated. Use `if_tag_exists` instead. The `reference_table` `if_not_exists`. type: boolean if_tag_exists: - $ref: '#/components/schemas/DataAttributesRulesItemsIfTagExists' + $ref: "#/components/schemas/DataAttributesRulesItemsIfTagExists" source_keys: description: The `reference_table` `source_keys`. example: - - '' + - "" items: type: string type: array table_name: description: The `reference_table` `table_name`. - example: '' + example: "" type: string required: - - field_pairs - - source_keys - - table_name + - field_pairs + - source_keys + - table_name type: object CreateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems: - description: The definition of `CreateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems` - object. + description: The definition of `CreateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems` object. properties: input_column: description: The `items` `input_column`. - example: '' + example: "" type: string output_key: description: The `items` `output_key`. - example: '' + example: "" type: string required: - - input_column - - output_key + - input_column + - output_key type: object CreateRulesetRequestDataType: default: create_ruleset description: Create ruleset resource type. enum: - - create_ruleset + - create_ruleset example: create_ruleset type: string x-enum-varnames: - - CREATE_RULESET + - CREATE_RULESET CreateStatusPageRequest: example: data: attributes: company_logo: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAIKMMMM components: - - name: API - position: 0 - type: component - - components: - - name: Login + - name: API position: 0 type: component - - name: Settings + - components: + - name: Login + position: 0 + type: component + - name: Settings + position: 1 + type: component + name: Web App position: 1 + type: group + - name: Webhooks + position: 2 type: component - name: Web App - position: 1 - type: group - - name: Webhooks - position: 2 - type: component domain_prefix: status-page-us1 email_header_image: data:image/png;base64,pQSLAw0KGgoAAAANSUhEUgAAAQ4AASJKFF enabled: true @@ -15960,17 +15359,17 @@ components: type: status_pages properties: data: - $ref: '#/components/schemas/CreateStatusPageRequestData' + $ref: "#/components/schemas/CreateStatusPageRequestData" type: object CreateStatusPageRequestData: properties: attributes: - $ref: '#/components/schemas/CreateStatusPageRequestDataAttributes' + $ref: "#/components/schemas/CreateStatusPageRequestDataAttributes" type: - $ref: '#/components/schemas/StatusPageDataType' + $ref: "#/components/schemas/StatusPageDataType" required: - - attributes - - type + - attributes + - type type: object CreateStatusPageRequestDataAttributes: description: The supported attributes for creating a status page. @@ -15982,33 +15381,31 @@ components: components: description: The components displayed on the status page. example: - - components: - - name: Login + - components: + - name: Login + position: 0 + type: component + - name: Settings + position: 1 + type: component + name: Web App position: 0 - type: component - - name: Settings + type: group + - name: API position: 1 type: component - name: Web App - position: 0 - type: group - - name: API - position: 1 - type: component - - name: Webhooks - position: 2 - type: component + - name: Webhooks + position: 2 + type: component items: - $ref: '#/components/schemas/CreateStatusPageRequestDataAttributesComponentsItems' + $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesComponentsItems" type: array domain_prefix: - description: The subdomain of the status page's url taking the form `https://{domain_prefix}.statuspage.datadoghq.com`. - Globally unique across Datadog Status Pages. + description: The subdomain of the status page's url taking the form `https://{domain_prefix}.statuspage.datadoghq.com`. Globally unique across Datadog Status Pages. example: status-page-us1 type: string email_header_image: - description: Base64-encoded image data included in email notifications sent - to status page subscribers. + description: Base64-encoded image data included in email notifications sent to status page subscribers. example: data:image/png;base64,pQSLAw0KGgoAAAANSUhEUgAAAQ4AASJKFF type: string enabled: @@ -16028,25 +15425,24 @@ components: example: true type: boolean type: - $ref: '#/components/schemas/CreateStatusPageRequestDataAttributesType' + $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesType" example: public visualization_type: - $ref: '#/components/schemas/CreateStatusPageRequestDataAttributesVisualizationType' + $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesVisualizationType" example: bars_and_uptime_percentage required: - - domain_prefix - - enabled - - name - - type - - visualization_type + - domain_prefix + - enabled + - name + - type + - visualization_type type: object CreateStatusPageRequestDataAttributesComponentsItems: properties: components: - description: If creating a component of type `group`, the components to - create within the group. + description: If creating a component of type `group`, the components to create within the group. items: - $ref: '#/components/schemas/CreateStatusPageRequestDataAttributesComponentsItemsComponentsItems' + $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesComponentsItemsComponentsItems" type: array id: description: The ID of the component. @@ -16061,9 +15457,9 @@ components: format: int64 type: integer status: - $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus' + $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus" type: - $ref: '#/components/schemas/CreateComponentRequestDataAttributesType' + $ref: "#/components/schemas/CreateComponentRequestDataAttributesType" type: object CreateStatusPageRequestDataAttributesComponentsItemsComponentsItems: properties: @@ -16076,107 +15472,100 @@ components: description: The name of the grouped component. type: string position: - description: The zero-indexed position of the grouped component. Relative - to the other components in the group. + description: The zero-indexed position of the grouped component. Relative to the other components in the group. format: int64 type: integer status: - $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus' + $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus" type: - $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType' + $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType" type: object CreateStatusPageRequestDataAttributesType: - description: The type of the status page controlling how the status page is - accessed. + description: The type of the status page controlling how the status page is accessed. enum: - - public - - internal + - public + - internal example: public type: string x-enum-varnames: - - PUBLIC - - INTERNAL + - PUBLIC + - INTERNAL CreateStatusPageRequestDataAttributesVisualizationType: description: The visualization type of the status page. enum: - - bars_and_uptime_percentage - - bars_only - - component_name_only + - bars_and_uptime_percentage + - bars_only + - component_name_only example: bars_and_uptime_percentage type: string x-enum-varnames: - - BARS_AND_UPTIME_PERCENTAGE - - BARS_ONLY - - COMPONENT_NAME_ONLY + - BARS_AND_UPTIME_PERCENTAGE + - BARS_ONLY + - COMPONENT_NAME_ONLY CreateTableRequest: - description: Request body for creating a new reference table from a local file - or cloud storage. + description: Request body for creating a new reference table from a local file or cloud storage. properties: data: - $ref: '#/components/schemas/CreateTableRequestData' + $ref: "#/components/schemas/CreateTableRequestData" type: object CreateTableRequestData: additionalProperties: false description: The data object containing the table definition. properties: attributes: - $ref: '#/components/schemas/CreateTableRequestDataAttributes' + $ref: "#/components/schemas/CreateTableRequestDataAttributes" type: - $ref: '#/components/schemas/CreateTableRequestDataType' + $ref: "#/components/schemas/CreateTableRequestDataType" required: - - type + - type type: object CreateTableRequestDataAttributes: - description: Attributes that define the reference table's configuration and - properties. + description: Attributes that define the reference table's configuration and properties. properties: description: - description: Optional text describing the purpose or contents of this reference - table. + description: Optional text describing the purpose or contents of this reference table. type: string file_metadata: - $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadata' + $ref: "#/components/schemas/CreateTableRequestDataAttributesFileMetadata" schema: - $ref: '#/components/schemas/CreateTableRequestDataAttributesSchema' + $ref: "#/components/schemas/CreateTableRequestDataAttributesSchema" source: - $ref: '#/components/schemas/ReferenceTableCreateSourceType' + $ref: "#/components/schemas/ReferenceTableCreateSourceType" table_name: description: Name to identify this reference table. - example: table_1 + example: "table_1" type: string tags: description: Tags for organizing and filtering reference tables. example: - - tag_1 - - tag_2 + - "tag_1" + - "tag_2" items: type: string type: array required: - - table_name - - schema - - source + - table_name + - schema + - source type: object CreateTableRequestDataAttributesFileMetadata: - description: Metadata specifying where and how to access the reference table's - data file. + description: Metadata specifying where and how to access the reference table's data file. oneOf: - - $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataCloudStorage' - - $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataLocalFile' + - $ref: "#/components/schemas/CreateTableRequestDataAttributesFileMetadataCloudStorage" + - $ref: "#/components/schemas/CreateTableRequestDataAttributesFileMetadataLocalFile" CreateTableRequestDataAttributesFileMetadataCloudStorage: additionalProperties: false - description: Cloud storage file metadata for create requests. Both access_details - and sync_enabled are required. + description: Cloud storage file metadata for create requests. Both access_details and sync_enabled are required. properties: access_details: - $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails' + $ref: "#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails" sync_enabled: description: Whether this table is synced automatically. example: false type: boolean required: - - access_details - - sync_enabled + - access_details + - sync_enabled title: CloudFileMetadataV2 type: object CreateTableRequestDataAttributesFileMetadataLocalFile: @@ -16185,167 +15574,161 @@ components: properties: upload_id: description: The upload ID. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string required: - - upload_id + - upload_id title: LocalFileMetadataV2 type: object CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails: - description: Cloud storage access configuration for the reference table data - file. + description: Cloud storage access configuration for the reference table data file. properties: aws_detail: - $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail' + $ref: "#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail" azure_detail: - $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail' + $ref: "#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail" gcp_detail: - $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail' + $ref: "#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail" type: object CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail: description: Amazon Web Services S3 storage access configuration. properties: aws_account_id: description: AWS account ID where the S3 bucket is located. - example: '123456789000' + example: "123456789000" type: string aws_bucket_name: description: S3 bucket containing the CSV file. - example: example-data-bucket + example: "example-data-bucket" type: string file_path: description: The relative file path from the S3 bucket root to the CSV file. - example: reference-tables/users.csv + example: "reference-tables/users.csv" type: string required: - - aws_account_id - - aws_bucket_name - - file_path + - aws_account_id + - aws_bucket_name + - file_path type: object x-oneOf-parent: - - AwsDetail + - AwsDetail CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail: description: Azure Blob Storage access configuration. properties: azure_client_id: - description: Azure service principal (application) client ID with permissions - to read from the container. - example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb + description: Azure service principal (application) client ID with permissions to read from the container. + example: "aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb" type: string azure_container_name: description: Azure Blob Storage container containing the CSV file. - example: reference-data + example: "reference-data" type: string azure_storage_account_name: description: Azure storage account where the container is located. - example: examplestorageaccount + example: "examplestorageaccount" type: string azure_tenant_id: description: Azure Active Directory tenant ID. - example: cccccccc-4444-5555-6666-dddddddddddd + example: "cccccccc-4444-5555-6666-dddddddddddd" type: string file_path: - description: The relative file path from the Azure container root to the - CSV file. - example: tables/users.csv + description: The relative file path from the Azure container root to the CSV file. + example: "tables/users.csv" type: string required: - - azure_client_id - - azure_container_name - - azure_storage_account_name - - azure_tenant_id - - file_path + - azure_client_id + - azure_container_name + - azure_storage_account_name + - azure_tenant_id + - file_path type: object x-oneOf-parent: - - AzureDetail + - AzureDetail CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail: description: Google Cloud Platform storage access configuration. properties: file_path: - description: The relative file path from the GCS bucket root to the CSV - file. - example: data/reference_tables/users.csv + description: The relative file path from the GCS bucket root to the CSV file. + example: "data/reference_tables/users.csv" type: string gcp_bucket_name: description: GCP bucket containing the CSV file. - example: example-data-bucket + example: "example-data-bucket" type: string gcp_project_id: description: GCP project ID where the bucket is located. - example: example-gcp-project-12345 + example: "example-gcp-project-12345" type: string gcp_service_account_email: description: Service account email with read permissions for the GCS bucket. - example: example-service@example-gcp-project-12345.iam.gserviceaccount.com + example: "example-service@example-gcp-project-12345.iam.gserviceaccount.com" type: string required: - - file_path - - gcp_bucket_name - - gcp_project_id - - gcp_service_account_email + - file_path + - gcp_bucket_name + - gcp_project_id + - gcp_service_account_email type: object x-oneOf-parent: - - GcpDetail + - GcpDetail CreateTableRequestDataAttributesSchema: description: Schema defining the structure and columns of the reference table. properties: fields: description: The schema fields. items: - $ref: '#/components/schemas/CreateTableRequestDataAttributesSchemaFieldsItems' + $ref: "#/components/schemas/CreateTableRequestDataAttributesSchemaFieldsItems" type: array primary_keys: - description: List of field names that serve as primary keys for the table. - Only one primary key is supported, and it is used as an ID to retrieve - rows. + description: List of field names that serve as primary keys for the table. Only one primary key is supported, and it is used as an ID to retrieve rows. example: - - field_1 + - "field_1" items: type: string type: array required: - - fields - - primary_keys + - fields + - primary_keys type: object CreateTableRequestDataAttributesSchemaFieldsItems: description: A single field (column) in the reference table schema to be created. properties: name: description: The field name. - example: field_1 + example: "field_1" type: string type: - $ref: '#/components/schemas/ReferenceTableSchemaFieldType' + $ref: "#/components/schemas/ReferenceTableSchemaFieldType" required: - - name - - type + - name + - type type: object CreateTableRequestDataType: default: reference_table description: Reference table resource type. enum: - - reference_table + - reference_table example: reference_table type: string x-enum-varnames: - - REFERENCE_TABLE + - REFERENCE_TABLE CreateTenancyConfigData: properties: attributes: - $ref: '#/components/schemas/CreateTenancyConfigDataAttributes' + $ref: "#/components/schemas/CreateTenancyConfigDataAttributes" id: - example: '' + example: "" type: string type: - $ref: '#/components/schemas/UpdateTenancyConfigDataType' + $ref: "#/components/schemas/UpdateTenancyConfigDataType" required: - - type - - id + - type + - id type: object CreateTenancyConfigDataAttributes: properties: auth_credentials: - $ref: '#/components/schemas/CreateTenancyConfigDataAttributesAuthCredentials' + $ref: "#/components/schemas/CreateTenancyConfigDataAttributesAuthCredentials" config_version: format: int64 nullable: true @@ -16357,33 +15740,33 @@ components: dd_stack_id: type: string home_region: - example: '' + example: "" type: string logs_config: - $ref: '#/components/schemas/CreateTenancyConfigDataAttributesLogsConfig' + $ref: "#/components/schemas/CreateTenancyConfigDataAttributesLogsConfig" metrics_config: - $ref: '#/components/schemas/CreateTenancyConfigDataAttributesMetricsConfig' + $ref: "#/components/schemas/CreateTenancyConfigDataAttributesMetricsConfig" regions_config: - $ref: '#/components/schemas/CreateTenancyConfigDataAttributesRegionsConfig' + $ref: "#/components/schemas/CreateTenancyConfigDataAttributesRegionsConfig" resource_collection_enabled: type: boolean user_ocid: - example: '' + example: "" type: string required: - - auth_credentials - - home_region - - user_ocid + - auth_credentials + - home_region + - user_ocid type: object CreateTenancyConfigDataAttributesAuthCredentials: properties: fingerprint: type: string private_key: - example: '' + example: "" type: string required: - - private_key + - private_key type: object CreateTenancyConfigDataAttributesLogsConfig: properties: @@ -16431,123 +15814,102 @@ components: data: attributes: auth_credentials: - fingerprint: '' - private_key: '----BEGIN PRIVATE KEY----- - + fingerprint: "" + private_key: |- + ----BEGIN PRIVATE KEY----- MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCdvSMmlfLyeD4M - QsA3WlrWBqKdWa5eVV3/uODyqT3wWMEMIJHcG3/quNs8nh9xrK1/JkQT2qoKEHqR - C5k59jN6Vp8em8ARJthMgam9K37ELt+IQ/G8ySTSuqZG8T4cHp/cs3fAclNqttOl - YnGr4RbVAgMBAAECggEAGZNLGbyCUbIRTW6Kh4d8ZVC+eZtJMqGmGJ3KfVaW8Pjn - QGWfSuJCEe2o2Y8G3phlidFauICnZ44enXA17Rhi+I/whnr7FIyQk2bR7rv+1Uhc - mOJygWX5eFFMsledgVAdIAl9Luk2nykx7Un3g6rtbl/Vs+5k4m7ITLFMpCHzsJLU - nm8kBzDOqY2JUkMd08nL88KL6QywWtal05UESzQpNFXd0e5kxYfexeMCsLsWP0mc - quMLRbn7NuBjCbe9VU2kmIvcfDDaWjurT7d5m1OXx1cc8p6P4PFZTVyCjdhiWOr3 - LQXZ4/vdZNR3zgEHypRoM6D9Yq99LWUOUEMrdiSLQQKBgQDQkh7C1OtAXnpy7F6R - W+/I3zBHici2p7A57UT7VECQ1IVGg37/uus83DkuOtdZ33JmHLAVrwLFJvUlbyjx - l6dc/1ms40L5HFdLgaVtd4k0rSPFeOSDr6evz0lX4yBuzlP0fEh+o3XHW7mwe2G+ - rWCULF/Uqza66fjbCSKMNgLIXQKBgQDBm9nZg/s4S0THWCFNWcB1tXBG0p/sH5eY - PC1H/VmTEINIixStrS4ufczf31X8rcoSjSbO7+vZDTTATdk7OLn1I2uGFVYl8M59 - 86BYT2Hi7cwp7YVzOc/cJigVeBAqSRW/iYYyWBEUTiW1gbkV0sRWwhPp67m+c0sP - XpY/iEZA2QKBgB1w8tynt4l/jKNaUEMOijt9ndALWATIiOy0XG9pxi9rgGCiwTOS - DBCsOXoYHjv2eayGUijNaoOv6xzcoxfvQ1WySdNIxTRq1ru20kYwgHKqGgmO9hrM - mcwMY5r/WZ2qjFlPjeAqbL62aPDLidGjoaVo2iIoBPK/gjxQ/5f0MS4N/YQ0zWoYBueSQ0DGs - - -----END PRIVATE KEY-----' - config_version: null + -----END PRIVATE KEY----- + config_version: cost_collection_enabled: true dd_compartment_id: ocid.compartment.test dd_stack_id: ocid.stack.test home_region: us-ashburn-1 logs_config: compartment_tag_filters: - - datadog:true - - env:prod + - datadog:true + - env:prod enabled: true enabled_services: - - service_1 - - service_1 + - service_1 + - service_1 metrics_config: compartment_tag_filters: - - datadog:true - - env:prod + - datadog:true + - env:prod enabled: true excluded_services: - - service_1 - - service_1 + - service_1 + - service_1 regions_config: available: - - us-ashburn-1 - - us-phoenix-1 + - us-ashburn-1 + - us-phoenix-1 disabled: - - us-phoenix-1 + - us-phoenix-1 enabled: - - us-ashburn-1 + - us-ashburn-1 resource_collection_enabled: true user_ocid: ocid.user.test id: ocid.tenancy.test type: oci_tenancy properties: data: - $ref: '#/components/schemas/CreateTenancyConfigData' + $ref: "#/components/schemas/CreateTenancyConfigData" required: - - data + - data type: object CreateUploadRequest: - description: Request to create an upload for a file to be ingested into a reference - table. + description: Request to create an upload for a file to be ingested into a reference table. example: data: attributes: headers: - - product_id - - product_name - - price + - product_id + - product_name + - price part_count: 3 part_size: 10000000 table_name: my_products_table type: upload properties: data: - $ref: '#/components/schemas/CreateUploadRequestData' + $ref: "#/components/schemas/CreateUploadRequestData" type: object CreateUploadRequestData: additionalProperties: false - description: Request data for creating an upload for a file to be ingested into - a reference table. + description: Request data for creating an upload for a file to be ingested into a reference table. properties: attributes: - $ref: '#/components/schemas/CreateUploadRequestDataAttributes' + $ref: "#/components/schemas/CreateUploadRequestDataAttributes" type: - $ref: '#/components/schemas/CreateUploadRequestDataType' + $ref: "#/components/schemas/CreateUploadRequestDataType" required: - - type + - type type: object CreateUploadRequestDataAttributes: - description: Upload configuration specifying how data is uploaded by the user, - and properties of the table to associate the upload with. + description: Upload configuration specifying how data is uploaded by the user, and properties of the table to associate the upload with. properties: headers: - description: The CSV file headers that define the schema fields, provided - in the same order as the columns in the uploaded file. + description: The CSV file headers that define the schema fields, provided in the same order as the columns in the uploaded file. example: - - field_1 - - field_2 + - "field_1" + - "field_2" items: type: string type: array @@ -16558,58 +15920,55 @@ components: maximum: 20 type: integer part_size: - description: The size of each part in the upload in bytes. All parts except - the last one must be at least 5,000,000 bytes. + description: >- + The size of each part in the upload in bytes. All parts except the last one must be at least 5,000,000 bytes. example: 10000000 format: int64 type: integer table_name: description: Name of the table to associate with this upload. - example: '' + example: "" type: string required: - - headers - - table_name - - part_count - - part_size + - headers + - table_name + - part_count + - part_size type: object CreateUploadRequestDataType: default: upload description: Upload resource type. enum: - - upload + - upload example: upload type: string x-enum-varnames: - - UPLOAD + - UPLOAD CreateUploadResponse: - description: Information about the upload created containing the upload ID and - pre-signed URLs to PUT chunks of the CSV file to. + description: Information about the upload created containing the upload ID and pre-signed URLs to PUT chunks of the CSV file to. properties: data: - $ref: '#/components/schemas/CreateUploadResponseData' + $ref: "#/components/schemas/CreateUploadResponseData" type: object CreateUploadResponseData: additionalProperties: false description: Upload ID and attributes of the created upload. properties: attributes: - $ref: '#/components/schemas/CreateUploadResponseDataAttributes' + $ref: "#/components/schemas/CreateUploadResponseDataAttributes" id: - description: Unique identifier for this upload. Use this ID when creating - the reference table. + description: Unique identifier for this upload. Use this ID when creating the reference table. type: string type: - $ref: '#/components/schemas/CreateUploadResponseDataType' + $ref: "#/components/schemas/CreateUploadResponseDataType" required: - - type + - type type: object CreateUploadResponseDataAttributes: description: Pre-signed URLs for uploading parts of the file. properties: part_urls: - description: The pre-signed URLs for uploading parts. These URLs expire - after 5 minutes. + description: The pre-signed URLs for uploading parts. These URLs expire after 5 minutes. items: type: string type: array @@ -16618,103 +15977,100 @@ components: default: upload description: Upload resource type. enum: - - upload + - upload example: upload type: string x-enum-varnames: - - UPLOAD + - UPLOAD CreateUserNotificationChannelRequest: description: A top-level wrapper for creating a notification channel for a user example: data: attributes: config: - address: foo@bar.com - formats: - - html - type: email + address: "foo@bar.com" + formats: ["html"] + type: "email" type: notification_channels properties: data: - $ref: '#/components/schemas/CreateNotificationChannelData' + $ref: "#/components/schemas/CreateNotificationChannelData" required: - - data + - data type: object CreateWorkflowRequest: description: A request object for creating a new workflow. example: data: attributes: - description: A sample workflow. - name: Example Workflow + description: "A sample workflow." + name: "Example Workflow" published: true spec: annotations: - - display: - bounds: - height: 150 - width: 300 - x: -375 - y: -0.5 - id: 99999999-9999-9999-9999-999999999999 - markdownTextAnnotation: - text: Example annotation. + - display: + bounds: + height: 150 + width: 300 + x: -375 + y: -0.5 + id: 99999999-9999-9999-9999-999999999999 + markdownTextAnnotation: + text: "Example annotation." connectionEnvs: - - connections: - - connectionId: 11111111-1111-1111-1111-111111111111 - label: INTEGRATION_DATADOG - env: default - handle: my-handle + - connections: + - connectionId: "11111111-1111-1111-1111-111111111111" + label: "INTEGRATION_DATADOG" + env: "default" + handle: "my-handle" inputSchema: parameters: - - defaultValue: default - name: input - type: STRING + - defaultValue: "default" + name: "input" + type: "STRING" outputSchema: parameters: - - name: output - type: ARRAY_OBJECT - value: '{{ Steps.Step1 }}' + - name: "output" + type: "ARRAY_OBJECT" + value: "{{ Steps.Step1 }}" steps: - - actionId: com.datadoghq.dd.monitor.listMonitors - connectionLabel: INTEGRATION_DATADOG - name: Step1 - outboundEdges: - - branchName: main - nextStepName: Step2 - parameters: - - name: tags - value: service:monitoring - - actionId: com.datadoghq.core.noop - name: Step2 + - actionId: "com.datadoghq.dd.monitor.listMonitors" + connectionLabel: "INTEGRATION_DATADOG" + name: "Step1" + outboundEdges: + - branchName: "main" + nextStepName: "Step2" + parameters: + - name: "tags" + value: "service:monitoring" + - actionId: "com.datadoghq.core.noop" + name: "Step2" triggers: - - monitorTrigger: - rateLimit: - count: 1 - interval: 3600s - startStepNames: - - Step1 - - githubWebhookTrigger: {} - startStepNames: - - Step1 + - monitorTrigger: + rateLimit: + count: 1 + interval: "3600s" + startStepNames: ["Step1"] + - githubWebhookTrigger: {} + startStepNames: ["Step1"] tags: - - team:infra - - service:monitoring - - foo:bar - type: workflows + - "team:infra" + - "service:monitoring" + - "foo:bar" + type: "workflows" properties: data: - $ref: '#/components/schemas/WorkflowData' + $ref: "#/components/schemas/WorkflowData" required: - - data + - data type: object CreateWorkflowResponse: description: The response object after creating a new workflow. properties: data: - $ref: '#/components/schemas/WorkflowData' + $ref: "#/components/schemas/WorkflowData" required: - - data + - data type: object Creator: description: Creator of the object. @@ -16734,16 +16090,16 @@ components: description: Single Agent Data. properties: attributes: - $ref: '#/components/schemas/CsmAgentsAttributes' + $ref: "#/components/schemas/CsmAgentsAttributes" id: - description: The ID of the Agent. - example: fffffc5505f6a006fdf7cf5aae053653 + description: "The ID of the Agent." + example: "fffffc5505f6a006fdf7cf5aae053653" type: string type: - $ref: '#/components/schemas/CSMAgentsType' + $ref: "#/components/schemas/CSMAgentsType" type: object CsmAgentsAttributes: - description: A CSM Agent returned by the API. + description: "A CSM Agent returned by the API." properties: agent_version: description: Version of the Datadog Agent. @@ -16815,48 +16171,48 @@ components: data: description: A list of Agents. items: - $ref: '#/components/schemas/CsmAgentData' + $ref: "#/components/schemas/CsmAgentData" type: array meta: - $ref: '#/components/schemas/CSMAgentsMetadata' + $ref: "#/components/schemas/CSMAgentsMetadata" type: object CsmCloudAccountsCoverageAnalysisAttributes: description: CSM Cloud Accounts Coverage Analysis attributes. properties: aws_coverage: - $ref: '#/components/schemas/CsmCoverageAnalysis' + $ref: "#/components/schemas/CsmCoverageAnalysis" azure_coverage: - $ref: '#/components/schemas/CsmCoverageAnalysis' + $ref: "#/components/schemas/CsmCoverageAnalysis" gcp_coverage: - $ref: '#/components/schemas/CsmCoverageAnalysis' + $ref: "#/components/schemas/CsmCoverageAnalysis" org_id: description: The ID of your organization. example: 123456 format: int64 type: integer total_coverage: - $ref: '#/components/schemas/CsmCoverageAnalysis' + $ref: "#/components/schemas/CsmCoverageAnalysis" type: object CsmCloudAccountsCoverageAnalysisData: description: CSM Cloud Accounts Coverage Analysis data. properties: attributes: - $ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisAttributes' + $ref: "#/components/schemas/CsmCloudAccountsCoverageAnalysisAttributes" id: - description: The ID of your organization. - example: 66b3c6b5-5c9a-457e-b1c3-f247ca23afa3 + description: "The ID of your organization." + example: "66b3c6b5-5c9a-457e-b1c3-f247ca23afa3" type: string type: - default: get_cloud_accounts_coverage_analysis_response_public_v0 - description: The type of the resource. The value should always be `get_cloud_accounts_coverage_analysis_response_public_v0`. - example: get_cloud_accounts_coverage_analysis_response_public_v0 + default: "get_cloud_accounts_coverage_analysis_response_public_v0" + description: "The type of the resource. The value should always be `get_cloud_accounts_coverage_analysis_response_public_v0`." + example: "get_cloud_accounts_coverage_analysis_response_public_v0" type: string type: object CsmCloudAccountsCoverageAnalysisResponse: description: CSM Cloud Accounts Coverage Analysis response. properties: data: - $ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisData' + $ref: "#/components/schemas/CsmCloudAccountsCoverageAnalysisData" type: object CsmCoverageAnalysis: description: CSM Coverage Analysis. @@ -16886,180 +16242,178 @@ components: description: CSM Hosts and Containers Coverage Analysis attributes. properties: cspm_coverage: - $ref: '#/components/schemas/CsmCoverageAnalysis' + $ref: "#/components/schemas/CsmCoverageAnalysis" cws_coverage: - $ref: '#/components/schemas/CsmCoverageAnalysis' + $ref: "#/components/schemas/CsmCoverageAnalysis" org_id: description: The ID of your organization. example: 123456 format: int64 type: integer total_coverage: - $ref: '#/components/schemas/CsmCoverageAnalysis' + $ref: "#/components/schemas/CsmCoverageAnalysis" vm_coverage: - $ref: '#/components/schemas/CsmCoverageAnalysis' + $ref: "#/components/schemas/CsmCoverageAnalysis" type: object CsmHostsAndContainersCoverageAnalysisData: description: CSM Hosts and Containers Coverage Analysis data. properties: attributes: - $ref: '#/components/schemas/CsmHostsAndContainersCoverageAnalysisAttributes' + $ref: "#/components/schemas/CsmHostsAndContainersCoverageAnalysisAttributes" id: - description: The ID of your organization. - example: 66b3c6b5-5c9a-457e-b1c3-f247ca23afa3 + description: "The ID of your organization." + example: "66b3c6b5-5c9a-457e-b1c3-f247ca23afa3" type: string type: - default: get_hosts_and_containers_coverage_analysis_response_public_v0 - description: The type of the resource. The value should always be `get_hosts_and_containers_coverage_analysis_response_public_v0`. - example: get_hosts_and_containers_coverage_analysis_response_public_v0 + default: "get_hosts_and_containers_coverage_analysis_response_public_v0" + description: "The type of the resource. The value should always be `get_hosts_and_containers_coverage_analysis_response_public_v0`." + example: "get_hosts_and_containers_coverage_analysis_response_public_v0" type: string type: object CsmHostsAndContainersCoverageAnalysisResponse: description: CSM Hosts and Containers Coverage Analysis response. properties: data: - $ref: '#/components/schemas/CsmHostsAndContainersCoverageAnalysisData' + $ref: "#/components/schemas/CsmHostsAndContainersCoverageAnalysisData" type: object CsmServerlessCoverageAnalysisAttributes: description: CSM Serverless Resources Coverage Analysis attributes. properties: cws_coverage: - $ref: '#/components/schemas/CsmCoverageAnalysis' + $ref: "#/components/schemas/CsmCoverageAnalysis" org_id: description: The ID of your organization. example: 123456 format: int64 type: integer total_coverage: - $ref: '#/components/schemas/CsmCoverageAnalysis' + $ref: "#/components/schemas/CsmCoverageAnalysis" type: object CsmServerlessCoverageAnalysisData: description: CSM Serverless Resources Coverage Analysis data. properties: attributes: - $ref: '#/components/schemas/CsmServerlessCoverageAnalysisAttributes' + $ref: "#/components/schemas/CsmServerlessCoverageAnalysisAttributes" id: - description: The ID of your organization. - example: 66b3c6b5-5c9a-457e-b1c3-f247ca23afa3 + description: "The ID of your organization." + example: "66b3c6b5-5c9a-457e-b1c3-f247ca23afa3" type: string type: - default: get_serverless_coverage_analysis_response_public_v0 - description: The type of the resource. The value should always be `get_serverless_coverage_analysis_response_public_v0`. - example: get_serverless_coverage_analysis_response_public_v0 + default: "get_serverless_coverage_analysis_response_public_v0" + description: "The type of the resource. The value should always be `get_serverless_coverage_analysis_response_public_v0`." + example: "get_serverless_coverage_analysis_response_public_v0" type: string type: object CsmServerlessCoverageAnalysisResponse: description: CSM Serverless Resources Coverage Analysis response. properties: data: - $ref: '#/components/schemas/CsmServerlessCoverageAnalysisData' + $ref: "#/components/schemas/CsmServerlessCoverageAnalysisData" type: object CustomAttributeConfig: description: The definition of `CustomAttributeConfig` object. properties: attributes: - $ref: '#/components/schemas/CustomAttributeConfigResourceAttributes' + $ref: "#/components/schemas/CustomAttributeConfigResourceAttributes" id: description: Custom attribute configs identifier - example: aeadc05e-98a8-11ec-ac2c-da7ad0900001 + example: "aeadc05e-98a8-11ec-ac2c-da7ad0900001" type: string type: - $ref: '#/components/schemas/CustomAttributeConfigResourceType' + $ref: "#/components/schemas/CustomAttributeConfigResourceType" type: object CustomAttributeConfigAttributesCreate: description: Custom attribute config resource attributes properties: description: description: Custom attribute description. - example: AWS Region, must be a valid region supported by AWS + example: "AWS Region, must be a valid region supported by AWS" type: string display_name: description: Custom attribute name. - example: AWS Region + example: "AWS Region" type: string is_multi: description: Whether multiple values can be set example: true type: boolean key: - description: Custom attribute key. This will be the value use to search - on this custom attribute - example: aws_region + description: Custom attribute key. This will be the value use to search on this custom attribute + example: "aws_region" type: string type: - $ref: '#/components/schemas/CustomAttributeType' + $ref: "#/components/schemas/CustomAttributeType" required: - - display_name - - key - - type - - is_multi + - display_name + - key + - type + - is_multi type: object CustomAttributeConfigCreate: description: Custom attribute config properties: attributes: - $ref: '#/components/schemas/CustomAttributeConfigAttributesCreate' + $ref: "#/components/schemas/CustomAttributeConfigAttributesCreate" type: - $ref: '#/components/schemas/CustomAttributeConfigResourceType' + $ref: "#/components/schemas/CustomAttributeConfigResourceType" required: - - attributes - - type + - attributes + - type type: object CustomAttributeConfigCreateRequest: description: Custom attribute config create request properties: data: - $ref: '#/components/schemas/CustomAttributeConfigCreate' + $ref: "#/components/schemas/CustomAttributeConfigCreate" required: - - data + - data type: object CustomAttributeConfigResourceAttributes: description: Custom attribute resource attributes properties: case_type_id: description: Custom attribute config identifier. - example: aeadc05e-98a8-11ec-ac2c-da7ad0900001 + example: "aeadc05e-98a8-11ec-ac2c-da7ad0900001" type: string description: description: Custom attribute description. - example: AWS Region, must be a valid region supported by AWS + example: "AWS Region, must be a valid region supported by AWS" type: string display_name: description: Custom attribute name. - example: AWS Region + example: "AWS Region" type: string is_multi: description: Whether multiple values can be set example: true type: boolean key: - description: Custom attribute key. This will be the value use to search - on this custom attribute - example: aws_region + description: Custom attribute key. This will be the value use to search on this custom attribute + example: "aws_region" type: string type: - $ref: '#/components/schemas/CustomAttributeType' + $ref: "#/components/schemas/CustomAttributeType" required: - - case_type_id - - display_name - - key - - type - - is_multi + - case_type_id + - display_name + - key + - type + - is_multi type: object CustomAttributeConfigResourceType: default: custom_attribute description: Custom attributes config JSON:API resource type enum: - - custom_attribute + - custom_attribute example: custom_attribute type: string x-enum-varnames: - - CUSTOM_ATTRIBUTE + - CUSTOM_ATTRIBUTE CustomAttributeConfigResponse: description: Custom attribute config response. properties: data: - $ref: '#/components/schemas/CustomAttributeConfig' + $ref: "#/components/schemas/CustomAttributeConfig" type: object CustomAttributeConfigsResponse: description: Custom attribute configs response. @@ -17067,7 +16421,7 @@ components: data: description: List of custom attribute configs of case type items: - $ref: '#/components/schemas/CustomAttributeConfig' + $ref: "#/components/schemas/CustomAttributeConfig" type: array type: object CustomAttributeMultiNumberValue: @@ -17093,17 +16447,17 @@ components: CustomAttributeType: description: Custom attributes type enum: - - URL - - TEXT - - NUMBER - - SELECT + - URL + - TEXT + - NUMBER + - SELECT example: NUMBER type: string x-enum-varnames: - - URL - - TEXT - - NUMBER - - SELECT + - URL + - TEXT + - NUMBER + - SELECT CustomAttributeValue: description: Custom attribute values properties: @@ -17112,34 +16466,34 @@ components: example: false type: boolean type: - $ref: '#/components/schemas/CustomAttributeType' + $ref: "#/components/schemas/CustomAttributeType" value: - $ref: '#/components/schemas/CustomAttributeValuesUnion' + $ref: "#/components/schemas/CustomAttributeValuesUnion" required: - - type - - is_multi - - value + - type + - is_multi + - value type: object CustomAttributeValuesUnion: description: Union of supported value for a custom attribute - example: '' + example: "" oneOf: - - $ref: '#/components/schemas/CustomAttributeStringValue' - - $ref: '#/components/schemas/CustomAttributeMultiStringValue' - - $ref: '#/components/schemas/CustomAttributeNumberValue' - - $ref: '#/components/schemas/CustomAttributeMultiNumberValue' + - $ref: "#/components/schemas/CustomAttributeStringValue" + - $ref: "#/components/schemas/CustomAttributeMultiStringValue" + - $ref: "#/components/schemas/CustomAttributeNumberValue" + - $ref: "#/components/schemas/CustomAttributeMultiNumberValue" CustomConnection: description: A custom connection used by an app. properties: attributes: - $ref: '#/components/schemas/CustomConnectionAttributes' + $ref: "#/components/schemas/CustomConnectionAttributes" id: description: The ID of the custom connection. example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 format: uuid type: string type: - $ref: '#/components/schemas/CustomConnectionType' + $ref: "#/components/schemas/CustomConnectionType" type: object CustomConnectionAttributes: description: The custom connection attributes. @@ -17148,11 +16502,10 @@ components: description: The name of the custom connection. type: string onPremRunner: - $ref: '#/components/schemas/CustomConnectionAttributesOnPremRunner' + $ref: "#/components/schemas/CustomConnectionAttributesOnPremRunner" type: object CustomConnectionAttributesOnPremRunner: - description: Information about the Private Action Runner used by the custom - connection, if the custom connection is associated with a Private Action Runner. + description: Information about the Private Action Runner used by the custom connection, if the custom connection is associated with a Private Action Runner. properties: id: description: The Private Action Runner ID. @@ -17165,11 +16518,11 @@ components: default: custom_connections description: The custom connection type. enum: - - custom_connections + - custom_connections example: custom_connections type: string x-enum-varnames: - - CUSTOM_CONNECTIONS + - CUSTOM_CONNECTIONS CustomCostGetResponseMeta: description: Meta for the response from the Get Custom Costs endpoints. properties: @@ -17181,8 +16534,7 @@ components: description: Meta for the response from the List Custom Costs endpoints. properties: total_filtered_count: - description: Number of Custom Costs files returned by the List Custom Costs - endpoint + description: Number of Custom Costs files returned by the List Custom Costs endpoint format: int64 type: integer version: @@ -17200,34 +16552,34 @@ components: description: Response for Get Custom Costs files. properties: data: - $ref: '#/components/schemas/CustomCostsFileMetadataWithContentHighLevel' + $ref: "#/components/schemas/CustomCostsFileMetadataWithContentHighLevel" meta: - $ref: '#/components/schemas/CustomCostGetResponseMeta' + $ref: "#/components/schemas/CustomCostGetResponseMeta" type: object CustomCostsFileLineItem: description: Line item details from a Custom Costs file. properties: BilledCost: description: Total cost in the cost file. - example: 100.5 + example: 100.50 format: double type: number BillingCurrency: description: Currency used in the Custom Costs file. - example: USD + example: "USD" type: string ChargeDescription: description: Description for the line item cost. - example: Monthly usage charge for my service + example: "Monthly usage charge for my service" type: string ChargePeriodEnd: description: End date of the usage charge. - example: '2023-02-28' + example: "2023-02-28" pattern: ^\d{4}-\d{2}-\d{2}$ type: string ChargePeriodStart: description: Start date of the usage charge. - example: '2023-02-01' + example: "2023-02-01" pattern: ^\d{4}-\d{2}-\d{2}$ type: string ProviderName: @@ -17245,54 +16597,53 @@ components: data: description: List of Custom Costs files. items: - $ref: '#/components/schemas/CustomCostsFileMetadataHighLevel' + $ref: "#/components/schemas/CustomCostsFileMetadataHighLevel" type: array meta: - $ref: '#/components/schemas/CustomCostListResponseMeta' + $ref: "#/components/schemas/CustomCostListResponseMeta" type: object CustomCostsFileMetadata: description: Schema of a Custom Costs metadata. properties: billed_cost: description: Total cost in the cost file. - example: 100.5 + example: 100.50 format: double type: number billing_currency: description: Currency used in the Custom Costs file. - example: USD + example: "USD" type: string charge_period: - $ref: '#/components/schemas/CustomCostsFileUsageChargePeriod' + $ref: "#/components/schemas/CustomCostsFileUsageChargePeriod" name: description: Name of the Custom Costs file. - example: my_file.json + example: "my_file.json" type: string provider_names: description: Providers contained in the Custom Costs file. items: description: Name of the provider. - example: my_provider + example: "my_provider" type: string type: array status: description: Status of the Custom Costs file. - example: active + example: "active" type: string uploaded_at: - description: Timestamp, in millisecond, of the upload time of the Custom - Costs file. + description: Timestamp, in millisecond, of the upload time of the Custom Costs file. example: 1704067200000 format: double type: number uploaded_by: - $ref: '#/components/schemas/CustomCostsUser' + $ref: "#/components/schemas/CustomCostsUser" type: object CustomCostsFileMetadataHighLevel: description: JSON API format for a Custom Costs file. properties: attributes: - $ref: '#/components/schemas/CustomCostsFileMetadata' + $ref: "#/components/schemas/CustomCostsFileMetadata" id: description: ID of the Custom Costs metadata. type: string @@ -17305,49 +16656,48 @@ components: properties: billed_cost: description: Total cost in the cost file. - example: 100.5 + example: 100.50 format: double type: number billing_currency: description: Currency used in the Custom Costs file. - example: USD + example: "USD" type: string charge_period: - $ref: '#/components/schemas/CustomCostsFileUsageChargePeriod' + $ref: "#/components/schemas/CustomCostsFileUsageChargePeriod" content: description: Detail of the line items from the Custom Costs file. items: - $ref: '#/components/schemas/CustomCostsFileLineItem' + $ref: "#/components/schemas/CustomCostsFileLineItem" type: array name: description: Name of the Custom Costs file. - example: my_file.json + example: "my_file.json" type: string provider_names: description: Providers contained in the Custom Costs file. items: description: Name of a provider. - example: my_provider + example: "my_provider" type: string type: array status: description: Status of the Custom Costs file. - example: active + example: "active" type: string uploaded_at: - description: Timestamp in millisecond of the upload time of the Custom Costs - file. + description: Timestamp in millisecond of the upload time of the Custom Costs file. example: 1704067200000 format: double type: number uploaded_by: - $ref: '#/components/schemas/CustomCostsUser' + $ref: "#/components/schemas/CustomCostsUser" type: object CustomCostsFileMetadataWithContentHighLevel: description: JSON API format of for a Custom Costs file with content. properties: attributes: - $ref: '#/components/schemas/CustomCostsFileMetadataWithContent' + $ref: "#/components/schemas/CustomCostsFileMetadataWithContent" id: description: ID of the Custom Costs metadata. type: string @@ -17358,15 +16708,15 @@ components: CustomCostsFileUploadRequest: description: Request for uploading a Custom Costs file. items: - $ref: '#/components/schemas/CustomCostsFileLineItem' + $ref: "#/components/schemas/CustomCostsFileLineItem" type: array CustomCostsFileUploadResponse: description: Response for Uploaded Custom Costs files. properties: data: - $ref: '#/components/schemas/CustomCostsFileMetadataHighLevel' + $ref: "#/components/schemas/CustomCostsFileMetadataHighLevel" meta: - $ref: '#/components/schemas/CustomCostUploadResponseMeta' + $ref: "#/components/schemas/CustomCostUploadResponseMeta" type: object CustomCostsFileUsageChargePeriod: description: Usage charge period of a Custom Costs file. @@ -17387,71 +16737,60 @@ components: properties: email: description: The name of the Custom Costs file. - example: email.test@datadohq.com + example: "email.test@datadohq.com" type: string icon: description: The name of the Custom Costs file. - example: icon.png + example: "icon.png" type: string name: description: Name of the user. - example: Test User + example: "Test User" type: string type: object CustomDestinationAttributeTagsRestrictionListType: default: ALLOW_LIST - description: 'How `forward_tags_restriction_list` parameter should be interpreted. - - If `ALLOW_LIST`, then only tags whose keys on the forwarded logs match the - ones on the restriction list - + description: |- + How `forward_tags_restriction_list` parameter should be interpreted. + If `ALLOW_LIST`, then only tags whose keys on the forwarded logs match the ones on the restriction list are forwarded. - - `BLOCK_LIST` works the opposite way. It does not forward the tags matching - the ones on the list.' + `BLOCK_LIST` works the opposite way. It does not forward the tags matching the ones on the list. enum: - - ALLOW_LIST - - BLOCK_LIST + - ALLOW_LIST + - BLOCK_LIST example: ALLOW_LIST type: string x-enum-varnames: - - ALLOW_LIST - - BLOCK_LIST + - ALLOW_LIST + - BLOCK_LIST CustomDestinationCreateRequest: description: The custom destination. properties: data: - $ref: '#/components/schemas/CustomDestinationCreateRequestDefinition' + $ref: "#/components/schemas/CustomDestinationCreateRequestDefinition" type: object CustomDestinationCreateRequestAttributes: description: The attributes associated with the custom destination. properties: enabled: default: true - description: Whether logs matching this custom destination should be forwarded - or not. + description: Whether logs matching this custom destination should be forwarded or not. example: true type: boolean forward_tags: default: true - description: Whether tags from the forwarded logs should be forwarded or - not. + description: Whether tags from the forwarded logs should be forwarded or not. example: true type: boolean forward_tags_restriction_list: default: [] - description: 'List of [keys of tags](https://docs.datadoghq.com/getting_started/tagging/#define-tags) - to be filtered. + description: |- + List of [keys of tags](https://docs.datadoghq.com/getting_started/tagging/#define-tags) to be filtered. - - An empty list represents no restriction is in place and either all or - no tags will be - - forwarded depending on `forward_tags_restriction_list_type` parameter.' - example: - - datacenter - - host + An empty list represents no restriction is in place and either all or no tags will be + forwarded depending on `forward_tags_restriction_list_type` parameter. + example: ["datacenter", "host"] items: description: The [key part of a tag](https://docs.datadoghq.com/getting_started/tagging/#define-tags). type: string @@ -17459,144 +16798,130 @@ components: minItems: 0 type: array forward_tags_restriction_list_type: - $ref: '#/components/schemas/CustomDestinationAttributeTagsRestrictionListType' + $ref: "#/components/schemas/CustomDestinationAttributeTagsRestrictionListType" forwarder_destination: - $ref: '#/components/schemas/CustomDestinationForwardDestination' + $ref: "#/components/schemas/CustomDestinationForwardDestination" name: description: The custom destination name. example: Nginx logs type: string query: - default: '' - description: The custom destination query and filter. Logs matching this - query are forwarded to the destination. + default: "" + description: The custom destination query and filter. Logs matching this query are forwarded to the destination. example: source:nginx type: string required: - - name - - forwarder_destination + - name + - forwarder_destination type: object CustomDestinationCreateRequestDefinition: description: The definition of a custom destination. properties: attributes: - $ref: '#/components/schemas/CustomDestinationCreateRequestAttributes' + $ref: "#/components/schemas/CustomDestinationCreateRequestAttributes" type: - $ref: '#/components/schemas/CustomDestinationType' + $ref: "#/components/schemas/CustomDestinationType" required: - - type - - attributes + - type + - attributes type: object CustomDestinationElasticsearchDestinationAuth: description: Basic access authentication. properties: password: - description: The password of the authentication. This field is not returned - by the API. + description: The password of the authentication. This field is not returned by the API. example: datadog-custom-destination-password type: string writeOnly: true username: - description: The username of the authentication. This field is not returned - by the API. + description: The username of the authentication. This field is not returned by the API. example: datadog-custom-destination-username type: string writeOnly: true required: - - username - - password + - username + - password type: object CustomDestinationForwardDestination: description: A custom destination's location to forward logs. oneOf: - - $ref: '#/components/schemas/CustomDestinationForwardDestinationHttp' - - $ref: '#/components/schemas/CustomDestinationForwardDestinationSplunk' - - $ref: '#/components/schemas/CustomDestinationForwardDestinationElasticsearch' - - $ref: '#/components/schemas/CustomDestinationForwardDestinationMicrosoftSentinel' + - $ref: "#/components/schemas/CustomDestinationForwardDestinationHttp" + - $ref: "#/components/schemas/CustomDestinationForwardDestinationSplunk" + - $ref: "#/components/schemas/CustomDestinationForwardDestinationElasticsearch" + - $ref: "#/components/schemas/CustomDestinationForwardDestinationMicrosoftSentinel" CustomDestinationForwardDestinationElasticsearch: description: The Elasticsearch destination. properties: auth: - $ref: '#/components/schemas/CustomDestinationElasticsearchDestinationAuth' + $ref: "#/components/schemas/CustomDestinationElasticsearchDestinationAuth" endpoint: - description: 'The destination for which logs will be forwarded to. - - Must have HTTPS scheme and forwarding back to Datadog is not allowed.' + description: |- + The destination for which logs will be forwarded to. + Must have HTTPS scheme and forwarding back to Datadog is not allowed. example: https://example.com type: string index_name: - description: Name of the Elasticsearch index (must follow [Elasticsearch's - criteria](https://www.elastic.co/guide/en/elasticsearch/reference/8.11/indices-create-index.html#indices-create-api-path-params)). + description: Name of the Elasticsearch index (must follow [Elasticsearch's criteria](https://www.elastic.co/guide/en/elasticsearch/reference/8.11/indices-create-index.html#indices-create-api-path-params)). example: nginx-logs type: string index_rotation: - description: 'Date pattern with US locale and UTC timezone to be appended - to the index name after adding `-` - + description: |- + Date pattern with US locale and UTC timezone to be appended to the index name after adding `-` (that is, `${index_name}-${indexPattern}`). - - You can customize the index rotation naming pattern by choosing one of - these options: - + You can customize the index rotation naming pattern by choosing one of these options: - Hourly: `yyyy-MM-dd-HH` (as an example, it would render: `2022-10-19-09`) - - Daily: `yyyy-MM-dd` (as an example, it would render: `2022-10-19`) - - - Weekly: `yyyy-''W''ww` (as an example, it would render: `2022-W42`) - + - Weekly: `yyyy-'W'ww` (as an example, it would render: `2022-W42`) - Monthly: `yyyy-MM` (as an example, it would render: `2022-10`) - - If this field is missing or is blank, it means that the index name will - always be the same - - (that is, no rotation).' + If this field is missing or is blank, it means that the index name will always be the same + (that is, no rotation). example: yyyy-MM-dd type: string type: - $ref: '#/components/schemas/CustomDestinationForwardDestinationElasticsearchType' + $ref: "#/components/schemas/CustomDestinationForwardDestinationElasticsearchType" required: - - type - - endpoint - - auth - - index_name + - type + - endpoint + - auth + - index_name type: object CustomDestinationForwardDestinationElasticsearchType: default: elasticsearch description: Type of the Elasticsearch destination. enum: - - elasticsearch + - elasticsearch example: elasticsearch type: string x-enum-varnames: - - ELASTICSEARCH + - ELASTICSEARCH CustomDestinationForwardDestinationHttp: description: The HTTP destination. properties: auth: - $ref: '#/components/schemas/CustomDestinationHttpDestinationAuth' + $ref: "#/components/schemas/CustomDestinationHttpDestinationAuth" endpoint: - description: 'The destination for which logs will be forwarded to. - - Must have HTTPS scheme and forwarding back to Datadog is not allowed.' + description: |- + The destination for which logs will be forwarded to. + Must have HTTPS scheme and forwarding back to Datadog is not allowed. example: https://example.com type: string type: - $ref: '#/components/schemas/CustomDestinationForwardDestinationHttpType' + $ref: "#/components/schemas/CustomDestinationForwardDestinationHttpType" required: - - type - - endpoint - - auth + - type + - endpoint + - auth type: object CustomDestinationForwardDestinationHttpType: default: http description: Type of the HTTP destination. enum: - - http + - http example: http type: string x-enum-varnames: - - HTTP + - HTTP CustomDestinationForwardDestinationMicrosoftSentinel: description: The Microsoft Sentinel destination. properties: @@ -17622,91 +16947,88 @@ components: example: f3c9a8a1-4c2e-4d2e-b911-9f3c28c3c8b2 type: string type: - $ref: '#/components/schemas/CustomDestinationForwardDestinationMicrosoftSentinelType' + $ref: "#/components/schemas/CustomDestinationForwardDestinationMicrosoftSentinelType" required: - - type - - tenant_id - - client_id - - data_collection_endpoint - - data_collection_rule_id - - stream_name + - type + - tenant_id + - client_id + - data_collection_endpoint + - data_collection_rule_id + - stream_name type: object CustomDestinationForwardDestinationMicrosoftSentinelType: default: microsoft_sentinel description: Type of the Microsoft Sentinel destination. enum: - - microsoft_sentinel + - microsoft_sentinel example: microsoft_sentinel type: string x-enum-varnames: - - MICROSOFT_SENTINEL + - MICROSOFT_SENTINEL CustomDestinationForwardDestinationSplunk: description: The Splunk HTTP Event Collector (HEC) destination. properties: access_token: - description: Access token of the Splunk HTTP Event Collector. This field - is not returned by the API. + description: Access token of the Splunk HTTP Event Collector. This field is not returned by the API. example: splunk_access_token type: string writeOnly: true endpoint: - description: 'The destination for which logs will be forwarded to. - - Must have HTTPS scheme and forwarding back to Datadog is not allowed.' + description: |- + The destination for which logs will be forwarded to. + Must have HTTPS scheme and forwarding back to Datadog is not allowed. example: https://example.com type: string type: - $ref: '#/components/schemas/CustomDestinationForwardDestinationSplunkType' + $ref: "#/components/schemas/CustomDestinationForwardDestinationSplunkType" required: - - type - - endpoint - - access_token + - type + - endpoint + - access_token type: object CustomDestinationForwardDestinationSplunkType: default: splunk_hec description: Type of the Splunk HTTP Event Collector (HEC) destination. enum: - - splunk_hec + - splunk_hec example: splunk_hec type: string x-enum-varnames: - - SPLUNK_HEC + - SPLUNK_HEC CustomDestinationHttpDestinationAuth: description: Authentication method of the HTTP requests. oneOf: - - $ref: '#/components/schemas/CustomDestinationHttpDestinationAuthBasic' - - $ref: '#/components/schemas/CustomDestinationHttpDestinationAuthCustomHeader' + - $ref: "#/components/schemas/CustomDestinationHttpDestinationAuthBasic" + - $ref: "#/components/schemas/CustomDestinationHttpDestinationAuthCustomHeader" CustomDestinationHttpDestinationAuthBasic: description: Basic access authentication. properties: password: - description: The password of the authentication. This field is not returned - by the API. + description: The password of the authentication. This field is not returned by the API. example: datadog-custom-destination-password type: string writeOnly: true type: - $ref: '#/components/schemas/CustomDestinationHttpDestinationAuthBasicType' + $ref: "#/components/schemas/CustomDestinationHttpDestinationAuthBasicType" username: - description: The username of the authentication. This field is not returned - by the API. + description: The username of the authentication. This field is not returned by the API. example: datadog-custom-destination-username type: string writeOnly: true required: - - type - - username - - password + - type + - username + - password type: object CustomDestinationHttpDestinationAuthBasicType: default: basic description: Type of the basic access authentication. enum: - - basic + - basic example: basic type: string x-enum-varnames: - - BASIC + - BASIC CustomDestinationHttpDestinationAuthCustomHeader: description: Custom header access authentication. properties: @@ -17715,61 +17037,53 @@ components: example: CUSTOM-HEADER-NAME type: string header_value: - description: The header value of the authentication. This field is not returned - by the API. + description: The header value of the authentication. This field is not returned by the API. example: CUSTOM-HEADER-AUTHENTICATION-VALUE type: string writeOnly: true type: - $ref: '#/components/schemas/CustomDestinationHttpDestinationAuthCustomHeaderType' + $ref: "#/components/schemas/CustomDestinationHttpDestinationAuthCustomHeaderType" required: - - type - - header_name - - header_value + - type + - header_name + - header_value type: object CustomDestinationHttpDestinationAuthCustomHeaderType: default: custom_header description: Type of the custom header access authentication. enum: - - custom_header + - custom_header example: custom_header type: string x-enum-varnames: - - CUSTOM_HEADER + - CUSTOM_HEADER CustomDestinationResponse: description: The custom destination. properties: data: - $ref: '#/components/schemas/CustomDestinationResponseDefinition' + $ref: "#/components/schemas/CustomDestinationResponseDefinition" type: object CustomDestinationResponseAttributes: description: The attributes associated with the custom destination. properties: enabled: default: true - description: Whether logs matching this custom destination should be forwarded - or not. + description: Whether logs matching this custom destination should be forwarded or not. example: true type: boolean forward_tags: default: true - description: Whether tags from the forwarded logs should be forwarded or - not. + description: Whether tags from the forwarded logs should be forwarded or not. example: true type: boolean forward_tags_restriction_list: default: [] - description: 'List of [keys of tags](https://docs.datadoghq.com/getting_started/tagging/#define-tags) - to be filtered. - - - An empty list represents no restriction is in place and either all or - no tags will be + description: |- + List of [keys of tags](https://docs.datadoghq.com/getting_started/tagging/#define-tags) to be filtered. - forwarded depending on `forward_tags_restriction_list_type` parameter.' - example: - - datacenter - - host + An empty list represents no restriction is in place and either all or no tags will be + forwarded depending on `forward_tags_restriction_list_type` parameter. + example: ["datacenter", "host"] items: description: The [key part of a tag](https://docs.datadoghq.com/getting_started/tagging/#define-tags). type: string @@ -17777,17 +17091,16 @@ components: minItems: 0 type: array forward_tags_restriction_list_type: - $ref: '#/components/schemas/CustomDestinationAttributeTagsRestrictionListType' + $ref: "#/components/schemas/CustomDestinationAttributeTagsRestrictionListType" forwarder_destination: - $ref: '#/components/schemas/CustomDestinationResponseForwardDestination' + $ref: "#/components/schemas/CustomDestinationResponseForwardDestination" name: description: The custom destination name. example: Nginx logs type: string query: - default: '' - description: The custom destination query filter. Logs matching this query - are forwarded to the destination. + default: "" + description: The custom destination query filter. Logs matching this query are forwarded to the destination. example: source:nginx type: string type: object @@ -17795,14 +17108,14 @@ components: description: The definition of a custom destination. properties: attributes: - $ref: '#/components/schemas/CustomDestinationResponseAttributes' + $ref: "#/components/schemas/CustomDestinationResponseAttributes" id: description: The custom destination ID. example: be5d7a69-d0c8-4d4d-8ee8-bba292d98139 readOnly: true type: string type: - $ref: '#/components/schemas/CustomDestinationType' + $ref: "#/components/schemas/CustomDestinationType" type: object CustomDestinationResponseElasticsearchDestinationAuth: additionalProperties: @@ -17812,94 +17125,83 @@ components: CustomDestinationResponseForwardDestination: description: A custom destination's location to forward logs. oneOf: - - $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationHttp' - - $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationSplunk' - - $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearch' - - $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationMicrosoftSentinel' + - $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationHttp" + - $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationSplunk" + - $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearch" + - $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationMicrosoftSentinel" CustomDestinationResponseForwardDestinationElasticsearch: description: The Elasticsearch destination. properties: auth: - $ref: '#/components/schemas/CustomDestinationResponseElasticsearchDestinationAuth' + $ref: "#/components/schemas/CustomDestinationResponseElasticsearchDestinationAuth" endpoint: - description: 'The destination for which logs will be forwarded to. - - Must have HTTPS scheme and forwarding back to Datadog is not allowed.' + description: |- + The destination for which logs will be forwarded to. + Must have HTTPS scheme and forwarding back to Datadog is not allowed. example: https://example.com type: string index_name: - description: Name of the Elasticsearch index (must follow [Elasticsearch's - criteria](https://www.elastic.co/guide/en/elasticsearch/reference/8.11/indices-create-index.html#indices-create-api-path-params)). + description: Name of the Elasticsearch index (must follow [Elasticsearch's criteria](https://www.elastic.co/guide/en/elasticsearch/reference/8.11/indices-create-index.html#indices-create-api-path-params)). example: nginx-logs type: string index_rotation: - description: 'Date pattern with US locale and UTC timezone to be appended - to the index name after adding `-` - + description: |- + Date pattern with US locale and UTC timezone to be appended to the index name after adding `-` (that is, `${index_name}-${indexPattern}`). - - You can customize the index rotation naming pattern by choosing one of - these options: - + You can customize the index rotation naming pattern by choosing one of these options: - Hourly: `yyyy-MM-dd-HH` (as an example, it would render: `2022-10-19-09`) - - Daily: `yyyy-MM-dd` (as an example, it would render: `2022-10-19`) - - - Weekly: `yyyy-''W''ww` (as an example, it would render: `2022-W42`) - + - Weekly: `yyyy-'W'ww` (as an example, it would render: `2022-W42`) - Monthly: `yyyy-MM` (as an example, it would render: `2022-10`) - - If this field is missing or is blank, it means that the index name will - always be the same - - (that is, no rotation).' + If this field is missing or is blank, it means that the index name will always be the same + (that is, no rotation). example: yyyy-MM-dd type: string type: - $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearchType' + $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearchType" required: - - type - - endpoint - - auth - - index_name + - type + - endpoint + - auth + - index_name type: object CustomDestinationResponseForwardDestinationElasticsearchType: default: elasticsearch description: Type of the Elasticsearch destination. enum: - - elasticsearch + - elasticsearch example: elasticsearch type: string x-enum-varnames: - - ELASTICSEARCH + - ELASTICSEARCH CustomDestinationResponseForwardDestinationHttp: description: The HTTP destination. properties: auth: - $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuth' + $ref: "#/components/schemas/CustomDestinationResponseHttpDestinationAuth" endpoint: - description: 'The destination for which logs will be forwarded to. - - Must have HTTPS scheme and forwarding back to Datadog is not allowed.' + description: |- + The destination for which logs will be forwarded to. + Must have HTTPS scheme and forwarding back to Datadog is not allowed. example: https://example.com type: string type: - $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationHttpType' + $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationHttpType" required: - - type - - endpoint - - auth + - type + - endpoint + - auth type: object CustomDestinationResponseForwardDestinationHttpType: default: http description: Type of the HTTP destination. enum: - - http + - http example: http type: string x-enum-varnames: - - HTTP + - HTTP CustomDestinationResponseForwardDestinationMicrosoftSentinel: description: The Microsoft Sentinel destination. properties: @@ -17925,70 +17227,70 @@ components: example: f3c9a8a1-4c2e-4d2e-b911-9f3c28c3c8b2 type: string type: - $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationMicrosoftSentinelType' + $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationMicrosoftSentinelType" required: - - type - - tenant_id - - client_id - - data_collection_endpoint - - data_collection_rule_id - - stream_name + - type + - tenant_id + - client_id + - data_collection_endpoint + - data_collection_rule_id + - stream_name type: object CustomDestinationResponseForwardDestinationMicrosoftSentinelType: default: microsoft_sentinel description: Type of the Microsoft Sentinel destination. enum: - - microsoft_sentinel + - microsoft_sentinel example: microsoft_sentinel type: string x-enum-varnames: - - MICROSOFT_SENTINEL + - MICROSOFT_SENTINEL CustomDestinationResponseForwardDestinationSplunk: description: The Splunk HTTP Event Collector (HEC) destination. properties: endpoint: - description: 'The destination for which logs will be forwarded to. - - Must have HTTPS scheme and forwarding back to Datadog is not allowed.' + description: |- + The destination for which logs will be forwarded to. + Must have HTTPS scheme and forwarding back to Datadog is not allowed. example: https://example.com type: string type: - $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationSplunkType' + $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationSplunkType" required: - - type - - endpoint + - type + - endpoint type: object CustomDestinationResponseForwardDestinationSplunkType: default: splunk_hec description: Type of the Splunk HTTP Event Collector (HEC) destination. enum: - - splunk_hec + - splunk_hec example: splunk_hec type: string x-enum-varnames: - - SPLUNK_HEC + - SPLUNK_HEC CustomDestinationResponseHttpDestinationAuth: description: Authentication method of the HTTP requests. oneOf: - - $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasic' - - $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeader' + - $ref: "#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasic" + - $ref: "#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeader" CustomDestinationResponseHttpDestinationAuthBasic: description: Basic access authentication. properties: type: - $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasicType' + $ref: "#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasicType" required: - - type + - type type: object CustomDestinationResponseHttpDestinationAuthBasicType: default: basic description: Type of the basic access authentication. enum: - - basic + - basic example: basic type: string x-enum-varnames: - - BASIC + - BASIC CustomDestinationResponseHttpDestinationAuthCustomHeader: description: Custom header access authentication. properties: @@ -17997,61 +17299,54 @@ components: example: CUSTOM-HEADER-NAME type: string type: - $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeaderType' + $ref: "#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeaderType" required: - - type - - header_name + - type + - header_name type: object CustomDestinationResponseHttpDestinationAuthCustomHeaderType: default: custom_header description: Type of the custom header access authentication. enum: - - custom_header + - custom_header example: custom_header type: string x-enum-varnames: - - CUSTOM_HEADER + - CUSTOM_HEADER CustomDestinationType: default: custom_destination description: The type of the resource. The value should always be `custom_destination`. enum: - - custom_destination + - custom_destination example: custom_destination type: string x-enum-varnames: - - CUSTOM_DESTINATION + - CUSTOM_DESTINATION CustomDestinationUpdateRequest: description: The custom destination. properties: data: - $ref: '#/components/schemas/CustomDestinationUpdateRequestDefinition' + $ref: "#/components/schemas/CustomDestinationUpdateRequestDefinition" type: object CustomDestinationUpdateRequestAttributes: description: The attributes associated with the custom destination. properties: enabled: default: true - description: Whether logs matching this custom destination should be forwarded - or not. + description: Whether logs matching this custom destination should be forwarded or not. example: true type: boolean forward_tags: default: true - description: Whether tags from the forwarded logs should be forwarded or - not. + description: Whether tags from the forwarded logs should be forwarded or not. example: true type: boolean forward_tags_restriction_list: default: [] - description: 'List of [keys of tags](https://docs.datadoghq.com/getting_started/tagging/#define-tags) - to be restricted from being forwarded. - - An empty list represents no restriction is in place and either all or - no tags will be forwarded depending on `forward_tags_restriction_list_type` - parameter.' - example: - - datacenter - - host + description: |- + List of [keys of tags](https://docs.datadoghq.com/getting_started/tagging/#define-tags) to be restricted from being forwarded. + An empty list represents no restriction is in place and either all or no tags will be forwarded depending on `forward_tags_restriction_list_type` parameter. + example: ["datacenter", "host"] items: description: The [key part of a tag](https://docs.datadoghq.com/getting_started/tagging/#define-tags). type: string @@ -18059,17 +17354,16 @@ components: minItems: 0 type: array forward_tags_restriction_list_type: - $ref: '#/components/schemas/CustomDestinationAttributeTagsRestrictionListType' + $ref: "#/components/schemas/CustomDestinationAttributeTagsRestrictionListType" forwarder_destination: - $ref: '#/components/schemas/CustomDestinationForwardDestination' + $ref: "#/components/schemas/CustomDestinationForwardDestination" name: description: The custom destination name. example: Nginx logs type: string query: - default: '' - description: The custom destination query and filter. Logs matching this - query are forwarded to the destination. + default: "" + description: The custom destination query and filter. Logs matching this query are forwarded to the destination. example: source:nginx type: string type: object @@ -18077,16 +17371,16 @@ components: description: The definition of a custom destination. properties: attributes: - $ref: '#/components/schemas/CustomDestinationUpdateRequestAttributes' + $ref: "#/components/schemas/CustomDestinationUpdateRequestAttributes" id: description: The custom destination ID. example: be5d7a69-d0c8-4d4d-8ee8-bba292d98139 type: string type: - $ref: '#/components/schemas/CustomDestinationType' + $ref: "#/components/schemas/CustomDestinationType" required: - - type - - id + - type + - id type: object CustomDestinationsResponse: description: The available custom destinations. @@ -18094,7 +17388,7 @@ components: data: description: A list of custom destinations. items: - $ref: '#/components/schemas/CustomDestinationResponseDefinition' + $ref: "#/components/schemas/CustomDestinationResponseDefinition" type: array type: object CustomFrameworkControl: @@ -18107,24 +17401,24 @@ components: rules_id: description: Rule IDs. example: - - '["def-000-abc"]' + - '["def-000-abc"]' items: type: string type: array required: - - name - - rules_id + - name + - rules_id type: object CustomFrameworkData: description: Contains type and attributes for custom frameworks. properties: attributes: - $ref: '#/components/schemas/CustomFrameworkDataAttributes' + $ref: "#/components/schemas/CustomFrameworkDataAttributes" type: - $ref: '#/components/schemas/CustomFrameworkType' + $ref: "#/components/schemas/CustomFrameworkType" required: - - type - - attributes + - type + - attributes type: object CustomFrameworkDataAttributes: description: Framework Data Attributes. @@ -18146,17 +17440,17 @@ components: requirements: description: Framework Requirements items: - $ref: '#/components/schemas/CustomFrameworkRequirement' + $ref: "#/components/schemas/CustomFrameworkRequirement" type: array version: description: Framework Version - example: '2' + example: "2" type: string required: - - handle - - version - - name - - requirements + - handle + - version + - name + - requirements type: object CustomFrameworkDataHandleAndVersion: description: Framework Handle and Version. @@ -18167,20 +17461,20 @@ components: type: string version: description: Framework Version - example: '2' + example: "2" type: string type: object CustomFrameworkMetadata: description: Metadata for custom frameworks. properties: attributes: - $ref: '#/components/schemas/CustomFrameworkWithoutRequirements' + $ref: "#/components/schemas/CustomFrameworkWithoutRequirements" id: description: The ID of the custom framework. example: handle-version type: string type: - $ref: '#/components/schemas/CustomFrameworkType' + $ref: "#/components/schemas/CustomFrameworkType" type: object CustomFrameworkRequirement: description: Framework Requirement. @@ -18188,25 +17482,25 @@ components: controls: description: Requirement Controls. items: - $ref: '#/components/schemas/CustomFrameworkControl' + $ref: "#/components/schemas/CustomFrameworkControl" type: array name: description: Requirement Name. example: criteria type: string required: - - name - - controls + - name + - controls type: object CustomFrameworkType: default: custom_framework description: The type of the resource. The value must be `custom_framework`. enum: - - custom_framework + - custom_framework example: custom_framework type: string x-enum-varnames: - - CUSTOM_FRAMEWORK + - CUSTOM_FRAMEWORK CustomFrameworkWithoutRequirements: description: Framework without requirements. properties: @@ -18228,18 +17522,18 @@ components: type: string version: description: Framework Version - example: '2' + example: "2" type: string required: - - handle - - version - - name + - handle + - version + - name type: object CustomRule: properties: created_at: description: Creation timestamp - example: '2026-01-09T13:00:57.473141Z' + example: "2026-01-09T13:00:57.473141Z" format: date-time type: string created_by: @@ -18247,7 +17541,7 @@ components: example: foobarbaz type: string last_revision: - $ref: '#/components/schemas/CustomRuleRevision' + $ref: "#/components/schemas/CustomRuleRevision" description: Most recent revision nullable: true name: @@ -18255,33 +17549,32 @@ components: example: my-rule type: string required: - - name - - created_at - - created_by - - last_revision + - name + - created_at + - created_by + - last_revision type: object CustomRuleDataType: description: Resource type - enum: - - custom_rule + enum: [custom_rule] example: custom_rule type: string x-enum-varnames: - - CUSTOM_RULE + - CUSTOM_RULE CustomRuleRequest: properties: data: - $ref: '#/components/schemas/CustomRuleRequestData' + $ref: "#/components/schemas/CustomRuleRequestData" type: object CustomRuleRequestData: properties: attributes: - $ref: '#/components/schemas/CustomRuleRequestDataAttributes' + $ref: "#/components/schemas/CustomRuleRequestDataAttributes" id: description: Rule identifier type: string type: - $ref: '#/components/schemas/CustomRuleDataType' + $ref: "#/components/schemas/CustomRuleDataType" type: object CustomRuleRequestDataAttributes: properties: @@ -18292,49 +17585,49 @@ components: CustomRuleResponse: properties: data: - $ref: '#/components/schemas/CustomRuleResponseData' + $ref: "#/components/schemas/CustomRuleResponseData" required: - - data + - data type: object CustomRuleResponseData: properties: attributes: - $ref: '#/components/schemas/CustomRule' + $ref: "#/components/schemas/CustomRule" id: description: Rule identifier example: my-rule type: string type: - $ref: '#/components/schemas/CustomRuleDataType' + $ref: "#/components/schemas/CustomRuleDataType" required: - - id - - type - - attributes + - id + - type + - attributes type: object CustomRuleRevision: properties: attributes: - $ref: '#/components/schemas/CustomRuleRevisionAttributes' + $ref: "#/components/schemas/CustomRuleRevisionAttributes" id: description: Revision identifier example: revision-123 type: string type: - $ref: '#/components/schemas/CustomRuleRevisionDataType' + $ref: "#/components/schemas/CustomRuleRevisionDataType" required: - - id - - type - - attributes + - id + - type + - attributes type: object CustomRuleRevisionAttributes: properties: arguments: description: Rule arguments items: - $ref: '#/components/schemas/Argument' + $ref: "#/components/schemas/Argument" type: array category: - $ref: '#/components/schemas/CustomRuleRevisionAttributesCategory' + $ref: "#/components/schemas/CustomRuleRevisionAttributesCategory" checksum: description: Code checksum example: 8a66c4e4e631099ad71be3c1ea3ea8fc2d57193e56db2c296e2dd8a508b26b99 @@ -18345,7 +17638,7 @@ components: type: string created_at: description: Creation timestamp - example: '2026-01-09T13:00:57.473141Z' + example: "2026-01-09T13:00:57.473141Z" format: date-time type: string created_by: @@ -18384,9 +17677,9 @@ components: example: false type: boolean language: - $ref: '#/components/schemas/Language' + $ref: "#/components/schemas/Language" severity: - $ref: '#/components/schemas/CustomRuleRevisionAttributesSeverity' + $ref: "#/components/schemas/CustomRuleRevisionAttributesSeverity" short_description: description: Short description example: c2hvcnQgZGVzY3JpcHRpb24= @@ -18398,87 +17691,78 @@ components: tags: description: Rule tags example: - - security - - custom + - security + - custom items: type: string type: array tests: description: Rule tests items: - $ref: '#/components/schemas/CustomRuleRevisionTest' + $ref: "#/components/schemas/CustomRuleRevisionTest" type: array tree_sitter_query: description: Tree-sitter query example: Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ== type: string required: - - creation_message - - short_description - - description - - code - - checksum - - language - - tree_sitter_query - - created_at - - created_by - - severity - - category - - cve - - cwe - - arguments - - tests - - tags - - is_published - - should_use_ai_fix - - documentation_url - - is_testing + - creation_message + - short_description + - description + - code + - checksum + - language + - tree_sitter_query + - created_at + - created_by + - severity + - category + - cve + - cwe + - arguments + - tests + - tags + - is_published + - should_use_ai_fix + - documentation_url + - is_testing type: object CustomRuleRevisionAttributesCategory: description: Rule category - enum: - - SECURITY - - BEST_PRACTICES - - CODE_STYLE - - ERROR_PRONE - - PERFORMANCE + enum: [SECURITY, BEST_PRACTICES, CODE_STYLE, ERROR_PRONE, PERFORMANCE] example: SECURITY type: string x-enum-varnames: - - SECURITY - - BEST_PRACTICES - - CODE_STYLE - - ERROR_PRONE - - PERFORMANCE + - SECURITY + - BEST_PRACTICES + - CODE_STYLE + - ERROR_PRONE + - PERFORMANCE CustomRuleRevisionAttributesSeverity: description: Rule severity - enum: - - ERROR - - WARNING - - NOTICE + enum: [ERROR, WARNING, NOTICE] example: ERROR type: string x-enum-varnames: - - ERROR - - WARNING - - NOTICE + - ERROR + - WARNING + - NOTICE CustomRuleRevisionDataType: description: Resource type - enum: - - custom_rule_revision + enum: [custom_rule_revision] example: custom_rule_revision type: string x-enum-varnames: - - CUSTOM_RULE_REVISION + - CUSTOM_RULE_REVISION CustomRuleRevisionInputAttributes: properties: arguments: description: Rule arguments items: - $ref: '#/components/schemas/Argument' + $ref: "#/components/schemas/Argument" type: array category: - $ref: '#/components/schemas/CustomRuleRevisionAttributesCategory' + $ref: "#/components/schemas/CustomRuleRevisionAttributesCategory" code: description: Rule code example: Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ== @@ -18515,9 +17799,9 @@ components: example: false type: boolean language: - $ref: '#/components/schemas/Language' + $ref: "#/components/schemas/Language" severity: - $ref: '#/components/schemas/CustomRuleRevisionAttributesSeverity' + $ref: "#/components/schemas/CustomRuleRevisionAttributesSeverity" short_description: description: Short description example: c2hvcnQgZGVzY3JpcHRpb24= @@ -18529,60 +17813,60 @@ components: tags: description: Rule tags example: - - security - - custom + - security + - custom items: type: string type: array tests: description: Rule tests items: - $ref: '#/components/schemas/CustomRuleRevisionTest' + $ref: "#/components/schemas/CustomRuleRevisionTest" type: array tree_sitter_query: description: Tree-sitter query example: Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ== type: string required: - - creation_message - - short_description - - description - - code - - language - - tree_sitter_query - - severity - - category - - cve - - cwe - - arguments - - tests - - tags - - is_published - - should_use_ai_fix - - documentation_url - - is_testing + - creation_message + - short_description + - description + - code + - language + - tree_sitter_query + - severity + - category + - cve + - cwe + - arguments + - tests + - tags + - is_published + - should_use_ai_fix + - documentation_url + - is_testing type: object CustomRuleRevisionRequest: properties: data: - $ref: '#/components/schemas/CustomRuleRevisionRequestData' + $ref: "#/components/schemas/CustomRuleRevisionRequestData" type: object CustomRuleRevisionRequestData: properties: attributes: - $ref: '#/components/schemas/CustomRuleRevisionInputAttributes' + $ref: "#/components/schemas/CustomRuleRevisionInputAttributes" id: description: Revision identifier type: string type: - $ref: '#/components/schemas/CustomRuleRevisionDataType' + $ref: "#/components/schemas/CustomRuleRevisionDataType" type: object CustomRuleRevisionResponse: properties: data: - $ref: '#/components/schemas/CustomRuleRevision' + $ref: "#/components/schemas/CustomRuleRevision" required: - - data + - data type: object CustomRuleRevisionTest: properties: @@ -18600,37 +17884,37 @@ components: example: test.yaml type: string required: - - filename - - code - - annotation_count + - filename + - code + - annotation_count type: object CustomRuleRevisionsResponse: properties: data: items: - $ref: '#/components/schemas/CustomRuleRevision' + $ref: "#/components/schemas/CustomRuleRevision" type: array type: object CustomRuleset: properties: attributes: - $ref: '#/components/schemas/CustomRulesetAttributes' + $ref: "#/components/schemas/CustomRulesetAttributes" id: description: Ruleset identifier example: my-ruleset type: string type: - $ref: '#/components/schemas/CustomRulesetDataType' + $ref: "#/components/schemas/CustomRulesetDataType" required: - - id - - type - - attributes + - id + - type + - attributes type: object CustomRulesetAttributes: properties: created_at: description: Creation timestamp - example: '2026-01-09T13:00:57.473141Z' + example: "2026-01-09T13:00:57.473141Z" format: date-time type: string created_by: @@ -18648,7 +17932,7 @@ components: rules: description: Rules in the ruleset items: - $ref: '#/components/schemas/CustomRule' + $ref: "#/components/schemas/CustomRule" nullable: true type: array short_description: @@ -18656,35 +17940,34 @@ components: example: c2hvcnQgZGVzY3JpcHRpb24= type: string required: - - name - - short_description - - description - - created_at - - created_by - - rules + - name + - short_description + - description + - created_at + - created_by + - rules type: object CustomRulesetDataType: description: Resource type - enum: - - custom_ruleset + enum: [custom_ruleset] example: custom_ruleset type: string x-enum-varnames: - - CUSTOM_RULESET + - CUSTOM_RULESET CustomRulesetRequest: properties: data: - $ref: '#/components/schemas/CustomRulesetRequestData' + $ref: "#/components/schemas/CustomRulesetRequestData" type: object CustomRulesetRequestData: properties: attributes: - $ref: '#/components/schemas/CustomRulesetRequestDataAttributes' + $ref: "#/components/schemas/CustomRulesetRequestDataAttributes" id: description: Ruleset identifier type: string type: - $ref: '#/components/schemas/CustomRulesetDataType' + $ref: "#/components/schemas/CustomRulesetDataType" type: object CustomRulesetRequestDataAttributes: properties: @@ -18697,7 +17980,7 @@ components: rules: description: Rules in the ruleset items: - $ref: '#/components/schemas/CustomRule' + $ref: "#/components/schemas/CustomRule" nullable: true type: array short_description: @@ -18707,16 +17990,15 @@ components: CustomRulesetResponse: properties: data: - $ref: '#/components/schemas/CustomRuleset' + $ref: "#/components/schemas/CustomRuleset" required: - - data + - data type: object DORACustomTags: - description: A list of user-defined tags. The tags must follow the `key:value` - pattern. Up to 100 may be added per event. + description: A list of user-defined tags. The tags must follow the `key:value` pattern. Up to 100 may be added per event. example: - - language:java - - department:engineering + - language:java + - department:engineering items: description: Tags in the form of `key:value`. type: string @@ -18726,41 +18008,41 @@ components: description: Response for fetching a single deployment event. properties: data: - $ref: '#/components/schemas/DORADeploymentObject' + $ref: "#/components/schemas/DORADeploymentObject" type: object DORADeploymentObject: description: A DORA deployment event. example: attributes: custom_tags: - - language:java - - department:engineering - - region:us-east-1 - env: production + - "language:java" + - "department:engineering" + - "region:us-east-1" + env: "production" finished_at: 1693491984000000000 git: - commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588 - repository_id: github.com/organization/example-repository - service: shopist + commit_sha: "66adc9350f2cc9b250b69abddab733dd55e1a588" + repository_id: "github.com/organization/example-repository" + service: "shopist" started_at: 1693491974000000000 - team: backend - version: v1.12.07 - id: 4242fcdd31586083 - type: dora_deployment + team: "backend" + version: "v1.12.07" + id: "4242fcdd31586083" + type: "dora_deployment" properties: attributes: - $ref: '#/components/schemas/DORADeploymentObjectAttributes' + $ref: "#/components/schemas/DORADeploymentObjectAttributes" id: description: The ID of the deployment event. type: string type: - $ref: '#/components/schemas/DORADeploymentType' + $ref: "#/components/schemas/DORADeploymentType" type: object DORADeploymentObjectAttributes: description: The attributes of the deployment event. properties: custom_tags: - $ref: '#/components/schemas/DORACustomTags' + $ref: "#/components/schemas/DORACustomTags" env: description: Environment name to where the service was deployed. example: production @@ -18771,7 +18053,7 @@ components: format: int64 type: integer git: - $ref: '#/components/schemas/DORAGitInfoResponse' + $ref: "#/components/schemas/DORAGitInfoResponse" service: description: Service name. example: shopist @@ -18790,33 +18072,30 @@ components: example: v1.12.07 type: string required: - - service - - started_at - - finished_at + - service + - started_at + - finished_at type: object DORADeploymentPatchRemediation: - description: Remediation details for the deployment. Optional, but required - to calculate failed deployment recovery time. + description: Remediation details for the deployment. Optional, but required to calculate failed deployment recovery time. properties: id: - description: The ID of the remediation deployment. Required when the failed - deployment must be linked to a remediation deployment. + description: The ID of the remediation deployment. Required when the failed deployment must be linked to a remediation deployment. example: eG42zNIkVjM type: string type: - $ref: '#/components/schemas/DORADeploymentPatchRemediationType' + $ref: "#/components/schemas/DORADeploymentPatchRemediationType" type: object DORADeploymentPatchRemediationType: - description: The type of remediation action taken. Required when the failed - deployment must be linked to a remediation deployment. + description: The type of remediation action taken. Required when the failed deployment must be linked to a remediation deployment. enum: - - rollback - - rollforward + - rollback + - rollforward example: rollback type: string x-enum-varnames: - - ROLLBACK - - ROLLFORWARD + - ROLLBACK + - ROLLFORWARD DORADeploymentPatchRequest: description: Request to patch a DORA deployment event. example: @@ -18824,15 +18103,15 @@ components: attributes: change_failure: true remediation: - id: eG42zNIkVjM - type: rollback - id: z_RwVLi7v4Y - type: dora_deployment_patch_request + id: "eG42zNIkVjM" + type: "rollback" + id: "z_RwVLi7v4Y" + type: "dora_deployment_patch_request" properties: data: - $ref: '#/components/schemas/DORADeploymentPatchRequestData' + $ref: "#/components/schemas/DORADeploymentPatchRequestData" required: - - data + - data type: object DORADeploymentPatchRequestAttributes: description: Attributes for patching a DORA deployment event. @@ -18842,7 +18121,7 @@ components: example: true type: boolean remediation: - $ref: '#/components/schemas/DORADeploymentPatchRemediation' + $ref: "#/components/schemas/DORADeploymentPatchRemediation" type: object DORADeploymentPatchRequestData: description: The JSON:API data for patching a deployment. @@ -18850,103 +18129,97 @@ components: attributes: change_failure: true remediation: - id: eG42zNIkVjM - type: rollback - id: z_RwVLi7v4Y - type: dora_deployment_patch_request + id: "eG42zNIkVjM" + type: "rollback" + id: "z_RwVLi7v4Y" + type: "dora_deployment_patch_request" properties: attributes: - $ref: '#/components/schemas/DORADeploymentPatchRequestAttributes' + $ref: "#/components/schemas/DORADeploymentPatchRequestAttributes" id: description: The ID of the deployment to patch. example: z_RwVLi7v4Y type: string type: - $ref: '#/components/schemas/DORADeploymentPatchRequestDataType' + $ref: "#/components/schemas/DORADeploymentPatchRequestDataType" required: - - type - - id - - attributes + - type + - id + - attributes type: object DORADeploymentPatchRequestDataType: default: dora_deployment_patch_request description: JSON:API type for DORA deployment patch request. enum: - - dora_deployment_patch_request + - dora_deployment_patch_request example: dora_deployment_patch_request type: string x-enum-varnames: - - DORA_DEPLOYMENT_PATCH_REQUEST + - DORA_DEPLOYMENT_PATCH_REQUEST DORADeploymentRequest: description: Request to create a DORA deployment event. properties: data: - $ref: '#/components/schemas/DORADeploymentRequestData' + $ref: "#/components/schemas/DORADeploymentRequestData" required: - - data + - data type: object DORADeploymentRequestAttributes: description: Attributes to create a DORA deployment event. properties: custom_tags: - $ref: '#/components/schemas/DORACustomTags' + $ref: "#/components/schemas/DORACustomTags" env: description: Environment name to where the service was deployed. example: staging type: string finished_at: - description: Unix timestamp when the deployment finished. It must be in - nanoseconds, milliseconds, or seconds. + description: Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds. example: 1693491984000000000 format: int64 type: integer git: - $ref: '#/components/schemas/DORAGitInfo' + $ref: "#/components/schemas/DORAGitInfo" id: - description: Deployment ID. Must be 16-128 characters and contain only alphanumeric - characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9, - -, _, ., :). + description: Deployment ID. Must be 16-128 characters and contain only alphanumeric characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9, -, _, ., :). type: string service: description: Service name. example: shopist type: string started_at: - description: Unix timestamp when the deployment started. It must be in nanoseconds, - milliseconds, or seconds. + description: Unix timestamp when the deployment started. It must be in nanoseconds, milliseconds, or seconds. example: 1693491974000000000 format: int64 type: integer team: - description: Name of the team owning the deployed service. If not provided, - this is automatically populated with the team associated with the service - in the Service Catalog. + description: Name of the team owning the deployed service. If not provided, this is automatically populated with the team associated with the service in the Service Catalog. example: backend type: string version: - description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/). + description: "Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/)." example: v1.12.07 type: string required: - - service - - started_at - - finished_at + - service + - started_at + - finished_at type: object DORADeploymentRequestData: description: The JSON:API data. properties: attributes: - $ref: '#/components/schemas/DORADeploymentRequestAttributes' + $ref: "#/components/schemas/DORADeploymentRequestAttributes" required: - - attributes + - attributes type: object DORADeploymentResponse: description: Response after receiving a DORA deployment event. properties: data: - $ref: '#/components/schemas/DORADeploymentResponseData' + $ref: "#/components/schemas/DORADeploymentResponseData" required: - - data + - data type: object DORADeploymentResponseData: description: The JSON:API data. @@ -18956,107 +18229,101 @@ components: example: 4242fcdd31586083 type: string type: - $ref: '#/components/schemas/DORADeploymentType' + $ref: "#/components/schemas/DORADeploymentType" required: - - id + - id type: object DORADeploymentType: default: dora_deployment description: JSON:API type for DORA deployment events. enum: - - dora_deployment + - dora_deployment example: dora_deployment type: string x-enum-varnames: - - DORA_DEPLOYMENT + - DORA_DEPLOYMENT DORADeploymentsListResponse: description: Response for the list deployments endpoint. example: data: - - attributes: - custom_tags: - - language:java - - department:engineering - - region:us-east-1 - env: production - finished_at: 1693491984000000000 - git: - commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588 - repository_id: github.com/organization/example-repository - service: shopist - started_at: 1693491974000000000 - team: backend - version: v1.12.07 - id: 4242fcdd31586083 - type: dora_deployment - - attributes: - custom_tags: - - language:go - - department:platform - env: production - finished_at: 1693492084000000000 - git: - commit_sha: 77bdc9350f2cc9b250b69abddab733dd55e1a599 - repository_id: github.com/organization/api-service - service: api-service - started_at: 1693492074000000000 - team: backend - version: v2.1.0 - id: 4242fcdd31586084 - type: dora_deployment + - attributes: + custom_tags: + - "language:java" + - "department:engineering" + - "region:us-east-1" + env: "production" + finished_at: 1693491984000000000 + git: + commit_sha: "66adc9350f2cc9b250b69abddab733dd55e1a588" + repository_id: "github.com/organization/example-repository" + service: "shopist" + started_at: 1693491974000000000 + team: "backend" + version: "v1.12.07" + id: "4242fcdd31586083" + type: "dora_deployment" + - attributes: + custom_tags: + - "language:go" + - "department:platform" + env: "production" + finished_at: 1693492084000000000 + git: + commit_sha: "77bdc9350f2cc9b250b69abddab733dd55e1a599" + repository_id: "github.com/organization/api-service" + service: "api-service" + started_at: 1693492074000000000 + team: "backend" + version: "v2.1.0" + id: "4242fcdd31586084" + type: "dora_deployment" properties: data: description: The list of DORA deployment events. items: - $ref: '#/components/schemas/DORADeploymentObject' + $ref: "#/components/schemas/DORADeploymentObject" type: array type: object DORAFailureFetchResponse: description: Response for fetching a single incident event. properties: data: - $ref: '#/components/schemas/DORAIncidentObject' + $ref: "#/components/schemas/DORAIncidentObject" type: object DORAFailureRequest: description: Request to create a DORA incident event. properties: data: - $ref: '#/components/schemas/DORAFailureRequestData' + $ref: "#/components/schemas/DORAFailureRequestData" required: - - data + - data type: object DORAFailureRequestAttributes: description: Attributes to create a DORA incident event. properties: custom_tags: - $ref: '#/components/schemas/DORACustomTags' + $ref: "#/components/schemas/DORACustomTags" env: description: Environment name that was impacted by the incident. example: staging type: string finished_at: - description: Unix timestamp when the incident finished. It must be in nanoseconds, - milliseconds, or seconds. + description: Unix timestamp when the incident finished. It must be in nanoseconds, milliseconds, or seconds. example: 1693491984000000000 format: int64 type: integer git: - $ref: '#/components/schemas/DORAGitInfo' + $ref: "#/components/schemas/DORAGitInfo" id: - description: Incident ID. Must be 16-128 characters and contain only alphanumeric - characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9, - -, _, ., :). + description: Incident ID. Must be 16-128 characters and contain only alphanumeric characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9, -, _, ., :). type: string name: description: Incident name. example: Webserver is down failing all requests. type: string services: - description: Service names impacted by the incident. If possible, use names - registered in the Service Catalog. Required when the team field is not - provided. - example: - - shopist + description: Service names impacted by the incident. If possible, use names registered in the Service Catalog. Required when the team field is not provided. + example: [shopist] items: type: string type: array @@ -19065,39 +18332,36 @@ components: example: High type: string started_at: - description: Unix timestamp when the incident started. It must be in nanoseconds, - milliseconds, or seconds. + description: Unix timestamp when the incident started. It must be in nanoseconds, milliseconds, or seconds. example: 1693491974000000000 format: int64 type: integer team: - description: Name of the team owning the services impacted. If possible, - use team handles registered in Datadog. Required when the services field - is not provided. + description: Name of the team owning the services impacted. If possible, use team handles registered in Datadog. Required when the services field is not provided. example: backend type: string version: - description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/). + description: "Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/)." example: v1.12.07 type: string required: - - started_at + - started_at type: object DORAFailureRequestData: description: The JSON:API data. properties: attributes: - $ref: '#/components/schemas/DORAFailureRequestAttributes' + $ref: "#/components/schemas/DORAFailureRequestAttributes" required: - - attributes + - attributes type: object DORAFailureResponse: description: Response after receiving a DORA incident event. properties: data: - $ref: '#/components/schemas/DORAFailureResponseData' + $ref: "#/components/schemas/DORAFailureResponseData" required: - - data + - data type: object DORAFailureResponseData: description: Response after receiving a DORA incident event. @@ -19107,115 +18371,115 @@ components: example: 4242fcdd31586083 type: string type: - $ref: '#/components/schemas/DORAFailureType' + $ref: "#/components/schemas/DORAFailureType" required: - - id + - id type: object DORAFailureType: default: dora_failure description: JSON:API type for DORA incident events. enum: - - dora_failure + - dora_failure example: dora_failure type: string x-enum-varnames: - - DORA_FAILURE + - DORA_FAILURE DORAFailuresListResponse: description: Response for the list incidents endpoint. example: data: - - attributes: - custom_tags: - - incident_type:database - - department:engineering - env: production - finished_at: 1693492274000000000 - name: Database outage - services: - - shopist - severity: SEV-1 - started_at: 1693492174000000000 - team: backend - id: 4242fcdd31586085 - type: dora_incident - - attributes: - custom_tags: - - incident_type:service_down - - department:platform - env: production - finished_at: 1693492474000000000 - name: API service outage - services: - - api-service - - payment-service - severity: SEV-2 - started_at: 1693492374000000000 - team: backend - id: 4242fcdd31586086 - type: dora_incident + - attributes: + custom_tags: + - "incident_type:database" + - "department:engineering" + env: "production" + finished_at: 1693492274000000000 + name: "Database outage" + services: + - "shopist" + severity: "SEV-1" + started_at: 1693492174000000000 + team: "backend" + id: "4242fcdd31586085" + type: "dora_incident" + - attributes: + custom_tags: + - "incident_type:service_down" + - "department:platform" + env: "production" + finished_at: 1693492474000000000 + name: "API service outage" + services: + - "api-service" + - "payment-service" + severity: "SEV-2" + started_at: 1693492374000000000 + team: "backend" + id: "4242fcdd31586086" + type: "dora_incident" properties: data: description: The list of DORA incident events. items: - $ref: '#/components/schemas/DORAIncidentObject' + $ref: "#/components/schemas/DORAIncidentObject" type: array type: object DORAGitInfo: - description: Git info for DORA Metrics events. + description: "Git info for DORA Metrics events." properties: commit_sha: - $ref: '#/components/schemas/GitCommitSHA' + $ref: "#/components/schemas/GitCommitSHA" repository_url: - $ref: '#/components/schemas/GitRepositoryURL' + $ref: "#/components/schemas/GitRepositoryURL" required: - - repository_url - - commit_sha + - repository_url + - commit_sha type: object DORAGitInfoResponse: - description: Git info returned by DORA Metrics events. + description: "Git info returned by DORA Metrics events." properties: commit_sha: - $ref: '#/components/schemas/GitCommitSHA' + $ref: "#/components/schemas/GitCommitSHA" repository_id: - $ref: '#/components/schemas/GitRepositoryID' + $ref: "#/components/schemas/GitRepositoryID" required: - - repository_id - - commit_sha + - repository_id + - commit_sha type: object DORAIncidentObject: description: A DORA incident event. example: attributes: custom_tags: - - incident_type:database - - department:engineering - env: production + - "incident_type:database" + - "department:engineering" + env: "production" finished_at: 1693492274000000000 git: - commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588 - repository_url: https://github.com/organization/example-repository - name: Database outage + commit_sha: "66adc9350f2cc9b250b69abddab733dd55e1a588" + repository_url: "https://github.com/organization/example-repository" + name: "Database outage" services: - - shopist - severity: SEV-1 + - "shopist" + severity: "SEV-1" started_at: 1693492174000000000 - team: backend - id: 4242fcdd31586085 - type: dora_incident + team: "backend" + id: "4242fcdd31586085" + type: "dora_incident" properties: attributes: - $ref: '#/components/schemas/DORAIncidentObjectAttributes' + $ref: "#/components/schemas/DORAIncidentObjectAttributes" id: description: The ID of the incident event. type: string type: - $ref: '#/components/schemas/DORAFailureType' + $ref: "#/components/schemas/DORAFailureType" type: object DORAIncidentObjectAttributes: description: The attributes of the incident event. properties: custom_tags: - $ref: '#/components/schemas/DORACustomTags' + $ref: "#/components/schemas/DORACustomTags" env: description: Environment name that was impacted by the incident. example: production @@ -19226,15 +18490,14 @@ components: format: int64 type: integer git: - $ref: '#/components/schemas/DORAGitInfo' + $ref: "#/components/schemas/DORAGitInfo" name: description: Incident name. example: Database outage type: string services: description: Service names impacted by the incident. - example: - - shopist + example: ["shopist"] items: type: string type: array @@ -19256,31 +18519,31 @@ components: example: v1.12.07 type: string required: - - started_at + - started_at type: object DORAListDeploymentsRequest: description: Request to get a list of deployments. example: data: attributes: - from: '2025-01-01T00:00:00Z' + from: "2025-01-01T00:00:00Z" limit: 100 - query: service:(shopist OR api-service) env:production team:backend - sort: -finished_at - to: '2025-01-31T23:59:59Z' - type: dora_deployments_list_request + query: "service:(shopist OR api-service) env:production team:backend" + sort: "-finished_at" + to: "2025-01-31T23:59:59Z" + type: "dora_deployments_list_request" properties: data: - $ref: '#/components/schemas/DORAListDeploymentsRequestData' + $ref: "#/components/schemas/DORAListDeploymentsRequestData" required: - - data + - data type: object DORAListDeploymentsRequestAttributes: description: Attributes to get a list of deployments. properties: from: description: Minimum timestamp for requested events. - example: '2025-01-01T00:00:00Z' + example: "2025-01-01T00:00:00Z" format: date-time type: string limit: @@ -19292,16 +18555,15 @@ components: type: integer query: description: Search query with event platform syntax. - example: service:(shopist OR api-service OR payment-service) env:(production - OR staging) team:(backend OR platform) + example: "service:(shopist OR api-service OR payment-service) env:(production OR staging) team:(backend OR platform)" type: string sort: description: Sort order (prefixed with `-` for descending). - example: -finished_at + example: "-finished_at" type: string to: description: Maximum timestamp for requested events. - example: '2025-01-31T23:59:59Z' + example: "2025-01-31T23:59:59Z" format: date-time type: string type: object @@ -19309,52 +18571,52 @@ components: description: The JSON:API data. example: attributes: - from: '2025-01-15T08:00:00Z' + from: "2025-01-15T08:00:00Z" limit: 200 - query: env:production service:payment-service version:*v2* - sort: -finished_at - to: '2025-01-15T18:00:00Z' - type: dora_deployments_list_request + query: "env:production service:payment-service version:*v2*" + sort: "-finished_at" + to: "2025-01-15T18:00:00Z" + type: "dora_deployments_list_request" properties: attributes: - $ref: '#/components/schemas/DORAListDeploymentsRequestAttributes' + $ref: "#/components/schemas/DORAListDeploymentsRequestAttributes" type: - $ref: '#/components/schemas/DORAListDeploymentsRequestDataType' + $ref: "#/components/schemas/DORAListDeploymentsRequestDataType" required: - - attributes + - attributes type: object DORAListDeploymentsRequestDataType: default: dora_deployments_list_request description: The definition of `DORAListDeploymentsRequestDataType` object. enum: - - dora_deployments_list_request + - dora_deployments_list_request example: dora_deployments_list_request type: string x-enum-varnames: - - DORA_DEPLOYMENTS_LIST_REQUEST + - DORA_DEPLOYMENTS_LIST_REQUEST DORAListFailuresRequest: description: Request to get a list of incidents. example: data: attributes: - from: '2025-01-01T00:00:00Z' + from: "2025-01-01T00:00:00Z" limit: 100 - query: severity:(SEV-1 OR SEV-2) env:production team:backend - sort: -started_at - to: '2025-01-31T23:59:59Z' - type: dora_failures_list_request + query: "severity:(SEV-1 OR SEV-2) env:production team:backend" + sort: "-started_at" + to: "2025-01-31T23:59:59Z" + type: "dora_failures_list_request" properties: data: - $ref: '#/components/schemas/DORAListFailuresRequestData' + $ref: "#/components/schemas/DORAListFailuresRequestData" required: - - data + - data type: object DORAListFailuresRequestAttributes: description: Attributes to get a list of incidents. properties: from: description: Minimum timestamp for requested events. - example: '2025-01-01T00:00:00Z' + example: "2025-01-01T00:00:00Z" format: date-time type: string limit: @@ -19366,16 +18628,15 @@ components: type: integer query: description: Search query with event platform syntax. - example: severity:(SEV-1 OR SEV-2) env:(production OR staging) service:(shopist - OR api-service OR payment-service) team:(backend OR platform OR payments) + example: "severity:(SEV-1 OR SEV-2) env:(production OR staging) service:(shopist OR api-service OR payment-service) team:(backend OR platform OR payments)" type: string sort: description: Sort order (prefixed with `-` for descending). - example: -started_at + example: "-started_at" type: string to: description: Maximum timestamp for requested events. - example: '2025-01-31T23:59:59Z' + example: "2025-01-31T23:59:59Z" format: date-time type: string type: object @@ -19383,36 +18644,36 @@ components: description: The JSON:API data. example: attributes: - from: '2025-01-15T00:00:00Z' + from: "2025-01-15T00:00:00Z" limit: 200 - query: severity:SEV-1 service:(api-service OR payment-service) env:production - sort: -finished_at - to: '2025-01-15T23:59:59Z' - type: dora_failures_list_request + query: "severity:SEV-1 service:(api-service OR payment-service) env:production" + sort: "-finished_at" + to: "2025-01-15T23:59:59Z" + type: "dora_failures_list_request" properties: attributes: - $ref: '#/components/schemas/DORAListFailuresRequestAttributes' + $ref: "#/components/schemas/DORAListFailuresRequestAttributes" type: - $ref: '#/components/schemas/DORAListFailuresRequestDataType' + $ref: "#/components/schemas/DORAListFailuresRequestDataType" required: - - attributes + - attributes type: object DORAListFailuresRequestDataType: default: dora_failures_list_request description: The definition of `DORAListFailuresRequestDataType` object. enum: - - dora_failures_list_request + - dora_failures_list_request example: dora_failures_list_request type: string x-enum-varnames: - - DORA_FAILURES_LIST_REQUEST + - DORA_FAILURES_LIST_REQUEST DashboardListAddItemsRequest: description: Request containing a list of dashboards to add. properties: dashboards: description: List of dashboards to add the dashboard list. items: - $ref: '#/components/schemas/DashboardListItemRequest' + $ref: "#/components/schemas/DashboardListItemRequest" type: array type: object DashboardListAddItemsResponse: @@ -19421,7 +18682,7 @@ components: added_dashboards_to_list: description: List of dashboards added to the dashboard list. items: - $ref: '#/components/schemas/DashboardListItemResponse' + $ref: "#/components/schemas/DashboardListItemResponse" type: array type: object DashboardListDeleteItemsRequest: @@ -19430,7 +18691,7 @@ components: dashboards: description: List of dashboards to delete from the dashboard list. items: - $ref: '#/components/schemas/DashboardListItemRequest' + $ref: "#/components/schemas/DashboardListItemRequest" type: array type: object DashboardListDeleteItemsResponse: @@ -19439,14 +18700,14 @@ components: deleted_dashboards_from_list: description: List of dashboards deleted from the dashboard list. items: - $ref: '#/components/schemas/DashboardListItemResponse' + $ref: "#/components/schemas/DashboardListItemResponse" type: array type: object DashboardListItem: description: A dashboard within a list. properties: author: - $ref: '#/components/schemas/Creator' + $ref: "#/components/schemas/Creator" created: description: Date of creation of the dashboard. format: date-time @@ -19459,7 +18720,7 @@ components: type: string id: description: ID of the dashboard. - example: q5j-nti-fv6 + example: "q5j-nti-fv6" type: string integration_id: description: The short name of the integration. @@ -19503,41 +18764,41 @@ components: readOnly: true type: string type: - $ref: '#/components/schemas/DashboardType' + $ref: "#/components/schemas/DashboardType" url: description: URL path to the dashboard. readOnly: true type: string required: - - type - - id + - type + - id type: object DashboardListItemRequest: description: A dashboard within a list. properties: id: description: ID of the dashboard. - example: q5j-nti-fv6 + example: "q5j-nti-fv6" type: string type: - $ref: '#/components/schemas/DashboardType' + $ref: "#/components/schemas/DashboardType" required: - - type - - id + - type + - id type: object DashboardListItemResponse: description: A dashboard within a list. properties: id: description: ID of the dashboard. - example: q5j-nti-fv6 + example: "q5j-nti-fv6" readOnly: true type: string type: - $ref: '#/components/schemas/DashboardType' + $ref: "#/components/schemas/DashboardType" required: - - type - - id + - type + - id type: object DashboardListItems: description: Dashboards within a list. @@ -19546,7 +18807,7 @@ components: description: List of dashboards in the dashboard list. example: [] items: - $ref: '#/components/schemas/DashboardListItem' + $ref: "#/components/schemas/DashboardListItem" type: array total: description: Number of dashboards in the dashboard list. @@ -19554,7 +18815,7 @@ components: readOnly: true type: integer required: - - dashboards + - dashboards type: object DashboardListUpdateItemsRequest: description: Request containing the list of dashboards to update to. @@ -19562,7 +18823,7 @@ components: dashboards: description: List of dashboards to update the dashboard list to. items: - $ref: '#/components/schemas/DashboardListItemRequest' + $ref: "#/components/schemas/DashboardListItemRequest" type: array type: object DashboardListUpdateItemsResponse: @@ -19571,100 +18832,100 @@ components: dashboards: description: List of dashboards in the dashboard list. items: - $ref: '#/components/schemas/DashboardListItemResponse' + $ref: "#/components/schemas/DashboardListItemResponse" type: array type: object DashboardTriggerWrapper: - description: Schema for a Dashboard-based trigger. + description: "Schema for a Dashboard-based trigger." properties: dashboardTrigger: - description: Trigger a workflow from a Dashboard. + description: "Trigger a workflow from a Dashboard." type: object startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - dashboardTrigger + - dashboardTrigger type: object DashboardType: description: The type of the dashboard. enum: - - custom_timeboard - - custom_screenboard - - integration_screenboard - - integration_timeboard - - host_timeboard + - custom_timeboard + - custom_screenboard + - integration_screenboard + - integration_timeboard + - host_timeboard example: host_timeboard type: string x-enum-varnames: - - CUSTOM_TIMEBOARD - - CUSTOM_SCREENBOARD - - INTEGRATION_SCREENBOARD - - INTEGRATION_TIMEBOARD - - HOST_TIMEBOARD + - CUSTOM_TIMEBOARD + - CUSTOM_SCREENBOARD + - INTEGRATION_SCREENBOARD + - INTEGRATION_TIMEBOARD + - HOST_TIMEBOARD DataAttributesRulesItemsIfTagExists: description: The behavior when the tag already exists. enum: - - append - - do_not_apply - - replace + - append + - do_not_apply + - replace type: string x-enum-varnames: - - APPEND - - DO_NOT_APPLY - - REPLACE + - APPEND + - DO_NOT_APPLY + - REPLACE DataAttributesRulesItemsMapping: description: The definition of `DataAttributesRulesItemsMapping` object. nullable: true properties: destination_key: description: The `mapping` `destination_key`. - example: '' + example: "" type: string if_not_exists: deprecated: true description: Deprecated. Use `if_tag_exists` instead. The `mapping` `if_not_exists`. type: boolean if_tag_exists: - $ref: '#/components/schemas/DataAttributesRulesItemsIfTagExists' + $ref: "#/components/schemas/DataAttributesRulesItemsIfTagExists" source_keys: description: The `mapping` `source_keys`. example: - - '' + - "" items: type: string type: array required: - - destination_key - - source_keys + - destination_key + - source_keys type: object DataDeletionResponseItem: description: The created data deletion request information. properties: attributes: - $ref: '#/components/schemas/DataDeletionResponseItemAttributes' + $ref: "#/components/schemas/DataDeletionResponseItemAttributes" id: description: The ID of the created data deletion request. - example: '1' + example: "1" type: string type: description: The type of the request created. - example: deletion_request + example: "deletion_request" type: string required: - - id - - type - - attributes + - id + - type + - attributes type: object DataDeletionResponseItemAttributes: description: Deletion attribute for data deletion response. properties: created_at: description: Creation time of the deletion request. - example: '2024-01-01T00:00:00.000000Z' + example: "2024-01-01T00:00:00.000000Z" type: string created_by: description: User who created the deletion request. - example: test.user@datadoghq.com + example: "test.user@datadoghq.com" type: string from_time: description: Start of requested time window, milliseconds since Unix epoch. @@ -19672,19 +18933,14 @@ components: format: int64 type: integer indexes: - description: List of indexes for the search. If not provided, the search - is performed in all indexes. - example: - - test-index - - test-index-2 + description: List of indexes for the search. If not provided, the search is performed in all indexes. + example: ["test-index", "test-index-2"] items: description: Individual index. type: string type: array is_created: - description: Whether the deletion request is fully created or not. It can - take several minutes to fully create a deletion request depending on the - target query and timeframe. + description: Whether the deletion request is fully created or not. It can take several minutes to fully create a deletion request depending on the target query and timeframe. example: true type: boolean org_id: @@ -19694,19 +18950,19 @@ components: type: integer product: description: Product name. - example: logs + example: "logs" type: string query: description: Query for creating a data deletion request. - example: service:xyz host:abc + example: "service:xyz host:abc" type: string starting_at: description: Starting time of the process to delete the requested data. - example: '2024-01-01T02:00:00.000000Z' + example: "2024-01-01T02:00:00.000000Z" type: string status: description: Status of the deletion request. - example: pending + example: "pending" type: string to_time: description: End of requested time window, milliseconds since Unix epoch. @@ -19714,29 +18970,27 @@ components: format: int64 type: integer total_unrestricted: - description: Total number of elements to be deleted. Only the data accessible - to the current user that matches the query and timeframe provided will - be deleted. + description: Total number of elements to be deleted. Only the data accessible to the current user that matches the query and timeframe provided will be deleted. example: 100 format: int64 type: integer updated_at: description: Update time of the deletion request. - example: '2024-01-01T00:00:00.000000Z' - type: string - required: - - created_at - - created_by - - from_time - - is_created - - org_id - - product - - query - - starting_at - - status - - to_time - - total_unrestricted - - updated_at + example: "2024-01-01T00:00:00.000000Z" + type: string + required: + - created_at + - created_by + - from_time + - is_created + - org_id + - product + - query + - starting_at + - status + - to_time + - total_unrestricted + - updated_at type: object DataDeletionResponseMeta: description: The metadata of the data deletion response. @@ -19746,31 +19000,26 @@ components: format: int64 type: integer description: The total deletion requests created by product. - example: - logs: 8 - rum: 7 + example: {"logs": 8, "rum": 7} type: object count_status: additionalProperties: format: int64 type: integer description: The total deletion requests created by status. - example: - completed: 10 - pending: 5 + example: {"completed": 10, "pending": 5} type: object next_page: - description: The next page when searching deletion requests created in the - current organization. - example: cGFnZTI= + description: The next page when searching deletion requests created in the current organization. + example: "cGFnZTI=" type: string product: description: The product of the deletion request. - example: logs + example: "logs" type: string request_status: description: The status of the executed request. - example: canceled + example: "canceled" type: string type: object DataExportConfig: @@ -19778,31 +19027,31 @@ components: properties: bucket_name: description: Name of the S3 bucket where the Cost and Usage Report is stored. - example: billing + example: "billing" type: string bucket_region: description: AWS region of the S3 bucket. - example: us-east-1 + example: "us-east-1" type: string report_name: description: Name of the Cost and Usage Report. - example: cost-and-usage-report + example: "cost-and-usage-report" type: string report_prefix: description: S3 prefix where the Cost and Usage Report is stored. - example: reports + example: "reports" type: string report_type: - description: Type of the Cost and Usage Report. Currently only `CUR2.0` - is supported. - example: CUR2.0 + description: |- + Type of the Cost and Usage Report. Currently only `CUR2.0` is supported. + example: "CUR2.0" type: string required: - - report_name - - report_prefix - - report_type - - bucket_name - - bucket_region + - report_name + - report_prefix + - report_type + - bucket_name + - bucket_region type: object DataRelationshipsTeams: description: Associates teams with this schedule in a data structure. @@ -19810,47 +19059,47 @@ components: data: description: An array of team references for this schedule. items: - $ref: '#/components/schemas/DataRelationshipsTeamsDataItems' + $ref: "#/components/schemas/DataRelationshipsTeamsDataItems" type: array type: object DataRelationshipsTeamsDataItems: - description: Relates a team to this schedule, identified by `id` and `type` - (must be `teams`). + description: |- + Relates a team to this schedule, identified by `id` and `type` (must be `teams`). properties: id: description: The unique identifier of the team in this relationship. - example: 00000000-da3a-0000-0000-000000000000 + example: "00000000-da3a-0000-0000-000000000000" type: string type: - $ref: '#/components/schemas/DataRelationshipsTeamsDataItemsType' + $ref: "#/components/schemas/DataRelationshipsTeamsDataItemsType" required: - - type - - id + - type + - id type: object DataRelationshipsTeamsDataItemsType: default: teams - description: Teams resource type. + description: |- + Teams resource type. enum: - - teams + - teams example: teams type: string x-enum-varnames: - - TEAMS + - TEAMS DataScalarColumn: description: A column containing the numerical results for a formula or query. properties: meta: - $ref: '#/components/schemas/ScalarMeta' + $ref: "#/components/schemas/ScalarMeta" name: description: The name referencing the formula or query for this column. example: a type: string type: - $ref: '#/components/schemas/ScalarColumnTypeNumber' + $ref: "#/components/schemas/ScalarColumnTypeNumber" values: description: The array of numerical values for one formula or query. - example: - - 0.5 + example: [0.5] items: description: An individual value for a given column and group-by. example: 0.5 @@ -19860,8 +19109,7 @@ components: type: array type: object DataTransform: - description: A data transformer, which is custom JavaScript code that executes - and transforms data when its inputs change. + description: A data transformer, which is custom JavaScript code that executes and transforms data when its inputs change. properties: id: description: The ID of the data transformer. @@ -19869,86 +19117,81 @@ components: format: uuid type: string name: - description: A unique identifier for this data transformer. This name is - also used to access the transformer's result throughout the app. - example: combineTwoOrders + description: A unique identifier for this data transformer. This name is also used to access the transformer's result throughout the app. + example: "combineTwoOrders" type: string properties: - $ref: '#/components/schemas/DataTransformProperties' + $ref: "#/components/schemas/DataTransformProperties" type: - $ref: '#/components/schemas/DataTransformType' + $ref: "#/components/schemas/DataTransformType" required: - - id - - name - - type - - properties + - id + - name + - type + - properties type: object DataTransformProperties: description: The properties of the data transformer. properties: outputs: description: A JavaScript function that returns the transformed data. - example: "${(() => {return {\n allItems: [...fetchOrder1.outputs.items, - ...fetchOrder2.outputs.items],\n}})()}" + example: "${(() => {return {\n allItems: [...fetchOrder1.outputs.items, ...fetchOrder2.outputs.items],\n}})()}" type: string type: object DataTransformType: default: dataTransform description: The data transform type. enum: - - dataTransform + - dataTransform example: dataTransform type: string x-enum-varnames: - - DATATRANSFORM + - DATATRANSFORM DatabaseMonitoringTriggerWrapper: - description: Schema for a Database Monitoring-based trigger. + description: "Schema for a Database Monitoring-based trigger." properties: databaseMonitoringTrigger: - description: Trigger a workflow from Database Monitoring. + description: "Trigger a workflow from Database Monitoring." type: object startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - databaseMonitoringTrigger + - databaseMonitoringTrigger type: object DatadogAPIKey: description: The definition of the `DatadogAPIKey` object. properties: api_key: description: The `DatadogAPIKey` `api_key`. - example: '' + example: "" type: string app_key: description: The `DatadogAPIKey` `app_key`. - example: '' + example: "" type: string datacenter: description: The `DatadogAPIKey` `datacenter`. - example: '' + example: "" type: string subdomain: - description: Custom subdomain used for Datadog URLs generated with this - Connection. For example, if this org uses `https://acme.datadoghq.com` - to access Datadog, set this field to `acme`. If this field is omitted, - generated URLs will use the default site URL for its datacenter (see [https://docs.datadoghq.com/getting_started/site](https://docs.datadoghq.com/getting_started/site)). + description: Custom subdomain used for Datadog URLs generated with this Connection. For example, if this org uses `https://acme.datadoghq.com` to access Datadog, set this field to `acme`. If this field is omitted, generated URLs will use the default site URL for its datacenter (see [https://docs.datadoghq.com/getting_started/site](https://docs.datadoghq.com/getting_started/site)). type: string type: - $ref: '#/components/schemas/DatadogAPIKeyType' + $ref: "#/components/schemas/DatadogAPIKeyType" required: - - type - - datacenter - - api_key - - app_key + - type + - datacenter + - api_key + - app_key type: object DatadogAPIKeyType: description: The definition of the `DatadogAPIKey` object. enum: - - DatadogAPIKey + - DatadogAPIKey example: DatadogAPIKey type: string x-enum-varnames: - - DATADOGAPIKEY + - DATADOGAPIKEY DatadogAPIKeyUpdate: description: The definition of the `DatadogAPIKey` object. properties: @@ -19962,78 +19205,75 @@ components: description: The `DatadogAPIKeyUpdate` `datacenter`. type: string subdomain: - description: Custom subdomain used for Datadog URLs generated with this - Connection. For example, if this org uses `https://acme.datadoghq.com` - to access Datadog, set this field to `acme`. If this field is omitted, - generated URLs will use the default site URL for its datacenter (see [https://docs.datadoghq.com/getting_started/site](https://docs.datadoghq.com/getting_started/site)). + description: Custom subdomain used for Datadog URLs generated with this Connection. For example, if this org uses `https://acme.datadoghq.com` to access Datadog, set this field to `acme`. If this field is omitted, generated URLs will use the default site URL for its datacenter (see [https://docs.datadoghq.com/getting_started/site](https://docs.datadoghq.com/getting_started/site)). type: string type: - $ref: '#/components/schemas/DatadogAPIKeyType' + $ref: "#/components/schemas/DatadogAPIKeyType" required: - - type + - type type: object DatadogCredentials: description: The definition of the `DatadogCredentials` object. oneOf: - - $ref: '#/components/schemas/DatadogAPIKey' + - $ref: "#/components/schemas/DatadogAPIKey" DatadogCredentialsUpdate: description: The definition of the `DatadogCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/DatadogAPIKeyUpdate' + - $ref: "#/components/schemas/DatadogAPIKeyUpdate" DatadogIntegration: description: The definition of the `DatadogIntegration` object. properties: credentials: - $ref: '#/components/schemas/DatadogCredentials' + $ref: "#/components/schemas/DatadogCredentials" type: - $ref: '#/components/schemas/DatadogIntegrationType' + $ref: "#/components/schemas/DatadogIntegrationType" required: - - type - - credentials + - type + - credentials type: object DatadogIntegrationType: description: The definition of the `DatadogIntegrationType` object. enum: - - Datadog + - Datadog example: Datadog type: string x-enum-varnames: - - DATADOG + - DATADOG DatadogIntegrationUpdate: description: The definition of the `DatadogIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/DatadogCredentialsUpdate' + $ref: "#/components/schemas/DatadogCredentialsUpdate" type: - $ref: '#/components/schemas/DatadogIntegrationType' + $ref: "#/components/schemas/DatadogIntegrationType" required: - - type + - type type: object DatasetAttributesRequest: description: Dataset metadata and configurations. properties: name: description: Name of the dataset. - example: Security Audit Dataset + example: "Security Audit Dataset" type: string principals: - description: List of access principals, formatted as `principal_type:id`. - Principal can be 'team' or 'role'. + description: |- + List of access principals, formatted as `principal_type:id`. Principal can be 'team' or 'role'. example: - - role:94172442-be03-11e9-a77a-3b7612558ac1 + - "role:94172442-be03-11e9-a77a-3b7612558ac1" items: - example: role:94172442-be03-11e9-a77a-3b7612558ac1 + example: "role:94172442-be03-11e9-a77a-3b7612558ac1" type: string type: array product_filters: description: List of product-specific filters. items: - $ref: '#/components/schemas/FiltersPerProduct' + $ref: "#/components/schemas/FiltersPerProduct" type: array required: - - name - - product_filters - - principals + - name + - product_filters + - principals type: object DatasetAttributesResponse: description: Dataset metadata and configuration(s). @@ -20049,67 +19289,75 @@ components: type: string name: description: Name of the dataset. - example: Security Audit Dataset + example: "Security Audit Dataset" type: string principals: - description: List of access principals, formatted as `principal_type:id`. - Principal can be 'team' or 'role'. + description: |- + List of access principals, formatted as `principal_type:id`. Principal can be 'team' or 'role'. example: - - role:86245fce-0a4e-11f0-92bd-da7ad0900002 + - "role:86245fce-0a4e-11f0-92bd-da7ad0900002" items: - example: role:86245fce-0a4e-11f0-92bd-da7ad0900002 + example: "role:86245fce-0a4e-11f0-92bd-da7ad0900002" type: string type: array product_filters: description: List of product-specific filters. items: - $ref: '#/components/schemas/FiltersPerProduct' + $ref: "#/components/schemas/FiltersPerProduct" type: array type: object DatasetCreateRequest: description: Create request for a dataset. properties: data: - $ref: '#/components/schemas/DatasetRequest' + $ref: "#/components/schemas/DatasetRequest" required: - - data + - data type: object DatasetRequest: - description: "**Datasets Object Constraints**\n- **Tag limit per dataset**:\n - \ - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- - **Tag key rules per telemetry type**:\n - Only one tag key or attribute may - be used to define access within a single telemetry type.\n - The same or - different tag key may be used across different telemetry types.\n\n- **Tag - value uniqueness**:\n - Tag values must be unique within a single dataset.\n - \ - A tag value used in one dataset cannot be reused in another dataset of - the same telemetry type." + description: |- + **Datasets Object Constraints** + - **Tag limit per dataset**: + - Each restricted dataset supports a maximum of 10 key:value pairs per product. + + - **Tag key rules per telemetry type**: + - Only one tag key or attribute may be used to define access within a single telemetry type. + - The same or different tag key may be used across different telemetry types. + + - **Tag value uniqueness**: + - Tag values must be unique within a single dataset. + - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type. properties: attributes: - $ref: '#/components/schemas/DatasetAttributesRequest' + $ref: "#/components/schemas/DatasetAttributesRequest" type: - $ref: '#/components/schemas/DatasetType' + $ref: "#/components/schemas/DatasetType" required: - - type - - attributes + - type + - attributes type: object DatasetResponse: - description: "**Datasets Object Constraints**\n- **Tag Limit per Dataset**:\n - \ - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- - **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may - be used to define access within a single telemetry type.\n - The same or - different tag key may be used across different telemetry types.\n\n- **Tag - Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - \ - A tag value used in one dataset cannot be reused in another dataset of - the same telemetry type." + description: |- + **Datasets Object Constraints** + - **Tag Limit per Dataset**: + - Each restricted dataset supports a maximum of 10 key:value pairs per product. + + - **Tag Key Rules per Telemetry Type**: + - Only one tag key or attribute may be used to define access within a single telemetry type. + - The same or different tag key may be used across different telemetry types. + + - **Tag Value Uniqueness**: + - Tag values must be unique within a single dataset. + - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type. properties: attributes: - $ref: '#/components/schemas/DatasetAttributesResponse' + $ref: "#/components/schemas/DatasetAttributesResponse" id: description: Unique identifier for the dataset. - example: 123e4567-e89b-12d3-a456-426614174000 + example: "123e4567-e89b-12d3-a456-426614174000" type: string type: - $ref: '#/components/schemas/DatasetType' + $ref: "#/components/schemas/DatasetType" type: object DatasetResponseMulti: description: Response containing a list of datasets. @@ -20117,70 +19365,69 @@ components: data: description: The list of datasets returned in response. items: - $ref: '#/components/schemas/DatasetResponse' + $ref: "#/components/schemas/DatasetResponse" type: array type: object DatasetResponseSingle: description: Response containing a single dataset object. properties: data: - $ref: '#/components/schemas/DatasetResponse' + $ref: "#/components/schemas/DatasetResponse" type: object DatasetType: default: dataset description: Resource type, always set to `dataset`. enum: - - dataset + - dataset example: dataset type: string x-enum-varnames: - - DATASET + - DATASET DatasetUpdateRequest: description: Edit request for a dataset. properties: data: - $ref: '#/components/schemas/DatasetRequest' + $ref: "#/components/schemas/DatasetRequest" required: - - data + - data type: object Datastore: description: A datastore's complete configuration and metadata. properties: data: - $ref: '#/components/schemas/DatastoreData' + $ref: "#/components/schemas/DatastoreData" type: object DatastoreArray: description: A collection of datastores returned by list operations. properties: data: - description: An array of datastore objects containing their configurations - and metadata. + description: An array of datastore objects containing their configurations and metadata. items: - $ref: '#/components/schemas/DatastoreData' + $ref: "#/components/schemas/DatastoreData" type: array required: - - data + - data type: object DatastoreAttributesPrimaryColumnName: - description: "The name of the primary key column for this datastore. Primary - column names:\n - Must abide by both [PostgreSQL naming conventions](https://www.postgresql.org/docs/7.0/syntax525.htm)\n - \ - Cannot exceed 63 characters" - example: '' + description: >- + The name of the primary key column for this datastore. Primary column names: + - Must abide by both [PostgreSQL naming conventions](https://www.postgresql.org/docs/7.0/syntax525.htm) + - Cannot exceed 63 characters + example: "" maxLength: 63 type: string DatastoreData: - description: Core information about a datastore, including its unique identifier - and attributes. + description: Core information about a datastore, including its unique identifier and attributes. properties: attributes: - $ref: '#/components/schemas/DatastoreDataAttributes' + $ref: "#/components/schemas/DatastoreDataAttributes" id: description: The unique identifier of the datastore. type: string type: - $ref: '#/components/schemas/DatastoreDataType' + $ref: "#/components/schemas/DatastoreDataType" required: - - type + - type type: object DatastoreDataAttributes: description: Detailed information about a datastore. @@ -20211,43 +19458,39 @@ components: format: int64 type: integer primary_column_name: - $ref: '#/components/schemas/DatastoreAttributesPrimaryColumnName' + $ref: "#/components/schemas/DatastoreAttributesPrimaryColumnName" primary_key_generation_strategy: - $ref: '#/components/schemas/DatastorePrimaryKeyGenerationStrategy' + $ref: "#/components/schemas/DatastorePrimaryKeyGenerationStrategy" type: object DatastoreDataType: default: datastores description: The resource type for datastores. enum: - - datastores + - datastores example: datastores type: string x-enum-varnames: - - DATASTORES + - DATASTORES DatastoreItemConflictMode: - description: How to handle conflicts when inserting items that already exist - in the datastore. + description: How to handle conflicts when inserting items that already exist in the datastore. enum: - - fail_on_conflict - - overwrite_on_conflict + - fail_on_conflict + - overwrite_on_conflict example: overwrite_on_conflict type: string x-enum-varnames: - - FAIL_ON_CONFLICT - - OVERWRITE_ON_CONFLICT + - FAIL_ON_CONFLICT + - OVERWRITE_ON_CONFLICT DatastoreItemValues: - description: An array of items to add to the datastore, where each item is a - set of key-value pairs representing the item's data. Up to 100 items can be - updated in a single request. + description: An array of items to add to the datastore, where each item is a set of key-value pairs representing the item's data. Up to 100 items can be updated in a single request. example: - - data: example data - key: value - - data: example data2 - key: value2 + - data: "example data" + key: "value" + - data: "example data2" + key: "value2" items: additionalProperties: {} - description: A single item's data as key-value pairs. Key names cannot exceed - 63 characters. + description: A single item's data as key-value pairs. Key names cannot exceed 63 characters. type: object maxItems: 100 type: array @@ -20255,38 +19498,35 @@ components: default: items description: The resource type for datastore items. enum: - - items + - items example: items type: string x-enum-varnames: - - ITEMS + - ITEMS DatastorePrimaryKeyGenerationStrategy: - description: Can be set to `uuid` to automatically generate primary keys when - new items are added. Default value is `none`, which requires you to supply - a primary key for each new item. + description: Can be set to `uuid` to automatically generate primary keys when new items are added. Default value is `none`, which requires you to supply a primary key for each new item. enum: - - none - - uuid + - none + - uuid type: string x-enum-varnames: - - NONE - - UUID + - NONE + - UUID DatastoreTrigger: - description: Trigger a workflow from a Datastore. For automatic triggering a - handle must be configured and the workflow must be published. + description: "Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published." properties: rateLimit: - $ref: '#/components/schemas/TriggerRateLimit' + $ref: "#/components/schemas/TriggerRateLimit" type: object DatastoreTriggerWrapper: - description: Schema for a Datastore-based trigger. + description: "Schema for a Datastore-based trigger." properties: datastoreTrigger: - $ref: '#/components/schemas/DatastoreTrigger' + $ref: "#/components/schemas/DatastoreTrigger" startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - datastoreTrigger + - datastoreTrigger type: object Date: description: Date as Unix timestamp in milliseconds. @@ -20296,45 +19536,43 @@ components: Degradation: properties: data: - $ref: '#/components/schemas/DegradationData' + $ref: "#/components/schemas/DegradationData" included: - description: The included related resources of a degradation. Client must - explicitly request these resources by name in the `include` query parameter. + description: The included related resources of a degradation. Client must explicitly request these resources by name in the `include` query parameter. items: - $ref: '#/components/schemas/DegradationIncluded' + $ref: "#/components/schemas/DegradationIncluded" type: array type: object DegradationArray: properties: data: items: - $ref: '#/components/schemas/DegradationData' + $ref: "#/components/schemas/DegradationData" type: array included: - description: The included related resources of a degradation. Client must - explicitly request these resources by name in the `include` query parameter. + description: The included related resources of a degradation. Client must explicitly request these resources by name in the `include` query parameter. items: - $ref: '#/components/schemas/DegradationIncluded' + $ref: "#/components/schemas/DegradationIncluded" type: array meta: - $ref: '#/components/schemas/PaginationMeta' + $ref: "#/components/schemas/PaginationMeta" required: - - data + - data type: object DegradationData: properties: attributes: - $ref: '#/components/schemas/DegradationDataAttributes' + $ref: "#/components/schemas/DegradationDataAttributes" id: description: The ID of the degradation. format: uuid type: string relationships: - $ref: '#/components/schemas/DegradationDataRelationships' + $ref: "#/components/schemas/DegradationDataRelationships" type: - $ref: '#/components/schemas/PatchDegradationRequestDataType' + $ref: "#/components/schemas/PatchDegradationRequestDataType" required: - - type + - type type: object DegradationDataAttributes: description: The attributes of a degradation. @@ -20342,7 +19580,7 @@ components: components_affected: description: Components affected by the degradation. items: - $ref: '#/components/schemas/DegradationDataAttributesComponentsAffectedItems' + $ref: "#/components/schemas/DegradationDataAttributesComponentsAffectedItems" type: array created_at: description: Timestamp of when the degradation was created. @@ -20356,23 +19594,23 @@ components: format: date-time type: string source: - $ref: '#/components/schemas/DegradationDataAttributesSource' + $ref: "#/components/schemas/DegradationDataAttributesSource" status: - $ref: '#/components/schemas/CreateDegradationRequestDataAttributesStatus' + $ref: "#/components/schemas/CreateDegradationRequestDataAttributesStatus" title: description: Title of the degradation. type: string updates: description: Past updates made to the degradation. items: - $ref: '#/components/schemas/DegradationDataAttributesUpdatesItems' + $ref: "#/components/schemas/DegradationDataAttributesUpdatesItems" type: array type: object DegradationDataAttributesComponentsAffectedItems: properties: id: description: The ID of the component. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string name: @@ -20380,44 +19618,44 @@ components: readOnly: true type: string status: - $ref: '#/components/schemas/StatusPagesComponentDataAttributesStatus' + $ref: "#/components/schemas/StatusPagesComponentDataAttributesStatus" required: - - id - - status + - id + - status type: object DegradationDataAttributesSource: description: The source of the degradation. properties: created_at: description: Timestamp of when the source was created. - example: '' + example: "" format: date-time type: string source_id: description: The ID of the source. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/DegradationDataAttributesSourceType' + $ref: "#/components/schemas/DegradationDataAttributesSourceType" required: - - created_at - - source_id - - type + - created_at + - source_id + - type type: object DegradationDataAttributesSourceType: description: The type of the source. enum: - - incident + - incident example: incident type: string x-enum-varnames: - - INCIDENT + - INCIDENT DegradationDataAttributesUpdatesItems: properties: components_affected: description: The components affected at the time of the update. items: - $ref: '#/components/schemas/DegradationDataAttributesUpdatesItemsComponentsAffectedItems' + $ref: "#/components/schemas/DegradationDataAttributesUpdatesItemsComponentsAffectedItems" type: array created_at: description: Timestamp of when the update was created. @@ -20442,13 +19680,13 @@ components: format: date-time type: string status: - $ref: '#/components/schemas/CreateDegradationRequestDataAttributesStatus' + $ref: "#/components/schemas/CreateDegradationRequestDataAttributesStatus" type: object DegradationDataAttributesUpdatesItemsComponentsAffectedItems: properties: id: description: Identifier of the component affected at the time of the update. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string name: @@ -20456,92 +19694,92 @@ components: readOnly: true type: string status: - $ref: '#/components/schemas/StatusPagesComponentDataAttributesStatus' + $ref: "#/components/schemas/StatusPagesComponentDataAttributesStatus" description: The status of the component affected at the time of the update. required: - - id - - status + - id + - status type: object DegradationDataRelationships: description: The relationships of a degradation. properties: created_by_user: - $ref: '#/components/schemas/DegradationDataRelationshipsCreatedByUser' + $ref: "#/components/schemas/DegradationDataRelationshipsCreatedByUser" description: The Datadog user who created the degradation. last_modified_by_user: - $ref: '#/components/schemas/DegradationDataRelationshipsLastModifiedByUser' + $ref: "#/components/schemas/DegradationDataRelationshipsLastModifiedByUser" description: The Datadog user who last modified the degradation. status_page: - $ref: '#/components/schemas/DegradationDataRelationshipsStatusPage' + $ref: "#/components/schemas/DegradationDataRelationshipsStatusPage" description: The status page the degradation belongs to. type: object DegradationDataRelationshipsCreatedByUser: properties: data: - $ref: '#/components/schemas/DegradationDataRelationshipsCreatedByUserData' + $ref: "#/components/schemas/DegradationDataRelationshipsCreatedByUserData" required: - - data + - data type: object DegradationDataRelationshipsCreatedByUserData: properties: id: description: The ID of the Datadog user who created the degradation. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/StatusPagesUserType' + $ref: "#/components/schemas/StatusPagesUserType" required: - - type - - id + - type + - id type: object DegradationDataRelationshipsLastModifiedByUser: properties: data: - $ref: '#/components/schemas/DegradationDataRelationshipsLastModifiedByUserData' + $ref: "#/components/schemas/DegradationDataRelationshipsLastModifiedByUserData" required: - - data + - data type: object DegradationDataRelationshipsLastModifiedByUserData: properties: id: description: The ID of the Datadog user who last modified the degradation. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/StatusPagesUserType' + $ref: "#/components/schemas/StatusPagesUserType" required: - - type - - id + - type + - id type: object DegradationDataRelationshipsStatusPage: properties: data: - $ref: '#/components/schemas/DegradationDataRelationshipsStatusPageData' + $ref: "#/components/schemas/DegradationDataRelationshipsStatusPageData" required: - - data + - data type: object DegradationDataRelationshipsStatusPageData: properties: id: description: The ID of the status page. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string type: - $ref: '#/components/schemas/StatusPageDataType' + $ref: "#/components/schemas/StatusPageDataType" required: - - type - - id + - type + - id type: object DegradationIncluded: oneOf: - - $ref: '#/components/schemas/StatusPagesUser' - - $ref: '#/components/schemas/StatusPageAsIncluded' + - $ref: "#/components/schemas/StatusPagesUser" + - $ref: "#/components/schemas/StatusPageAsIncluded" DeleteAppResponse: description: The response object after an app is successfully deleted. properties: data: - $ref: '#/components/schemas/DeleteAppResponseData' + $ref: "#/components/schemas/DeleteAppResponseData" type: object DeleteAppResponseData: description: The definition of `DeleteAppResponseData` object. @@ -20552,51 +19790,47 @@ components: format: uuid type: string type: - $ref: '#/components/schemas/AppDefinitionType' + $ref: "#/components/schemas/AppDefinitionType" required: - - id - - type + - id + - type type: object DeleteAppsDatastoreItemRequest: - description: Request to delete a specific item from a datastore by its primary - key. + description: Request to delete a specific item from a datastore by its primary key. properties: data: - $ref: '#/components/schemas/DeleteAppsDatastoreItemRequestData' + $ref: "#/components/schemas/DeleteAppsDatastoreItemRequestData" type: object DeleteAppsDatastoreItemRequestData: - description: Data wrapper containing the information needed to identify and - delete a specific datastore item. + description: Data wrapper containing the information needed to identify and delete a specific datastore item. properties: attributes: - $ref: '#/components/schemas/DeleteAppsDatastoreItemRequestDataAttributes' + $ref: "#/components/schemas/DeleteAppsDatastoreItemRequestDataAttributes" type: - $ref: '#/components/schemas/DatastoreItemsDataType' + $ref: "#/components/schemas/DatastoreItemsDataType" required: - - type + - type type: object DeleteAppsDatastoreItemRequestDataAttributes: - description: Attributes specifying which datastore item to delete by its primary - key. + description: Attributes specifying which datastore item to delete by its primary key. properties: id: description: Optional unique identifier of the item to delete. - example: a7656bcc-51d4-4884-adf7-4d0d9a3e0633 + example: "a7656bcc-51d4-4884-adf7-4d0d9a3e0633" type: string item_key: - description: The primary key value that identifies the item to delete. Cannot - exceed 256 characters. - example: primaryKey + description: The primary key value that identifies the item to delete. Cannot exceed 256 characters. + example: "primaryKey" maxLength: 256 type: string required: - - item_key + - item_key type: object DeleteAppsDatastoreItemResponse: description: Response from successfully deleting a datastore item. properties: data: - $ref: '#/components/schemas/DeleteAppsDatastoreItemResponseData' + $ref: "#/components/schemas/DeleteAppsDatastoreItemResponseData" type: object DeleteAppsDatastoreItemResponseArray: description: The definition of `DeleteAppsDatastoreItemResponseArray` object. @@ -20604,38 +19838,37 @@ components: data: description: The `DeleteAppsDatastoreItemResponseArray` `data`. items: - $ref: '#/components/schemas/DeleteAppsDatastoreItemResponseData' + $ref: "#/components/schemas/DeleteAppsDatastoreItemResponseData" type: array required: - - data + - data type: object DeleteAppsDatastoreItemResponseData: - description: Data containing the identifier of the datastore item that was successfully - deleted. + description: Data containing the identifier of the datastore item that was successfully deleted. properties: id: description: The unique identifier of the item that was deleted. type: string type: - $ref: '#/components/schemas/DatastoreItemsDataType' + $ref: "#/components/schemas/DatastoreItemsDataType" required: - - type + - type type: object DeleteAppsRequest: description: A request object for deleting multiple apps by ID. example: data: - - id: aea2ed17-b45f-40d0-ba59-c86b7972c901 - type: appDefinitions - - id: f69bb8be-6168-4fe7-a30d-370256b6504a - type: appDefinitions - - id: ab1ed73e-13ad-4426-b0df-a0ff8876a088 - type: appDefinitions + - id: aea2ed17-b45f-40d0-ba59-c86b7972c901 + type: appDefinitions + - id: f69bb8be-6168-4fe7-a30d-370256b6504a + type: appDefinitions + - id: ab1ed73e-13ad-4426-b0df-a0ff8876a088 + type: appDefinitions properties: data: description: An array of objects containing the IDs of the apps to delete. items: - $ref: '#/components/schemas/DeleteAppsRequestDataItems' + $ref: "#/components/schemas/DeleteAppsRequestDataItems" type: array type: object DeleteAppsRequestDataItems: @@ -20647,10 +19880,10 @@ components: format: uuid type: string type: - $ref: '#/components/schemas/AppDefinitionType' + $ref: "#/components/schemas/AppDefinitionType" required: - - id - - type + - id + - type type: object DeleteAppsResponse: description: The response object after multiple apps are successfully deleted. @@ -20658,7 +19891,7 @@ components: data: description: An array of objects containing the IDs of the deleted apps. items: - $ref: '#/components/schemas/DeleteAppsResponseDataItems' + $ref: "#/components/schemas/DeleteAppsResponseDataItems" type: array type: object DeleteAppsResponseDataItems: @@ -20670,27 +19903,27 @@ components: format: uuid type: string type: - $ref: '#/components/schemas/AppDefinitionType' + $ref: "#/components/schemas/AppDefinitionType" required: - - id - - type + - id + - type type: object DeleteCustomFrameworkResponse: description: Response object to delete a custom framework. properties: data: - $ref: '#/components/schemas/CustomFrameworkMetadata' + $ref: "#/components/schemas/CustomFrameworkMetadata" required: - - data + - data type: object DeletedSuiteResponseData: properties: attributes: - $ref: '#/components/schemas/DeletedSuiteResponseDataAttributes' + $ref: "#/components/schemas/DeletedSuiteResponseDataAttributes" id: type: string type: - $ref: '#/components/schemas/SyntheticsSuiteTypes' + $ref: "#/components/schemas/SyntheticsSuiteTypes" type: object DeletedSuiteResponseDataAttributes: properties: @@ -20704,13 +19937,13 @@ components: DeletedSuitesRequestDelete: properties: attributes: - $ref: '#/components/schemas/DeletedSuitesRequestDeleteAttributes' + $ref: "#/components/schemas/DeletedSuitesRequestDeleteAttributes" id: type: string type: - $ref: '#/components/schemas/DeletedSuitesRequestType' + $ref: "#/components/schemas/DeletedSuitesRequestType" required: - - attributes + - attributes type: object DeletedSuitesRequestDeleteAttributes: properties: @@ -20718,43 +19951,43 @@ components: type: boolean public_ids: example: - - '' + - "" items: type: string type: array required: - - public_ids + - public_ids type: object DeletedSuitesRequestDeleteRequest: properties: data: - $ref: '#/components/schemas/DeletedSuitesRequestDelete' + $ref: "#/components/schemas/DeletedSuitesRequestDelete" required: - - data + - data type: object DeletedSuitesRequestType: default: delete_suites_request enum: - - delete_suites_request + - delete_suites_request example: delete_suites_request type: string x-enum-varnames: - - DELETE_SUITES_REQUEST + - DELETE_SUITES_REQUEST DeletedSuitesResponse: properties: data: items: - $ref: '#/components/schemas/DeletedSuiteResponseData' + $ref: "#/components/schemas/DeletedSuiteResponseData" type: array type: object DeletedTestResponseData: properties: attributes: - $ref: '#/components/schemas/DeletedTestResponseDataAttributes' + $ref: "#/components/schemas/DeletedTestResponseDataAttributes" id: type: string type: - $ref: '#/components/schemas/DeletedTestsResponseType' + $ref: "#/components/schemas/DeletedTestsResponseType" type: object DeletedTestResponseDataAttributes: properties: @@ -20768,13 +20001,13 @@ components: DeletedTestsRequestDelete: properties: attributes: - $ref: '#/components/schemas/DeletedTestsRequestDeleteAttributes' + $ref: "#/components/schemas/DeletedTestsRequestDeleteAttributes" id: type: string type: - $ref: '#/components/schemas/DeletedTestsRequestType' + $ref: "#/components/schemas/DeletedTestsRequestType" required: - - attributes + - attributes type: object DeletedTestsRequestDeleteAttributes: properties: @@ -20782,43 +20015,43 @@ components: type: boolean public_ids: example: - - '' + - "" items: type: string type: array required: - - public_ids + - public_ids type: object DeletedTestsRequestDeleteRequest: properties: data: - $ref: '#/components/schemas/DeletedTestsRequestDelete' + $ref: "#/components/schemas/DeletedTestsRequestDelete" required: - - data + - data type: object DeletedTestsRequestType: default: delete_tests_request enum: - - delete_tests_request + - delete_tests_request example: delete_tests_request type: string x-enum-varnames: - - DELETE_TESTS_REQUEST + - DELETE_TESTS_REQUEST DeletedTestsResponse: properties: data: items: - $ref: '#/components/schemas/DeletedTestResponseData' + $ref: "#/components/schemas/DeletedTestResponseData" type: array type: object DeletedTestsResponseType: default: delete_tests enum: - - delete_tests + - delete_tests example: delete_tests type: string x-enum-varnames: - - DELETE_TESTS + - DELETE_TESTS DependencyLocation: description: Static library vulnerability location. properties: @@ -20847,34 +20080,32 @@ components: format: int64 type: integer required: - - file_name - - line_start - - line_end - - column_start - - column_end + - file_name + - line_start + - line_end + - column_start + - column_end type: object Deployment: description: The version of the app that was published. properties: attributes: - $ref: '#/components/schemas/DeploymentAttributes' + $ref: "#/components/schemas/DeploymentAttributes" id: description: The deployment ID. example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 format: uuid type: string meta: - $ref: '#/components/schemas/DeploymentMetadata' + $ref: "#/components/schemas/DeploymentMetadata" type: - $ref: '#/components/schemas/AppDeploymentType' + $ref: "#/components/schemas/AppDeploymentType" type: object DeploymentAttributes: - description: The attributes object containing the version ID of the published - app. + description: The attributes object containing the version ID of the published app. properties: app_version_id: - description: The version ID of the app that was published. For an unpublished - app, this is always the nil UUID (`00000000-0000-0000-0000-000000000000`). + description: The version ID of the app that was published. For an unpublished app, this is always the nil UUID (`00000000-0000-0000-0000-000000000000`). example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 format: uuid type: string @@ -20882,115 +20113,115 @@ components: DeploymentGateDataType: description: Deployment gate resource type. enum: - - deployment_gate + - deployment_gate example: deployment_gate type: string x-enum-varnames: - - DEPLOYMENT_GATE + - DEPLOYMENT_GATE DeploymentGateResponse: description: Response for a deployment gate. properties: data: - $ref: '#/components/schemas/DeploymentGateResponseData' + $ref: "#/components/schemas/DeploymentGateResponseData" type: object DeploymentGateResponseData: description: Data for a deployment gate. properties: attributes: - $ref: '#/components/schemas/DeploymentGateResponseDataAttributes' + $ref: "#/components/schemas/DeploymentGateResponseDataAttributes" id: description: Unique identifier of the deployment gate. - example: 1111-2222-3333-4444-555566667777 + example: "1111-2222-3333-4444-555566667777" type: string type: - $ref: '#/components/schemas/DeploymentGateDataType' + $ref: "#/components/schemas/DeploymentGateDataType" required: - - type - - attributes - - id + - type + - attributes + - id type: object DeploymentGateResponseDataAttributes: description: Basic information about a deployment gate. properties: created_at: description: The timestamp when the deployment gate was created. - example: '2021-01-01T00:00:00Z' + example: "2021-01-01T00:00:00Z" format: date-time type: string created_by: - $ref: '#/components/schemas/DeploymentGateResponseDataAttributesCreatedBy' + $ref: "#/components/schemas/DeploymentGateResponseDataAttributesCreatedBy" dry_run: description: Whether this gate is run in dry-run mode. example: false type: boolean env: description: The environment of the deployment gate. - example: production + example: "production" type: string identifier: description: The identifier of the deployment gate. - example: pre + example: "pre" type: string service: description: The service of the deployment gate. - example: my-service + example: "my-service" type: string updated_at: description: The timestamp when the deployment gate was last updated. - example: '2021-01-01T00:00:00Z' + example: "2021-01-01T00:00:00Z" format: date-time type: string updated_by: - $ref: '#/components/schemas/DeploymentGateResponseDataAttributesUpdatedBy' + $ref: "#/components/schemas/DeploymentGateResponseDataAttributesUpdatedBy" required: - - created_at - - created_by - - dry_run - - env - - identifier - - service + - created_at + - created_by + - dry_run + - env + - identifier + - service type: object DeploymentGateResponseDataAttributesCreatedBy: description: Information about the user who created the deployment gate. properties: handle: description: The handle of the user who created the deployment rule. - example: test-user + example: "test-user" type: string id: description: The ID of the user who created the deployment rule. - example: 1111-2222-3333-4444-555566667777 + example: "1111-2222-3333-4444-555566667777" type: string name: description: The name of the user who created the deployment rule. - example: Test User + example: "Test User" type: string required: - - id + - id type: object DeploymentGateResponseDataAttributesUpdatedBy: description: Information about the user who updated the deployment gate. properties: handle: description: The handle of the user who updated the deployment rule. - example: test-user + example: "test-user" type: string id: description: The ID of the user who updated the deployment rule. - example: 1111-2222-3333-4444-555566667777 + example: "1111-2222-3333-4444-555566667777" type: string name: description: The name of the user who updated the deployment rule. - example: Test User + example: "Test User" type: string required: - - id + - id type: object DeploymentGateRulesResponse: description: Response for a deployment gate rules. properties: data: - $ref: '#/components/schemas/ListDeploymentRuleResponseData' + $ref: "#/components/schemas/ListDeploymentRuleResponseData" type: object DeploymentMetadata: description: Metadata object containing the publication creation information. @@ -21016,9 +20247,9 @@ components: description: Information pointing to the app's publication status. properties: data: - $ref: '#/components/schemas/DeploymentRelationshipData' + $ref: "#/components/schemas/DeploymentRelationshipData" meta: - $ref: '#/components/schemas/DeploymentMetadata' + $ref: "#/components/schemas/DeploymentMetadata" type: object DeploymentRelationshipData: description: Data object containing the deployment ID. @@ -21029,16 +20260,16 @@ components: format: uuid type: string type: - $ref: '#/components/schemas/AppDeploymentType' + $ref: "#/components/schemas/AppDeploymentType" type: object DeploymentRuleDataType: description: Deployment rule resource type. enum: - - deployment_rule + - deployment_rule example: deployment_rule type: string x-enum-varnames: - - DEPLOYMENT_RULE + - DEPLOYMENT_RULE DeploymentRuleOptionsFaultyDeploymentDetection: additionalProperties: false description: Faulty deployment detection options for deployment rules. @@ -21050,9 +20281,7 @@ components: type: integer excluded_resources: description: Resources to exclude from faulty deployment detection. - example: - - resource1 - - resource2 + example: ["resource1", "resource2"] items: type: string type: array @@ -21062,218 +20291,203 @@ components: description: Monitor options for deployment rules. properties: duration: - description: Seconds the monitor needs to stay in OK status for the rule - to pass. + description: Seconds the monitor needs to stay in OK status for the rule to pass. example: 3600 format: int64 type: integer query: description: Monitors that match this query are evaluated. - example: service:my-service env:prod + example: "service:my-service env:prod" type: string required: - - query + - query type: object DeploymentRuleResponse: description: Response for a deployment rule. properties: data: - $ref: '#/components/schemas/DeploymentRuleResponseData' + $ref: "#/components/schemas/DeploymentRuleResponseData" type: object DeploymentRuleResponseData: description: Data for a deployment rule. properties: attributes: - $ref: '#/components/schemas/DeploymentRuleResponseDataAttributes' + $ref: "#/components/schemas/DeploymentRuleResponseDataAttributes" id: description: Unique identifier of the deployment rule. - example: 1111-2222-3333-4444-555566667777 + example: "1111-2222-3333-4444-555566667777" type: string type: - $ref: '#/components/schemas/DeploymentRuleDataType' + $ref: "#/components/schemas/DeploymentRuleDataType" required: - - type - - attributes - - id + - type + - attributes + - id type: object DeploymentRuleResponseDataAttributes: description: Basic information about a deployment rule. properties: created_at: description: The timestamp when the deployment rule was created. - example: '2021-01-01T00:00:00Z' + example: "2021-01-01T00:00:00Z" format: date-time type: string created_by: - $ref: '#/components/schemas/DeploymentRuleResponseDataAttributesCreatedBy' + $ref: "#/components/schemas/DeploymentRuleResponseDataAttributesCreatedBy" dry_run: description: Whether this rule is run in dry-run mode. example: false type: boolean gate_id: description: The ID of the deployment gate. - example: 1111-2222-3333-4444-555566667777 + example: "1111-2222-3333-4444-555566667777" type: string name: description: The name of the deployment rule. - example: My deployment rule + example: "My deployment rule" type: string options: - $ref: '#/components/schemas/DeploymentRulesOptions' + $ref: "#/components/schemas/DeploymentRulesOptions" type: - $ref: '#/components/schemas/DeploymentRuleResponseDataAttributesType' + $ref: "#/components/schemas/DeploymentRuleResponseDataAttributesType" updated_at: description: The timestamp when the deployment rule was last updated. format: date-time type: string updated_by: - $ref: '#/components/schemas/DeploymentRuleResponseDataAttributesUpdatedBy' + $ref: "#/components/schemas/DeploymentRuleResponseDataAttributesUpdatedBy" required: - - created_at - - created_by - - dry_run - - gate_id - - name - - options - - type + - created_at + - created_by + - dry_run + - gate_id + - name + - options + - type type: object DeploymentRuleResponseDataAttributesCreatedBy: description: Information about the user who created the deployment rule. properties: handle: description: The handle of the user who created the deployment rule. - example: test-user + example: "test-user" type: string id: description: The ID of the user who created the deployment rule. - example: 1111-2222-3333-4444-555566667777 + example: "1111-2222-3333-4444-555566667777" type: string name: description: The name of the user who created the deployment rule. - example: Test User + example: "Test User" type: string required: - - id + - id type: object DeploymentRuleResponseDataAttributesType: description: The type of the deployment rule. enum: - - faulty_deployment_detection - - monitor + - faulty_deployment_detection + - monitor example: faulty_deployment_detection type: string x-enum-varnames: - - FAULTY_DEPLOYMENT_DETECTION - - MONITOR + - FAULTY_DEPLOYMENT_DETECTION + - MONITOR DeploymentRuleResponseDataAttributesUpdatedBy: description: Information about the user who updated the deployment rule. properties: handle: description: The handle of the user who updated the deployment rule. - example: test-user + example: "test-user" type: string id: description: The ID of the user who updated the deployment rule. - example: 1111-2222-3333-4444-555566667777 + example: "1111-2222-3333-4444-555566667777" type: string name: description: The name of the user who updated the deployment rule. - example: Test User + example: "Test User" type: string required: - - id + - id type: object DeploymentRulesOptions: - description: Options for deployment rule response representing either faulty - deployment detection or monitor options. + description: Options for deployment rule response representing either faulty deployment detection or monitor options. oneOf: - - $ref: '#/components/schemas/DeploymentRuleOptionsFaultyDeploymentDetection' - - $ref: '#/components/schemas/DeploymentRuleOptionsMonitor' + - $ref: "#/components/schemas/DeploymentRuleOptionsFaultyDeploymentDetection" + - $ref: "#/components/schemas/DeploymentRuleOptionsMonitor" DetachCaseRequest: description: Request for detaching security findings from their case. properties: data: - $ref: '#/components/schemas/DetachCaseRequestData' + $ref: "#/components/schemas/DetachCaseRequestData" type: object DetachCaseRequestData: description: Data for detaching security findings from their case. properties: relationships: - $ref: '#/components/schemas/DetachCaseRequestDataRelationships' + $ref: "#/components/schemas/DetachCaseRequestDataRelationships" type: - $ref: '#/components/schemas/CaseDataType' + $ref: "#/components/schemas/CaseDataType" required: - - type + - type type: object DetachCaseRequestDataRelationships: description: Relationships detaching security findings from their case. properties: findings: - $ref: '#/components/schemas/Findings' + $ref: "#/components/schemas/Findings" description: Security findings to detach from their case. required: - - findings + - findings type: object DetailedFinding: description: A single finding with with message and resource configuration. properties: attributes: - $ref: '#/components/schemas/DetailedFindingAttributes' + $ref: "#/components/schemas/DetailedFindingAttributes" id: - $ref: '#/components/schemas/FindingID' + $ref: "#/components/schemas/FindingID" type: - $ref: '#/components/schemas/DetailedFindingType' + $ref: "#/components/schemas/DetailedFindingType" type: object DetailedFindingAttributes: description: The JSON:API attributes of the detailed finding. properties: evaluation: - $ref: '#/components/schemas/FindingEvaluation' + $ref: "#/components/schemas/FindingEvaluation" evaluation_changed_at: - $ref: '#/components/schemas/FindingEvaluationChangedAt' + $ref: "#/components/schemas/FindingEvaluationChangedAt" message: description: The remediation message for this finding. - example: '## Remediation - - - ### From the console - - - 1. Go to Storage Account - - 2. For each Storage Account, navigate to Data Protection - - 3. Select Set soft delete enabled and enter the number of days to retain - soft deleted data.' + example: "## Remediation\n\n### From the console\n\n1. Go to Storage Account\n2. For each Storage Account, navigate to Data Protection\n3. Select Set soft delete enabled and enter the number of days to retain soft deleted data." type: string mute: - $ref: '#/components/schemas/FindingMute' + $ref: "#/components/schemas/FindingMute" resource: - $ref: '#/components/schemas/FindingResource' + $ref: "#/components/schemas/FindingResource" resource_configuration: description: The resource configuration for this finding. type: object resource_discovery_date: - $ref: '#/components/schemas/FindingResourceDiscoveryDate' + $ref: "#/components/schemas/FindingResourceDiscoveryDate" resource_type: - $ref: '#/components/schemas/FindingResourceType' + $ref: "#/components/schemas/FindingResourceType" rule: - $ref: '#/components/schemas/FindingRule' + $ref: "#/components/schemas/FindingRule" status: - $ref: '#/components/schemas/FindingStatus' + $ref: "#/components/schemas/FindingStatus" tags: - $ref: '#/components/schemas/FindingTags' + $ref: "#/components/schemas/FindingTags" type: object DetailedFindingType: default: detailed_finding - description: The JSON:API type for findings that have the message and resource - configuration. + description: The JSON:API type for findings that have the message and resource configuration. enum: - - detailed_finding + - detailed_finding example: detailed_finding type: string - x-enum-varnames: - - DETAILED_FINDING + x-enum-varnames: ["DETAILED_FINDING"] DeviceAttributes: description: The device attributes properties: @@ -21290,7 +20504,7 @@ components: example: snmp type: string interface_statuses: - $ref: '#/components/schemas/DeviceAttributesInterfaceStatuses' + $ref: "#/components/schemas/DeviceAttributesInterfaceStatuses" ip_address: description: The device IP address example: 1.2.3.4 @@ -21344,9 +20558,7 @@ components: type: string tags: description: The list of device tags - example: - - device_ip:1.2.3.4 - - device_id:example:1.2.3.4 + example: ["device_ip:1.2.3.4", "device_id:example:1.2.3.4"] items: type: string type: array @@ -21363,7 +20575,7 @@ components: description: Count of the device interfaces by status example: down: 1 - 'off': 2 + "off": 2 up: 12 warning: 5 properties: @@ -21371,7 +20583,7 @@ components: description: The number of interfaces that are down format: int64 type: integer - 'off': + "off": description: The number of interfaces that are off format: int64 type: integer @@ -21388,7 +20600,7 @@ components: description: The devices list data properties: attributes: - $ref: '#/components/schemas/DeviceAttributes' + $ref: "#/components/schemas/DeviceAttributes" id: description: The device ID example: example:1.2.3.4 @@ -21400,52 +20612,52 @@ components: DnsMetricKey: description: The metric key for DNS metrics. enum: - - dns_total_requests - - dns_failures - - dns_successful_responses - - dns_failed_responses - - dns_timeouts - - dns_responses.nxdomain - - dns_responses.servfail - - dns_responses.other - - dns_success_latency_percentile - - dns_failure_latency_percentile + - dns_total_requests + - dns_failures + - dns_successful_responses + - dns_failed_responses + - dns_timeouts + - dns_responses.nxdomain + - dns_responses.servfail + - dns_responses.other + - dns_success_latency_percentile + - dns_failure_latency_percentile type: string x-enum-descriptions: - - The total number of DNS requests made by the client. - - The total number of timeouts and errors in DNS requests. - - The total number of successful DNS responses. - - The total number of failed DNS responses. - - The total number of DNS timeouts. - - The total number of DNS responses with the NXDOMAIN error code. - - The total number of DNS responses with the SERVFAIL error code. - - The total number of DNS responses with other error codes. - - The latency percentile for successful DNS responses. - - The latency percentile for failed DNS responses. - x-enum-varnames: - - DNS_TOTAL_REQUESTS - - DNS_FAILURES - - DNS_SUCCESSFUL_RESPONSES - - DNS_FAILED_RESPONSES - - DNS_TIMEOUTS - - DNS_RESPONSES_NXDOMAIN - - DNS_RESPONSES_SERVFAIL - - DNS_RESPONSES_OTHER - - DNS_SUCCESS_LATENCY_PERCENTILE - - DNS_FAILURE_LATENCY_PERCENTILE + - The total number of DNS requests made by the client. + - The total number of timeouts and errors in DNS requests. + - The total number of successful DNS responses. + - The total number of failed DNS responses. + - The total number of DNS timeouts. + - The total number of DNS responses with the NXDOMAIN error code. + - The total number of DNS responses with the SERVFAIL error code. + - The total number of DNS responses with other error codes. + - The latency percentile for successful DNS responses. + - The latency percentile for failed DNS responses. + x-enum-varnames: + - DNS_TOTAL_REQUESTS + - DNS_FAILURES + - DNS_SUCCESSFUL_RESPONSES + - DNS_FAILED_RESPONSES + - DNS_TIMEOUTS + - DNS_RESPONSES_NXDOMAIN + - DNS_RESPONSES_SERVFAIL + - DNS_RESPONSES_OTHER + - DNS_SUCCESS_LATENCY_PERCENTILE + - DNS_FAILURE_LATENCY_PERCENTILE DomainAllowlist: description: The email domain allowlist for an org. properties: attributes: - $ref: '#/components/schemas/DomainAllowlistAttributes' + $ref: "#/components/schemas/DomainAllowlistAttributes" id: description: The unique identifier of the org. nullable: true type: string type: - $ref: '#/components/schemas/DomainAllowlistType' + $ref: "#/components/schemas/DomainAllowlistType" required: - - type + - type type: object DomainAllowlistAttributes: description: The details of the email domain allowlist. @@ -21463,29 +20675,29 @@ components: description: Request containing the desired email domain allowlist configuration. properties: data: - $ref: '#/components/schemas/DomainAllowlist' + $ref: "#/components/schemas/DomainAllowlist" required: - - data + - data type: object DomainAllowlistResponse: description: Response containing information about the email domain allowlist. properties: data: - $ref: '#/components/schemas/DomainAllowlistResponseData' + $ref: "#/components/schemas/DomainAllowlistResponseData" type: object DomainAllowlistResponseData: description: The email domain allowlist response for an org. properties: attributes: - $ref: '#/components/schemas/DomainAllowlistResponseDataAttributes' + $ref: "#/components/schemas/DomainAllowlistResponseDataAttributes" id: description: The unique identifier of the org. nullable: true type: string type: - $ref: '#/components/schemas/DomainAllowlistType' + $ref: "#/components/schemas/DomainAllowlistType" required: - - type + - type type: object DomainAllowlistResponseDataAttributes: description: The details of the email domain allowlist. @@ -21503,84 +20715,82 @@ components: default: domain_allowlist description: Email domain allowlist allowlist type. enum: - - domain_allowlist + - domain_allowlist example: domain_allowlist type: string x-enum-varnames: - - DOMAIN_ALLOWLIST + - DOMAIN_ALLOWLIST DowntimeCreateRequest: description: Request for creating a downtime. properties: data: - $ref: '#/components/schemas/DowntimeCreateRequestData' + $ref: "#/components/schemas/DowntimeCreateRequestData" required: - - data + - data type: object DowntimeCreateRequestAttributes: description: Downtime details. properties: display_timezone: - $ref: '#/components/schemas/DowntimeDisplayTimezone' + $ref: "#/components/schemas/DowntimeDisplayTimezone" message: - $ref: '#/components/schemas/DowntimeMessage' + $ref: "#/components/schemas/DowntimeMessage" monitor_identifier: - $ref: '#/components/schemas/DowntimeMonitorIdentifier' + $ref: "#/components/schemas/DowntimeMonitorIdentifier" mute_first_recovery_notification: - $ref: '#/components/schemas/DowntimeMuteFirstRecoveryNotification' + $ref: "#/components/schemas/DowntimeMuteFirstRecoveryNotification" notify_end_states: - $ref: '#/components/schemas/DowntimeNotifyEndStates' + $ref: "#/components/schemas/DowntimeNotifyEndStates" notify_end_types: - $ref: '#/components/schemas/DowntimeNotifyEndTypes' + $ref: "#/components/schemas/DowntimeNotifyEndTypes" schedule: - $ref: '#/components/schemas/DowntimeScheduleCreateRequest' + $ref: "#/components/schemas/DowntimeScheduleCreateRequest" scope: - $ref: '#/components/schemas/DowntimeScope' + $ref: "#/components/schemas/DowntimeScope" required: - - scope - - monitor_identifier + - scope + - monitor_identifier type: object DowntimeCreateRequestData: description: Object to create a downtime. properties: attributes: - $ref: '#/components/schemas/DowntimeCreateRequestAttributes' + $ref: "#/components/schemas/DowntimeCreateRequestAttributes" type: - $ref: '#/components/schemas/DowntimeResourceType' + $ref: "#/components/schemas/DowntimeResourceType" required: - - type - - attributes + - type + - attributes type: object DowntimeDisplayTimezone: - default: UTC - description: 'The timezone in which to display the downtime''s start and end - times in Datadog applications. This is not used - - as an offset for scheduling.' - example: America/New_York + default: "UTC" + description: |- + The timezone in which to display the downtime's start and end times in Datadog applications. This is not used + as an offset for scheduling. + example: "America/New_York" nullable: true type: string DowntimeIncludedMonitorType: default: monitors description: Monitor resource type. enum: - - monitors - example: monitors + - monitors + example: "monitors" type: string x-enum-varnames: - - MONITORS + - MONITORS DowntimeMessage: - description: 'A message to include with notifications for this downtime. Email - notifications can be sent to specific users - - by using the same `@username` notation as events.' - example: Message about the downtime + description: |- + A message to include with notifications for this downtime. Email notifications can be sent to specific users + by using the same `@username` notation as events. + example: "Message about the downtime" nullable: true type: string DowntimeMeta: description: Pagination metadata returned by the API. properties: page: - $ref: '#/components/schemas/DowntimeMetaPage' + $ref: "#/components/schemas/DowntimeMetaPage" type: object DowntimeMetaPage: description: Object containing the total filtered count. @@ -21593,8 +20803,8 @@ components: DowntimeMonitorIdentifier: description: Monitor identifier for the downtime. oneOf: - - $ref: '#/components/schemas/DowntimeMonitorIdentifierId' - - $ref: '#/components/schemas/DowntimeMonitorIdentifierTags' + - $ref: "#/components/schemas/DowntimeMonitorIdentifierId" + - $ref: "#/components/schemas/DowntimeMonitorIdentifierTags" DowntimeMonitorIdentifierId: additionalProperties: {} description: Object of the monitor identifier. @@ -21605,116 +20815,100 @@ components: format: int64 type: integer required: - - monitor_id + - monitor_id type: object DowntimeMonitorIdentifierTags: additionalProperties: {} description: Object of the monitor tags. properties: monitor_tags: - description: 'A list of monitor tags. For example, tags that are applied - directly to monitors, - - not tags that are used in monitor queries (which are filtered by the scope - parameter), to which the downtime applies. - - The resulting downtime applies to monitors that match **all** provided - monitor tags. Setting `monitor_tags` - - to `[*]` configures the downtime to mute all monitors for the given scope.' - example: - - service:postgres - - team:frontend + description: |- + A list of monitor tags. For example, tags that are applied directly to monitors, + not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. + The resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags` + to `[*]` configures the downtime to mute all monitors for the given scope. + example: ["service:postgres", "team:frontend"] items: description: A list of monitor tags. - example: service:postgres + example: "service:postgres" type: string minItems: 1 type: array required: - - monitor_tags + - monitor_tags type: object DowntimeMonitorIncludedAttributes: description: Attributes of the monitor identified by the downtime. properties: name: description: The name of the monitor identified by the downtime. - example: A monitor name + example: "A monitor name" type: string type: object DowntimeMonitorIncludedItem: description: Information about the monitor identified by the downtime. properties: attributes: - $ref: '#/components/schemas/DowntimeMonitorIncludedAttributes' + $ref: "#/components/schemas/DowntimeMonitorIncludedAttributes" id: description: ID of the monitor identified by the downtime. example: 12345 format: int64 type: integer type: - $ref: '#/components/schemas/DowntimeIncludedMonitorType' + $ref: "#/components/schemas/DowntimeIncludedMonitorType" type: object DowntimeMuteFirstRecoveryNotification: - description: If the first recovery notification during a downtime should be - muted. + description: If the first recovery notification during a downtime should be muted. example: false type: boolean DowntimeNotifyEndStateActions: - description: Action that will trigger a monitor notification if the downtime - is in the `notify_end_types` state. + description: Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state. enum: - - canceled - - expired - example: canceled + - canceled + - expired + example: "canceled" type: string x-enum-varnames: - - CANCELED - - EXPIRED + - CANCELED + - EXPIRED DowntimeNotifyEndStateTypes: - description: State that will trigger a monitor notification when the `notify_end_types` - action occurs. + description: State that will trigger a monitor notification when the `notify_end_types` action occurs. enum: - - alert - - no data - - warn - example: alert + - alert + - no data + - warn + example: "alert" type: string x-enum-varnames: - - ALERT - - NO_DATA - - WARN + - ALERT + - NO_DATA + - WARN DowntimeNotifyEndStates: - description: States that will trigger a monitor notification when the `notify_end_types` - action occurs. - example: - - alert - - warn + description: States that will trigger a monitor notification when the `notify_end_types` action occurs. + example: ["alert", "warn"] items: - $ref: '#/components/schemas/DowntimeNotifyEndStateTypes' + $ref: "#/components/schemas/DowntimeNotifyEndStateTypes" type: array DowntimeNotifyEndTypes: - description: Actions that will trigger a monitor notification if the downtime - is in the `notify_end_types` state. - example: - - canceled - - expired + description: Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state. + example: ["canceled", "expired"] items: - $ref: '#/components/schemas/DowntimeNotifyEndStateActions' + $ref: "#/components/schemas/DowntimeNotifyEndStateActions" type: array DowntimeRelationships: description: All relationships associated with downtime. properties: created_by: - $ref: '#/components/schemas/DowntimeRelationshipsCreatedBy' + $ref: "#/components/schemas/DowntimeRelationshipsCreatedBy" monitor: - $ref: '#/components/schemas/DowntimeRelationshipsMonitor' + $ref: "#/components/schemas/DowntimeRelationshipsMonitor" type: object DowntimeRelationshipsCreatedBy: description: The user who created the downtime. properties: data: - $ref: '#/components/schemas/DowntimeRelationshipsCreatedByData' + $ref: "#/components/schemas/DowntimeRelationshipsCreatedByData" type: object DowntimeRelationshipsCreatedByData: description: Data for the user who created the downtime. @@ -21722,16 +20916,16 @@ components: properties: id: description: User ID of the downtime creator. - example: 00000000-0000-1234-0000-000000000000 + example: "00000000-0000-1234-0000-000000000000" type: string type: - $ref: '#/components/schemas/UsersType' + $ref: "#/components/schemas/UsersType" type: object DowntimeRelationshipsMonitor: description: The monitor identified by the downtime. properties: data: - $ref: '#/components/schemas/DowntimeRelationshipsMonitorData' + $ref: "#/components/schemas/DowntimeRelationshipsMonitorData" type: object DowntimeRelationshipsMonitorData: description: Data for the monitor. @@ -21739,36 +20933,33 @@ components: properties: id: description: Monitor ID of the downtime. - example: '12345' + example: "12345" type: string type: - $ref: '#/components/schemas/DowntimeIncludedMonitorType' + $ref: "#/components/schemas/DowntimeIncludedMonitorType" type: object DowntimeResourceType: default: downtime description: Downtime resource type. enum: - - downtime - example: downtime + - downtime + example: "downtime" type: string x-enum-varnames: - - DOWNTIME + - DOWNTIME DowntimeResponse: - description: 'Downtiming gives you greater control over monitor notifications - by - + description: |- + Downtiming gives you greater control over monitor notifications by allowing you to globally exclude scopes from alerting. - Downtime settings, which can be scheduled with start and end times, - - prevent all alerting related to specified Datadog tags.' + prevent all alerting related to specified Datadog tags. properties: data: - $ref: '#/components/schemas/DowntimeResponseData' + $ref: "#/components/schemas/DowntimeResponseData" included: description: Array of objects related to the downtime that the user requested. items: - $ref: '#/components/schemas/DowntimeResponseIncludedItem' + $ref: "#/components/schemas/DowntimeResponseIncludedItem" type: array type: object DowntimeResponseAttributes: @@ -21776,71 +20967,68 @@ components: properties: canceled: description: Time that the downtime was canceled. - example: 2020-01-02T03:04:05.282979+0000 + example: "2020-01-02T03:04:05.282979+0000" format: date-time nullable: true type: string created: description: Creation time of the downtime. - example: 2020-01-02T03:04:05.282979+0000 + example: "2020-01-02T03:04:05.282979+0000" format: date-time type: string display_timezone: - $ref: '#/components/schemas/DowntimeDisplayTimezone' + $ref: "#/components/schemas/DowntimeDisplayTimezone" message: - $ref: '#/components/schemas/DowntimeMessage' + $ref: "#/components/schemas/DowntimeMessage" modified: description: Time that the downtime was last modified. - example: 2020-01-02T03:04:05.282979+0000 + example: "2020-01-02T03:04:05.282979+0000" format: date-time type: string monitor_identifier: - $ref: '#/components/schemas/DowntimeMonitorIdentifier' + $ref: "#/components/schemas/DowntimeMonitorIdentifier" mute_first_recovery_notification: - $ref: '#/components/schemas/DowntimeMuteFirstRecoveryNotification' + $ref: "#/components/schemas/DowntimeMuteFirstRecoveryNotification" notify_end_states: - $ref: '#/components/schemas/DowntimeNotifyEndStates' + $ref: "#/components/schemas/DowntimeNotifyEndStates" notify_end_types: - $ref: '#/components/schemas/DowntimeNotifyEndTypes' + $ref: "#/components/schemas/DowntimeNotifyEndTypes" schedule: - $ref: '#/components/schemas/DowntimeScheduleResponse' + $ref: "#/components/schemas/DowntimeScheduleResponse" scope: - $ref: '#/components/schemas/DowntimeScope' + $ref: "#/components/schemas/DowntimeScope" status: - $ref: '#/components/schemas/DowntimeStatus' + $ref: "#/components/schemas/DowntimeStatus" type: object DowntimeResponseData: description: Downtime data. properties: attributes: - $ref: '#/components/schemas/DowntimeResponseAttributes' + $ref: "#/components/schemas/DowntimeResponseAttributes" id: description: The downtime ID. - example: 00000000-0000-1234-0000-000000000000 + example: "00000000-0000-1234-0000-000000000000" type: string relationships: - $ref: '#/components/schemas/DowntimeRelationships' + $ref: "#/components/schemas/DowntimeRelationships" type: - $ref: '#/components/schemas/DowntimeResourceType' + $ref: "#/components/schemas/DowntimeResourceType" type: object DowntimeResponseIncludedItem: description: An object related to a downtime. oneOf: - - $ref: '#/components/schemas/User' - - $ref: '#/components/schemas/DowntimeMonitorIncludedItem' + - $ref: "#/components/schemas/User" + - $ref: "#/components/schemas/DowntimeMonitorIncludedItem" DowntimeScheduleCreateRequest: description: Schedule for the downtime. oneOf: - - $ref: '#/components/schemas/DowntimeScheduleRecurrencesCreateRequest' - - $ref: '#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest' + - $ref: "#/components/schemas/DowntimeScheduleRecurrencesCreateRequest" + - $ref: "#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest" DowntimeScheduleCurrentDowntimeResponse: - description: 'The most recent actual start and end dates for a recurring downtime. - For a canceled downtime, - - this is the previously occurring downtime. For active downtimes, this is the - ongoing downtime, and for scheduled - - downtimes it is the upcoming downtime.' + description: |- + The most recent actual start and end dates for a recurring downtime. For a canceled downtime, + this is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled + downtimes it is the upcoming downtime. properties: end: description: The end of the current downtime. @@ -21859,19 +21047,17 @@ components: description: A one-time downtime definition. properties: end: - description: 'ISO-8601 Datetime to end the downtime. Must include a UTC - offset of zero. If not provided, the - - downtime continues forever.' + description: |- + ISO-8601 Datetime to end the downtime. Must include a UTC offset of zero. If not provided, the + downtime continues forever. example: 2020-01-02 03:04:00+00:00 format: date-time nullable: true type: string start: - description: 'ISO-8601 Datetime to start the downtime. Must include a UTC - offset of zero. If not provided, the - - downtime starts the moment it is created.' + description: |- + ISO-8601 Datetime to start the downtime. Must include a UTC offset of zero. If not provided, the + downtime starts the moment it is created. example: 2020-01-02 03:04:00+00:00 format: date-time nullable: true @@ -21892,62 +21078,53 @@ components: format: date-time type: string required: - - start + - start type: object DowntimeScheduleRecurrenceCreateUpdateRequest: additionalProperties: {} description: An object defining the recurrence of the downtime. properties: duration: - $ref: '#/components/schemas/DowntimeScheduleRecurrenceDuration' + $ref: "#/components/schemas/DowntimeScheduleRecurrenceDuration" rrule: - $ref: '#/components/schemas/DowntimeScheduleRecurrenceRrule' + $ref: "#/components/schemas/DowntimeScheduleRecurrenceRrule" start: - description: 'ISO-8601 Datetime to start the downtime. Must not include - a UTC offset. If not provided, the - - downtime starts the moment it is created.' + description: |- + ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the + downtime starts the moment it is created. example: 2020-01-02T03:04 nullable: true type: string required: - - duration - - rrule + - duration + - rrule type: object DowntimeScheduleRecurrenceDuration: - description: The length of the downtime. Must begin with an integer and end - with one of 'm', 'h', d', or 'w'. + description: The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'. example: 123d type: string DowntimeScheduleRecurrenceResponse: description: An RRULE-based recurring downtime. properties: duration: - $ref: '#/components/schemas/DowntimeScheduleRecurrenceDuration' + $ref: "#/components/schemas/DowntimeScheduleRecurrenceDuration" rrule: - $ref: '#/components/schemas/DowntimeScheduleRecurrenceRrule' + $ref: "#/components/schemas/DowntimeScheduleRecurrenceRrule" start: - description: 'ISO-8601 Datetime to start the downtime. Must not include - a UTC offset. If not provided, the - - downtime starts the moment it is created.' + description: |- + ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the + downtime starts the moment it is created. example: 2020-01-02T03:04 type: string type: object DowntimeScheduleRecurrenceRrule: - description: 'The `RRULE` standard for defining recurring events. - - For example, to have a recurring event on the first day of each month, set - the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`. - - Most common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) - are supported. - + description: |- + The `RRULE` standard for defining recurring events. + For example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`. + Most common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported. - **Note**: Attributes specifying the duration in `RRULE` are not supported - (for example, `DTSTART`, `DTEND`, `DURATION`). - - More examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).' + **Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`). + More examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api). example: FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1 type: string DowntimeScheduleRecurrencesCreateRequest: @@ -21956,7 +21133,7 @@ components: recurrences: description: A list of downtime recurrences. items: - $ref: '#/components/schemas/DowntimeScheduleRecurrenceCreateUpdateRequest' + $ref: "#/components/schemas/DowntimeScheduleRecurrenceCreateUpdateRequest" type: array timezone: default: UTC @@ -21964,30 +21141,29 @@ components: example: America/New_York type: string required: - - recurrences + - recurrences type: object DowntimeScheduleRecurrencesResponse: description: A recurring downtime schedule definition. properties: current_downtime: - $ref: '#/components/schemas/DowntimeScheduleCurrentDowntimeResponse' + $ref: "#/components/schemas/DowntimeScheduleCurrentDowntimeResponse" recurrences: description: A list of downtime recurrences. items: - $ref: '#/components/schemas/DowntimeScheduleRecurrenceResponse' + $ref: "#/components/schemas/DowntimeScheduleRecurrenceResponse" maxItems: 5 minItems: 1 type: array timezone: default: UTC - description: 'The timezone in which to schedule the downtime. This affects - recurring start and end dates. - - Must match `display_timezone`.' - example: America/New_York + description: |- + The timezone in which to schedule the downtime. This affects recurring start and end dates. + Must match `display_timezone`. + example: "America/New_York" type: string required: - - recurrences + - recurrences type: object DowntimeScheduleRecurrencesUpdateRequest: additionalProperties: false @@ -21996,7 +21172,7 @@ components: recurrences: description: A list of downtime recurrences. items: - $ref: '#/components/schemas/DowntimeScheduleRecurrenceCreateUpdateRequest' + $ref: "#/components/schemas/DowntimeScheduleRecurrenceCreateUpdateRequest" type: array timezone: default: UTC @@ -22005,83 +21181,80 @@ components: type: string type: object DowntimeScheduleResponse: - description: 'The schedule that defines when the monitor starts, stops, and - recurs. There are two types of schedules: - - one-time and recurring. Recurring schedules may have up to five RRULE-based - recurrences. If no schedules are - - provided, the downtime will begin immediately and never end.' + description: |- + The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules: + one-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are + provided, the downtime will begin immediately and never end. oneOf: - - $ref: '#/components/schemas/DowntimeScheduleRecurrencesResponse' - - $ref: '#/components/schemas/DowntimeScheduleOneTimeResponse' + - $ref: "#/components/schemas/DowntimeScheduleRecurrencesResponse" + - $ref: "#/components/schemas/DowntimeScheduleOneTimeResponse" DowntimeScheduleUpdateRequest: description: Schedule for the downtime. oneOf: - - $ref: '#/components/schemas/DowntimeScheduleRecurrencesUpdateRequest' - - $ref: '#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest' + - $ref: "#/components/schemas/DowntimeScheduleRecurrencesUpdateRequest" + - $ref: "#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest" DowntimeScope: - description: The scope to which the downtime applies. Must follow the [common - search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/). - example: env:(staging OR prod) AND datacenter:us-east-1 + description: |- + The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/). + example: "env:(staging OR prod) AND datacenter:us-east-1" type: string DowntimeStatus: description: The current status of the downtime. enum: - - active - - canceled - - ended - - scheduled - example: active + - active + - canceled + - ended + - scheduled + example: "active" type: string x-enum-varnames: - - ACTIVE - - CANCELED - - ENDED - - SCHEDULED + - ACTIVE + - CANCELED + - ENDED + - SCHEDULED DowntimeUpdateRequest: description: Request for editing a downtime. properties: data: - $ref: '#/components/schemas/DowntimeUpdateRequestData' + $ref: "#/components/schemas/DowntimeUpdateRequestData" required: - - data + - data type: object DowntimeUpdateRequestAttributes: description: Attributes of the downtime to update. properties: display_timezone: - $ref: '#/components/schemas/DowntimeDisplayTimezone' + $ref: "#/components/schemas/DowntimeDisplayTimezone" message: - $ref: '#/components/schemas/DowntimeMessage' + $ref: "#/components/schemas/DowntimeMessage" monitor_identifier: - $ref: '#/components/schemas/DowntimeMonitorIdentifier' + $ref: "#/components/schemas/DowntimeMonitorIdentifier" mute_first_recovery_notification: - $ref: '#/components/schemas/DowntimeMuteFirstRecoveryNotification' + $ref: "#/components/schemas/DowntimeMuteFirstRecoveryNotification" notify_end_states: - $ref: '#/components/schemas/DowntimeNotifyEndStates' + $ref: "#/components/schemas/DowntimeNotifyEndStates" notify_end_types: - $ref: '#/components/schemas/DowntimeNotifyEndTypes' + $ref: "#/components/schemas/DowntimeNotifyEndTypes" schedule: - $ref: '#/components/schemas/DowntimeScheduleUpdateRequest' + $ref: "#/components/schemas/DowntimeScheduleUpdateRequest" scope: - $ref: '#/components/schemas/DowntimeScope' + $ref: "#/components/schemas/DowntimeScope" type: object DowntimeUpdateRequestData: description: Object to update a downtime. properties: attributes: - $ref: '#/components/schemas/DowntimeUpdateRequestAttributes' + $ref: "#/components/schemas/DowntimeUpdateRequestAttributes" id: description: ID of this downtime. - example: 00000000-0000-1234-0000-000000000000 + example: "00000000-0000-1234-0000-000000000000" type: string type: - $ref: '#/components/schemas/DowntimeResourceType' + $ref: "#/components/schemas/DowntimeResourceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object EPSS: description: Vulnerability EPSS severity. @@ -22092,10 +21265,10 @@ components: format: double type: number severity: - $ref: '#/components/schemas/VulnerabilitySeverity' + $ref: "#/components/schemas/VulnerabilitySeverity" required: - - score - - severity + - score + - severity type: object Enabled: description: Field used to enable or disable the rule. @@ -22135,14 +21308,14 @@ components: description: Entity data. properties: attributes: - $ref: '#/components/schemas/EntityAttributes' + $ref: "#/components/schemas/EntityAttributes" id: description: Entity ID. type: string meta: - $ref: '#/components/schemas/EntityMeta' + $ref: "#/components/schemas/EntityMeta" relationships: - $ref: '#/components/schemas/EntityRelationships' + $ref: "#/components/schemas/EntityRelationships" type: description: Entity. type: string @@ -22165,39 +21338,43 @@ components: type: object EntityRaw: description: Entity definition in raw JSON or YAML representation. - example: "apiVersion: v3\nkind: service\nmetadata:\n name: myservice" + example: |- + apiVersion: v3 + kind: service + metadata: + name: myservice type: string EntityReference: description: The unique reference for an IDP entity. - example: service:my-service + example: "service:my-service" type: string EntityRelationships: description: Entity relationships. properties: incidents: - $ref: '#/components/schemas/EntityToIncidents' + $ref: "#/components/schemas/EntityToIncidents" oncall: - $ref: '#/components/schemas/EntityToOncalls' + $ref: "#/components/schemas/EntityToOncalls" rawSchema: - $ref: '#/components/schemas/EntityToRawSchema' + $ref: "#/components/schemas/EntityToRawSchema" relatedEntities: - $ref: '#/components/schemas/EntityToRelatedEntities' + $ref: "#/components/schemas/EntityToRelatedEntities" schema: - $ref: '#/components/schemas/EntityToSchema' + $ref: "#/components/schemas/EntityToSchema" type: object EntityResponseArray: properties: data: items: - $ref: '#/components/schemas/PreviewEntityResponseData' + $ref: "#/components/schemas/PreviewEntityResponseData" type: array required: - - data + - data type: object EntityResponseData: description: List of entity data. items: - $ref: '#/components/schemas/EntityData' + $ref: "#/components/schemas/EntityData" type: array EntityResponseDataAttributes: properties: @@ -22226,206 +21403,206 @@ components: EntityResponseDataRelationships: properties: incidents: - $ref: '#/components/schemas/EntityResponseDataRelationshipsIncidents' + $ref: "#/components/schemas/EntityResponseDataRelationshipsIncidents" oncalls: - $ref: '#/components/schemas/EntityResponseDataRelationshipsOncalls' + $ref: "#/components/schemas/EntityResponseDataRelationshipsOncalls" rawSchema: - $ref: '#/components/schemas/EntityResponseDataRelationshipsRawSchema' + $ref: "#/components/schemas/EntityResponseDataRelationshipsRawSchema" relatedEntities: - $ref: '#/components/schemas/EntityResponseDataRelationshipsRelatedEntities' + $ref: "#/components/schemas/EntityResponseDataRelationshipsRelatedEntities" schema: - $ref: '#/components/schemas/EntityResponseDataRelationshipsSchema' + $ref: "#/components/schemas/EntityResponseDataRelationshipsSchema" type: object EntityResponseDataRelationshipsIncidents: properties: data: items: - $ref: '#/components/schemas/EntityResponseDataRelationshipsIncidentsDataItems' + $ref: "#/components/schemas/EntityResponseDataRelationshipsIncidentsDataItems" type: array type: object EntityResponseDataRelationshipsIncidentsDataItems: properties: id: - example: '' + example: "" type: string type: - $ref: '#/components/schemas/EntityResponseDataRelationshipsIncidentsDataItemsType' + $ref: "#/components/schemas/EntityResponseDataRelationshipsIncidentsDataItemsType" required: - - type - - id + - type + - id type: object EntityResponseDataRelationshipsIncidentsDataItemsType: default: incident description: Incident resource type. enum: - - incident + - incident example: incident type: string x-enum-varnames: - - INCIDENT + - INCIDENT EntityResponseDataRelationshipsOncalls: properties: data: items: - $ref: '#/components/schemas/EntityResponseDataRelationshipsOncallsDataItems' + $ref: "#/components/schemas/EntityResponseDataRelationshipsOncallsDataItems" type: array type: object EntityResponseDataRelationshipsOncallsDataItems: properties: id: - example: '' + example: "" type: string type: - $ref: '#/components/schemas/EntityResponseDataRelationshipsOncallsDataItemsType' + $ref: "#/components/schemas/EntityResponseDataRelationshipsOncallsDataItemsType" required: - - type - - id + - type + - id type: object EntityResponseDataRelationshipsOncallsDataItemsType: default: oncall description: Oncall resource type. enum: - - oncall + - oncall example: oncall type: string x-enum-varnames: - - ONCALL + - ONCALL EntityResponseDataRelationshipsRawSchema: properties: data: - $ref: '#/components/schemas/EntityResponseDataRelationshipsRawSchemaData' + $ref: "#/components/schemas/EntityResponseDataRelationshipsRawSchemaData" required: - - data + - data type: object EntityResponseDataRelationshipsRawSchemaData: properties: id: - example: '' + example: "" type: string type: - $ref: '#/components/schemas/EntityResponseDataRelationshipsRawSchemaDataType' + $ref: "#/components/schemas/EntityResponseDataRelationshipsRawSchemaDataType" required: - - type - - id + - type + - id type: object EntityResponseDataRelationshipsRawSchemaDataType: default: rawSchema description: Raw schema resource type. enum: - - rawSchema + - rawSchema example: rawSchema type: string x-enum-varnames: - - RAWSCHEMA + - RAWSCHEMA EntityResponseDataRelationshipsRelatedEntities: properties: data: items: - $ref: '#/components/schemas/EntityResponseDataRelationshipsRelatedEntitiesDataItems' + $ref: "#/components/schemas/EntityResponseDataRelationshipsRelatedEntitiesDataItems" type: array type: object EntityResponseDataRelationshipsRelatedEntitiesDataItems: properties: id: - example: '' + example: "" type: string type: - $ref: '#/components/schemas/EntityResponseDataRelationshipsRelatedEntitiesDataItemsType' + $ref: "#/components/schemas/EntityResponseDataRelationshipsRelatedEntitiesDataItemsType" required: - - type - - id + - type + - id type: object EntityResponseDataRelationshipsRelatedEntitiesDataItemsType: default: relatedEntity description: Related entity resource type. enum: - - relatedEntity + - relatedEntity example: relatedEntity type: string x-enum-varnames: - - RELATEDENTITY + - RELATEDENTITY EntityResponseDataRelationshipsSchema: properties: data: - $ref: '#/components/schemas/EntityResponseDataRelationshipsSchemaData' + $ref: "#/components/schemas/EntityResponseDataRelationshipsSchemaData" required: - - data + - data type: object EntityResponseDataRelationshipsSchemaData: properties: id: - example: '' + example: "" type: string type: - $ref: '#/components/schemas/EntityResponseDataRelationshipsSchemaDataType' + $ref: "#/components/schemas/EntityResponseDataRelationshipsSchemaDataType" required: - - type - - id + - type + - id type: object EntityResponseDataRelationshipsSchemaDataType: default: schema description: Schema resource type. enum: - - schema + - schema example: schema type: string x-enum-varnames: - - SCHEMA + - SCHEMA EntityResponseDataType: default: entity description: Entity resource type. enum: - - entity + - entity example: entity type: string x-enum-varnames: - - ENTITY + - ENTITY EntityResponseIncludedIncident: description: Included incident. properties: attributes: - $ref: '#/components/schemas/EntityResponseIncludedRelatedIncidentAttributes' + $ref: "#/components/schemas/EntityResponseIncludedRelatedIncidentAttributes" id: description: Incident ID. type: string type: - $ref: '#/components/schemas/EntityResponseIncludedIncidentType' + $ref: "#/components/schemas/EntityResponseIncludedIncidentType" type: object EntityResponseIncludedIncidentType: description: Incident description. enum: - - incident + - incident type: string x-enum-varnames: - - INCIDENT + - INCIDENT EntityResponseIncludedOncall: description: Included oncall. properties: attributes: - $ref: '#/components/schemas/EntityResponseIncludedRelatedOncallAttributes' + $ref: "#/components/schemas/EntityResponseIncludedRelatedOncallAttributes" id: description: Oncall ID. type: string type: - $ref: '#/components/schemas/EntityResponseIncludedOncallType' + $ref: "#/components/schemas/EntityResponseIncludedOncallType" type: object EntityResponseIncludedOncallType: description: Oncall type. enum: - - oncall + - oncall type: string x-enum-varnames: - - ONCALL + - ONCALL EntityResponseIncludedRawSchema: description: Included raw schema. properties: attributes: - $ref: '#/components/schemas/EntityResponseIncludedRawSchemaAttributes' + $ref: "#/components/schemas/EntityResponseIncludedRawSchemaAttributes" id: description: Raw schema ID. type: string type: - $ref: '#/components/schemas/EntityResponseIncludedRawSchemaType' + $ref: "#/components/schemas/EntityResponseIncludedRawSchemaType" type: object EntityResponseIncludedRawSchemaAttributes: description: Included raw schema attributes. @@ -22437,22 +21614,22 @@ components: EntityResponseIncludedRawSchemaType: description: Raw schema type. enum: - - rawSchema + - rawSchema type: string x-enum-varnames: - - RAW_SCHEMA + - RAW_SCHEMA EntityResponseIncludedRelatedEntity: description: Included related entity. properties: attributes: - $ref: '#/components/schemas/EntityResponseIncludedRelatedEntityAttributes' + $ref: "#/components/schemas/EntityResponseIncludedRelatedEntityAttributes" id: description: Entity UUID. type: string meta: - $ref: '#/components/schemas/EntityResponseIncludedRelatedEntityMeta' + $ref: "#/components/schemas/EntityResponseIncludedRelatedEntityMeta" type: - $ref: '#/components/schemas/EntityResponseIncludedRelatedEntityType' + $ref: "#/components/schemas/EntityResponseIncludedRelatedEntityType" type: object EntityResponseIncludedRelatedEntityAttributes: description: Related entity attributes. @@ -22491,10 +21668,10 @@ components: EntityResponseIncludedRelatedEntityType: description: Related entity. enum: - - relatedEntity + - relatedEntity type: string x-enum-varnames: - - RELATED_ENTITY + - RELATED_ENTITY EntityResponseIncludedRelatedIncidentAttributes: description: Incident attributes. properties: @@ -22519,7 +21696,7 @@ components: description: Included related oncall attributes. properties: escalations: - $ref: '#/components/schemas/EntityResponseIncludedRelatedOncallEscalations' + $ref: "#/components/schemas/EntityResponseIncludedRelatedOncallEscalations" provider: description: Oncall provider. type: string @@ -22541,32 +21718,32 @@ components: EntityResponseIncludedRelatedOncallEscalations: description: Oncall escalations. items: - $ref: '#/components/schemas/EntityResponseIncludedRelatedOncallEscalationItem' + $ref: "#/components/schemas/EntityResponseIncludedRelatedOncallEscalationItem" type: array EntityResponseIncludedSchema: description: Included detail entity schema. properties: attributes: - $ref: '#/components/schemas/EntityResponseIncludedSchemaAttributes' + $ref: "#/components/schemas/EntityResponseIncludedSchemaAttributes" id: description: Entity ID. type: string type: - $ref: '#/components/schemas/EntityResponseIncludedSchemaType' + $ref: "#/components/schemas/EntityResponseIncludedSchemaType" type: object EntityResponseIncludedSchemaAttributes: description: Included schema. properties: schema: - $ref: '#/components/schemas/EntityV3' + $ref: "#/components/schemas/EntityV3" type: object EntityResponseIncludedSchemaType: description: Schema type. enum: - - schema + - schema type: string x-enum-varnames: - - SCHEMA + - SCHEMA EntityResponseMeta: description: Entity metadata. properties: @@ -22583,89 +21760,88 @@ components: description: Entity to incidents relationship. properties: data: - $ref: '#/components/schemas/RelationshipArray' + $ref: "#/components/schemas/RelationshipArray" type: object EntityToOncalls: description: Entity to oncalls relationship. properties: data: - $ref: '#/components/schemas/RelationshipArray' + $ref: "#/components/schemas/RelationshipArray" type: object EntityToRawSchema: description: Entity to raw schema relationship. properties: data: - $ref: '#/components/schemas/RelationshipItem' + $ref: "#/components/schemas/RelationshipItem" type: object EntityToRelatedEntities: description: Entity to related entities relationship. properties: data: - $ref: '#/components/schemas/RelationshipArray' + $ref: "#/components/schemas/RelationshipArray" type: object EntityToSchema: description: Entity to detail schema relationship. properties: data: - $ref: '#/components/schemas/RelationshipItem' + $ref: "#/components/schemas/RelationshipItem" type: object EntityV3: description: Entity schema v3. oneOf: - - $ref: '#/components/schemas/EntityV3Service' - - $ref: '#/components/schemas/EntityV3Datastore' - - $ref: '#/components/schemas/EntityV3Queue' - - $ref: '#/components/schemas/EntityV3System' - - $ref: '#/components/schemas/EntityV3API' + - $ref: "#/components/schemas/EntityV3Service" + - $ref: "#/components/schemas/EntityV3Datastore" + - $ref: "#/components/schemas/EntityV3Queue" + - $ref: "#/components/schemas/EntityV3System" + - $ref: "#/components/schemas/EntityV3API" EntityV3API: additionalProperties: false description: Schema for API entities. properties: apiVersion: - $ref: '#/components/schemas/EntityV3APIVersion' + $ref: "#/components/schemas/EntityV3APIVersion" datadog: - $ref: '#/components/schemas/EntityV3APIDatadog' + $ref: "#/components/schemas/EntityV3APIDatadog" extensions: additionalProperties: {} - description: Custom extensions. This is the free-formed field to send client-side - metadata. No Datadog features are affected by this field. + description: Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. type: object integrations: - $ref: '#/components/schemas/EntityV3Integrations' + $ref: "#/components/schemas/EntityV3Integrations" kind: - $ref: '#/components/schemas/EntityV3APIKind' + $ref: "#/components/schemas/EntityV3APIKind" metadata: - $ref: '#/components/schemas/EntityV3Metadata' + $ref: "#/components/schemas/EntityV3Metadata" spec: - $ref: '#/components/schemas/EntityV3APISpec' + $ref: "#/components/schemas/EntityV3APISpec" required: - - apiVersion - - kind - - metadata + - apiVersion + - kind + - metadata type: object EntityV3APIDatadog: additionalProperties: false description: Datadog product integrations for the API entity. properties: codeLocations: - $ref: '#/components/schemas/EntityV3DatadogCodeLocations' + $ref: "#/components/schemas/EntityV3DatadogCodeLocations" events: - $ref: '#/components/schemas/EntityV3DatadogEvents' + $ref: "#/components/schemas/EntityV3DatadogEvents" logs: - $ref: '#/components/schemas/EntityV3DatadogLogs' + $ref: "#/components/schemas/EntityV3DatadogLogs" performanceData: - $ref: '#/components/schemas/EntityV3DatadogPerformance' + $ref: "#/components/schemas/EntityV3DatadogPerformance" pipelines: - $ref: '#/components/schemas/EntityV3DatadogPipelines' + $ref: "#/components/schemas/EntityV3DatadogPipelines" type: object EntityV3APIKind: description: The definition of Entity V3 API Kind object. enum: - - api + - api example: api type: string x-enum-varnames: - - API + - API EntityV3APISpec: additionalProperties: false description: The definition of Entity V3 API Spec object. @@ -22676,7 +21852,7 @@ components: type: string type: array interface: - $ref: '#/components/schemas/EntityV3APISpecInterface' + $ref: "#/components/schemas/EntityV3APISpecInterface" lifecycle: description: The lifecycle state of the component. minLength: 1 @@ -22693,8 +21869,8 @@ components: additionalProperties: false description: The API definition. oneOf: - - $ref: '#/components/schemas/EntityV3APISpecInterfaceFileRef' - - $ref: '#/components/schemas/EntityV3APISpecInterfaceDefinition' + - $ref: "#/components/schemas/EntityV3APISpecInterfaceFileRef" + - $ref: "#/components/schemas/EntityV3APISpecInterfaceDefinition" EntityV3APISpecInterfaceDefinition: additionalProperties: false description: The definition of `EntityV3APISpecInterfaceDefinition` object. @@ -22712,21 +21888,19 @@ components: type: string type: object EntityV3APIVersion: - description: The version of the schema data that was used to populate this entity's - data. This could be via the API, Terraform, or YAML file in a repository. - The field is known as schema-version in the previous version. - enum: - - v3 - - v2.2 - - v2.1 - - v2 + description: The version of the schema data that was used to populate this entity's data. This could be via the API, Terraform, or YAML file in a repository. The field is known as schema-version in the previous version. + enum: + - v3 + - v2.2 + - v2.1 + - v2 example: v3 type: string x-enum-varnames: - - V3 - - V2_2 - - V2_1 - - V2 + - V3 + - V2_2 + - V2_1 + - V2 EntityV3DatadogCodeLocationItem: additionalProperties: false description: Code location item. @@ -22744,7 +21918,7 @@ components: additionalProperties: false description: Schema for mapping source code locations to an entity. items: - $ref: '#/components/schemas/EntityV3DatadogCodeLocationItem' + $ref: "#/components/schemas/EntityV3DatadogCodeLocationItem" type: array EntityV3DatadogEventItem: additionalProperties: false @@ -22761,7 +21935,7 @@ components: additionalProperties: false description: Events associations. items: - $ref: '#/components/schemas/EntityV3DatadogEventItem' + $ref: "#/components/schemas/EntityV3DatadogEventItem" type: array EntityV3DatadogIntegrationOpsgenie: additionalProperties: false @@ -22773,11 +21947,11 @@ components: type: string serviceURL: description: The service URL for the Opsgenie integration. - example: https://www.opsgenie.com/service/shopping-cart + example: "https://www.opsgenie.com/service/shopping-cart" minLength: 1 type: string required: - - serviceURL + - serviceURL type: object EntityV3DatadogIntegrationPagerduty: additionalProperties: false @@ -22785,11 +21959,11 @@ components: properties: serviceURL: description: The service URL for the PagerDuty integration. - example: https://www.pagerduty.com/service-directory/Pshopping-cart + example: "https://www.pagerduty.com/service-directory/Pshopping-cart" minLength: 1 type: string required: - - serviceURL + - serviceURL type: object EntityV3DatadogLogItem: additionalProperties: false @@ -22806,15 +21980,14 @@ components: additionalProperties: false description: Logs association. items: - $ref: '#/components/schemas/EntityV3DatadogLogItem' + $ref: "#/components/schemas/EntityV3DatadogLogItem" type: array EntityV3DatadogPerformance: additionalProperties: false description: Performance stats association. properties: tags: - description: A list of APM entity tags that associates the APM Stats data - with the entity. + description: A list of APM entity tags that associates the APM Stats data with the entity. items: type: string type: array @@ -22824,8 +21997,7 @@ components: description: CI Pipelines association. properties: fingerprints: - description: A list of CI Fingerprints that associate CI Pipelines with - the entity. + description: A list of CI Fingerprints that associate CI Pipelines with the entity. items: type: string type: array @@ -22835,46 +22007,45 @@ components: description: Schema for datastore entities. properties: apiVersion: - $ref: '#/components/schemas/EntityV3APIVersion' + $ref: "#/components/schemas/EntityV3APIVersion" datadog: - $ref: '#/components/schemas/EntityV3DatastoreDatadog' + $ref: "#/components/schemas/EntityV3DatastoreDatadog" extensions: additionalProperties: {} - description: Custom extensions. This is the free-formed field to send client - side metadata. No Datadog features are affected by this field. + description: Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field. type: object integrations: - $ref: '#/components/schemas/EntityV3Integrations' + $ref: "#/components/schemas/EntityV3Integrations" kind: - $ref: '#/components/schemas/EntityV3DatastoreKind' + $ref: "#/components/schemas/EntityV3DatastoreKind" metadata: - $ref: '#/components/schemas/EntityV3Metadata' + $ref: "#/components/schemas/EntityV3Metadata" spec: - $ref: '#/components/schemas/EntityV3DatastoreSpec' + $ref: "#/components/schemas/EntityV3DatastoreSpec" required: - - apiVersion - - kind - - metadata + - apiVersion + - kind + - metadata type: object EntityV3DatastoreDatadog: additionalProperties: false description: Datadog product integrations for the datastore entity. properties: events: - $ref: '#/components/schemas/EntityV3DatadogEvents' + $ref: "#/components/schemas/EntityV3DatadogEvents" logs: - $ref: '#/components/schemas/EntityV3DatadogLogs' + $ref: "#/components/schemas/EntityV3DatadogLogs" performanceData: - $ref: '#/components/schemas/EntityV3DatadogPerformance' + $ref: "#/components/schemas/EntityV3DatadogPerformance" type: object EntityV3DatastoreKind: description: The definition of Entity V3 Datastore Kind object. enum: - - datastore + - datastore example: datastore type: string x-enum-varnames: - - DATASTORE + - DATASTORE EntityV3DatastoreSpec: additionalProperties: false description: The definition of Entity V3 Datastore Spec object. @@ -22901,9 +22072,9 @@ components: description: A base schema for defining third-party integrations. properties: opsgenie: - $ref: '#/components/schemas/EntityV3DatadogIntegrationOpsgenie' + $ref: "#/components/schemas/EntityV3DatadogIntegrationOpsgenie" pagerduty: - $ref: '#/components/schemas/EntityV3DatadogIntegrationPagerduty' + $ref: "#/components/schemas/EntityV3DatadogIntegrationPagerduty" type: object EntityV3Metadata: additionalProperties: false @@ -22913,25 +22084,22 @@ components: additionalProperties: false description: The additional owners of the entity, usually a team. items: - $ref: '#/components/schemas/EntityV3MetadataAdditionalOwnersItems' + $ref: "#/components/schemas/EntityV3MetadataAdditionalOwnersItems" type: array contacts: additionalProperties: false description: A list of contacts for the entity. items: - $ref: '#/components/schemas/EntityV3MetadataContactsItems' + $ref: "#/components/schemas/EntityV3MetadataContactsItems" type: array description: - description: Short description of the entity. The UI can leverage the description - for display. + description: Short description of the entity. The UI can leverage the description for display. type: string displayName: - description: User friendly name of the entity. The UI can leverage the display - name for display. + description: User friendly name of the entity. The UI can leverage the display name for display. type: string id: - description: A read-only globally unique identifier for the entity generated - by Datadog. User supplied values are ignored. + description: A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored. example: 4b163705-23c0-4573-b2fb-f6cea2163fcb minLength: 1 type: string @@ -22943,21 +22111,19 @@ components: additionalProperties: false description: A list of links for the entity. items: - $ref: '#/components/schemas/EntityV3MetadataLinksItems' + $ref: "#/components/schemas/EntityV3MetadataLinksItems" type: array managed: additionalProperties: {} - description: A read-only set of Datadog managed attributes generated by - Datadog. User supplied values are ignored. + description: A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored. type: object name: - description: Unique name given to an entity under the kind/namespace. + description: "Unique name given to an entity under the kind/namespace." example: myService minLength: 1 type: string namespace: - description: Namespace is a part of unique identifier. It has a default - value of 'default'. + description: "Namespace is a part of unique identifier. It has a default value of 'default'." example: default minLength: 1 type: string @@ -22966,27 +22132,25 @@ components: type: string tags: description: A set of custom tags. - example: - - this:tag - - that:tag + example: [this:tag, that:tag] items: type: string type: array required: - - name + - name type: object EntityV3MetadataAdditionalOwnersItems: description: The definition of Entity V3 Metadata Additional Owners Items object. properties: name: description: Team name. - example: '' + example: "" type: string type: description: Team type. type: string required: - - name + - name type: object EntityV3MetadataContactsItems: additionalProperties: false @@ -22994,7 +22158,7 @@ components: properties: contact: description: Contact value. - example: https://slack/ + example: "https://slack/" type: string name: description: Contact name. @@ -23005,8 +22169,8 @@ components: example: slack type: string required: - - type - - contact + - type + - contact type: object EntityV3MetadataLinksItems: additionalProperties: false @@ -23026,58 +22190,57 @@ components: type: string url: description: Link URL. - example: https://mylink + example: "https://mylink" type: string required: - - name - - type - - url + - name + - type + - url type: object EntityV3Queue: additionalProperties: false description: Schema for queue entities. properties: apiVersion: - $ref: '#/components/schemas/EntityV3APIVersion' + $ref: "#/components/schemas/EntityV3APIVersion" datadog: - $ref: '#/components/schemas/EntityV3QueueDatadog' + $ref: "#/components/schemas/EntityV3QueueDatadog" extensions: additionalProperties: {} - description: Custom extensions. This is the free-formed field to send client-side - metadata. No Datadog features are affected by this field. + description: Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. type: object integrations: - $ref: '#/components/schemas/EntityV3Integrations' + $ref: "#/components/schemas/EntityV3Integrations" kind: - $ref: '#/components/schemas/EntityV3QueueKind' + $ref: "#/components/schemas/EntityV3QueueKind" metadata: - $ref: '#/components/schemas/EntityV3Metadata' + $ref: "#/components/schemas/EntityV3Metadata" spec: - $ref: '#/components/schemas/EntityV3QueueSpec' + $ref: "#/components/schemas/EntityV3QueueSpec" required: - - apiVersion - - kind - - metadata + - apiVersion + - kind + - metadata type: object EntityV3QueueDatadog: additionalProperties: false description: Datadog product integrations for the datastore entity. properties: events: - $ref: '#/components/schemas/EntityV3DatadogEvents' + $ref: "#/components/schemas/EntityV3DatadogEvents" logs: - $ref: '#/components/schemas/EntityV3DatadogLogs' + $ref: "#/components/schemas/EntityV3DatadogLogs" performanceData: - $ref: '#/components/schemas/EntityV3DatadogPerformance' + $ref: "#/components/schemas/EntityV3DatadogPerformance" type: object EntityV3QueueKind: description: The definition of Entity V3 Queue Kind object. enum: - - queue + - queue example: queue type: string x-enum-varnames: - - QUEUE + - QUEUE EntityV3QueueSpec: additionalProperties: false description: The definition of Entity V3 Queue Spec object. @@ -23104,50 +22267,49 @@ components: description: Schema for service entities. properties: apiVersion: - $ref: '#/components/schemas/EntityV3APIVersion' + $ref: "#/components/schemas/EntityV3APIVersion" datadog: - $ref: '#/components/schemas/EntityV3ServiceDatadog' + $ref: "#/components/schemas/EntityV3ServiceDatadog" extensions: additionalProperties: {} - description: Custom extensions. This is the free-formed field to send client-side - metadata. No Datadog features are affected by this field. + description: Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. type: object integrations: - $ref: '#/components/schemas/EntityV3Integrations' + $ref: "#/components/schemas/EntityV3Integrations" kind: - $ref: '#/components/schemas/EntityV3ServiceKind' + $ref: "#/components/schemas/EntityV3ServiceKind" metadata: - $ref: '#/components/schemas/EntityV3Metadata' + $ref: "#/components/schemas/EntityV3Metadata" spec: - $ref: '#/components/schemas/EntityV3ServiceSpec' + $ref: "#/components/schemas/EntityV3ServiceSpec" required: - - apiVersion - - kind - - metadata + - apiVersion + - kind + - metadata type: object EntityV3ServiceDatadog: additionalProperties: false description: Datadog product integrations for the service entity. properties: codeLocations: - $ref: '#/components/schemas/EntityV3DatadogCodeLocations' + $ref: "#/components/schemas/EntityV3DatadogCodeLocations" events: - $ref: '#/components/schemas/EntityV3DatadogEvents' + $ref: "#/components/schemas/EntityV3DatadogEvents" logs: - $ref: '#/components/schemas/EntityV3DatadogLogs' + $ref: "#/components/schemas/EntityV3DatadogLogs" performanceData: - $ref: '#/components/schemas/EntityV3DatadogPerformance' + $ref: "#/components/schemas/EntityV3DatadogPerformance" pipelines: - $ref: '#/components/schemas/EntityV3DatadogPipelines' + $ref: "#/components/schemas/EntityV3DatadogPipelines" type: object EntityV3ServiceKind: description: The definition of Entity V3 Service Kind object. enum: - - service + - service example: service type: string x-enum-varnames: - - SERVICE + - SERVICE EntityV3ServiceSpec: additionalProperties: false description: The definition of Entity V3 Service Spec object. @@ -23184,48 +22346,47 @@ components: description: Schema for system entities. properties: apiVersion: - $ref: '#/components/schemas/EntityV3APIVersion' + $ref: "#/components/schemas/EntityV3APIVersion" datadog: - $ref: '#/components/schemas/EntityV3SystemDatadog' + $ref: "#/components/schemas/EntityV3SystemDatadog" extensions: additionalProperties: {} - description: Custom extensions. This is the free-formed field to send client-side - metadata. No Datadog features are affected by this field. + description: Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. type: object integrations: - $ref: '#/components/schemas/EntityV3Integrations' + $ref: "#/components/schemas/EntityV3Integrations" kind: - $ref: '#/components/schemas/EntityV3SystemKind' + $ref: "#/components/schemas/EntityV3SystemKind" metadata: - $ref: '#/components/schemas/EntityV3Metadata' + $ref: "#/components/schemas/EntityV3Metadata" spec: - $ref: '#/components/schemas/EntityV3SystemSpec' + $ref: "#/components/schemas/EntityV3SystemSpec" required: - - apiVersion - - kind - - metadata + - apiVersion + - kind + - metadata type: object EntityV3SystemDatadog: additionalProperties: false description: Datadog product integrations for the service entity. properties: events: - $ref: '#/components/schemas/EntityV3DatadogEvents' + $ref: "#/components/schemas/EntityV3DatadogEvents" logs: - $ref: '#/components/schemas/EntityV3DatadogLogs' + $ref: "#/components/schemas/EntityV3DatadogLogs" performanceData: - $ref: '#/components/schemas/EntityV3DatadogPerformance' + $ref: "#/components/schemas/EntityV3DatadogPerformance" pipelines: - $ref: '#/components/schemas/EntityV3DatadogPipelines' + $ref: "#/components/schemas/EntityV3DatadogPipelines" type: object EntityV3SystemKind: description: The definition of Entity V3 System Kind object. enum: - - system + - system example: system type: string x-enum-varnames: - - SYSTEM + - SYSTEM EntityV3SystemSpec: additionalProperties: false description: The definition of Entity V3 System Spec object. @@ -23249,13 +22410,13 @@ components: properties: fallbackStepName: description: The `ErrorHandler` `fallbackStepName`. - example: '' + example: "" type: string retryStrategy: - $ref: '#/components/schemas/RetryStrategy' + $ref: "#/components/schemas/RetryStrategy" required: - - retryStrategy - - fallbackStepName + - retryStrategy + - fallbackStepName type: object Escalation: description: Represents an escalation policy step. @@ -23264,15 +22425,14 @@ components: description: Unique identifier of the escalation step. type: string relationships: - $ref: '#/components/schemas/EscalationRelationships' + $ref: "#/components/schemas/EscalationRelationships" type: - $ref: '#/components/schemas/EscalationType' + $ref: "#/components/schemas/EscalationType" required: - - type + - type type: object EscalationPolicy: - description: Represents a complete escalation policy response, including policy - data and optionally included related resources. + description: "Represents a complete escalation policy response, including policy data and optionally included related resources." example: data: attributes: @@ -23283,65 +22443,63 @@ components: relationships: steps: data: - - id: 00000000-aba1-0000-0000-000000000000 - type: steps + - id: 00000000-aba1-0000-0000-000000000000 + type: steps teams: data: - - id: 00000000-da3a-0000-0000-000000000000 - type: teams + - id: 00000000-da3a-0000-0000-000000000000 + type: teams type: policies included: - - attributes: - avatar: '' - description: Team 1 description - handle: team1 - name: Team 1 - id: 00000000-da3a-0000-0000-000000000000 - type: teams - - attributes: - assignment: default - escalate_after_seconds: 3600 - id: 00000000-aba1-0000-0000-000000000000 - relationships: - targets: - data: - - id: 00000000-aba1-0000-0000-000000000000 - type: users - - id: 00000000-aba2-0000-0000-000000000000 - type: schedules - - id: 00000000-aba2-0000-0000-000000000000_previous - type: schedule_target - - id: 00000000-aba3-0000-0000-000000000000 - type: teams - type: steps - - id: 00000000-aba1-0000-0000-000000000000 - type: users - - id: 00000000-aba2-0000-0000-000000000000 - type: schedules - - attributes: - position: previous - id: 00000000-aba2-0000-0000-000000000000_previous - relationships: - schedule: - data: - id: 00000000-aba2-0000-0000-000000000000 - type: schedules - type: schedule_target - - id: 00000000-aba3-0000-0000-000000000000 - type: teams + - attributes: + avatar: "" + description: Team 1 description + handle: team1 + name: Team 1 + id: 00000000-da3a-0000-0000-000000000000 + type: teams + - attributes: + assignment: default + escalate_after_seconds: 3600 + id: 00000000-aba1-0000-0000-000000000000 + relationships: + targets: + data: + - id: 00000000-aba1-0000-0000-000000000000 + type: users + - id: 00000000-aba2-0000-0000-000000000000 + type: schedules + - id: 00000000-aba2-0000-0000-000000000000_previous + type: schedule_target + - id: 00000000-aba3-0000-0000-000000000000 + type: teams + type: steps + - id: 00000000-aba1-0000-0000-000000000000 + type: users + - id: 00000000-aba2-0000-0000-000000000000 + type: schedules + - attributes: + position: previous + id: 00000000-aba2-0000-0000-000000000000_previous + relationships: + schedule: + data: + id: 00000000-aba2-0000-0000-000000000000 + type: schedules + type: schedule_target + - id: 00000000-aba3-0000-0000-000000000000 + type: teams properties: data: - $ref: '#/components/schemas/EscalationPolicyData' + $ref: "#/components/schemas/EscalationPolicyData" included: - description: Provides any included related resources, such as steps or targets, - returned with the policy. + description: "Provides any included related resources, such as steps or targets, returned with the policy." items: - $ref: '#/components/schemas/EscalationPolicyIncluded' + $ref: "#/components/schemas/EscalationPolicyIncluded" type: array type: object EscalationPolicyCreateRequest: - description: Represents a request to create a new escalation policy, including - the policy data. + description: "Represents a request to create a new escalation policy, including the policy data." example: data: attributes: @@ -23349,321 +22507,296 @@ components: resolve_page_on_policy_end: true retries: 2 steps: - - assignment: default - escalate_after_seconds: 3600 - targets: - - id: 00000000-aba1-0000-0000-000000000000 - type: users - - config: - schedule: - position: previous - id: 00000000-aba2-0000-0000-000000000000 - type: schedules - - id: 00000000-aba3-0000-0000-000000000000 - type: teams - - assignment: round-robin - escalate_after_seconds: 3600 - targets: - - id: 00000000-aba1-0000-0000-000000000000 - type: users - - id: 00000000-abb1-0000-0000-000000000000 - type: users + - assignment: default + escalate_after_seconds: 3600 + targets: + - id: 00000000-aba1-0000-0000-000000000000 + type: users + - config: + schedule: + position: previous + id: 00000000-aba2-0000-0000-000000000000 + type: schedules + - id: 00000000-aba3-0000-0000-000000000000 + type: teams + - assignment: round-robin + escalate_after_seconds: 3600 + targets: + - id: 00000000-aba1-0000-0000-000000000000 + type: users + - id: 00000000-abb1-0000-0000-000000000000 + type: users relationships: teams: data: - - id: 00000000-da3a-0000-0000-000000000000 - type: teams + - id: 00000000-da3a-0000-0000-000000000000 + type: teams type: policies properties: data: - $ref: '#/components/schemas/EscalationPolicyCreateRequestData' + $ref: "#/components/schemas/EscalationPolicyCreateRequestData" required: - - data + - data type: object EscalationPolicyCreateRequestData: - description: Represents the data for creating an escalation policy, including - its attributes, relationships, and resource type. + description: "Represents the data for creating an escalation policy, including its attributes, relationships, and resource type." properties: attributes: - $ref: '#/components/schemas/EscalationPolicyCreateRequestDataAttributes' + $ref: "#/components/schemas/EscalationPolicyCreateRequestDataAttributes" relationships: - $ref: '#/components/schemas/EscalationPolicyCreateRequestDataRelationships' + $ref: "#/components/schemas/EscalationPolicyCreateRequestDataRelationships" type: - $ref: '#/components/schemas/EscalationPolicyCreateRequestDataType' + $ref: "#/components/schemas/EscalationPolicyCreateRequestDataType" required: - - type - - attributes + - type + - attributes type: object EscalationPolicyCreateRequestDataAttributes: - description: Defines the attributes for creating an escalation policy, including - its description, name, resolution behavior, retries, and steps. + description: "Defines the attributes for creating an escalation policy, including its description, name, resolution behavior, retries, and steps." properties: name: - description: Specifies the name for the new escalation policy. - example: On-Call Escalation Policy + description: "Specifies the name for the new escalation policy." + example: "On-Call Escalation Policy" minLength: 1 type: string resolve_page_on_policy_end: - description: Indicates whether the page is automatically resolved when the - policy ends. + description: "Indicates whether the page is automatically resolved when the policy ends." type: boolean retries: - description: Specifies how many times the escalation sequence is retried - if there is no response. + description: "Specifies how many times the escalation sequence is retried if there is no response." format: int64 maximum: 10 minimum: 0 type: integer steps: - description: A list of escalation steps, each defining assignment, escalation - timeout, and targets for the new policy. + description: "A list of escalation steps, each defining assignment, escalation timeout, and targets for the new policy." items: - $ref: '#/components/schemas/EscalationPolicyCreateRequestDataAttributesStepsItems' + $ref: "#/components/schemas/EscalationPolicyCreateRequestDataAttributesStepsItems" maxItems: 10 minItems: 1 type: array required: - - name - - steps + - name + - steps type: object EscalationPolicyCreateRequestDataAttributesStepsItems: - description: Defines a single escalation step within an escalation policy creation - request. Contains assignment strategy, escalation timeout, and a list of targets. + description: "Defines a single escalation step within an escalation policy creation request. Contains assignment strategy, escalation timeout, and a list of targets." properties: assignment: - $ref: '#/components/schemas/EscalationPolicyStepAttributesAssignment' + $ref: "#/components/schemas/EscalationPolicyStepAttributesAssignment" escalate_after_seconds: - description: Defines how many seconds to wait before escalating to the next - step. + description: "Defines how many seconds to wait before escalating to the next step." example: 3600 format: int64 maximum: 36000 minimum: 60 type: integer targets: - description: Specifies the collection of escalation targets for this step. + description: "Specifies the collection of escalation targets for this step." example: - - users + - "users" items: - $ref: '#/components/schemas/EscalationPolicyStepTarget' + $ref: "#/components/schemas/EscalationPolicyStepTarget" type: array required: - - targets + - targets type: object EscalationPolicyCreateRequestDataRelationships: - description: Represents relationships in an escalation policy creation request, - including references to teams. + description: "Represents relationships in an escalation policy creation request, including references to teams." properties: teams: - $ref: '#/components/schemas/DataRelationshipsTeams' + $ref: "#/components/schemas/DataRelationshipsTeams" type: object EscalationPolicyCreateRequestDataType: default: policies - description: Indicates that the resource is of type `policies`. + description: "Indicates that the resource is of type `policies`." enum: - - policies + - policies example: policies type: string x-enum-varnames: - - POLICIES + - POLICIES EscalationPolicyData: - description: Represents the data for a single escalation policy, including its - attributes, ID, relationships, and resource type. + description: "Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type." properties: attributes: - $ref: '#/components/schemas/EscalationPolicyDataAttributes' + $ref: "#/components/schemas/EscalationPolicyDataAttributes" id: - description: Specifies the unique identifier of the escalation policy. - example: ab000000-0000-0000-0000-000000000000 + description: "Specifies the unique identifier of the escalation policy." + example: "ab000000-0000-0000-0000-000000000000" type: string relationships: - $ref: '#/components/schemas/EscalationPolicyDataRelationships' + $ref: "#/components/schemas/EscalationPolicyDataRelationships" type: - $ref: '#/components/schemas/EscalationPolicyDataType' + $ref: "#/components/schemas/EscalationPolicyDataType" required: - - type + - type type: object EscalationPolicyDataAttributes: - description: Defines the main attributes of an escalation policy, such as its - name and behavior on policy end. + description: "Defines the main attributes of an escalation policy, such as its name and behavior on policy end." properties: name: - description: Specifies the name of the escalation policy. - example: On-Call Escalation Policy + description: "Specifies the name of the escalation policy." + example: "On-Call Escalation Policy" minLength: 1 type: string resolve_page_on_policy_end: - description: Indicates whether the page is automatically resolved when the - policy ends. + description: "Indicates whether the page is automatically resolved when the policy ends." type: boolean retries: - description: Specifies how many times the escalation sequence is retried - if there is no response. + description: "Specifies how many times the escalation sequence is retried if there is no response." format: int64 maximum: 10 minimum: 0 type: integer required: - - name + - name type: object EscalationPolicyDataRelationships: - description: Represents the relationships for an escalation policy, including - references to steps and teams. + description: "Represents the relationships for an escalation policy, including references to steps and teams." properties: steps: - $ref: '#/components/schemas/EscalationPolicyDataRelationshipsSteps' + $ref: "#/components/schemas/EscalationPolicyDataRelationshipsSteps" teams: - $ref: '#/components/schemas/DataRelationshipsTeams' + $ref: "#/components/schemas/DataRelationshipsTeams" required: - - steps + - steps type: object EscalationPolicyDataRelationshipsSteps: - description: Defines the relationship to a collection of steps within an escalation - policy. Contains an array of step data references. + description: "Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references." properties: data: - description: An array of references to the steps defined in this escalation - policy. + description: "An array of references to the steps defined in this escalation policy." items: - $ref: '#/components/schemas/EscalationPolicyDataRelationshipsStepsDataItems' + $ref: "#/components/schemas/EscalationPolicyDataRelationshipsStepsDataItems" type: array type: object EscalationPolicyDataRelationshipsStepsDataItems: - description: Defines a relationship to a single step within an escalation policy. - Contains the step's `id` and `type`. + description: "Defines a relationship to a single step within an escalation policy. Contains the step's `id` and `type`." properties: id: - description: Specifies the unique identifier for the step resource. - example: 00000000-aba1-0000-0000-000000000000 + description: "Specifies the unique identifier for the step resource." + example: "00000000-aba1-0000-0000-000000000000" type: string type: - $ref: '#/components/schemas/EscalationPolicyDataRelationshipsStepsDataItemsType' + $ref: "#/components/schemas/EscalationPolicyDataRelationshipsStepsDataItemsType" required: - - type - - id + - type + - id type: object EscalationPolicyDataRelationshipsStepsDataItemsType: default: steps - description: Indicates that the resource is of type `steps`. + description: "Indicates that the resource is of type `steps`." enum: - - steps + - steps example: steps type: string x-enum-varnames: - - STEPS + - STEPS EscalationPolicyDataType: default: policies - description: Indicates that the resource is of type `policies`. + description: "Indicates that the resource is of type `policies`." enum: - - policies + - policies example: policies type: string x-enum-varnames: - - POLICIES + - POLICIES EscalationPolicyIncluded: - description: Represents included related resources when retrieving an escalation - policy, such as teams, steps, or targets. + description: "Represents included related resources when retrieving an escalation policy, such as teams, steps, or targets." oneOf: - - $ref: '#/components/schemas/EscalationPolicyStep' - - $ref: '#/components/schemas/EscalationPolicyUser' - - $ref: '#/components/schemas/ScheduleData' - - $ref: '#/components/schemas/ConfiguredSchedule' - - $ref: '#/components/schemas/TeamReference' + - $ref: "#/components/schemas/EscalationPolicyStep" + - $ref: "#/components/schemas/EscalationPolicyUser" + - $ref: "#/components/schemas/ScheduleData" + - $ref: "#/components/schemas/ConfiguredSchedule" + - $ref: "#/components/schemas/TeamReference" EscalationPolicyStep: - description: Represents a single step in an escalation policy, including its - attributes, relationships, and resource type. + description: "Represents a single step in an escalation policy, including its attributes, relationships, and resource type." properties: attributes: - $ref: '#/components/schemas/EscalationPolicyStepAttributes' + $ref: "#/components/schemas/EscalationPolicyStepAttributes" id: - description: Specifies the unique identifier of this escalation policy step. + description: "Specifies the unique identifier of this escalation policy step." type: string relationships: - $ref: '#/components/schemas/EscalationPolicyStepRelationships' + $ref: "#/components/schemas/EscalationPolicyStepRelationships" type: - $ref: '#/components/schemas/EscalationPolicyStepType' + $ref: "#/components/schemas/EscalationPolicyStepType" required: - - type + - type type: object EscalationPolicyStepAttributes: - description: Defines attributes for an escalation policy step, such as assignment - strategy and escalation timeout. + description: "Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout." properties: assignment: - $ref: '#/components/schemas/EscalationPolicyStepAttributesAssignment' + $ref: "#/components/schemas/EscalationPolicyStepAttributesAssignment" escalate_after_seconds: - description: Specifies how many seconds to wait before escalating to the - next step. + description: "Specifies how many seconds to wait before escalating to the next step." format: int64 type: integer type: object EscalationPolicyStepAttributesAssignment: - description: Specifies how this escalation step will assign targets (example - `default` or `round-robin`). + description: "Specifies how this escalation step will assign targets (example `default` or `round-robin`)." enum: - - default - - round-robin + - default + - round-robin type: string x-enum-varnames: - - DEFAULT - - ROUND_ROBIN + - DEFAULT + - ROUND_ROBIN EscalationPolicyStepRelationships: - description: Represents the relationship of an escalation policy step to its - targets. + description: "Represents the relationship of an escalation policy step to its targets." properties: targets: - $ref: '#/components/schemas/EscalationTargets' + $ref: "#/components/schemas/EscalationTargets" type: object EscalationPolicyStepTarget: - description: Defines a single escalation target within a step for an escalation - policy creation request. Contains `id`, `type`, and optional `config`. + description: "Defines a single escalation target within a step for an escalation policy creation request. Contains `id`, `type`, and optional `config`." properties: config: - $ref: '#/components/schemas/EscalationPolicyStepTargetConfig' + $ref: "#/components/schemas/EscalationPolicyStepTargetConfig" id: - description: Specifies the unique identifier for this target. - example: 00000000-aba1-0000-0000-000000000000 + description: "Specifies the unique identifier for this target." + example: "00000000-aba1-0000-0000-000000000000" type: string type: - $ref: '#/components/schemas/EscalationPolicyStepTargetType' + $ref: "#/components/schemas/EscalationPolicyStepTargetType" type: object EscalationPolicyStepTargetConfig: - description: Configuration for an escalation target, such as schedule position. + description: "Configuration for an escalation target, such as schedule position." properties: schedule: - $ref: '#/components/schemas/EscalationPolicyStepTargetConfigSchedule' + $ref: "#/components/schemas/EscalationPolicyStepTargetConfigSchedule" type: object EscalationPolicyStepTargetConfigSchedule: - description: Schedule-specific configuration for an escalation target. + description: "Schedule-specific configuration for an escalation target." properties: position: - $ref: '#/components/schemas/ScheduleTargetPosition' + $ref: "#/components/schemas/ScheduleTargetPosition" type: object EscalationPolicyStepTargetType: - description: Specifies the type of escalation target (example `users`, `schedules`, - or `teams`). + description: "Specifies the type of escalation target (example `users`, `schedules`, or `teams`)." enum: - - users - - schedules - - teams - example: users + - users + - schedules + - teams + example: "users" type: string x-enum-varnames: - - USERS - - SCHEDULES - - TEAMS + - USERS + - SCHEDULES + - TEAMS EscalationPolicyStepType: default: steps - description: Indicates that the resource is of type `steps`. + description: "Indicates that the resource is of type `steps`." enum: - - steps + - steps example: steps type: string x-enum-varnames: - - STEPS + - STEPS EscalationPolicyUpdateRequest: - description: Represents a request to update an existing escalation policy, including - the updated policy data. + description: "Represents a request to update an existing escalation policy, including the updated policy data." example: data: attributes: @@ -23671,175 +22804,162 @@ components: resolve_page_on_policy_end: false retries: 2 steps: - - assignment: default - escalate_after_seconds: 3600 - id: 00000000-aba1-0000-0000-000000000000 - targets: - - id: 00000000-aba1-0000-0000-000000000000 - type: users - - id: 00000000-aba2-0000-0000-000000000000 - type: schedules + - assignment: default + escalate_after_seconds: 3600 + id: 00000000-aba1-0000-0000-000000000000 + targets: + - id: 00000000-aba1-0000-0000-000000000000 + type: users + - id: 00000000-aba2-0000-0000-000000000000 + type: schedules id: a3000000-0000-0000-0000-000000000000 relationships: teams: data: - - id: 00000000-da3a-0000-0000-000000000000 - type: teams + - id: 00000000-da3a-0000-0000-000000000000 + type: teams type: policies properties: data: - $ref: '#/components/schemas/EscalationPolicyUpdateRequestData' + $ref: "#/components/schemas/EscalationPolicyUpdateRequestData" required: - - data + - data type: object EscalationPolicyUpdateRequestData: - description: Represents the data for updating an existing escalation policy, - including its ID, attributes, relationships, and resource type. + description: "Represents the data for updating an existing escalation policy, including its ID, attributes, relationships, and resource type." properties: attributes: - $ref: '#/components/schemas/EscalationPolicyUpdateRequestDataAttributes' + $ref: "#/components/schemas/EscalationPolicyUpdateRequestDataAttributes" id: - description: Specifies the unique identifier of the escalation policy being - updated. - example: 00000000-aba1-0000-0000-000000000000 + description: "Specifies the unique identifier of the escalation policy being updated." + example: "00000000-aba1-0000-0000-000000000000" type: string relationships: - $ref: '#/components/schemas/EscalationPolicyUpdateRequestDataRelationships' + $ref: "#/components/schemas/EscalationPolicyUpdateRequestDataRelationships" type: - $ref: '#/components/schemas/EscalationPolicyUpdateRequestDataType' + $ref: "#/components/schemas/EscalationPolicyUpdateRequestDataType" required: - - type - - id - - attributes + - type + - id + - attributes type: object EscalationPolicyUpdateRequestDataAttributes: - description: Defines the attributes that can be updated for an escalation policy, - such as description, name, resolution behavior, retries, and steps. + description: "Defines the attributes that can be updated for an escalation policy, such as description, name, resolution behavior, retries, and steps." properties: name: - description: Specifies the name of the escalation policy. - example: On-Call Escalation Policy + description: "Specifies the name of the escalation policy." + example: "On-Call Escalation Policy" minLength: 1 type: string resolve_page_on_policy_end: - description: Indicates whether the page is automatically resolved when the - policy ends. + description: "Indicates whether the page is automatically resolved when the policy ends." type: boolean retries: - description: Specifies how many times the escalation sequence is retried - if there is no response. + description: "Specifies how many times the escalation sequence is retried if there is no response." format: int64 maximum: 10 minimum: 0 type: integer steps: - description: A list of escalation steps, each defining assignment, escalation - timeout, and targets. + description: "A list of escalation steps, each defining assignment, escalation timeout, and targets." items: - $ref: '#/components/schemas/EscalationPolicyUpdateRequestDataAttributesStepsItems' + $ref: "#/components/schemas/EscalationPolicyUpdateRequestDataAttributesStepsItems" maxItems: 10 minItems: 1 type: array required: - - name - - steps + - name + - steps type: object EscalationPolicyUpdateRequestDataAttributesStepsItems: - description: Defines a single escalation step within an escalation policy update - request. Contains assignment strategy, escalation timeout, an optional step - ID, and a list of targets. + description: "Defines a single escalation step within an escalation policy update request. Contains assignment strategy, escalation timeout, an optional step ID, and a list of targets." properties: assignment: - $ref: '#/components/schemas/EscalationPolicyStepAttributesAssignment' + $ref: "#/components/schemas/EscalationPolicyStepAttributesAssignment" escalate_after_seconds: - description: Defines how many seconds to wait before escalating to the next - step. + description: "Defines how many seconds to wait before escalating to the next step." example: 3600 format: int64 maximum: 36000 minimum: 60 type: integer id: - description: Specifies the unique identifier of this step. - example: 00000000-aba1-0000-0000-000000000000 + description: "Specifies the unique identifier of this step." + example: "00000000-aba1-0000-0000-000000000000" type: string targets: - description: Specifies the collection of escalation targets for this step. + description: "Specifies the collection of escalation targets for this step." items: - $ref: '#/components/schemas/EscalationPolicyStepTarget' + $ref: "#/components/schemas/EscalationPolicyStepTarget" type: array required: - - targets + - targets type: object EscalationPolicyUpdateRequestDataRelationships: - description: Represents relationships in an escalation policy update request, - including references to teams. + description: "Represents relationships in an escalation policy update request, including references to teams." properties: teams: - $ref: '#/components/schemas/DataRelationshipsTeams' + $ref: "#/components/schemas/DataRelationshipsTeams" type: object EscalationPolicyUpdateRequestDataType: default: policies - description: Indicates that the resource is of type `policies`. + description: "Indicates that the resource is of type `policies`." enum: - - policies + - policies example: policies type: string x-enum-varnames: - - POLICIES + - POLICIES EscalationPolicyUser: - description: Represents a user object in the context of an escalation policy, - including their `id`, type, and basic attributes. + description: Represents a user object in the context of an escalation policy, including their `id`, type, and basic attributes. properties: attributes: - $ref: '#/components/schemas/EscalationPolicyUserAttributes' + $ref: "#/components/schemas/EscalationPolicyUserAttributes" id: description: The unique user identifier. type: string type: - $ref: '#/components/schemas/EscalationPolicyUserType' + $ref: "#/components/schemas/EscalationPolicyUserType" required: - - type + - type type: object EscalationPolicyUserAttributes: - description: Provides basic user information for an escalation policy, including - a name and email address. + description: Provides basic user information for an escalation policy, including a name and email address. properties: email: description: The user's email address. - example: jane.doe@example.com + example: "jane.doe@example.com" type: string name: description: The user's name. - example: Jane Doe + example: "Jane Doe" type: string status: - $ref: '#/components/schemas/UserAttributesStatus' + $ref: "#/components/schemas/UserAttributesStatus" type: object EscalationPolicyUserType: default: users - description: Users resource type. + description: |- + Users resource type. enum: - - users + - users example: users type: string x-enum-varnames: - - USERS + - USERS EscalationRelationships: - description: Contains the relationships of an escalation object, including its - responders. + description: Contains the relationships of an escalation object, including its responders. properties: responders: - $ref: '#/components/schemas/EscalationRelationshipsResponders' + $ref: "#/components/schemas/EscalationRelationshipsResponders" type: object EscalationRelationshipsResponders: description: Lists the users involved in a specific step of the escalation policy. properties: data: - description: Array of user references assigned as responders for this escalation - step. + description: Array of user references assigned as responders for this escalation step. items: - $ref: '#/components/schemas/EscalationRelationshipsRespondersDataItems' + $ref: "#/components/schemas/EscalationRelationshipsRespondersDataItems" type: array type: object EscalationRelationshipsRespondersDataItems: @@ -23847,61 +22967,55 @@ components: properties: id: description: Unique identifier of the user assigned to the escalation step. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/EscalationRelationshipsRespondersDataItemsType' + $ref: "#/components/schemas/EscalationRelationshipsRespondersDataItemsType" required: - - type - - id + - type + - id type: object EscalationRelationshipsRespondersDataItemsType: default: users - description: Represents the resource type for users assigned as responders in - an escalation step. + description: Represents the resource type for users assigned as responders in an escalation step. enum: - - users + - users example: users type: string x-enum-varnames: - - USERS + - USERS EscalationTarget: - description: Represents an escalation target, which can be a team, user, schedule, - or configured schedule target. + description: "Represents an escalation target, which can be a team, user, schedule, or configured schedule target." oneOf: - - $ref: '#/components/schemas/TeamTarget' - - $ref: '#/components/schemas/UserTarget' - - $ref: '#/components/schemas/ScheduleTarget' - - $ref: '#/components/schemas/ConfiguredScheduleTarget' + - $ref: "#/components/schemas/TeamTarget" + - $ref: "#/components/schemas/UserTarget" + - $ref: "#/components/schemas/ScheduleTarget" + - $ref: "#/components/schemas/ConfiguredScheduleTarget" EscalationTargets: - description: A list of escalation targets for a step + description: "A list of escalation targets for a step" properties: data: description: The `EscalationTargets` `data`. items: - $ref: '#/components/schemas/EscalationTarget' + $ref: "#/components/schemas/EscalationTarget" type: array type: object EscalationType: default: escalation_policy_steps - description: Represents the resource type for individual steps in an escalation - policy used during incident response. + description: Represents the resource type for individual steps in an escalation policy used during incident response. enum: - - escalation_policy_steps + - escalation_policy_steps example: escalation_policy_steps type: string x-enum-varnames: - - ESCALATION_POLICY_STEPS + - ESCALATION_POLICY_STEPS Estimation: - description: Recommended resource values for a Spark driver or executor, derived - from recent real usage metrics. Used by SPA to propose more efficient pod - sizing. + description: Recommended resource values for a Spark driver or executor, derived from recent real usage metrics. Used by SPA to propose more efficient pod sizing. properties: cpu: - $ref: '#/components/schemas/Cpu' + $ref: "#/components/schemas/Cpu" ephemeral_storage: - description: Recommended ephemeral storage allocation (in MiB). Derived - from job temporary storage patterns. + description: Recommended ephemeral storage allocation (in MiB). Derived from job temporary storage patterns. format: int64 type: integer heap: @@ -23909,13 +23023,11 @@ components: format: int64 type: integer memory: - description: Recommended total memory allocation (in MiB). Includes both - heap and overhead. + description: Recommended total memory allocation (in MiB). Includes both heap and overhead. format: int64 type: integer overhead: - description: Recommended JVM overhead (in MiB). Computed as total memory - - heap. + description: Recommended JVM overhead (in MiB). Computed as total memory - heap. format: int64 type: integer type: object @@ -23924,7 +23036,7 @@ components: properties: id: description: Event ID. - example: '6509751066204996294' + example: "6509751066204996294" type: string name: description: The event name. @@ -23936,7 +23048,7 @@ components: type: integer type: description: Event type. - example: error_tracking_alert + example: "error_tracking_alert" type: string type: object EventAttributes: @@ -23946,33 +23058,31 @@ components: description: Aggregation key of the event. type: string date_happened: - description: 'POSIX timestamp of the event. Must be sent as an integer (no - quotation marks). - - Limited to events no older than 18 hours.' + description: |- + POSIX timestamp of the event. Must be sent as an integer (no quotation marks). + Limited to events no older than 18 hours. format: int64 type: integer device_name: description: A device name. type: string duration: - description: The duration between the triggering of the event and its recovery - in nanoseconds. + description: The duration between the triggering of the event and its recovery in nanoseconds. format: int64 type: integer event_object: description: The event title. - example: Did you hear the news today? + example: "Did you hear the news today?" type: string evt: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" hostname: - description: 'Host name to associate with the event. - - Any tags associated with the host are also applied to this event.' + description: |- + Host name to associate with the event. + Any tags associated with the host are also applied to this event. type: string monitor: - $ref: '#/components/schemas/MonitorType' + $ref: "#/components/schemas/MonitorType" monitor_groups: description: List of groups referred to in the event. items: @@ -23981,39 +23091,34 @@ components: nullable: true type: array monitor_id: - description: ID of the monitor that triggered the event. When an event isn't - related to a monitor, this field is empty. + description: ID of the monitor that triggered the event. When an event isn't related to a monitor, this field is empty. format: int64 nullable: true type: integer priority: - $ref: '#/components/schemas/EventPriority' + $ref: "#/components/schemas/EventPriority" related_event_id: description: Related event ID. format: int64 type: integer service: description: Service that triggered the event. - example: datadog-api + example: "datadog-api" type: string source_type_name: - description: 'The type of event being posted. - - For example, `nagios`, `hudson`, `jenkins`, `my_apps`, `chef`, `puppet`, - `git` or `bitbucket`. - - The list of standard source attribute values is [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).' + description: |- + The type of event being posted. + For example, `nagios`, `hudson`, `jenkins`, `my_apps`, `chef`, `puppet`, `git` or `bitbucket`. + The list of standard source attribute values is [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). type: string sourcecategory: - description: Identifier for the source of the event, such as a monitor alert, - an externally-submitted event, or an integration. + description: Identifier for the source of the event, such as a monitor alert, an externally-submitted event, or an integration. type: string status: - $ref: '#/components/schemas/EventStatusType' + $ref: "#/components/schemas/EventStatusType" tags: description: A list of tags to apply to the event. - example: - - environment:test + example: ["environment:test"] items: description: A tag. type: string @@ -24025,95 +23130,97 @@ components: type: integer title: description: The event title. - example: Oh boy! + example: "Oh boy!" type: string type: object EventCategory: - description: Event category identifying the type of event. + description: |- + Event category identifying the type of event. enum: - - change - - alert + - change + - alert example: change type: string x-enum-varnames: - - CHANGE - - ALERT + - CHANGE + - ALERT EventCreateRequest: description: An event object. properties: attributes: - $ref: '#/components/schemas/EventPayload' + $ref: "#/components/schemas/EventPayload" type: - $ref: '#/components/schemas/EventCreateRequestType' + $ref: "#/components/schemas/EventCreateRequestType" required: - - type - - attributes + - type + - attributes type: object EventCreateRequestPayload: description: Payload for creating an event. properties: data: - $ref: '#/components/schemas/EventCreateRequest' + $ref: "#/components/schemas/EventCreateRequest" required: - - data + - data type: object EventCreateRequestType: description: Entity type. enum: - - event - example: event + - event + example: "event" type: string x-enum-varnames: - - EVENT + - EVENT EventCreateResponse: description: Event object. properties: attributes: - $ref: '#/components/schemas/EventCreateResponseAttributes' + $ref: "#/components/schemas/EventCreateResponseAttributes" type: description: Entity type. - example: event + example: "event" type: string type: object EventCreateResponseAttributes: description: Event attributes. properties: attributes: - $ref: '#/components/schemas/EventCreateResponseAttributesAttributes' + $ref: "#/components/schemas/EventCreateResponseAttributesAttributes" type: object EventCreateResponseAttributesAttributes: description: JSON object for category-specific attributes. properties: evt: - $ref: '#/components/schemas/EventCreateResponseAttributesAttributesEvt' + $ref: "#/components/schemas/EventCreateResponseAttributesAttributesEvt" type: object EventCreateResponseAttributesAttributesEvt: description: JSON object of event system attributes. properties: id: deprecated: true - description: Event identifier. This field is deprecated and will be removed - in a future version. Use the `uid` field instead. + description: |- + Event identifier. This field is deprecated and will be removed in a future version. Use the `uid` field instead. type: string uid: - description: A unique identifier for the event. You can use this identifier - to query or reference the event. + description: |- + A unique identifier for the event. You can use this identifier to query or reference the event. type: string type: object EventCreateResponsePayload: description: Event creation response. properties: data: - $ref: '#/components/schemas/EventCreateResponse' + $ref: "#/components/schemas/EventCreateResponse" links: - $ref: '#/components/schemas/EventCreateResponsePayloadLinks' + $ref: "#/components/schemas/EventCreateResponsePayloadLinks" type: object EventCreateResponsePayloadLinks: - description: Links to the event. + description: |- + Links to the event. properties: self: - description: The URL of the event. This link is only functional when using - the default subdomain. + description: |- + The URL of the event. This link is only functional when using the default subdomain. type: string type: object EventPayload: @@ -24121,41 +23228,37 @@ components: description: Event attributes. properties: aggregation_key: - description: A string used for aggregation when [correlating](https://docs.datadoghq.com/service_management/events/correlation/) - events. If you specify a key, events are deduplicated to alerts based - on this key. Limited to 100 characters. - example: aggregation_key_123 + description: |- + A string used for aggregation when [correlating](https://docs.datadoghq.com/service_management/events/correlation/) events. If you specify a key, events are deduplicated to alerts based on this key. Limited to 100 characters. + example: "aggregation_key_123" maxLength: 100 minLength: 1 type: string attributes: - $ref: '#/components/schemas/EventPayloadAttributes' + $ref: "#/components/schemas/EventPayloadAttributes" category: - $ref: '#/components/schemas/EventCategory' + $ref: "#/components/schemas/EventCategory" host: - description: Host name to associate with the event. Any tags associated - with the host are also applied to this event. Limited to 255 characters. - example: hostname + description: |- + Host name to associate with the event. Any tags associated with the host are also applied to this event. Limited to 255 characters. + example: "hostname" maxLength: 255 minLength: 1 type: string integration_id: - $ref: '#/components/schemas/EventPayloadIntegrationId' + $ref: "#/components/schemas/EventPayloadIntegrationId" message: - description: Free formed text associated with the event. It's suggested - to use `data.attributes.attributes.custom` for well-structured attributes. - Limited to 4000 characters. - example: payment_processed feature flag has been enabled + description: |- + Free formed text associated with the event. It's suggested to use `data.attributes.attributes.custom` for well-structured attributes. Limited to 4000 characters. + example: "payment_processed feature flag has been enabled" maxLength: 4000 minLength: 1 type: string tags: - description: 'A list of tags associated with the event. Maximum of 100 tags - allowed. - - Refer to [Tags docs](https://docs.datadoghq.com/getting_started/tagging/).' - example: - - env:api_client_test + description: |- + A list of tags associated with the event. Maximum of 100 tags allowed. + Refer to [Tags docs](https://docs.datadoghq.com/getting_started/tagging/). + example: ["env:api_client_test"] items: description: A tag. maxLength: 200 @@ -24165,192 +23268,186 @@ components: minItems: 1 type: array timestamp: - description: 'Timestamp when the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) - format. - + description: |- + Timestamp when the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. For example `"2017-01-15T01:30:15.010000Z"`. - - Defaults to the timestamp of receipt. Limited to values no older than - 18 hours.' + Defaults to the timestamp of receipt. Limited to values no older than 18 hours. type: string title: description: The title of the event. Limited to 500 characters. - example: payment_processed feature flag updated + example: "payment_processed feature flag updated" maxLength: 500 minLength: 1 type: string required: - - title - - category - - attributes + - title + - category + - attributes type: object EventPayloadAttributes: - description: JSON object for category-specific attributes. Schema is different - per event category. + description: |- + JSON object for category-specific attributes. Schema is different per event category. oneOf: - - $ref: '#/components/schemas/ChangeEventCustomAttributes' - - $ref: '#/components/schemas/AlertEventCustomAttributes' + - $ref: "#/components/schemas/ChangeEventCustomAttributes" + - $ref: "#/components/schemas/AlertEventCustomAttributes" EventPayloadIntegrationId: - description: Integration ID sourced from integration manifests. + description: |- + Integration ID sourced from integration manifests. enum: - - custom-events - example: custom-events + - custom-events + example: "custom-events" type: string x-enum-varnames: - - CUSTOM_EVENTS + - CUSTOM_EVENTS EventPriority: - description: The priority of the event's monitor. For example, `normal` or `low`. + description: |- + The priority of the event's monitor. For example, `normal` or `low`. enum: - - normal - - low - example: normal + - normal + - low + example: "normal" nullable: true type: string x-enum-varnames: - - NORMAL - - LOW + - NORMAL + - LOW EventResponse: - description: The object description of an event after being processed and stored - by Datadog. + description: The object description of an event after being processed and stored by Datadog. properties: attributes: - $ref: '#/components/schemas/EventResponseAttributes' + $ref: "#/components/schemas/EventResponseAttributes" id: description: the unique ID of the event. - example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA" type: string type: - $ref: '#/components/schemas/EventType' + $ref: "#/components/schemas/EventType" type: object EventResponseAttributes: description: The object description of an event response attribute. properties: attributes: - $ref: '#/components/schemas/EventAttributes' + $ref: "#/components/schemas/EventAttributes" message: description: The message of the event. type: string tags: description: An array of tags associated with the event. - example: - - team:A + example: ["team:A"] items: description: The tag associated with the event. type: string type: array timestamp: description: The timestamp of the event. - example: '2019-01-02T09:42:36.320Z' + example: "2019-01-02T09:42:36.320Z" format: date-time type: string type: object EventStatusType: - description: 'If an alert event is enabled, its status is one of the following: - + description: |- + If an alert event is enabled, its status is one of the following: `failure`, `error`, `warning`, `info`, `success`, `user_update`, - - `recommendation`, or `snapshot`.' - enum: - - failure - - error - - warning - - info - - success - - user_update - - recommendation - - snapshot - example: info - type: string - x-enum-varnames: - - FAILURE - - ERROR - - WARNING - - INFO - - SUCCESS - - USER_UPDATE - - RECOMMENDATION - - SNAPSHOT + `recommendation`, or `snapshot`. + enum: + - failure + - error + - warning + - info + - success + - user_update + - recommendation + - snapshot + example: "info" + type: string + x-enum-varnames: + - FAILURE + - ERROR + - WARNING + - INFO + - SUCCESS + - USER_UPDATE + - RECOMMENDATION + - SNAPSHOT EventSystemAttributes: description: JSON object of event system attributes. properties: category: - $ref: '#/components/schemas/EventSystemAttributesCategory' + $ref: "#/components/schemas/EventSystemAttributesCategory" id: - description: Event identifier. This field is deprecated and will be removed - in a future version. Use the `uid` field instead. + description: Event identifier. This field is deprecated and will be removed in a future version. Use the `uid` field instead. type: string integration_id: - $ref: '#/components/schemas/EventSystemAttributesIntegrationId' + $ref: "#/components/schemas/EventSystemAttributesIntegrationId" source_id: description: The source type ID of the event. format: int64 type: integer uid: - description: A unique identifier for the event. You can use this identifier - to query or reference the event. + description: A unique identifier for the event. You can use this identifier to query or reference the event. type: string type: object EventSystemAttributesCategory: description: Event category identifying the type of event. enum: - - change - - alert - example: change + - change + - alert + example: "change" type: string x-enum-varnames: - - CHANGE - - ALERT + - CHANGE + - ALERT EventSystemAttributesIntegrationId: description: Integration ID sourced from integration manifests. enum: - - custom-events - example: custom-events + - custom-events + example: "custom-events" type: string x-enum-varnames: - - CUSTOM_EVENTS + - CUSTOM_EVENTS EventType: default: event description: Type of the event. enum: - - event - example: event + - event + example: "event" type: string x-enum-varnames: - - EVENT + - EVENT EventsAggregation: default: count description: The type of aggregation that can be performed on events-based queries. enum: - - count - - cardinality - - pc75 - - pc90 - - pc95 - - pc98 - - pc99 - - sum - - min - - max - - avg + - count + - cardinality + - pc75 + - pc90 + - pc95 + - pc98 + - pc99 + - sum + - min + - max + - avg example: count type: string x-enum-varnames: - - COUNT - - CARDINALITY - - PC75 - - PC90 - - PC95 - - PC98 - - PC99 - - SUM - - MIN - - MAX - - AVG + - COUNT + - CARDINALITY + - PC75 + - PC90 + - PC95 + - PC98 + - PC99 + - SUM + - MIN + - MAX + - AVG EventsCompute: description: The instructions for what to compute for this query. properties: aggregation: - $ref: '#/components/schemas/EventsAggregation' + $ref: "#/components/schemas/EventsAggregation" interval: description: Interval for compute in milliseconds. example: 60000 @@ -24360,140 +23457,134 @@ components: description: The "measure" attribute on which to perform the computation. type: string required: - - aggregation + - aggregation type: object EventsDataSource: default: logs description: A data source that is powered by the Events Platform. enum: - - logs - - rum - - dora + - logs + - rum + - dora example: logs type: string x-enum-varnames: - - LOGS - - RUM - - DORA + - LOGS + - RUM + - DORA EventsGroupBy: description: A dimension on which to split a query's results. properties: facet: description: The facet by which to split groups. - example: '@error.type' + example: "@error.type" type: string limit: default: 10 - description: 'The maximum buckets to return for this group by. Note: at - most 10000 buckets are allowed. - - If grouping by multiple facets, the product of limits must not exceed - 10000.' + description: |- + The maximum buckets to return for this group by. Note: at most 10000 buckets are allowed. + If grouping by multiple facets, the product of limits must not exceed 10000. example: 10 format: int32 maximum: 10000 type: integer sort: - $ref: '#/components/schemas/EventsGroupBySort' + $ref: "#/components/schemas/EventsGroupBySort" required: - - facet + - facet type: object EventsGroupBySort: description: The dimension by which to sort a query's results. properties: aggregation: - $ref: '#/components/schemas/EventsAggregation' + $ref: "#/components/schemas/EventsAggregation" metric: - description: The metric's calculated value which should be used to define - the sort order of a query's results. - example: '@duration' + description: The metric's calculated value which should be used to define the sort order of a query's results. + example: "@duration" type: string order: - $ref: '#/components/schemas/QuerySortOrder' + $ref: "#/components/schemas/QuerySortOrder" type: - $ref: '#/components/schemas/EventsSortType' + $ref: "#/components/schemas/EventsSortType" required: - - aggregation + - aggregation type: object EventsListRequest: - description: The object sent with the request to retrieve a list of events from - your organization. + description: |- + The object sent with the request to retrieve a list of events from your organization. properties: filter: - $ref: '#/components/schemas/EventsQueryFilter' + $ref: "#/components/schemas/EventsQueryFilter" options: - $ref: '#/components/schemas/EventsQueryOptions' + $ref: "#/components/schemas/EventsQueryOptions" page: - $ref: '#/components/schemas/EventsRequestPage' + $ref: "#/components/schemas/EventsRequestPage" sort: - $ref: '#/components/schemas/EventsSort' + $ref: "#/components/schemas/EventsSort" type: object EventsListResponse: - description: The response object with all events matching the request and pagination - information. + description: The response object with all events matching the request and pagination information. properties: data: description: An array of events matching the request. items: - $ref: '#/components/schemas/EventResponse' + $ref: "#/components/schemas/EventResponse" type: array links: - $ref: '#/components/schemas/EventsListResponseLinks' + $ref: "#/components/schemas/EventsListResponseLinks" meta: - $ref: '#/components/schemas/EventsResponseMetadata' + $ref: "#/components/schemas/EventsResponseMetadata" type: object EventsListResponseLinks: description: Links attributes. properties: next: - description: 'Link for the next set of results. Note that the request can - also be made using the - - POST endpoint.' - example: https://app.datadoghq.com/api/v2/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + Link for the next set of results. Note that the request can also be made using the + POST endpoint. + example: "https://app.datadoghq.com/api/v2/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string type: object EventsQueryFilter: description: The search and filter query settings. properties: from: - default: now-15m - description: The minimum time for the requested events. Supports date math - and regular timestamps in milliseconds. - example: now-15m + default: "now-15m" + description: |- + The minimum time for the requested events. Supports date math and regular timestamps in milliseconds. + example: "now-15m" type: string query: - default: '*' + default: "*" description: The search query following the event search syntax. - example: service:web* AND @http.status_code:[200 TO 299] + example: "service:web* AND @http.status_code:[200 TO 299]" type: string to: - default: now - description: The maximum time for the requested events. Supports date math - and regular timestamps in milliseconds. - example: now + default: "now" + description: |- + The maximum time for the requested events. Supports date math and regular timestamps in milliseconds. + example: "now" type: string type: object EventsQueryGroupBys: description: The list of facets on which to split results. items: - $ref: '#/components/schemas/EventsGroupBy' + $ref: "#/components/schemas/EventsGroupBy" type: array EventsQueryOptions: - description: 'The global query options that are used. Either provide a timezone - or a time offset but not both, - - otherwise the query fails.' + description: |- + The global query options that are used. Either provide a timezone or a time offset but not both, + otherwise the query fails. properties: timeOffset: description: The time offset to apply to the query in seconds. format: int64 type: integer timezone: - default: UTC - description: The timezone can be specified as GMT, UTC, an offset from UTC - (like UTC+1), or as a Timezone Database identifier (like America/New_York). - example: GMT + default: "UTC" + description: |- + The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York). + example: "GMT" type: string type: object EventsRequestPage: @@ -24501,7 +23592,7 @@ components: properties: cursor: description: The returned paging point to use to get the next results. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string limit: default: 10 @@ -24520,48 +23611,45 @@ components: format: int64 type: integer page: - $ref: '#/components/schemas/EventsResponseMetadataPage' + $ref: "#/components/schemas/EventsResponseMetadataPage" request_id: description: The identifier of the request. - example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR + example: "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR" type: string status: description: The request status. - example: done + example: "done" type: string warnings: - description: 'A list of warnings (non-fatal errors) encountered. Partial - results might be returned if - - warnings are present in the response.' + description: |- + A list of warnings (non-fatal errors) encountered. Partial results might be returned if + warnings are present in the response. items: - $ref: '#/components/schemas/EventsWarning' + $ref: "#/components/schemas/EventsWarning" type: array type: object EventsResponseMetadataPage: description: Pagination attributes. properties: after: - description: 'The cursor to use to get the next results, if any. To make - the next request, use the same - - parameters with the addition of the `page[cursor]`.' - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + The cursor to use to get the next results, if any. To make the next request, use the same + parameters with the addition of the `page[cursor]`. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string type: object EventsScalarQuery: description: An individual scalar events query. properties: compute: - $ref: '#/components/schemas/EventsCompute' + $ref: "#/components/schemas/EventsCompute" data_source: - $ref: '#/components/schemas/EventsDataSource' + $ref: "#/components/schemas/EventsDataSource" group_by: - $ref: '#/components/schemas/EventsQueryGroupBys' + $ref: "#/components/schemas/EventsQueryGroupBys" indexes: description: The indexes in which to search. - example: - - main + example: ["main"] items: description: The unique index name. example: main @@ -24571,50 +23659,49 @@ components: description: The variable name for use in formulas. type: string search: - $ref: '#/components/schemas/EventsSearch' + $ref: "#/components/schemas/EventsSearch" required: - - data_source - - compute + - data_source + - compute type: object EventsSearch: description: Configuration of the search/filter for an events query. properties: query: description: The search/filter string for an events query. - example: status:warn service:foo + example: "status:warn service:foo" type: string type: object EventsSort: description: The sort parameters when querying events. enum: - - timestamp - - -timestamp + - timestamp + - -timestamp type: string x-enum-varnames: - - TIMESTAMP_ASCENDING - - TIMESTAMP_DESCENDING + - TIMESTAMP_ASCENDING + - TIMESTAMP_DESCENDING EventsSortType: description: The type of sort to use on the calculated value. enum: - - alphabetical - - measure + - alphabetical + - measure type: string x-enum-varnames: - - ALPHABETICAL - - MEASURE + - ALPHABETICAL + - MEASURE EventsTimeseriesQuery: description: An individual timeseries events query. properties: compute: - $ref: '#/components/schemas/EventsCompute' + $ref: "#/components/schemas/EventsCompute" data_source: - $ref: '#/components/schemas/EventsDataSource' + $ref: "#/components/schemas/EventsDataSource" group_by: - $ref: '#/components/schemas/EventsQueryGroupBys' + $ref: "#/components/schemas/EventsQueryGroupBys" indexes: description: The indexes in which to search. - example: - - main + example: ["main"] items: description: The unique index name. example: main @@ -24624,26 +23711,25 @@ components: description: The variable name for use in formulas. type: string search: - $ref: '#/components/schemas/EventsSearch' + $ref: "#/components/schemas/EventsSearch" required: - - data_source - - compute + - data_source + - compute type: object EventsWarning: description: A warning message indicating something is wrong with the query. properties: code: description: A unique code for this type of warning. - example: unknown_index + example: "unknown_index" type: string detail: description: A detailed explanation of this specific warning. - example: 'indexes: foo, bar' + example: "indexes: foo, bar" type: string title: description: A short human-readable summary of the warning. - example: One or several indexes are missing or invalid. Results hold data - from the other indexes. + example: "One or several indexes are missing or invalid. Results hold data from the other indexes." type: string type: object FacetInfoRequest: @@ -24660,35 +23746,35 @@ components: type: users_facet_info_request properties: data: - $ref: '#/components/schemas/FacetInfoRequestData' + $ref: "#/components/schemas/FacetInfoRequestData" type: object FacetInfoRequestData: properties: attributes: - $ref: '#/components/schemas/FacetInfoRequestDataAttributes' + $ref: "#/components/schemas/FacetInfoRequestDataAttributes" id: type: string type: - $ref: '#/components/schemas/FacetInfoRequestDataType' + $ref: "#/components/schemas/FacetInfoRequestDataType" required: - - type + - type type: object FacetInfoRequestDataAttributes: properties: facet_id: - example: '' + example: "" type: string limit: example: 0 format: int64 type: integer search: - $ref: '#/components/schemas/FacetInfoRequestDataAttributesSearch' + $ref: "#/components/schemas/FacetInfoRequestDataAttributesSearch" term_search: - $ref: '#/components/schemas/FacetInfoRequestDataAttributesTermSearch' + $ref: "#/components/schemas/FacetInfoRequestDataAttributesTermSearch" required: - - facet_id - - limit + - facet_id + - limit type: object FacetInfoRequestDataAttributesSearch: properties: @@ -24704,56 +23790,56 @@ components: default: users_facet_info_request description: Users facet info request resource type. enum: - - users_facet_info_request + - users_facet_info_request example: users_facet_info_request type: string x-enum-varnames: - - USERS_FACET_INFO_REQUEST + - USERS_FACET_INFO_REQUEST FacetInfoResponse: example: data: attributes: result: values: - - count: 4892 - value: Chrome - - count: 2341 - value: Safari - - count: 1567 - value: Firefox - - count: 892 - value: Edge - - count: 234 - value: Opera + - count: 4892 + value: Chrome + - count: 2341 + value: Safari + - count: 1567 + value: Firefox + - count: 892 + value: Edge + - count: 234 + value: Opera id: facet_info_response type: users_facet_info properties: data: - $ref: '#/components/schemas/FacetInfoResponseData' + $ref: "#/components/schemas/FacetInfoResponseData" type: object FacetInfoResponseData: properties: attributes: - $ref: '#/components/schemas/FacetInfoResponseDataAttributes' + $ref: "#/components/schemas/FacetInfoResponseDataAttributes" id: type: string type: - $ref: '#/components/schemas/FacetInfoResponseDataType' + $ref: "#/components/schemas/FacetInfoResponseDataType" required: - - type + - type type: object FacetInfoResponseDataAttributes: properties: result: - $ref: '#/components/schemas/FacetInfoResponseDataAttributesResult' + $ref: "#/components/schemas/FacetInfoResponseDataAttributesResult" type: object FacetInfoResponseDataAttributesResult: properties: range: - $ref: '#/components/schemas/FacetInfoResponseDataAttributesResultRange' + $ref: "#/components/schemas/FacetInfoResponseDataAttributesResultRange" values: items: - $ref: '#/components/schemas/FacetInfoResponseDataAttributesResultValuesItems' + $ref: "#/components/schemas/FacetInfoResponseDataAttributesResultValuesItems" type: array type: object FacetInfoResponseDataAttributesResultRange: @@ -24775,32 +23861,32 @@ components: default: users_facet_info description: Users facet info resource type. enum: - - users_facet_info + - users_facet_info example: users_facet_info type: string x-enum-varnames: - - USERS_FACET_INFO + - USERS_FACET_INFO FastlyAPIKey: description: The definition of the `FastlyAPIKey` object. properties: api_key: description: The `FastlyAPIKey` `api_key`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/FastlyAPIKeyType' + $ref: "#/components/schemas/FastlyAPIKeyType" required: - - type - - api_key + - type + - api_key type: object FastlyAPIKeyType: description: The definition of the `FastlyAPIKey` object. enum: - - FastlyAPIKey + - FastlyAPIKey example: FastlyAPIKey type: string x-enum-varnames: - - FASTLYAPIKEY + - FASTLYAPIKEY FastlyAPIKeyUpdate: description: The definition of the `FastlyAPIKey` object. properties: @@ -24808,109 +23894,109 @@ components: description: The `FastlyAPIKeyUpdate` `api_key`. type: string type: - $ref: '#/components/schemas/FastlyAPIKeyType' + $ref: "#/components/schemas/FastlyAPIKeyType" required: - - type + - type type: object FastlyAccounResponseAttributes: description: Attributes object of a Fastly account. properties: name: description: The name of the Fastly account. - example: test-name + example: "test-name" type: string services: description: A list of services belonging to the parent account. items: - $ref: '#/components/schemas/FastlyService' + $ref: "#/components/schemas/FastlyService" type: array required: - - name + - name type: object FastlyAccountCreateRequest: description: Payload schema when adding a Fastly account. properties: data: - $ref: '#/components/schemas/FastlyAccountCreateRequestData' + $ref: "#/components/schemas/FastlyAccountCreateRequestData" required: - - data + - data type: object FastlyAccountCreateRequestAttributes: description: Attributes object for creating a Fastly account. properties: api_key: description: The API key for the Fastly account. - example: ABCDEFG123 + example: "ABCDEFG123" type: string name: description: The name of the Fastly account. - example: test-name + example: "test-name" type: string services: description: A list of services belonging to the parent account. items: - $ref: '#/components/schemas/FastlyService' + $ref: "#/components/schemas/FastlyService" type: array required: - - api_key - - name + - api_key + - name type: object FastlyAccountCreateRequestData: description: Data object for creating a Fastly account. properties: attributes: - $ref: '#/components/schemas/FastlyAccountCreateRequestAttributes' + $ref: "#/components/schemas/FastlyAccountCreateRequestAttributes" type: - $ref: '#/components/schemas/FastlyAccountType' + $ref: "#/components/schemas/FastlyAccountType" required: - - attributes - - type + - attributes + - type type: object FastlyAccountResponse: description: The expected response schema when getting a Fastly account. properties: data: - $ref: '#/components/schemas/FastlyAccountResponseData' + $ref: "#/components/schemas/FastlyAccountResponseData" type: object FastlyAccountResponseData: description: Data object of a Fastly account. properties: attributes: - $ref: '#/components/schemas/FastlyAccounResponseAttributes' + $ref: "#/components/schemas/FastlyAccounResponseAttributes" id: description: The ID of the Fastly account, a hash of the account name. - example: abc123 + example: "abc123" type: string type: - $ref: '#/components/schemas/FastlyAccountType' + $ref: "#/components/schemas/FastlyAccountType" required: - - attributes - - id - - type + - attributes + - id + - type type: object FastlyAccountType: default: fastly-accounts description: The JSON:API type for this API. Should always be `fastly-accounts`. enum: - - fastly-accounts + - fastly-accounts example: fastly-accounts type: string x-enum-varnames: - - FASTLY_ACCOUNTS + - FASTLY_ACCOUNTS FastlyAccountUpdateRequest: description: Payload schema when updating a Fastly account. properties: data: - $ref: '#/components/schemas/FastlyAccountUpdateRequestData' + $ref: "#/components/schemas/FastlyAccountUpdateRequestData" required: - - data + - data type: object FastlyAccountUpdateRequestAttributes: description: Attributes object for updating a Fastly account. properties: api_key: description: The API key of the Fastly account. - example: ABCDEFG123 + example: "ABCDEFG123" type: string name: description: The name of the Fastly account. @@ -24920,9 +24006,9 @@ components: description: Data object for updating a Fastly account. properties: attributes: - $ref: '#/components/schemas/FastlyAccountUpdateRequestAttributes' + $ref: "#/components/schemas/FastlyAccountUpdateRequestAttributes" type: - $ref: '#/components/schemas/FastlyAccountType' + $ref: "#/components/schemas/FastlyAccountType" type: object FastlyAccountsResponse: description: The expected response schema when getting Fastly accounts. @@ -24930,45 +24016,45 @@ components: data: description: The JSON:API data schema. items: - $ref: '#/components/schemas/FastlyAccountResponseData' + $ref: "#/components/schemas/FastlyAccountResponseData" type: array type: object FastlyCredentials: description: The definition of the `FastlyCredentials` object. oneOf: - - $ref: '#/components/schemas/FastlyAPIKey' + - $ref: "#/components/schemas/FastlyAPIKey" FastlyCredentialsUpdate: description: The definition of the `FastlyCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/FastlyAPIKeyUpdate' + - $ref: "#/components/schemas/FastlyAPIKeyUpdate" FastlyIntegration: description: The definition of the `FastlyIntegration` object. properties: credentials: - $ref: '#/components/schemas/FastlyCredentials' + $ref: "#/components/schemas/FastlyCredentials" type: - $ref: '#/components/schemas/FastlyIntegrationType' + $ref: "#/components/schemas/FastlyIntegrationType" required: - - type - - credentials + - type + - credentials type: object FastlyIntegrationType: description: The definition of the `FastlyIntegrationType` object. enum: - - Fastly + - Fastly example: Fastly type: string x-enum-varnames: - - FASTLY + - FASTLY FastlyIntegrationUpdate: description: The definition of the `FastlyIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/FastlyCredentialsUpdate' + $ref: "#/components/schemas/FastlyCredentialsUpdate" type: - $ref: '#/components/schemas/FastlyIntegrationType' + $ref: "#/components/schemas/FastlyIntegrationType" required: - - type + - type type: object FastlyService: description: The schema representation of a Fastly service. @@ -24980,13 +24066,13 @@ components: tags: description: A list of tags for the Fastly service. example: - - myTag - - myTag2:myValue + - myTag + - myTag2:myValue items: type: string type: array required: - - id + - id type: object FastlyServiceAttributes: description: Attributes object for Fastly service requests. @@ -24994,8 +24080,8 @@ components: tags: description: A list of tags for the Fastly service. example: - - myTag - - myTag2:myValue + - myTag + - myTag2:myValue items: type: string type: array @@ -25004,162 +24090,156 @@ components: description: Data object for Fastly service requests. properties: attributes: - $ref: '#/components/schemas/FastlyServiceAttributes' + $ref: "#/components/schemas/FastlyServiceAttributes" id: description: The ID of the Fastly service. - example: abc123 + example: "abc123" type: string type: - $ref: '#/components/schemas/FastlyServiceType' + $ref: "#/components/schemas/FastlyServiceType" required: - - id - - type + - id + - type type: object FastlyServiceRequest: description: Payload schema for Fastly service requests. properties: data: - $ref: '#/components/schemas/FastlyServiceData' + $ref: "#/components/schemas/FastlyServiceData" required: - - data + - data type: object FastlyServiceResponse: description: The expected response schema when getting a Fastly service. properties: data: - $ref: '#/components/schemas/FastlyServiceData' + $ref: "#/components/schemas/FastlyServiceData" type: object FastlyServiceType: default: fastly-services description: The JSON:API type for this API. Should always be `fastly-services`. enum: - - fastly-services + - fastly-services example: fastly-services type: string x-enum-varnames: - - FASTLY_SERVICES + - FASTLY_SERVICES FastlyServicesResponse: description: The expected response schema when getting Fastly services. properties: data: description: The JSON:API data schema. items: - $ref: '#/components/schemas/FastlyServiceData' + $ref: "#/components/schemas/FastlyServiceData" type: array type: object FiltersPerProduct: description: Product-specific filters for the dataset. properties: filters: - description: 'Defines the list of tag-based filters used to restrict access - to telemetry data for a specific product. - - These filters act as access control rules. Each filter must follow the - tag query syntax used by - - Datadog (such as `@tag.key:value`), and only one tag or attribute may - be used to define the access strategy - - per telemetry type.' + description: |- + Defines the list of tag-based filters used to restrict access to telemetry data for a specific product. + These filters act as access control rules. Each filter must follow the tag query syntax used by + Datadog (such as `@tag.key:value`), and only one tag or attribute may be used to define the access strategy + per telemetry type. example: - - '@application.id:ABCD' + - "@application.id:ABCD" items: - example: '@application.id:ABCD' + example: "@application.id:ABCD" type: string type: array product: - description: 'Name of the product the dataset is for. Possible values are - ''apm'', ''rum'', - - ''metrics'', ''logs'', ''error_tracking'', ''cloud_cost'', and ''sd_repoinfo''.' - example: logs + description: |- + Name of the product the dataset is for. Possible values are 'apm', 'rum', + 'metrics', 'logs', 'error_tracking', 'cloud_cost', and 'sd_repoinfo'. + example: "logs" type: string required: - - product - - filters + - product + - filters type: object Finding: description: A single finding without the message and resource configuration. properties: attributes: - $ref: '#/components/schemas/FindingAttributes' + $ref: "#/components/schemas/FindingAttributes" id: - $ref: '#/components/schemas/FindingID' + $ref: "#/components/schemas/FindingID" type: - $ref: '#/components/schemas/FindingType' + $ref: "#/components/schemas/FindingType" type: object FindingAttributes: description: The JSON:API attributes of the finding. properties: datadog_link: - $ref: '#/components/schemas/FindingDatadogLink' + $ref: "#/components/schemas/FindingDatadogLink" description: - $ref: '#/components/schemas/FindingDescription' + $ref: "#/components/schemas/FindingDescription" evaluation: - $ref: '#/components/schemas/FindingEvaluation' + $ref: "#/components/schemas/FindingEvaluation" evaluation_changed_at: - $ref: '#/components/schemas/FindingEvaluationChangedAt' + $ref: "#/components/schemas/FindingEvaluationChangedAt" external_id: - $ref: '#/components/schemas/FindingExternalId' + $ref: "#/components/schemas/FindingExternalId" mute: - $ref: '#/components/schemas/FindingMute' + $ref: "#/components/schemas/FindingMute" resource: - $ref: '#/components/schemas/FindingResource' + $ref: "#/components/schemas/FindingResource" resource_discovery_date: - $ref: '#/components/schemas/FindingResourceDiscoveryDate' + $ref: "#/components/schemas/FindingResourceDiscoveryDate" resource_type: - $ref: '#/components/schemas/FindingResourceType' + $ref: "#/components/schemas/FindingResourceType" rule: - $ref: '#/components/schemas/FindingRule' + $ref: "#/components/schemas/FindingRule" status: - $ref: '#/components/schemas/FindingStatus' + $ref: "#/components/schemas/FindingStatus" tags: - $ref: '#/components/schemas/FindingTags' + $ref: "#/components/schemas/FindingTags" vulnerability_type: - $ref: '#/components/schemas/FindingVulnerabilityType' + $ref: "#/components/schemas/FindingVulnerabilityType" type: object FindingCaseResponse: description: Case response. properties: data: - $ref: '#/components/schemas/FindingCaseResponseData' + $ref: "#/components/schemas/FindingCaseResponseData" type: object FindingCaseResponseArray: description: List of case responses. properties: data: items: - $ref: '#/components/schemas/FindingCaseResponseData' + $ref: "#/components/schemas/FindingCaseResponseData" type: array required: - - data + - data type: object FindingCaseResponseData: description: Data of the case. properties: attributes: - $ref: '#/components/schemas/FindingCaseResponseDataAttributes' + $ref: "#/components/schemas/FindingCaseResponseDataAttributes" id: description: Unique identifier of the case. - example: c1234567-89ab-cdef-0123-456789abcdef + example: "c1234567-89ab-cdef-0123-456789abcdef" type: string relationships: - $ref: '#/components/schemas/FindingCaseResponseDataRelationships' + $ref: "#/components/schemas/FindingCaseResponseDataRelationships" type: - $ref: '#/components/schemas/CaseDataType' + $ref: "#/components/schemas/CaseDataType" required: - - type + - type type: object FindingCaseResponseDataAttributes: description: Attributes of the case. properties: archived_at: description: Timestamp of when the case was archived. - example: '2025-01-01T00:00:00.000Z' + example: "2025-01-01T00:00:00.000Z" format: date-time type: string assigned_to: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" description: User assigned to the case. attributes: additionalProperties: @@ -25169,138 +24249,127 @@ components: type: object closed_at: description: Timestamp of when the case was closed. - example: '2025-01-01T00:00:00.000Z' + example: "2025-01-01T00:00:00.000Z" format: date-time type: string created_at: description: Timestamp of when the case was created. - example: '2025-01-01T00:00:00.000Z' + example: "2025-01-01T00:00:00.000Z" format: date-time type: string creation_source: description: Source of the case creation. - example: CS_SECURITY_FINDING + example: "CS_SECURITY_FINDING" type: string description: description: Description of the case. - example: A description of the case. + example: "A description of the case." type: string due_date: description: Due date of the case. - example: '2025-01-01' + example: "2025-01-01" type: string insights: description: Insights of the case. items: - $ref: '#/components/schemas/CaseInsightsItems' + $ref: "#/components/schemas/CaseInsightsItems" type: array jira_issue: - $ref: '#/components/schemas/FindingJiraIssue' + $ref: "#/components/schemas/FindingJiraIssue" description: Jira issue associated with the case. key: description: Key of the case. - example: PROJ-123 + example: "PROJ-123" type: string modified_at: description: Timestamp of when the case was last modified. - example: '2025-01-01T00:00:00.000Z' + example: "2025-01-01T00:00:00.000Z" format: date-time type: string priority: description: Priority of the case. - example: P4 + example: "P4" type: string status: description: Status of the case. - example: OPEN + example: "OPEN" type: string status_group: description: Status group of the case. - example: SG_OPEN + example: "SG_OPEN" type: string status_name: description: Status name of the case. - example: Open + example: "Open" type: string title: description: Title of the case. - example: A title for the case. + example: "A title for the case." type: string type: description: Type of the case. For security cases, this is always "SECURITY". - example: SECURITY + example: "SECURITY" type: string type: object FindingCaseResponseDataRelationships: description: Relationships of the case. properties: created_by: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" description: User who created the case. modified_by: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" description: User who last modified the case. project: - $ref: '#/components/schemas/CaseManagementProject' + $ref: "#/components/schemas/CaseManagementProject" description: Project in which the case was created. type: object FindingData: properties: id: description: Unique identifier of the security finding. - example: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw== + example: "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==" type: string type: - $ref: '#/components/schemas/FindingDataType' + $ref: "#/components/schemas/FindingDataType" required: - - type - - id + - type + - id type: object FindingDataType: default: findings description: Security findings resource type. enum: - - findings + - findings example: findings type: string x-enum-varnames: - - FINDINGS + - FINDINGS FindingDatadogLink: description: The Datadog relative link for this finding. - example: /security/compliance?panels=cpfinding%7Cevent%7CruleId%3Adef-000-u5t%7CresourceId%3Ae8c9ab7c52ebd7bf2fdb4db641082d7d%7CtabId%3Aoverview + example: "/security/compliance?panels=cpfinding%7Cevent%7CruleId%3Adef-000-u5t%7CresourceId%3Ae8c9ab7c52ebd7bf2fdb4db641082d7d%7CtabId%3Aoverview" type: string FindingDescription: description: The description and remediation steps for this finding. - example: '## Remediation - - - 1. In the console, go to **Storage Account**. - - 2. For each Storage Account, navigate to **Data Protection**. - - 3. Select **Set soft delete enabled** and enter the number of days to retain - soft deleted data.' + example: "## Remediation\n\n1. In the console, go to **Storage Account**.\n2. For each Storage Account, navigate to **Data Protection**.\n3. Select **Set soft delete enabled** and enter the number of days to retain soft deleted data." type: string FindingEvaluation: description: The evaluation of the finding. enum: - - pass - - fail + - pass + - fail example: pass type: string - x-enum-varnames: - - PASS - - FAIL + x-enum-varnames: ["PASS", "FAIL"] FindingEvaluationChangedAt: - description: The date on which the evaluation for this finding changed (Unix - ms). + description: The date on which the evaluation for this finding changed (Unix ms). example: 1678721573794 format: int64 minimum: 1 type: integer FindingExternalId: description: The cloud-based ID for the resource related to the finding. - example: arn:aws:s3:::my-example-bucket + example: "arn:aws:s3:::my-example-bucket" type: string FindingID: description: The unique ID for this finding. @@ -25314,12 +24383,10 @@ components: example: '{"errorMessages":["An error occured."],"errors":{}}' type: string result: - $ref: '#/components/schemas/FindingJiraIssueResult' + $ref: "#/components/schemas/FindingJiraIssueResult" status: - description: Status of the Jira issue creation. Can be "COMPLETED" if the - Jira issue was created successfully, or "FAILED" if the Jira issue creation - failed. - example: COMPLETED + description: Status of the Jira issue creation. Can be "COMPLETED" if the Jira issue was created successfully, or "FAILED" if the Jira issue creation failed. + example: "COMPLETED" type: string type: object FindingJiraIssueResult: @@ -25327,19 +24394,19 @@ components: properties: account_id: description: Account ID of the Jira issue. - example: 463a8631-680e-455c-bfd3-3ed04d326eb7 + example: "463a8631-680e-455c-bfd3-3ed04d326eb7" type: string issue_id: description: Unique identifier of the Jira issue. - example: '2871276' + example: "2871276" type: string issue_key: description: Key of the Jira issue. - example: PROJ-123 + example: "PROJ-123" type: string issue_url: description: URL of the Jira issue. - example: https://domain.atlassian.net/browse/PROJ-123 + example: "https://domain.atlassian.net/browse/PROJ-123" type: string type: object FindingMute: @@ -25347,8 +24414,7 @@ components: description: Information about the mute status of this finding. properties: description: - description: Additional information about the reason why this finding is - muted or unmuted. + description: Additional information about the reason why this finding is muted or unmuted. example: To be resolved later type: string expiration_date: @@ -25361,7 +24427,7 @@ components: example: true type: boolean reason: - $ref: '#/components/schemas/FindingMuteReason' + $ref: "#/components/schemas/FindingMuteReason" start_date: description: The start of the mute period. example: 1678721573794 @@ -25375,23 +24441,16 @@ components: FindingMuteReason: description: The reason why this finding is muted or unmuted. enum: - - PENDING_FIX - - FALSE_POSITIVE - - ACCEPTED_RISK - - NO_PENDING_FIX - - HUMAN_ERROR - - NO_LONGER_ACCEPTED_RISK - - OTHER + - PENDING_FIX + - FALSE_POSITIVE + - ACCEPTED_RISK + - NO_PENDING_FIX + - HUMAN_ERROR + - NO_LONGER_ACCEPTED_RISK + - OTHER example: ACCEPTED_RISK type: string - x-enum-varnames: - - PENDING_FIX - - FALSE_POSITIVE - - ACCEPTED_RISK - - NO_PENDING_FIX - - HUMAN_ERROR - - NO_LONGER_ACCEPTED_RISK - - OTHER + x-enum-varnames: ["PENDING_FIX", "FALSE_POSITIVE", "ACCEPTED_RISK", "NO_PENDING_FIX", "HUMAN_ERROR", "NO_LONGER_ACCEPTED_RISK", "OTHER"] FindingResource: description: The resource name of this finding. example: my_resource_name @@ -25422,24 +24481,19 @@ components: FindingStatus: description: The status of the finding. enum: - - critical - - high - - medium - - low - - info + - critical + - high + - medium + - low + - info example: critical type: string - x-enum-varnames: - - CRITICAL - - HIGH - - MEDIUM - - LOW - - INFO + x-enum-varnames: ["CRITICAL", "HIGH", "MEDIUM", "LOW", "INFO"] FindingTags: description: The tags associated with this finding. example: - - cloud_provider:aws - - myTag:myValue + - cloud_provider:aws + - myTag:myValue items: description: The list of tags. type: string @@ -25448,70 +24502,57 @@ components: default: finding description: The JSON:API type for findings. enum: - - finding + - finding example: finding type: string - x-enum-varnames: - - FINDING + x-enum-varnames: ["FINDING"] FindingVulnerabilityType: description: The vulnerability type of the finding. enum: - - misconfiguration - - attack_path - - identity_risk - - api_security + - misconfiguration + - attack_path + - identity_risk + - api_security example: misconfiguration type: string x-enum-varnames: - - MISCONFIGURATION - - ATTACK_PATH - - IDENTITY_RISK - - API_SECURITY + - MISCONFIGURATION + - ATTACK_PATH + - IDENTITY_RISK + - API_SECURITY Findings: description: A list of security findings. properties: data: items: - $ref: '#/components/schemas/FindingData' + $ref: "#/components/schemas/FindingData" type: array type: object FlakyTest: description: A flaky test object. properties: attributes: - $ref: '#/components/schemas/FlakyTestAttributes' + $ref: "#/components/schemas/FlakyTestAttributes" id: - description: Test's ID. This ID is the hash of the test's Fully Qualified - Name and Git repository ID. On the Test Runs UI it is the same as the - `test_fingerprint_fqn` tag. + description: Test's ID. This ID is the hash of the test's Fully Qualified Name and Git repository ID. On the Test Runs UI it is the same as the `test_fingerprint_fqn` tag. type: string type: - $ref: '#/components/schemas/FlakyTestType' + $ref: "#/components/schemas/FlakyTestType" type: object FlakyTestAttributes: description: Attributes of a flaky test. properties: attempt_to_fix_id: - description: 'Unique identifier for the attempt to fix this flaky test. - Use this ID in the Git commit message in order to trigger the attempt - to fix workflow. - + description: |- + Unique identifier for the attempt to fix this flaky test. Use this ID in the Git commit message in order to trigger the attempt to fix workflow. - When the workflow is triggered the test is automatically retried by the - tracer a certain number of configurable times. When all retries pass, - the test is automatically marked as fixed in Flaky Test Management. - - Test runs are tagged with @test.test_management.attempt_to_fix_passed - and @test.test_management.is_attempt_to_fix when the attempt to fix workflow - is triggered.' + When the workflow is triggered the test is automatically retried by the tracer a certain number of configurable times. When all retries pass, the test is automatically marked as fixed in Flaky Test Management. + Test runs are tagged with @test.test_management.attempt_to_fix_passed and @test.test_management.is_attempt_to_fix when the attempt to fix workflow is triggered. example: I42TEO type: string codeowners: - description: The name of the test's code owners as inferred from the repository - configuration. - example: - - '@foo' - - '@bar' + description: The name of the test's code owners as inferred from the repository configuration. + example: ["@foo", "@bar"] items: type: string type: array @@ -25522,18 +24563,15 @@ components: type: string type: array first_flaked_branch: - description: The branch name where the test exhibited flakiness for the - first time. + description: The branch name where the test exhibited flakiness for the first time. example: main type: string first_flaked_sha: - description: The commit SHA where the test exhibited flakiness for the first - time. + description: The commit SHA where the test exhibited flakiness for the first time. example: 0c6be03165b7f7ffe96e076ffb29afb2825616c3 type: string first_flaked_ts: - description: Unix timestamp when the test exhibited flakiness for the first - time. + description: Unix timestamp when the test exhibited flakiness for the first time. example: 1757688149 format: int64 type: integer @@ -25543,114 +24581,82 @@ components: nullable: true type: string flaky_state: - $ref: '#/components/schemas/FlakyTestAttributesFlakyState' + $ref: "#/components/schemas/FlakyTestAttributesFlakyState" history: - description: 'Chronological history of status changes for this flaky test, - ordered from most recent to oldest. - - Includes state transitions like new -> quarantined -> fixed, along with - the associated commit SHA when available.' + description: |- + Chronological history of status changes for this flaky test, ordered from most recent to oldest. + Includes state transitions like new -> quarantined -> fixed, along with the associated commit SHA when available. example: - - commit_sha: abc123def456 - status: quarantined - timestamp: 1704067200000 - - commit_sha: '' - status: new - timestamp: 1703980800000 + - commit_sha: abc123def456 + status: quarantined + timestamp: 1704067200000 + - commit_sha: "" + status: new + timestamp: 1703980800000 items: - $ref: '#/components/schemas/FlakyTestHistory' + $ref: "#/components/schemas/FlakyTestHistory" type: array last_flaked_branch: - description: The branch name where the test exhibited flakiness for the - last time. + description: The branch name where the test exhibited flakiness for the last time. example: main type: string last_flaked_sha: - description: The commit SHA where the test exhibited flakiness for the last - time. + description: The commit SHA where the test exhibited flakiness for the last time. example: 0c6be03165b7f7ffe96e076ffb29afb2825616c3 type: string last_flaked_ts: - description: Unix timestamp when the test exhibited flakiness for the last - time. + description: Unix timestamp when the test exhibited flakiness for the last time. example: 1757688149 format: int64 type: integer module: - description: 'The name of the test module. The definition of module changes - slightly per language: - - - In .NET, a test module groups every test that is run under the same - unit test project. - + description: |- + The name of the test module. The definition of module changes slightly per language: + - In .NET, a test module groups every test that is run under the same unit test project. - In Swift, a test module groups every test that is run for a given bundle. - - In JavaScript, the test modules map one-to-one to test sessions. - - - In Java, a test module groups every test that is run by the same Maven - Surefire/Failsafe or Gradle Test task execution. - - - In Python, a test module groups every test that is run under the same - `.py` file as part of a test suite, which is typically managed by a framework - like `unittest` or `pytest`. - - - In Ruby, a test module groups every test that is run within the same - test file, which is typically managed by a framework like `RSpec` or `Minitest`.' + - In Java, a test module groups every test that is run by the same Maven Surefire/Failsafe or Gradle Test task execution. + - In Python, a test module groups every test that is run under the same `.py` file as part of a test suite, which is typically managed by a framework like `unittest` or `pytest`. + - In Ruby, a test module groups every test that is run within the same test file, which is typically managed by a framework like `RSpec` or `Minitest`. example: TestModule nullable: true type: string name: - description: The test name. A concise name for a test case. Defined in the - test itself. + description: The test name. A concise name for a test case. Defined in the test itself. example: TestName type: string pipeline_stats: - $ref: '#/components/schemas/FlakyTestPipelineStats' + $ref: "#/components/schemas/FlakyTestPipelineStats" nullable: true services: - description: 'List of test service names where this test has been flaky. - + description: |- + List of test service names where this test has been flaky. - A test service is a group of tests associated with a project or repository. - It contains all the individual tests for your code, optionally organized - into test suites, which are like folders for your tests.' - example: - - foo - - bar + A test service is a group of tests associated with a project or repository. It contains all the individual tests for your code, optionally organized into test suites, which are like folders for your tests. + example: ["foo", "bar"] items: type: string type: array suite: - description: The name of the test suite. A group of tests exercising the - same unit of code depending on your language and testing framework. + description: The name of the test suite. A group of tests exercising the same unit of code depending on your language and testing framework. example: TestSuite type: string test_run_metadata: - $ref: '#/components/schemas/FlakyTestRunMetadata' + $ref: "#/components/schemas/FlakyTestRunMetadata" test_stats: - $ref: '#/components/schemas/FlakyTestStats' + $ref: "#/components/schemas/FlakyTestStats" type: object FlakyTestAttributesFlakyState: description: The current state of the flaky test. - enum: - - active - - fixed - - quarantined - - disabled + enum: [active, fixed, quarantined, disabled] example: active type: string - x-enum-varnames: - - ACTIVE - - FIXED - - QUARANTINED - - DISABLED + x-enum-varnames: [ACTIVE, FIXED, QUARANTINED, DISABLED] FlakyTestHistory: - description: A single history entry representing a status change for a flaky - test. + description: A single history entry representing a status change for a flaky test. properties: commit_sha: - description: The commit SHA associated with this status change. Will be - an empty string if the commit SHA is not available. + description: The commit SHA associated with this status change. Will be an empty string if the commit SHA is not available. example: abc123def456 type: string status: @@ -25663,27 +24669,21 @@ components: format: int64 type: integer required: - - status - - commit_sha - - timestamp + - status + - commit_sha + - timestamp type: object FlakyTestPipelineStats: - description: CI pipeline related statistics for the flaky test. This information - is only available if test runs are associated with CI pipeline events from - CI Visibility. + description: CI pipeline related statistics for the flaky test. This information is only available if test runs are associated with CI pipeline events from CI Visibility. properties: failed_pipelines: - description: The number of pipelines that failed due to this test for the - past 7 days. This is computed as the sum of failed CI pipeline events - associated with test runs where the flaky test failed. + description: The number of pipelines that failed due to this test for the past 7 days. This is computed as the sum of failed CI pipeline events associated with test runs where the flaky test failed. example: 319 format: int64 nullable: true type: integer total_lost_time_ms: - description: The total time lost by CI pipelines due to this flaky test - in milliseconds. This is computed as the sum of the duration of failed - CI pipeline events associated with test runs where the flaky test failed. + description: The total time lost by CI pipelines due to this flaky test in milliseconds. This is computed as the sum of the duration of failed CI pipeline events associated with test runs where the flaky test failed. example: 1527550000 format: int64 nullable: true @@ -25700,14 +24700,12 @@ components: type: integer error_message: description: The error message from the test failure. - example: Expecting actual not to be empty + example: "Expecting actual not to be empty" nullable: true type: string error_stack: description: The stack trace from the test failure. - example: "Traceback (most recent call last):\n File \"test_foo.py\", line - 10, in test_foo\n assert actual == expected\nAssertionError: Expecting - actual not to be empty" + example: "Traceback (most recent call last):\n File \"test_foo.py\", line 10, in test_foo\n assert actual == expected\nAssertionError: Expecting actual not to be empty" nullable: true type: string source_end: @@ -25732,9 +24730,7 @@ components: description: Test statistics for the flaky test. properties: failure_rate_pct: - description: The failure rate percentage of the test for the past 7 days. - This is the number of failed test runs divided by the total number of - test runs (excluding skipped test runs). + description: The failure rate percentage of the test for the past 7 days. This is the number of failed test runs divided by the total number of test runs (excluding skipped test runs). example: 0.1 format: double nullable: true @@ -25742,11 +24738,9 @@ components: type: object FlakyTestType: description: The type of the flaky test from Flaky Test Management. - enum: - - flaky_test + enum: [flaky_test] type: string - x-enum-varnames: - - FLAKY_TEST + x-enum-varnames: [FLAKY_TEST] FlakyTestsPagination: description: Pagination metadata for flaky tests. properties: @@ -25759,39 +24753,29 @@ components: description: Search filter settings. properties: query: - default: '*' - description: 'Search query following log syntax used to filter flaky tests, - same as on Flaky Tests Management UI. The supported search keys are: - + default: "*" + description: |- + Search query following log syntax used to filter flaky tests, same as on Flaky Tests Management UI. The supported search keys are: - `flaky_test_state` - - `flaky_test_category` - - `@test.name` - - `@test.suite` - - `@test.module` - - `@test.service` - - `@git.repository.id_v2` - - `@git.branch` - - `@test.codeowners` - - - `env`' - example: flaky_test_state:active @git.repository.id_v2:"github.com/datadog/shopist" + - `env` + example: 'flaky_test_state:active @git.repository.id_v2:"github.com/datadog/shopist"' type: string type: object FlakyTestsSearchPageOptions: description: Pagination attributes for listing flaky tests. properties: cursor: - description: List following results with a cursor provided in the previous - request. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + List following results with a cursor provided in the previous request. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string limit: default: 10 @@ -25806,118 +24790,113 @@ components: description: The request for a flaky tests search. properties: data: - $ref: '#/components/schemas/FlakyTestsSearchRequestData' + $ref: "#/components/schemas/FlakyTestsSearchRequestData" type: object FlakyTestsSearchRequestAttributes: description: Attributes for the flaky tests search request. properties: filter: - $ref: '#/components/schemas/FlakyTestsSearchFilter' + $ref: "#/components/schemas/FlakyTestsSearchFilter" include_history: default: false - description: 'Whether to include the status change history for each flaky - test in the response. - - When set to true, each test will include a `history` array with chronological - status changes. - - Defaults to false.' + description: |- + Whether to include the status change history for each flaky test in the response. + When set to true, each test will include a `history` array with chronological status changes. + Defaults to false. example: true type: boolean page: - $ref: '#/components/schemas/FlakyTestsSearchPageOptions' + $ref: "#/components/schemas/FlakyTestsSearchPageOptions" sort: - $ref: '#/components/schemas/FlakyTestsSearchSort' + $ref: "#/components/schemas/FlakyTestsSearchSort" type: object FlakyTestsSearchRequestData: description: The JSON:API data for flaky tests search request. properties: attributes: - $ref: '#/components/schemas/FlakyTestsSearchRequestAttributes' + $ref: "#/components/schemas/FlakyTestsSearchRequestAttributes" type: - $ref: '#/components/schemas/FlakyTestsSearchRequestDataType' + $ref: "#/components/schemas/FlakyTestsSearchRequestDataType" type: object FlakyTestsSearchRequestDataType: description: The definition of `FlakyTestsSearchRequestDataType` object. enum: - - search_flaky_tests_request + - search_flaky_tests_request type: string x-enum-varnames: - - SEARCH_FLAKY_TESTS_REQUEST + - SEARCH_FLAKY_TESTS_REQUEST FlakyTestsSearchResponse: description: Response object with flaky tests matching the search request. properties: data: description: Array of flaky tests matching the request. items: - $ref: '#/components/schemas/FlakyTest' + $ref: "#/components/schemas/FlakyTest" type: array meta: - $ref: '#/components/schemas/FlakyTestsSearchResponseMeta' + $ref: "#/components/schemas/FlakyTestsSearchResponseMeta" type: object FlakyTestsSearchResponseMeta: description: Metadata for the flaky tests search response. properties: pagination: - $ref: '#/components/schemas/FlakyTestsPagination' + $ref: "#/components/schemas/FlakyTestsPagination" type: object FlakyTestsSearchSort: - description: Parameter for sorting flaky test results. The default sort is by - ascending Fully Qualified Name (FQN). The FQN is the concatenation of the - test module, suite, and name. - enum: - - fqn - - -fqn - - first_flaked - - -first_flaked - - last_flaked - - -last_flaked - - failure_rate - - -failure_rate - - pipelines_failed - - -pipelines_failed - - pipelines_duration_lost - - -pipelines_duration_lost + description: Parameter for sorting flaky test results. The default sort is by ascending Fully Qualified Name (FQN). The FQN is the concatenation of the test module, suite, and name. + enum: + - fqn + - -fqn + - first_flaked + - -first_flaked + - last_flaked + - -last_flaked + - failure_rate + - -failure_rate + - pipelines_failed + - -pipelines_failed + - pipelines_duration_lost + - -pipelines_duration_lost example: failure_rate type: string x-enum-varnames: - - FQN_ASCENDING - - FQN_DESCENDING - - FIRST_FLAKED_ASCENDING - - FIRST_FLAKED_DESCENDING - - LAST_FLAKED_ASCENDING - - LAST_FLAKED_DESCENDING - - FAILURE_RATE_ASCENDING - - FAILURE_RATE_DESCENDING - - PIPELINES_FAILED_ASCENDING - - PIPELINES_FAILED_DESCENDING - - PIPELINES_DURATION_LOST_ASCENDING - - PIPELINES_DURATION_LOST_DESCENDING + - FQN_ASCENDING + - FQN_DESCENDING + - FIRST_FLAKED_ASCENDING + - FIRST_FLAKED_DESCENDING + - LAST_FLAKED_ASCENDING + - LAST_FLAKED_DESCENDING + - FAILURE_RATE_ASCENDING + - FAILURE_RATE_DESCENDING + - PIPELINES_FAILED_ASCENDING + - PIPELINES_FAILED_DESCENDING + - PIPELINES_DURATION_LOST_ASCENDING + - PIPELINES_DURATION_LOST_DESCENDING FleetAgentAttributes: description: Attributes of a Datadog Agent in the list view. properties: agent_version: description: The Datadog Agent version. - example: 7.50.0 + example: "7.50.0" type: string api_key_name: description: The API key name (if available and not redacted). - example: Production API Key + example: "Production API Key" type: string api_key_uuid: description: The API key UUID. - example: a1b2c3d4-e5f6-4321-a123-123456789abc + example: "a1b2c3d4-e5f6-4321-a123-123456789abc" type: string cloud_provider: description: The cloud provider where the agent is running. - example: aws + example: "aws" type: string cluster_name: description: Kubernetes cluster name (if applicable). type: string datadog_agent_key: description: The unique agent key identifier. - example: my-agent-hostname + example: "my-agent-hostname" type: string enabled_products: description: Datadog products enabled on the agent. @@ -25935,7 +24914,7 @@ components: type: integer hostname: description: The hostname of the agent. - example: my-hostname + example: "my-hostname" type: string ip_addresses: description: IP addresses of the agent. @@ -25951,7 +24930,7 @@ components: type: integer os: description: The operating system. - example: linux + example: "linux" type: string otel_collector_version: description: OpenTelemetry collector version (if applicable). @@ -25966,11 +24945,11 @@ components: type: string remote_agent_management: description: Remote agent management status. - example: enabled + example: "enabled" type: string remote_config_status: description: Remote configuration status. - example: connected + example: "connected" type: string services: description: Services running on the agent. @@ -25980,7 +24959,7 @@ components: tags: description: Tags associated with the agent. items: - $ref: '#/components/schemas/FleetAgentAttributesTagsItems' + $ref: "#/components/schemas/FleetAgentAttributesTagsItems" type: array team: description: Team associated with the agent. @@ -25997,58 +24976,58 @@ components: description: Represents detailed information about a specific Datadog Agent. properties: attributes: - $ref: '#/components/schemas/FleetAgentInfoAttributes' + $ref: "#/components/schemas/FleetAgentInfoAttributes" id: description: The unique agent key identifier. - example: my-agent-hostname + example: "my-agent-hostname" type: string type: - $ref: '#/components/schemas/FleetAgentInfoResourceType' + $ref: "#/components/schemas/FleetAgentInfoResourceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object FleetAgentInfoAttributes: description: Attributes for agent information. properties: agent_infos: - $ref: '#/components/schemas/FleetAgentInfoDetails' + $ref: "#/components/schemas/FleetAgentInfoDetails" configuration_files: - $ref: '#/components/schemas/FleetConfigurationLayer' + $ref: "#/components/schemas/FleetConfigurationLayer" detected_integrations: description: List of detected integrations. items: - $ref: '#/components/schemas/FleetDetectedIntegration' + $ref: "#/components/schemas/FleetDetectedIntegration" type: array integrations: - $ref: '#/components/schemas/FleetIntegrationsByStatus' + $ref: "#/components/schemas/FleetIntegrationsByStatus" type: object FleetAgentInfoDetails: description: Detailed information about a Datadog Agent. properties: agent_version: description: The Datadog Agent version. - example: 7.50.0 + example: "7.50.0" type: string api_key_name: description: The API key name (if available and not redacted). - example: Production API Key + example: "Production API Key" type: string api_key_uuid: description: The API key UUID. - example: a1b2c3d4-e5f6-4321-a123-123456789abc + example: "a1b2c3d4-e5f6-4321-a123-123456789abc" type: string cloud_provider: description: The cloud provider where the agent is running. - example: aws + example: "aws" type: string cluster_name: description: Kubernetes cluster name (if applicable). type: string datadog_agent_key: description: The unique agent key identifier. - example: my-agent-hostname + example: "my-agent-hostname" type: string enabled_products: description: Datadog products enabled on the agent. @@ -26066,7 +25045,7 @@ components: type: integer hostname: description: The hostname of the agent. - example: my-hostname + example: "my-hostname" type: string hostname_aliases: description: Alternative hostname list for the agent. @@ -26075,11 +25054,11 @@ components: type: array install_method_installer_version: description: The version of the installer used. - example: 1.2.3 + example: "1.2.3" type: string install_method_tool: description: The tool used to install the agent. - example: chef + example: "chef" type: string ip_addresses: description: IP addresses of the agent. @@ -26095,11 +25074,11 @@ components: type: integer os: description: The operating system. - example: linux + example: "linux" type: string os_version: description: The operating system version. - example: Ubuntu 20.04 + example: "Ubuntu 20.04" type: string otel_collector_version: description: OpenTelemetry collector version (if applicable). @@ -26112,14 +25091,14 @@ components: otel_collectors: description: OpenTelemetry collectors associated with the agent (if applicable). items: - $ref: '#/components/schemas/FleetOtelCollector' + $ref: "#/components/schemas/FleetOtelCollector" type: array pod_name: description: Kubernetes pod name (if applicable). type: string python_version: description: The Python version used by the agent. - example: 3.9.5 + example: "3.9.5" type: string region: description: Regions where the agent is running. @@ -26128,11 +25107,11 @@ components: type: array remote_agent_management: description: Remote agent management status. - example: enabled + example: "enabled" type: string remote_config_status: description: Remote configuration status. - example: connected + example: "connected" type: string services: description: Services running on the agent. @@ -26152,103 +25131,102 @@ components: default: datadog_agent_key description: The type of Agent info resource. enum: - - datadog_agent_key + - datadog_agent_key example: datadog_agent_key type: string x-enum-varnames: - - DATADOG_AGENT_KEY + - DATADOG_AGENT_KEY FleetAgentInfoResponse: description: Response containing detailed information about a specific agent. properties: data: - $ref: '#/components/schemas/FleetAgentInfo' + $ref: "#/components/schemas/FleetAgentInfo" required: - - data + - data type: object FleetAgentVersion: description: Represents an available Datadog Agent version. properties: attributes: - $ref: '#/components/schemas/FleetAgentVersionAttributes' + $ref: "#/components/schemas/FleetAgentVersionAttributes" id: description: Unique identifier for the Agent version (same as version). - example: 7.50.0 + example: "7.50.0" type: string type: - $ref: '#/components/schemas/FleetAgentVersionResourceType' + $ref: "#/components/schemas/FleetAgentVersionResourceType" required: - - id - - type + - id + - type type: object FleetAgentVersionAttributes: properties: version: description: The Agent version string. - example: 7.50.0 + example: "7.50.0" type: string type: object FleetAgentVersionResourceType: default: agent_version description: The type of Agent version resource. enum: - - agent_version + - agent_version example: agent_version type: string x-enum-varnames: - - AGENT_VERSION + - AGENT_VERSION FleetAgentVersionsResponse: description: Response containing a list of available Agent versions. properties: data: description: Array of available Agent versions. items: - $ref: '#/components/schemas/FleetAgentVersion' + $ref: "#/components/schemas/FleetAgentVersion" type: array required: - - data + - data type: object FleetAgentsResponse: description: Response containing a paginated list of Datadog Agents. properties: data: - $ref: '#/components/schemas/FleetAgentsResponseData' + $ref: "#/components/schemas/FleetAgentsResponseData" meta: - $ref: '#/components/schemas/FleetAgentsResponseMeta' + $ref: "#/components/schemas/FleetAgentsResponseMeta" required: - - data + - data type: object FleetAgentsResponseData: description: The response data containing status and agents array. properties: attributes: - $ref: '#/components/schemas/FleetAgentsResponseDataAttributes' + $ref: "#/components/schemas/FleetAgentsResponseDataAttributes" id: description: Status identifier. - example: done + example: "done" type: string type: description: Resource type. - example: status + example: "status" type: string required: - - id - - type - - attributes + - id + - type + - attributes type: object FleetAgentsResponseDataAttributes: properties: agents: description: Array of agents matching the query criteria. items: - $ref: '#/components/schemas/FleetAgentAttributes' + $ref: "#/components/schemas/FleetAgentAttributes" type: array type: object FleetAgentsResponseMeta: description: Metadata for the list of agents response. properties: total_filtered_count: - description: Total number of agents matching the filter criteria across - all pages. + description: Total number of agents matching the filter criteria across all pages. example: 150 format: int64 type: integer @@ -26261,11 +25239,11 @@ components: type: string file_path: description: Path to the configuration file. - example: /conf.d/postgres.d/postgres.yaml + example: "/conf.d/postgres.d/postgres.yaml" type: string filename: description: Name of the configuration file. - example: postgres.yaml + example: "postgres.yaml" type: string type: object FleetConfigurationLayer: @@ -26291,66 +25269,56 @@ components: type: string type: object FleetDeployment: - description: A deployment that defines automated configuration changes for a - fleet of hosts. + description: A deployment that defines automated configuration changes for a fleet of hosts. properties: attributes: - $ref: '#/components/schemas/FleetDeploymentAttributes' + $ref: "#/components/schemas/FleetDeploymentAttributes" id: description: Unique identifier for the deployment. - example: aeadc05e-98a8-11ec-ac2c-da7ad0900001 + example: "aeadc05e-98a8-11ec-ac2c-da7ad0900001" type: string type: - $ref: '#/components/schemas/FleetDeploymentResourceType' + $ref: "#/components/schemas/FleetDeploymentResourceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object FleetDeploymentAttributes: description: Attributes of a deployment in the response. properties: config_operations: - description: Ordered list of configuration file operations to perform on - the target hosts. + description: Ordered list of configuration file operations to perform on the target hosts. items: - $ref: '#/components/schemas/FleetDeploymentOperation' + $ref: "#/components/schemas/FleetDeploymentOperation" type: array estimated_end_time_unix: - description: Estimated completion time of the deployment as a Unix timestamp - (seconds since epoch). + description: Estimated completion time of the deployment as a Unix timestamp (seconds since epoch). example: 1699999999 format: int64 type: integer filter_query: - description: Query used to filter and select target hosts for the deployment. - Uses the Datadog query syntax. - example: env:prod AND service:web + description: Query used to filter and select target hosts for the deployment. Uses the Datadog query syntax. + example: "env:prod AND service:web" type: string high_level_status: - description: 'Current high-level status of the deployment (for example, - "pending", "running", - - "completed", "failed").' - example: pending + description: |- + Current high-level status of the deployment (for example, "pending", "running", + "completed", "failed"). + example: "pending" type: string hosts: - description: 'Paginated list of hosts in this deployment with their individual - statuses. Only included - - when fetching a single deployment by ID. Use the `limit` and `page` query - parameters to - - navigate through pages. Pagination metadata is included in the response - `meta.hosts` field.' + description: |- + Paginated list of hosts in this deployment with their individual statuses. Only included + when fetching a single deployment by ID. Use the `limit` and `page` query parameters to + navigate through pages. Pagination metadata is included in the response `meta.hosts` field. items: - $ref: '#/components/schemas/FleetDeploymentHost' + $ref: "#/components/schemas/FleetDeploymentHost" type: array packages: - description: List of packages to deploy to target hosts. Present only for - package upgrade deployments. + description: List of packages to deploy to target hosts. Present only for package upgrade deployments. items: - $ref: '#/components/schemas/FleetDeploymentPackage' + $ref: "#/components/schemas/FleetDeploymentPackage" type: array total_hosts: description: Total number of hosts targeted by this deployment. @@ -26362,95 +25330,91 @@ components: description: Attributes for creating a new configuration deployment. properties: config_operations: - description: Ordered list of configuration file operations to perform on - the target hosts. + description: Ordered list of configuration file operations to perform on the target hosts. items: - $ref: '#/components/schemas/FleetDeploymentOperation' + $ref: "#/components/schemas/FleetDeploymentOperation" type: array filter_query: - description: Query used to filter and select target hosts for the deployment. - Uses the Datadog query syntax. - example: env:prod AND service:web + description: Query used to filter and select target hosts for the deployment. Uses the Datadog query syntax. + example: "env:prod AND service:web" type: string required: - - config_operations + - config_operations type: object FleetDeploymentConfigureCreate: description: Data for creating a new configuration deployment. properties: attributes: - $ref: '#/components/schemas/FleetDeploymentConfigureAttributes' + $ref: "#/components/schemas/FleetDeploymentConfigureAttributes" type: - $ref: '#/components/schemas/FleetDeploymentResourceType' + $ref: "#/components/schemas/FleetDeploymentResourceType" required: - - type - - attributes + - type + - attributes type: object FleetDeploymentConfigureCreateRequest: description: Request payload for creating a new configuration deployment. properties: data: - $ref: '#/components/schemas/FleetDeploymentConfigureCreate' + $ref: "#/components/schemas/FleetDeploymentConfigureCreate" required: - - data + - data type: object FleetDeploymentFileOp: - description: "Type of file operation to perform on the target configuration - file.\n- `merge-patch`: Merges the provided patch data with the existing configuration - file.\n Creates the file if it doesn't exist.\n- `delete`: Removes the specified - configuration file from the target hosts." + description: |- + Type of file operation to perform on the target configuration file. + - `merge-patch`: Merges the provided patch data with the existing configuration file. + Creates the file if it doesn't exist. + - `delete`: Removes the specified configuration file from the target hosts. enum: - - merge-patch - - delete - example: merge-patch + - "merge-patch" + - "delete" + example: "merge-patch" type: string x-enum-varnames: - - MERGE_PATCH - - DELETE + - MERGE_PATCH + - DELETE FleetDeploymentHost: description: A host that is part of a deployment with its current status. properties: error: description: Error message if the deployment failed on this host. - example: '' + example: "" type: string hostname: description: The hostname of the agent. - example: web-server-01.example.com + example: "web-server-01.example.com" type: string status: description: Current deployment status for this specific host. - example: succeeded + example: "succeeded" type: string versions: - description: List of packages and their versions currently installed on - this host. + description: List of packages and their versions currently installed on this host. items: - $ref: '#/components/schemas/FleetDeploymentHostPackage' + $ref: "#/components/schemas/FleetDeploymentHostPackage" type: array type: object FleetDeploymentHostPackage: - description: 'Package version information for a host, showing the initial version - before deployment, - - the target version to deploy, and the current version on the host.' + description: |- + Package version information for a host, showing the initial version before deployment, + the target version to deploy, and the current version on the host. properties: current_version: description: The current version of the package on the host. - example: 7.51.0 + example: "7.51.0" type: string initial_version: - description: The initial version of the package on the host before the deployment - started. - example: 7.51.0 + description: The initial version of the package on the host before the deployment started. + example: "7.51.0" type: string package_name: description: The name of the package. - example: datadog-agent + example: "datadog-agent" type: string target_version: description: The target version that the deployment is attempting to install. - example: 7.52.0 + example: "7.52.0" type: string type: object FleetDeploymentHostsPage: @@ -26478,112 +25442,103 @@ components: type: integer type: object FleetDeploymentOperation: - description: A single configuration file operation to perform on the target - hosts. + description: A single configuration file operation to perform on the target hosts. properties: file_op: - $ref: '#/components/schemas/FleetDeploymentFileOp' + $ref: "#/components/schemas/FleetDeploymentFileOp" file_path: description: Absolute path to the target configuration file on the host. - example: /datadog.yaml + example: "/datadog.yaml" type: string patch: additionalProperties: {} - description: 'Patch data in JSON format to apply to the configuration file. - + description: |- + Patch data in JSON format to apply to the configuration file. When using `merge-patch`, this object is merged with the existing configuration, - - allowing you to add, update, or override specific fields without replacing - the entire file. - - The structure must match the target configuration file format (for example, - YAML structure - - for Datadog Agent config). Not applicable when using the `delete` operation.' + allowing you to add, update, or override specific fields without replacing the entire file. + The structure must match the target configuration file format (for example, YAML structure + for Datadog Agent config). Not applicable when using the `delete` operation. example: apm_config: enabled: true - log_level: debug + log_level: "debug" logs_enabled: true type: object required: - - file_op - - file_path + - file_op + - file_path type: object FleetDeploymentPackage: description: A package and its target version for deployment. properties: name: description: The name of the package to deploy. - example: datadog-agent + example: "datadog-agent" type: string version: description: The target version of the package to deploy. - example: 7.52.0 + example: "7.52.0" type: string required: - - name - - version + - name + - version type: object FleetDeploymentPackageUpgradeAttributes: description: Attributes for creating a new package upgrade deployment. properties: filter_query: - description: Query used to filter and select target hosts for the deployment. - Uses the Datadog query syntax. - example: env:prod AND service:web + description: Query used to filter and select target hosts for the deployment. Uses the Datadog query syntax. + example: "env:prod AND service:web" type: string target_packages: - description: List of packages and their target versions to deploy to the - selected hosts. + description: List of packages and their target versions to deploy to the selected hosts. items: - $ref: '#/components/schemas/FleetDeploymentPackage' + $ref: "#/components/schemas/FleetDeploymentPackage" type: array required: - - target_packages + - target_packages type: object FleetDeploymentPackageUpgradeCreate: description: Data for creating a new package upgrade deployment. properties: attributes: - $ref: '#/components/schemas/FleetDeploymentPackageUpgradeAttributes' + $ref: "#/components/schemas/FleetDeploymentPackageUpgradeAttributes" type: - $ref: '#/components/schemas/FleetDeploymentResourceType' + $ref: "#/components/schemas/FleetDeploymentResourceType" required: - - type - - attributes + - type + - attributes type: object FleetDeploymentPackageUpgradeCreateRequest: description: Request payload for creating a new package upgrade deployment. properties: data: - $ref: '#/components/schemas/FleetDeploymentPackageUpgradeCreate' + $ref: "#/components/schemas/FleetDeploymentPackageUpgradeCreate" required: - - data + - data type: object FleetDeploymentResourceType: default: deployment description: The type of deployment resource. enum: - - deployment + - deployment example: deployment type: string x-enum-varnames: - - DEPLOYMENT + - DEPLOYMENT FleetDeploymentResponse: description: Response containing a single deployment. properties: data: - $ref: '#/components/schemas/FleetDeployment' + $ref: "#/components/schemas/FleetDeployment" meta: - $ref: '#/components/schemas/FleetDeploymentResponseMeta' + $ref: "#/components/schemas/FleetDeploymentResponseMeta" type: object FleetDeploymentResponseMeta: - description: Metadata for a single deployment response, including pagination - information for hosts. + description: Metadata for a single deployment response, including pagination information for hosts. properties: hosts: - $ref: '#/components/schemas/FleetDeploymentHostsPage' + $ref: "#/components/schemas/FleetDeploymentHostsPage" type: object FleetDeploymentsPage: description: Pagination details for the list of deployments. @@ -26600,29 +25555,29 @@ components: data: description: Array of deployments matching the query criteria. items: - $ref: '#/components/schemas/FleetDeployment' + $ref: "#/components/schemas/FleetDeployment" type: array meta: - $ref: '#/components/schemas/FleetDeploymentsResponseMeta' + $ref: "#/components/schemas/FleetDeploymentsResponseMeta" required: - - data + - data type: object FleetDeploymentsResponseMeta: description: Metadata for the list of deployments, including pagination information. properties: page: - $ref: '#/components/schemas/FleetDeploymentsPage' + $ref: "#/components/schemas/FleetDeploymentsPage" type: object FleetDetectedIntegration: description: An integration detected on the agent but not necessarily configured. properties: escaped_name: description: Escaped integration name. - example: postgresql + example: "postgresql" type: string prefix: description: Integration prefix identifier. - example: postgres + example: "postgres" type: string type: object FleetIntegrationDetails: @@ -26630,7 +25585,7 @@ components: properties: data_type: description: Type of data collected (metrics, logs). - example: metrics + example: "metrics" type: string error_messages: description: Error messages if the integration has issues. @@ -26661,7 +25616,7 @@ components: type: string type: description: Integration type. - example: postgres + example: "postgres" type: string type: object FleetIntegrationsByStatus: @@ -26670,7 +25625,7 @@ components: configuration_files: description: Configuration files for integrations. items: - $ref: '#/components/schemas/FleetConfigurationFile' + $ref: "#/components/schemas/FleetConfigurationFile" type: array datadog_agent_key: description: The unique agent key identifier. @@ -26678,22 +25633,22 @@ components: error_integrations: description: Integrations with errors. items: - $ref: '#/components/schemas/FleetIntegrationDetails' + $ref: "#/components/schemas/FleetIntegrationDetails" type: array missing_integrations: description: Detected but not configured integrations. items: - $ref: '#/components/schemas/FleetDetectedIntegration' + $ref: "#/components/schemas/FleetDetectedIntegration" type: array warning_integrations: description: Integrations with warnings. items: - $ref: '#/components/schemas/FleetIntegrationDetails' + $ref: "#/components/schemas/FleetIntegrationDetails" type: array working_integrations: description: Integrations that are working correctly. items: - $ref: '#/components/schemas/FleetIntegrationDetails' + $ref: "#/components/schemas/FleetIntegrationDetails" type: array type: object FleetOtelCollector: @@ -26701,68 +25656,61 @@ components: description: OpenTelemetry collector information. type: object FleetSchedule: - description: A schedule that automatically creates deployments based on a recurrence - rule. + description: A schedule that automatically creates deployments based on a recurrence rule. properties: attributes: - $ref: '#/components/schemas/FleetScheduleAttributes' + $ref: "#/components/schemas/FleetScheduleAttributes" id: description: Unique identifier for the schedule. - example: abc-def-ghi-123 + example: "abc-def-ghi-123" type: string type: - $ref: '#/components/schemas/FleetScheduleResourceType' + $ref: "#/components/schemas/FleetScheduleResourceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object FleetScheduleAttributes: description: Attributes of a schedule in the response. properties: created_at_unix: - description: Unix timestamp (seconds since epoch) when the schedule was - created. + description: Unix timestamp (seconds since epoch) when the schedule was created. example: 1699999999 format: int64 type: integer created_by: description: User handle of the person who created the schedule. - example: user@example.com + example: "user@example.com" type: string name: description: Human-readable name for the schedule. - example: Weekly Production Agent Updates + example: "Weekly Production Agent Updates" type: string query: - description: Query used to filter and select target hosts for scheduled - deployments. Uses the Datadog query syntax. - example: env:prod AND service:web + description: Query used to filter and select target hosts for scheduled deployments. Uses the Datadog query syntax. + example: "env:prod AND service:web" type: string rule: - $ref: '#/components/schemas/FleetScheduleRecurrenceRule' + $ref: "#/components/schemas/FleetScheduleRecurrenceRule" status: - $ref: '#/components/schemas/FleetScheduleStatus' + $ref: "#/components/schemas/FleetScheduleStatus" updated_at_unix: - description: Unix timestamp (seconds since epoch) when the schedule was - last updated. + description: Unix timestamp (seconds since epoch) when the schedule was last updated. example: 1699999999 format: int64 type: integer updated_by: description: User handle of the person who last updated the schedule. - example: user@example.com + example: "user@example.com" type: string version_to_latest: - description: 'Number of major versions behind the latest to target for upgrades. - + description: |- + Number of major versions behind the latest to target for upgrades. - 0: Always upgrade to the latest version - - 1: Upgrade to latest minus 1 major version - - 2: Upgrade to latest minus 2 major versions - - Maximum value is 2.' + Maximum value is 2. example: 0 format: int64 maximum: 2 @@ -26773,93 +25721,85 @@ components: description: Data for creating a new schedule. properties: attributes: - $ref: '#/components/schemas/FleetScheduleCreateAttributes' + $ref: "#/components/schemas/FleetScheduleCreateAttributes" type: - $ref: '#/components/schemas/FleetScheduleResourceType' + $ref: "#/components/schemas/FleetScheduleResourceType" required: - - type - - attributes + - type + - attributes type: object FleetScheduleCreateAttributes: description: Attributes for creating a new schedule. properties: name: description: Human-readable name for the schedule. - example: Weekly Production Agent Updates + example: "Weekly Production Agent Updates" type: string query: - description: Query used to filter and select target hosts for scheduled - deployments. Uses the Datadog query syntax. - example: env:prod AND service:web + description: Query used to filter and select target hosts for scheduled deployments. Uses the Datadog query syntax. + example: "env:prod AND service:web" type: string rule: - $ref: '#/components/schemas/FleetScheduleRecurrenceRule' + $ref: "#/components/schemas/FleetScheduleRecurrenceRule" status: - $ref: '#/components/schemas/FleetScheduleStatus' + $ref: "#/components/schemas/FleetScheduleStatus" version_to_latest: - description: 'Number of major versions behind the latest to target for upgrades. - + description: |- + Number of major versions behind the latest to target for upgrades. - 0: Always upgrade to the latest version (default) - - 1: Upgrade to latest minus 1 major version - - 2: Upgrade to latest minus 2 major versions - - Maximum value is 2.' + Maximum value is 2. example: 0 format: int64 maximum: 2 minimum: 0 type: integer required: - - name - - query - - rule + - name + - query + - rule type: object FleetScheduleCreateRequest: description: Request payload for creating a new schedule. properties: data: - $ref: '#/components/schemas/FleetScheduleCreate' + $ref: "#/components/schemas/FleetScheduleCreate" required: - - data + - data type: object FleetSchedulePatch: description: Data for partially updating a schedule. properties: attributes: - $ref: '#/components/schemas/FleetSchedulePatchAttributes' + $ref: "#/components/schemas/FleetSchedulePatchAttributes" type: - $ref: '#/components/schemas/FleetScheduleResourceType' + $ref: "#/components/schemas/FleetScheduleResourceType" required: - - type + - type type: object FleetSchedulePatchAttributes: description: Attributes for partially updating a schedule. All fields are optional. properties: name: description: Human-readable name for the schedule. - example: Weekly Production Agent Updates + example: "Weekly Production Agent Updates" type: string query: - description: Query used to filter and select target hosts for scheduled - deployments. Uses the Datadog query syntax. - example: env:prod AND service:web + description: Query used to filter and select target hosts for scheduled deployments. Uses the Datadog query syntax. + example: "env:prod AND service:web" type: string rule: - $ref: '#/components/schemas/FleetScheduleRecurrenceRule' + $ref: "#/components/schemas/FleetScheduleRecurrenceRule" status: - $ref: '#/components/schemas/FleetScheduleStatus' + $ref: "#/components/schemas/FleetScheduleStatus" version_to_latest: - description: 'Number of major versions behind the latest to target for upgrades. - + description: |- + Number of major versions behind the latest to target for upgrades. - 0: Always upgrade to the latest version - - 1: Upgrade to latest minus 1 major version - - 2: Upgrade to latest minus 2 major versions - - Maximum value is 2.' + Maximum value is 2. example: 0 format: int64 maximum: 2 @@ -26870,25 +25810,20 @@ components: description: Request payload for partially updating a schedule. properties: data: - $ref: '#/components/schemas/FleetSchedulePatch' + $ref: "#/components/schemas/FleetSchedulePatch" required: - - data + - data type: object FleetScheduleRecurrenceRule: - description: 'Defines the recurrence pattern for the schedule. Specifies when - deployments should be - - automatically triggered based on maintenance windows.' + description: |- + Defines the recurrence pattern for the schedule. Specifies when deployments should be + automatically triggered based on maintenance windows. properties: days_of_week: - description: 'List of days of the week when the schedule should trigger. - Valid values are: - - "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun".' - example: - - Mon - - Wed - - Fri + description: |- + List of days of the week when the schedule should trigger. Valid values are: + "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun". + example: ["Mon", "Wed", "Fri"] items: type: string type: array @@ -26898,87 +25833,82 @@ components: format: int64 type: integer start_maintenance_window: - description: 'Start time of the maintenance window in 24-hour clock format - (HH:MM). - - Deployments will be triggered at this time on the specified days.' - example: 02:00 + description: |- + Start time of the maintenance window in 24-hour clock format (HH:MM). + Deployments will be triggered at this time on the specified days. + example: "02:00" type: string timezone: - description: Timezone for the schedule in IANA Time Zone Database format - (e.g., "America/New_York", "UTC"). - example: America/New_York + description: Timezone for the schedule in IANA Time Zone Database format (e.g., "America/New_York", "UTC"). + example: "America/New_York" type: string required: - - days_of_week - - start_maintenance_window - - maintenance_window_duration - - timezone + - days_of_week + - start_maintenance_window + - maintenance_window_duration + - timezone type: object FleetScheduleResourceType: default: schedule description: The type of schedule resource. enum: - - schedule + - schedule example: schedule type: string x-enum-varnames: - - SCHEDULE + - SCHEDULE FleetScheduleResponse: description: Response containing a single schedule. properties: data: - $ref: '#/components/schemas/FleetSchedule' + $ref: "#/components/schemas/FleetSchedule" type: object FleetScheduleStatus: - description: 'The status of the schedule. - - - `active`: The schedule is active and will create deployments according to - its recurrence rule. - - - `inactive`: The schedule is inactive and will not create any deployments.' + description: |- + The status of the schedule. + - `active`: The schedule is active and will create deployments according to its recurrence rule. + - `inactive`: The schedule is inactive and will not create any deployments. enum: - - active - - inactive + - active + - inactive example: active type: string x-enum-varnames: - - ACTIVE - - INACTIVE + - ACTIVE + - INACTIVE FleetSchedulesResponse: description: Response containing a list of schedules. properties: data: description: Array of schedules. items: - $ref: '#/components/schemas/FleetSchedule' + $ref: "#/components/schemas/FleetSchedule" type: array required: - - data + - data type: object FormTrigger: - description: Trigger a workflow from a Form. + description: "Trigger a workflow from a Form." properties: formId: description: The form UUID. - example: '' + example: "" type: string type: object FormTriggerWrapper: - description: Schema for a Form-based trigger. + description: "Schema for a Form-based trigger." properties: formTrigger: - $ref: '#/components/schemas/FormTrigger' + $ref: "#/components/schemas/FormTrigger" startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - formTrigger + - formTrigger type: object FormulaLimit: - description: 'Message for specifying limits to the number of values returned - by a query. - - This limit is only for scalar queries and has no effect on timeseries queries.' + description: |- + Message for specifying limits to the number of values returned by a query. + This limit is only for scalar queries and has no effect on timeseries queries. properties: count: description: The number of results to which to limit. @@ -26987,50 +25917,50 @@ components: maximum: 2147483647 type: integer order: - $ref: '#/components/schemas/QuerySortOrder' + $ref: "#/components/schemas/QuerySortOrder" type: object FrameworkHandleAndVersionResponseData: description: Contains type and attributes for custom frameworks. properties: attributes: - $ref: '#/components/schemas/CustomFrameworkDataHandleAndVersion' + $ref: "#/components/schemas/CustomFrameworkDataHandleAndVersion" id: description: The ID of the custom framework. example: handle-version type: string type: - $ref: '#/components/schemas/CustomFrameworkType' + $ref: "#/components/schemas/CustomFrameworkType" required: - - id - - type - - attributes + - id + - type + - attributes type: object FreshserviceAPIKey: description: The definition of the `FreshserviceAPIKey` object. properties: api_key: description: The `FreshserviceAPIKey` `api_key`. - example: '' + example: "" type: string domain: description: The `FreshserviceAPIKey` `domain`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/FreshserviceAPIKeyType' + $ref: "#/components/schemas/FreshserviceAPIKeyType" required: - - type - - domain - - api_key + - type + - domain + - api_key type: object FreshserviceAPIKeyType: description: The definition of the `FreshserviceAPIKey` object. enum: - - FreshserviceAPIKey + - FreshserviceAPIKey example: FreshserviceAPIKey type: string x-enum-varnames: - - FRESHSERVICEAPIKEY + - FRESHSERVICEAPIKEY FreshserviceAPIKeyUpdate: description: The definition of the `FreshserviceAPIKey` object. properties: @@ -27041,59 +25971,59 @@ components: description: The `FreshserviceAPIKeyUpdate` `domain`. type: string type: - $ref: '#/components/schemas/FreshserviceAPIKeyType' + $ref: "#/components/schemas/FreshserviceAPIKeyType" required: - - type + - type type: object FreshserviceCredentials: description: The definition of the `FreshserviceCredentials` object. oneOf: - - $ref: '#/components/schemas/FreshserviceAPIKey' + - $ref: "#/components/schemas/FreshserviceAPIKey" FreshserviceCredentialsUpdate: description: The definition of the `FreshserviceCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/FreshserviceAPIKeyUpdate' + - $ref: "#/components/schemas/FreshserviceAPIKeyUpdate" FreshserviceIntegration: description: The definition of the `FreshserviceIntegration` object. properties: credentials: - $ref: '#/components/schemas/FreshserviceCredentials' + $ref: "#/components/schemas/FreshserviceCredentials" type: - $ref: '#/components/schemas/FreshserviceIntegrationType' + $ref: "#/components/schemas/FreshserviceIntegrationType" required: - - type - - credentials + - type + - credentials type: object FreshserviceIntegrationType: description: The definition of the `FreshserviceIntegrationType` object. enum: - - Freshservice + - Freshservice example: Freshservice type: string x-enum-varnames: - - FRESHSERVICE + - FRESHSERVICE FreshserviceIntegrationUpdate: description: The definition of the `FreshserviceIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/FreshserviceCredentialsUpdate' + $ref: "#/components/schemas/FreshserviceCredentialsUpdate" type: - $ref: '#/components/schemas/FreshserviceIntegrationType' + $ref: "#/components/schemas/FreshserviceIntegrationType" required: - - type + - type type: object FullAPIKey: description: Datadog API key. properties: attributes: - $ref: '#/components/schemas/FullAPIKeyAttributes' + $ref: "#/components/schemas/FullAPIKeyAttributes" id: description: ID of the API key. type: string relationships: - $ref: '#/components/schemas/APIKeyRelationships' + $ref: "#/components/schemas/APIKeyRelationships" type: - $ref: '#/components/schemas/APIKeysType' + $ref: "#/components/schemas/APIKeysType" type: object FullAPIKeyAttributes: description: Attributes of a full API key. @@ -27103,13 +26033,13 @@ components: type: string created_at: description: Creation date of the API key. - example: '2020-11-23T10:00:00.000Z' + example: "2020-11-23T10:00:00.000Z" format: date-time readOnly: true type: string date_last_used: - description: Date the API Key was last used - example: '2020-11-27T10:00:00.000Z' + description: "Date the API Key was last used" + example: "2020-11-27T10:00:00.000Z" format: date-time nullable: true readOnly: true @@ -27120,20 +26050,20 @@ components: type: string last4: description: The last four characters of the API key. - example: abcd + example: "abcd" maxLength: 4 minLength: 4 readOnly: true type: string modified_at: description: Date the API key was last modified. - example: '2020-11-23T10:00:00.000Z' + example: "2020-11-23T10:00:00.000Z" format: date-time readOnly: true type: string name: description: Name of the API key. - example: API Key for submitting metrics + example: "API Key for submitting metrics" type: string remote_config_read_enabled: description: The remote config read enabled status. @@ -27143,21 +26073,21 @@ components: description: Datadog application key. properties: attributes: - $ref: '#/components/schemas/FullApplicationKeyAttributes' + $ref: "#/components/schemas/FullApplicationKeyAttributes" id: description: ID of the application key. type: string relationships: - $ref: '#/components/schemas/ApplicationKeyRelationships' + $ref: "#/components/schemas/ApplicationKeyRelationships" type: - $ref: '#/components/schemas/ApplicationKeysType' + $ref: "#/components/schemas/ApplicationKeysType" type: object FullApplicationKeyAttributes: description: Attributes of a full application key. properties: created_at: description: Creation date of the application key. - example: '2020-11-23T10:00:00.000Z' + example: "2020-11-23T10:00:00.000Z" format: date-time readOnly: true type: string @@ -27167,28 +26097,25 @@ components: type: string last4: description: The last four characters of the application key. - example: abcd + example: "abcd" maxLength: 4 minLength: 4 readOnly: true type: string last_used_at: description: Last usage timestamp of the application key. - example: '2020-12-20T10:00:00.000Z' + example: "2020-12-20T10:00:00.000Z" format: date-time nullable: true readOnly: true type: string name: description: Name of the application key. - example: Application Key for managing dashboards + example: "Application Key for managing dashboards" type: string scopes: description: Array of scopes to grant the application key. - example: - - dashboards_read - - dashboards_write - - dashboards_public_share + example: ["dashboards_read", "dashboards_write", "dashboards_public_share"] items: description: Name of scope. type: string @@ -27199,17 +26126,17 @@ components: description: Contains type and attributes for custom frameworks. properties: attributes: - $ref: '#/components/schemas/FullCustomFrameworkDataAttributes' + $ref: "#/components/schemas/FullCustomFrameworkDataAttributes" id: description: The ID of the custom framework. example: handle-version type: string type: - $ref: '#/components/schemas/CustomFrameworkType' + $ref: "#/components/schemas/CustomFrameworkType" required: - - id - - type - - attributes + - id + - type + - attributes type: object FullCustomFrameworkDataAttributes: description: Full Framework Data Attributes. @@ -27229,315 +26156,276 @@ components: requirements: description: Framework Requirements items: - $ref: '#/components/schemas/CustomFrameworkRequirement' + $ref: "#/components/schemas/CustomFrameworkRequirement" type: array version: description: Framework Version - example: '2' + example: "2" type: string required: - - handle - - version - - name - - requirements + - handle + - version + - name + - requirements type: object GCPCredentials: description: The definition of the `GCPCredentials` object. oneOf: - - $ref: '#/components/schemas/GCPServiceAccount' + - $ref: "#/components/schemas/GCPServiceAccount" GCPCredentialsUpdate: description: The definition of the `GCPCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/GCPServiceAccountUpdate' + - $ref: "#/components/schemas/GCPServiceAccountUpdate" GCPIntegration: description: The definition of the `GCPIntegration` object. properties: credentials: - $ref: '#/components/schemas/GCPCredentials' + $ref: "#/components/schemas/GCPCredentials" type: - $ref: '#/components/schemas/GCPIntegrationType' + $ref: "#/components/schemas/GCPIntegrationType" required: - - type - - credentials + - type + - credentials type: object GCPIntegrationType: description: The definition of the `GCPIntegrationType` object. enum: - - GCP + - GCP example: GCP type: string x-enum-varnames: - - GCP + - GCP GCPIntegrationUpdate: description: The definition of the `GCPIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/GCPCredentialsUpdate' + $ref: "#/components/schemas/GCPCredentialsUpdate" type: - $ref: '#/components/schemas/GCPIntegrationType' + $ref: "#/components/schemas/GCPIntegrationType" required: - - type + - type type: object GCPMetricNamespaceConfig: description: Configuration for a GCP metric namespace. properties: disabled: default: false - description: When disabled, Datadog does not collect metrics that are related - to this GCP metric namespace. + description: When disabled, Datadog does not collect metrics that are related to this GCP metric namespace. example: true type: boolean filters: - description: When enabled, Datadog applies these additional filters to limit - metric collection. A metric is collected only if it does not match all - exclusion filters and matches at least one allow filter. - example: - - snapshot.* - - '!*_by_region' + description: |- + When enabled, Datadog applies these additional filters to limit metric collection. A metric is collected only if it does not match all exclusion filters and matches at least one allow filter. + example: ["snapshot.*", "!*_by_region"] items: description: A metric namespace filter type: string type: array id: description: The id of the GCP metric namespace. - example: pubsub + example: "pubsub" type: string type: object GCPMonitoredResourceConfig: description: Configuration for a GCP monitored resource. properties: filters: - description: 'List of filters to limit the monitored resources that are - pulled into Datadog by using tags. - - Only monitored resources that apply to specified filters are imported - into Datadog.' - example: - - $KEY:$VALUE + description: |- + List of filters to limit the monitored resources that are pulled into Datadog by using tags. + Only monitored resources that apply to specified filters are imported into Datadog. + example: ["$KEY:$VALUE"] items: description: A monitored resource filter type: string type: array type: - $ref: '#/components/schemas/GCPMonitoredResourceConfigType' + $ref: "#/components/schemas/GCPMonitoredResourceConfigType" type: object GCPMonitoredResourceConfigType: - description: The GCP monitored resource type. Only a subset of resource types - are supported. - enum: - - cloud_function - - cloud_run_revision - - gce_instance - example: gce_instance + description: The GCP monitored resource type. Only a subset of resource types are supported. + enum: ["cloud_function", "cloud_run_revision", "gce_instance"] + example: "gce_instance" type: string x-enum-varnames: - - CLOUD_FUNCTION - - CLOUD_RUN_REVISION - - GCE_INSTANCE + - CLOUD_FUNCTION + - CLOUD_RUN_REVISION + - GCE_INSTANCE GCPSTSDelegateAccount: description: Datadog principal service account info. properties: attributes: - $ref: '#/components/schemas/GCPSTSDelegateAccountAttributes' + $ref: "#/components/schemas/GCPSTSDelegateAccountAttributes" id: description: The ID of the delegate service account. - example: ddgci-1a19n28hb1a812221893@datadog-gci-sts-us5-prod.iam.gserviceaccount.com + example: "ddgci-1a19n28hb1a812221893@datadog-gci-sts-us5-prod.iam.gserviceaccount.com" type: string type: - $ref: '#/components/schemas/GCPSTSDelegateAccountType' + $ref: "#/components/schemas/GCPSTSDelegateAccountType" type: object GCPSTSDelegateAccountAttributes: description: Your delegate account attributes. properties: delegate_account_email: description: Your organization's Datadog principal email address. - example: ddgci-1a19n28hb1a812221893@datadog-gci-sts-us5-prod.iam.gserviceaccount.com + example: "ddgci-1a19n28hb1a812221893@datadog-gci-sts-us5-prod.iam.gserviceaccount.com" type: string type: object GCPSTSDelegateAccountResponse: description: Your delegate service account response data. properties: data: - $ref: '#/components/schemas/GCPSTSDelegateAccount' + $ref: "#/components/schemas/GCPSTSDelegateAccount" type: object GCPSTSDelegateAccountType: default: gcp_sts_delegate description: The type of account. enum: - - gcp_sts_delegate + - gcp_sts_delegate example: gcp_sts_delegate type: string x-enum-varnames: - - GCP_STS_DELEGATE + - GCP_STS_DELEGATE GCPSTSServiceAccount: description: Info on your service account. properties: attributes: - $ref: '#/components/schemas/GCPSTSServiceAccountAttributes' + $ref: "#/components/schemas/GCPSTSServiceAccountAttributes" id: description: Your service account's unique ID. - example: d291291f-12c2-22g4-j290-123456678897 + example: "d291291f-12c2-22g4-j290-123456678897" type: string meta: - $ref: '#/components/schemas/GCPServiceAccountMeta' + $ref: "#/components/schemas/GCPServiceAccountMeta" type: - $ref: '#/components/schemas/GCPServiceAccountType' + $ref: "#/components/schemas/GCPServiceAccountType" type: object GCPSTSServiceAccountAttributes: description: Attributes associated with your service account. properties: account_tags: - description: Tags to be associated with GCP metrics and service checks from - your account. + description: Tags to be associated with GCP metrics and service checks from your account. items: description: Account Level Tag type: string type: array automute: - description: Silence monitors for expected GCE instance shutdowns. + description: |- + Silence monitors for expected GCE instance shutdowns. type: boolean client_email: description: Your service account email address. - example: datadog-service-account@test-project.iam.gserviceaccount.com + example: "datadog-service-account@test-project.iam.gserviceaccount.com" type: string cloud_run_revision_filters: deprecated: true - description: 'List of filters to limit the Cloud Run revisions that are - pulled into Datadog by using tags. - - Only Cloud Run revision resources that apply to specified filters are - imported into Datadog. - - **Note:** This field is deprecated. Instead, use `monitored_resource_configs` - with `type=cloud_run_revision`' - example: - - $KEY:$VALUE + description: |- + List of filters to limit the Cloud Run revisions that are pulled into Datadog by using tags. + Only Cloud Run revision resources that apply to specified filters are imported into Datadog. + **Note:** This field is deprecated. Instead, use `monitored_resource_configs` with `type=cloud_run_revision` + example: ["$KEY:$VALUE"] items: description: Cloud Run revision filters type: string type: array host_filters: deprecated: true - description: 'List of filters to limit the VM instances that are pulled - into Datadog by using tags. - - Only VM instance resources that apply to specified filters are imported - into Datadog. - - **Note:** This field is deprecated. Instead, use `monitored_resource_configs` - with `type=gce_instance`' - example: - - $KEY:$VALUE + description: |- + List of filters to limit the VM instances that are pulled into Datadog by using tags. + Only VM instance resources that apply to specified filters are imported into Datadog. + **Note:** This field is deprecated. Instead, use `monitored_resource_configs` with `type=gce_instance` + example: ["$KEY:$VALUE"] items: description: VM instance filters type: string type: array is_cspm_enabled: - description: 'When enabled, Datadog will activate the Cloud Security Monitoring - product for this service account. Note: This requires resource_collection_enabled - to be set to true.' + description: |- + When enabled, Datadog will activate the Cloud Security Monitoring product for this service account. Note: This requires resource_collection_enabled to be set to true. type: boolean is_global_location_enabled: default: true - description: When enabled, Datadog collects metrics where location is explicitly - stated as "global" or where location information cannot be deduced from - GCP labels. + description: When enabled, Datadog collects metrics where location is explicitly stated as "global" or where location information cannot be deduced from GCP labels. example: true type: boolean is_per_project_quota_enabled: default: false - description: When enabled, Datadog applies the `X-Goog-User-Project` header, - attributing Google Cloud billing and quota usage to the project being - monitored rather than the default service account project. + description: |- + When enabled, Datadog applies the `X-Goog-User-Project` header, attributing Google Cloud billing and quota usage to the project being monitored rather than the default service account project. example: true type: boolean is_resource_change_collection_enabled: default: false - description: When enabled, Datadog scans for all resource change data in - your Google Cloud environment. + description: |- + When enabled, Datadog scans for all resource change data in your Google Cloud environment. example: true type: boolean is_security_command_center_enabled: default: false - description: 'When enabled, Datadog will attempt to collect Security Command - Center Findings. Note: This requires additional permissions on the service - account.' + description: |- + When enabled, Datadog will attempt to collect Security Command Center Findings. Note: This requires additional permissions on the service account. example: true type: boolean metric_namespace_configs: description: Configurations for GCP metric namespaces. - example: - - disabled: true - id: aiplatform - - filters: - - snapshot.* - - '!*_by_region' - id: pubsub + example: [{"disabled": true, "id": "aiplatform"}, {"filters": ["snapshot.*", "!*_by_region"], "id": "pubsub"}] items: - $ref: '#/components/schemas/GCPMetricNamespaceConfig' + $ref: "#/components/schemas/GCPMetricNamespaceConfig" type: array monitored_resource_configs: description: Configurations for GCP monitored resources. - example: - - filters: - - $KEY:$VALUE - type: gce_instance + example: [{"filters": ["$KEY:$VALUE"], "type": "gce_instance"}] items: - $ref: '#/components/schemas/GCPMonitoredResourceConfig' + $ref: "#/components/schemas/GCPMonitoredResourceConfig" type: array region_filter_configs: - description: Configurations for GCP location filtering, such as region, - multi-region, or zone. Only monitored resources that match the specified - regions are imported into Datadog. By default, Datadog collects from all - locations. - example: - - nam4 - - europe-north1 + description: Configurations for GCP location filtering, such as region, multi-region, or zone. Only monitored resources that match the specified regions are imported into Datadog. By default, Datadog collects from all locations. + example: ["nam4", "europe-north1"] items: description: Region Filter Configs type: string type: array resource_collection_enabled: - description: When enabled, Datadog scans for all resources in your GCP environment. + description: |- + When enabled, Datadog scans for all resources in your GCP environment. type: boolean type: object GCPSTSServiceAccountCreateRequest: description: Data on your newly generated service account. properties: data: - $ref: '#/components/schemas/GCPSTSServiceAccountData' + $ref: "#/components/schemas/GCPSTSServiceAccountData" type: object GCPSTSServiceAccountData: description: Additional metadata on your generated service account. properties: attributes: - $ref: '#/components/schemas/GCPSTSServiceAccountAttributes' + $ref: "#/components/schemas/GCPSTSServiceAccountAttributes" type: - $ref: '#/components/schemas/GCPServiceAccountType' + $ref: "#/components/schemas/GCPServiceAccountType" type: object GCPSTSServiceAccountResponse: description: The account creation response. properties: data: - $ref: '#/components/schemas/GCPSTSServiceAccount' + $ref: "#/components/schemas/GCPSTSServiceAccount" type: object GCPSTSServiceAccountUpdateRequest: description: Service account info. properties: data: - $ref: '#/components/schemas/GCPSTSServiceAccountUpdateRequestData' + $ref: "#/components/schemas/GCPSTSServiceAccountUpdateRequestData" type: object GCPSTSServiceAccountUpdateRequestData: description: Data on your service account. properties: attributes: - $ref: '#/components/schemas/GCPSTSServiceAccountAttributes' + $ref: "#/components/schemas/GCPSTSServiceAccountAttributes" id: description: Your service account's unique ID. - example: d291291f-12c2-22g4-j290-123456678897 + example: "d291291f-12c2-22g4-j290-123456678897" type: string type: - $ref: '#/components/schemas/GCPServiceAccountType' + $ref: "#/components/schemas/GCPServiceAccountType" type: object GCPSTSServiceAccountsResponse: description: Object containing all your STS enabled accounts. @@ -27545,7 +26433,7 @@ components: data: description: Array of GCP STS enabled service accounts. items: - $ref: '#/components/schemas/GCPSTSServiceAccount' + $ref: "#/components/schemas/GCPSTSServiceAccount" type: array type: object GCPServiceAccount: @@ -27553,27 +26441,27 @@ components: properties: private_key: description: The `GCPServiceAccount` `private_key`. - example: '' + example: "" type: string service_account_email: description: The `GCPServiceAccount` `service_account_email`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/GCPServiceAccountCredentialType' + $ref: "#/components/schemas/GCPServiceAccountCredentialType" required: - - type - - service_account_email - - private_key + - type + - service_account_email + - private_key type: object GCPServiceAccountCredentialType: description: The definition of the `GCPServiceAccount` object. enum: - - GCPServiceAccount + - GCPServiceAccount example: GCPServiceAccount type: string x-enum-varnames: - - GCPSERVICEACCOUNT + - GCPSERVICEACCOUNT GCPServiceAccountMeta: description: Additional information related to your service account. properties: @@ -27588,11 +26476,11 @@ components: default: gcp_service_account description: The type of account. enum: - - gcp_service_account + - gcp_service_account example: gcp_service_account type: string x-enum-varnames: - - GCP_SERVICE_ACCOUNT + - GCP_SERVICE_ACCOUNT GCPServiceAccountUpdate: description: The definition of the `GCPServiceAccount` object. properties: @@ -27603,43 +26491,42 @@ components: description: The `GCPServiceAccountUpdate` `service_account_email`. type: string type: - $ref: '#/components/schemas/GCPServiceAccountCredentialType' + $ref: "#/components/schemas/GCPServiceAccountCredentialType" required: - - type + - type type: object GCPUsageCostConfig: description: Google Cloud Usage Cost config. properties: attributes: - $ref: '#/components/schemas/GCPUsageCostConfigAttributes' + $ref: "#/components/schemas/GCPUsageCostConfigAttributes" id: description: The ID of the Google Cloud Usage Cost config. type: string type: - $ref: '#/components/schemas/GCPUsageCostConfigType' + $ref: "#/components/schemas/GCPUsageCostConfigType" required: - - attributes - - type + - attributes + - type type: object GCPUsageCostConfigAttributes: description: Attributes for a Google Cloud Usage Cost config. properties: account_id: description: The Google Cloud account ID. - example: 123456_A123BC_12AB34 + example: "123456_A123BC_12AB34" type: string bucket_name: description: The Google Cloud bucket name used to store the Usage Cost export. - example: dd-cost-bucket + example: "dd-cost-bucket" type: string created_at: description: The timestamp when the Google Cloud Usage Cost config was created. pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$ type: string dataset: - description: The export dataset name used for the Google Cloud Usage Cost - Report. - example: billing + description: The export dataset name used for the Google Cloud Usage Cost Report. + example: "billing" type: string error_messages: description: The error messages for the Google Cloud Usage Cost config. @@ -27649,11 +26536,11 @@ components: type: array export_prefix: description: The export prefix used for the Google Cloud Usage Cost Report. - example: datadog_cloud_cost_usage_export + example: "datadog_cloud_cost_usage_export" type: string export_project_name: description: The name of the Google Cloud Usage Cost Report. - example: dd-cloud-cost-report + example: "dd-cloud-cost-report" type: string months: deprecated: true @@ -27663,53 +26550,51 @@ components: type: integer project_id: description: The `project_id` of the Google Cloud Usage Cost report. - example: my-project-123 + example: "my-project-123" type: string service_account: description: The unique Google Cloud service account email. - example: dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com + example: "dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com" type: string status: description: The status of the Google Cloud Usage Cost config. - example: active + example: "active" type: string status_updated_at: - description: The timestamp when the Google Cloud Usage Cost config status - was updated. + description: The timestamp when the Google Cloud Usage Cost config status was updated. pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$ type: string updated_at: - description: The timestamp when the Google Cloud Usage Cost config status - was updated. + description: The timestamp when the Google Cloud Usage Cost config status was updated. pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}$ type: string required: - - account_id - - bucket_name - - dataset - - export_prefix - - export_project_name - - service_account - - status + - account_id + - bucket_name + - dataset + - export_prefix + - export_project_name + - service_account + - status type: object GCPUsageCostConfigPatchData: description: Google Cloud Usage Cost config patch data. properties: attributes: - $ref: '#/components/schemas/GCPUsageCostConfigPatchRequestAttributes' + $ref: "#/components/schemas/GCPUsageCostConfigPatchRequestAttributes" type: - $ref: '#/components/schemas/GCPUsageCostConfigPatchRequestType' + $ref: "#/components/schemas/GCPUsageCostConfigPatchRequestType" required: - - attributes - - type + - attributes + - type type: object GCPUsageCostConfigPatchRequest: description: Google Cloud Usage Cost config patch request. properties: data: - $ref: '#/components/schemas/GCPUsageCostConfigPatchData' + $ref: "#/components/schemas/GCPUsageCostConfigPatchData" required: - - data + - data type: object GCPUsageCostConfigPatchRequestAttributes: description: Attributes for Google Cloud Usage Cost config patch request. @@ -27719,104 +26604,103 @@ components: example: true type: boolean required: - - is_enabled + - is_enabled type: object GCPUsageCostConfigPatchRequestType: default: gcp_uc_config_patch_request description: Type of Google Cloud Usage Cost config patch request. enum: - - gcp_uc_config_patch_request + - gcp_uc_config_patch_request example: gcp_uc_config_patch_request type: string x-enum-varnames: - - GCP_USAGE_COST_CONFIG_PATCH_REQUEST + - GCP_USAGE_COST_CONFIG_PATCH_REQUEST GCPUsageCostConfigPostData: description: Google Cloud Usage Cost config post data. properties: attributes: - $ref: '#/components/schemas/GCPUsageCostConfigPostRequestAttributes' + $ref: "#/components/schemas/GCPUsageCostConfigPostRequestAttributes" type: - $ref: '#/components/schemas/GCPUsageCostConfigPostRequestType' + $ref: "#/components/schemas/GCPUsageCostConfigPostRequestType" required: - - type + - type type: object GCPUsageCostConfigPostRequest: description: Google Cloud Usage Cost config post request. properties: data: - $ref: '#/components/schemas/GCPUsageCostConfigPostData' + $ref: "#/components/schemas/GCPUsageCostConfigPostData" required: - - data + - data type: object GCPUsageCostConfigPostRequestAttributes: description: Attributes for Google Cloud Usage Cost config post request. properties: billing_account_id: description: The Google Cloud account ID. - example: 123456_A123BC_12AB34 + example: "123456_A123BC_12AB34" type: string bucket_name: description: The Google Cloud bucket name used to store the Usage Cost export. - example: dd-cost-bucket + example: "dd-cost-bucket" type: string export_dataset_name: - description: The export dataset name used for the Google Cloud Usage Cost - report. - example: billing + description: The export dataset name used for the Google Cloud Usage Cost report. + example: "billing" type: string export_prefix: description: The export prefix used for the Google Cloud Usage Cost report. - example: datadog_cloud_cost_usage_export + example: "datadog_cloud_cost_usage_export" type: string export_project_name: description: The name of the Google Cloud Usage Cost report. - example: dd-cloud-cost-report + example: "dd-cloud-cost-report" type: string service_account: description: The unique Google Cloud service account email. - example: dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com + example: "dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com" type: string required: - - billing_account_id - - bucket_name - - export_project_name - - export_dataset_name - - service_account + - billing_account_id + - bucket_name + - export_project_name + - export_dataset_name + - service_account type: object GCPUsageCostConfigPostRequestType: default: gcp_uc_config_post_request description: Type of Google Cloud Usage Cost config post request. enum: - - gcp_uc_config_post_request + - gcp_uc_config_post_request example: gcp_usage_cost_config_post_request type: string x-enum-varnames: - - GCP_USAGE_COST_CONFIG_POST_REQUEST + - GCP_USAGE_COST_CONFIG_POST_REQUEST GCPUsageCostConfigResponse: description: Response of Google Cloud Usage Cost config. properties: data: - $ref: '#/components/schemas/GCPUsageCostConfig' + $ref: "#/components/schemas/GCPUsageCostConfig" type: object GCPUsageCostConfigType: default: gcp_uc_config description: Type of Google Cloud Usage Cost config. enum: - - gcp_uc_config + - gcp_uc_config example: gcp_uc_config type: string x-enum-varnames: - - GCP_UC_CONFIG + - GCP_UC_CONFIG GCPUsageCostConfigsResponse: description: List of Google Cloud Usage Cost configs. properties: data: description: A Google Cloud Usage Cost config. items: - $ref: '#/components/schemas/GCPUsageCostConfig' + $ref: "#/components/schemas/GCPUsageCostConfig" type: array required: - - data + - data type: object GcpScanOptions: description: Response object containing GCP scan options for a single project. @@ -27829,47 +26713,46 @@ components: type: gcp_scan_options properties: data: - $ref: '#/components/schemas/GcpScanOptionsData' + $ref: "#/components/schemas/GcpScanOptionsData" type: object GcpScanOptionsArray: description: Response object containing a list of GCP scan options. example: data: - - attributes: - vuln_containers_os: true - vuln_host_os: true - id: company-project-id - type: gcp_scan_options + - attributes: + vuln_containers_os: true + vuln_host_os: true + id: company-project-id + type: gcp_scan_options properties: data: description: A list of GCP scan options. items: - $ref: '#/components/schemas/GcpScanOptionsData' + $ref: "#/components/schemas/GcpScanOptionsData" type: array required: - - data + - data type: object GcpScanOptionsData: description: Single GCP scan options entry. properties: attributes: - $ref: '#/components/schemas/GcpScanOptionsDataAttributes' + $ref: "#/components/schemas/GcpScanOptionsDataAttributes" id: description: The GCP project ID. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/GcpScanOptionsDataType' + $ref: "#/components/schemas/GcpScanOptionsDataType" required: - - type - - id + - type + - id type: object GcpScanOptionsDataAttributes: description: Attributes for GCP scan options configuration. properties: vuln_containers_os: - description: Indicates if scanning for vulnerabilities in containers is - enabled. + description: Indicates if scanning for vulnerabilities in containers is enabled. type: boolean vuln_host_os: description: Indicates if scanning for vulnerabilities in hosts is enabled. @@ -27879,11 +26762,11 @@ components: default: gcp_scan_options description: GCP scan options resource type. enum: - - gcp_scan_options + - gcp_scan_options example: gcp_scan_options type: string x-enum-varnames: - - GCP_SCAN_OPTIONS + - GCP_SCAN_OPTIONS GcpScanOptionsInputUpdate: description: Request object for updating GCP scan options. example: @@ -27892,29 +26775,28 @@ components: type: gcp_scan_options properties: data: - $ref: '#/components/schemas/GcpScanOptionsInputUpdateData' + $ref: "#/components/schemas/GcpScanOptionsInputUpdateData" type: object GcpScanOptionsInputUpdateData: description: Data object for updating the scan options of a single GCP project. properties: attributes: - $ref: '#/components/schemas/GcpScanOptionsInputUpdateDataAttributes' + $ref: "#/components/schemas/GcpScanOptionsInputUpdateDataAttributes" id: description: The GCP project ID. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/GcpScanOptionsInputUpdateDataType' + $ref: "#/components/schemas/GcpScanOptionsInputUpdateDataType" required: - - type - - id + - type + - id type: object GcpScanOptionsInputUpdateDataAttributes: description: Attributes for updating GCP scan options configuration. properties: vuln_containers_os: - description: Indicates if scanning for vulnerabilities in containers is - enabled. + description: Indicates if scanning for vulnerabilities in containers is enabled. type: boolean vuln_host_os: description: Indicates if scanning for vulnerabilities in hosts is enabled. @@ -27924,11 +26806,11 @@ components: default: gcp_scan_options description: GCP scan options resource type. enum: - - gcp_scan_options + - gcp_scan_options example: gcp_scan_options type: string x-enum-varnames: - - GCP_SCAN_OPTIONS + - GCP_SCAN_OPTIONS GcpUcConfigResponse: description: The definition of `GcpUcConfigResponse` object. example: @@ -27947,24 +26829,24 @@ components: status: active status_updated_at: 2023-01-01 12:00:00 updated_at: 2023-01-01 12:00:00 - id: '123456789123' + id: "123456789123" type: gcp_uc_config properties: data: - $ref: '#/components/schemas/GcpUcConfigResponseData' + $ref: "#/components/schemas/GcpUcConfigResponseData" type: object GcpUcConfigResponseData: description: The definition of `GcpUcConfigResponseData` object. properties: attributes: - $ref: '#/components/schemas/GcpUcConfigResponseDataAttributes' + $ref: "#/components/schemas/GcpUcConfigResponseDataAttributes" id: description: The `GcpUcConfigResponseData` `id`. type: string type: - $ref: '#/components/schemas/GcpUcConfigResponseDataType' + $ref: "#/components/schemas/GcpUcConfigResponseDataType" required: - - type + - type type: object GcpUcConfigResponseDataAttributes: description: The definition of `GcpUcConfigResponseDataAttributes` object. @@ -28017,32 +26899,32 @@ components: default: gcp_uc_config description: Google Cloud Usage Cost config resource type. enum: - - gcp_uc_config + - gcp_uc_config example: gcp_uc_config type: string x-enum-varnames: - - GCP_UC_CONFIG + - GCP_UC_CONFIG GeminiAPIKey: description: The definition of the `GeminiAPIKey` object. properties: api_key: description: The `GeminiAPIKey` `api_key`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/GeminiAPIKeyType' + $ref: "#/components/schemas/GeminiAPIKeyType" required: - - type - - api_key + - type + - api_key type: object GeminiAPIKeyType: description: The definition of the `GeminiAPIKey` object. enum: - - GeminiAPIKey + - GeminiAPIKey example: GeminiAPIKey type: string x-enum-varnames: - - GEMINIAPIKEY + - GEMINIAPIKEY GeminiAPIKeyUpdate: description: The definition of the `GeminiAPIKey` object. properties: @@ -28050,90 +26932,90 @@ components: description: The `GeminiAPIKeyUpdate` `api_key`. type: string type: - $ref: '#/components/schemas/GeminiAPIKeyType' + $ref: "#/components/schemas/GeminiAPIKeyType" required: - - type + - type type: object GeminiCredentials: description: The definition of the `GeminiCredentials` object. oneOf: - - $ref: '#/components/schemas/GeminiAPIKey' + - $ref: "#/components/schemas/GeminiAPIKey" GeminiCredentialsUpdate: description: The definition of the `GeminiCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/GeminiAPIKeyUpdate' + - $ref: "#/components/schemas/GeminiAPIKeyUpdate" GeminiIntegration: description: The definition of the `GeminiIntegration` object. properties: credentials: - $ref: '#/components/schemas/GeminiCredentials' + $ref: "#/components/schemas/GeminiCredentials" type: - $ref: '#/components/schemas/GeminiIntegrationType' + $ref: "#/components/schemas/GeminiIntegrationType" required: - - type - - credentials + - type + - credentials type: object GeminiIntegrationType: description: The definition of the `GeminiIntegrationType` object. enum: - - Gemini + - Gemini example: Gemini type: string x-enum-varnames: - - GEMINI + - GEMINI GeminiIntegrationUpdate: description: The definition of the `GeminiIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/GeminiCredentialsUpdate' + $ref: "#/components/schemas/GeminiCredentialsUpdate" type: - $ref: '#/components/schemas/GeminiIntegrationType' + $ref: "#/components/schemas/GeminiIntegrationType" required: - - type + - type type: object GetActionConnectionResponse: description: The response for found connection properties: data: - $ref: '#/components/schemas/ActionConnectionData' + $ref: "#/components/schemas/ActionConnectionData" type: object GetAppKeyRegistrationResponse: description: The response object after getting an app key registration. properties: data: - $ref: '#/components/schemas/AppKeyRegistrationData' + $ref: "#/components/schemas/AppKeyRegistrationData" type: object GetAppResponse: description: The full app definition response object. properties: data: - $ref: '#/components/schemas/GetAppResponseData' + $ref: "#/components/schemas/GetAppResponseData" included: description: Data on the version of the app that was published. items: - $ref: '#/components/schemas/Deployment' + $ref: "#/components/schemas/Deployment" type: array meta: - $ref: '#/components/schemas/AppMeta' + $ref: "#/components/schemas/AppMeta" relationship: - $ref: '#/components/schemas/AppRelationship' + $ref: "#/components/schemas/AppRelationship" type: object GetAppResponseData: description: The data object containing the app definition. properties: attributes: - $ref: '#/components/schemas/GetAppResponseDataAttributes' + $ref: "#/components/schemas/GetAppResponseDataAttributes" id: description: The ID of the app. example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 format: uuid type: string type: - $ref: '#/components/schemas/AppDefinitionType' + $ref: "#/components/schemas/AppDefinitionType" required: - - id - - type - - attributes + - id + - type + - attributes type: object GetAppResponseDataAttributes: description: The app definition attributes, such as name, description, and components. @@ -28141,7 +27023,7 @@ components: components: description: The UI components that make up the app. items: - $ref: '#/components/schemas/ComponentGrid' + $ref: "#/components/schemas/ComponentGrid" type: array description: description: A human-readable description for the app. @@ -28153,20 +27035,18 @@ components: description: The name of the app. type: string queries: - description: An array of queries, such as external actions and state variables, - that the app uses. + description: An array of queries, such as external actions and state variables, that the app uses. items: - $ref: '#/components/schemas/Query' + $ref: "#/components/schemas/Query" type: array rootInstanceName: - description: The name of the root component of the app. This must be a `grid` - component that contains all other components. + description: The name of the root component of the app. This must be a `grid` component that contains all other components. type: string tags: description: A list of tags for the app, which can be used to filter apps. example: - - service:webshop-backend - - team:webshop + - "service:webshop-backend" + - "team:webshop" items: description: An individual tag for the app. type: string @@ -28176,9 +27056,9 @@ components: description: Response object to get a custom framework. properties: data: - $ref: '#/components/schemas/FullCustomFrameworkData' + $ref: "#/components/schemas/FullCustomFrameworkData" required: - - data + - data type: object GetDataDeletionsResponseBody: description: The response from the get data deletion requests endpoint. @@ -28186,10 +27066,10 @@ components: data: description: The list of data deletion requests that matches the query. items: - $ref: '#/components/schemas/DataDeletionResponseItem' + $ref: "#/components/schemas/DataDeletionResponseItem" type: array meta: - $ref: '#/components/schemas/DataDeletionResponseMeta' + $ref: "#/components/schemas/DataDeletionResponseMeta" type: object GetDeviceAttributes: description: The device attributes @@ -28260,9 +27140,7 @@ components: type: string tags: description: A list of tags associated with the device. - example: - - device_ip:1.2.3.4 - - device_id:example:1.2.3.4 + example: ["device_ip:1.2.3.4", "device_id:example:1.2.3.4"] items: type: string type: array @@ -28279,7 +27157,7 @@ components: description: Get device response data. properties: attributes: - $ref: '#/components/schemas/GetDeviceAttributes' + $ref: "#/components/schemas/GetDeviceAttributes" id: description: The device ID example: example:1.2.3.4 @@ -28292,21 +27170,21 @@ components: description: The `GetDevice` operation's response. properties: data: - $ref: '#/components/schemas/GetDeviceData' + $ref: "#/components/schemas/GetDeviceData" type: object GetFindingResponse: description: The expected response schema when getting a finding. properties: data: - $ref: '#/components/schemas/DetailedFinding' + $ref: "#/components/schemas/DetailedFinding" required: - - data + - data type: object GetInterfacesData: description: The interfaces list data properties: attributes: - $ref: '#/components/schemas/InterfaceAttributes' + $ref: "#/components/schemas/InterfaceAttributes" id: description: The interface ID example: example:1.2.3.4:99 @@ -28321,77 +27199,77 @@ components: data: description: Get Interfaces response items: - $ref: '#/components/schemas/GetInterfacesData' + $ref: "#/components/schemas/GetInterfacesData" type: array type: object GetIssueIncludeQueryParameterItem: description: Relationship object that should be included in the response. enum: - - assignee - - case - - team_owners - example: case + - assignee + - case + - team_owners + example: "case" type: string x-enum-varnames: - - ASSIGNEE - - CASE - - TEAM_OWNERS + - ASSIGNEE + - CASE + - TEAM_OWNERS GetMappingResponse: example: data: attributes: attributes: - - attribute: user_id - description: Unique user identifier - display_name: User ID - groups: - - Identity - is_custom: false - type: string - - attribute: user_email - description: User email address - display_name: Email Address - groups: - - Identity - - Contact - is_custom: false - type: string - - attribute: first_country_code - description: The ISO code of the country for the user's first session - display_name: First Country Code - groups: - - Geography - is_custom: false - type: string - - attribute: '@customer_tier' - description: Customer subscription tier - display_name: Customer Tier - groups: - - Business - is_custom: true - type: string + - attribute: user_id + description: Unique user identifier + display_name: User ID + groups: + - Identity + is_custom: false + type: string + - attribute: user_email + description: User email address + display_name: Email Address + groups: + - Identity + - Contact + is_custom: false + type: string + - attribute: first_country_code + description: The ISO code of the country for the user's first session + display_name: First Country Code + groups: + - Geography + is_custom: false + type: string + - attribute: "@customer_tier" + description: Customer subscription tier + display_name: Customer Tier + groups: + - Business + is_custom: true + type: string id: get_mappings_response type: get_mappings_response properties: data: - $ref: '#/components/schemas/GetMappingResponseData' + $ref: "#/components/schemas/GetMappingResponseData" type: object GetMappingResponseData: properties: attributes: - $ref: '#/components/schemas/GetMappingResponseDataAttributes' + $ref: "#/components/schemas/GetMappingResponseDataAttributes" id: type: string type: - $ref: '#/components/schemas/GetMappingResponseDataType' + $ref: "#/components/schemas/GetMappingResponseDataType" required: - - type + - type type: object GetMappingResponseDataAttributes: properties: attributes: items: - $ref: '#/components/schemas/GetMappingResponseDataAttributesAttributesItems' + $ref: "#/components/schemas/GetMappingResponseDataAttributesAttributesItems" type: array type: object GetMappingResponseDataAttributesAttributesItems: @@ -28415,26 +27293,26 @@ components: default: get_mappings_response description: Get mappings response resource type. enum: - - get_mappings_response + - get_mappings_response example: get_mappings_response type: string x-enum-varnames: - - GET_MAPPINGS_RESPONSE + - GET_MAPPINGS_RESPONSE GetMultipleRulesetsRequest: properties: data: - $ref: '#/components/schemas/GetMultipleRulesetsRequestData' + $ref: "#/components/schemas/GetMultipleRulesetsRequestData" type: object GetMultipleRulesetsRequestData: properties: attributes: - $ref: '#/components/schemas/GetMultipleRulesetsRequestDataAttributes' + $ref: "#/components/schemas/GetMultipleRulesetsRequestDataAttributes" id: type: string type: - $ref: '#/components/schemas/GetMultipleRulesetsRequestDataType' + $ref: "#/components/schemas/GetMultipleRulesetsRequestDataType" required: - - type + - type type: object GetMultipleRulesetsRequestDataAttributes: properties: @@ -28451,74 +27329,74 @@ components: default: get_multiple_rulesets_request description: Get multiple rulesets request resource type. enum: - - get_multiple_rulesets_request + - get_multiple_rulesets_request example: get_multiple_rulesets_request type: string x-enum-varnames: - - GET_MULTIPLE_RULESETS_REQUEST + - GET_MULTIPLE_RULESETS_REQUEST GetMultipleRulesetsResponse: properties: data: - $ref: '#/components/schemas/GetMultipleRulesetsResponseData' + $ref: "#/components/schemas/GetMultipleRulesetsResponseData" type: object GetMultipleRulesetsResponseData: properties: attributes: - $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributes' + $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributes" id: type: string type: - $ref: '#/components/schemas/GetMultipleRulesetsResponseDataType' + $ref: "#/components/schemas/GetMultipleRulesetsResponseDataType" required: - - type + - type type: object GetMultipleRulesetsResponseDataAttributes: properties: rulesets: items: - $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItems' + $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItems" type: array type: object GetMultipleRulesetsResponseDataAttributesRulesetsItems: properties: data: - $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsData' + $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsData" description: type: string name: type: string rules: items: - $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems' + $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems" type: array short_description: type: string required: - - data + - data type: object GetMultipleRulesetsResponseDataAttributesRulesetsItemsData: properties: id: type: string type: - $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType' + $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType" required: - - type + - type type: object GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType: default: rulesets description: Rulesets resource type. enum: - - rulesets + - rulesets example: rulesets type: string x-enum-varnames: - - RULESETS + - RULESETS GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems: properties: arguments: items: - $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems' + $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems" type: array category: type: string @@ -28536,7 +27414,7 @@ components: cwe: type: string data: - $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData' + $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData" description: type: string documentation_url: @@ -28566,14 +27444,14 @@ components: type: boolean tests: items: - $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems' + $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems" type: array tree_sitter_query: type: string type: type: string required: - - data + - data type: object GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems: properties: @@ -28587,19 +27465,19 @@ components: id: type: string type: - $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType' + $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType" required: - - type + - type type: object GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType: default: rules description: Rules resource type. enum: - - rules + - rules example: rules type: string x-enum-varnames: - - RULES + - RULES GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems: properties: annotation_count: @@ -28616,168 +27494,164 @@ components: default: get_multiple_rulesets_response description: Get multiple rulesets response resource type. enum: - - get_multiple_rulesets_response + - get_multiple_rulesets_response example: get_multiple_rulesets_response type: string x-enum-varnames: - - GET_MULTIPLE_RULESETS_RESPONSE + - GET_MULTIPLE_RULESETS_RESPONSE GetResourceEvaluationFiltersResponse: description: The definition of `GetResourceEvaluationFiltersResponse` object. properties: data: - $ref: '#/components/schemas/GetResourceEvaluationFiltersResponseData' + $ref: "#/components/schemas/GetResourceEvaluationFiltersResponseData" required: - - data + - data type: object GetResourceEvaluationFiltersResponseData: description: The definition of `GetResourceFilterResponseData` object. properties: attributes: - $ref: '#/components/schemas/ResourceFilterAttributes' + $ref: "#/components/schemas/ResourceFilterAttributes" id: description: The `data` `id`. example: csm_resource_filter type: string type: - $ref: '#/components/schemas/ResourceFilterRequestType' + $ref: "#/components/schemas/ResourceFilterRequestType" type: object GetRuleVersionHistoryData: description: Data for the rule version history. properties: attributes: - $ref: '#/components/schemas/RuleVersionHistory' + $ref: "#/components/schemas/RuleVersionHistory" id: description: ID of the rule. type: string type: - $ref: '#/components/schemas/GetRuleVersionHistoryDataType' + $ref: "#/components/schemas/GetRuleVersionHistoryDataType" type: object GetRuleVersionHistoryDataType: description: Type of data. enum: - - GetRuleVersionHistoryResponse + - GetRuleVersionHistoryResponse type: string x-enum-varnames: - - GETRULEVERSIONHISTORYRESPONSE + - GETRULEVERSIONHISTORYRESPONSE GetRuleVersionHistoryResponse: description: Response for getting the rule version history. properties: data: - $ref: '#/components/schemas/GetRuleVersionHistoryData' + $ref: "#/components/schemas/GetRuleVersionHistoryData" type: object GetSBOMResponse: description: The expected response schema when getting an SBOM. properties: data: - $ref: '#/components/schemas/SBOM' + $ref: "#/components/schemas/SBOM" required: - - data + - data type: object GetSuppressionVersionHistoryData: description: Data for the suppression version history. properties: attributes: - $ref: '#/components/schemas/SuppressionVersionHistory' + $ref: "#/components/schemas/SuppressionVersionHistory" id: description: ID of the suppression. type: string type: - $ref: '#/components/schemas/GetSuppressionVersionHistoryDataType' + $ref: "#/components/schemas/GetSuppressionVersionHistoryDataType" type: object GetSuppressionVersionHistoryDataType: description: Type of data. enum: - - suppression_version_history + - suppression_version_history type: string x-enum-varnames: - - SUPPRESSIONVERSIONHISTORY + - SUPPRESSIONVERSIONHISTORY GetSuppressionVersionHistoryResponse: description: Response for getting the suppression version history. properties: data: - $ref: '#/components/schemas/GetSuppressionVersionHistoryData' + $ref: "#/components/schemas/GetSuppressionVersionHistoryData" type: object GetTeamMembershipsSort: description: Specifies the order of returned team memberships enum: - - manager_name - - -manager_name - - name - - -name - - handle - - -handle - - email - - -email - type: string - x-enum-varnames: - - MANAGER_NAME - - _MANAGER_NAME - - NAME - - _NAME - - HANDLE - - _HANDLE - - EMAIL - - _EMAIL + - manager_name + - -manager_name + - name + - -name + - handle + - -handle + - email + - -email + type: string + x-enum-varnames: + - MANAGER_NAME + - _MANAGER_NAME + - NAME + - _NAME + - HANDLE + - _HANDLE + - EMAIL + - _EMAIL GetWorkflowResponse: description: The response object after getting a workflow. properties: data: - $ref: '#/components/schemas/WorkflowData' + $ref: "#/components/schemas/WorkflowData" type: object GitCommitSHA: - description: Git Commit SHA. + description: "Git Commit SHA." example: 66adc9350f2cc9b250b69abddab733dd55e1a588 - pattern: ^[a-fA-F0-9]{40,}$ + pattern: "^[a-fA-F0-9]{40,}$" type: string GitRepositoryID: - description: Git Repository ID - example: github.com/organization/example-repository + description: "Git Repository ID" + example: "github.com/organization/example-repository" type: string GitRepositoryURL: - description: Git Repository URL - example: https://github.com/organization/example-repository + description: "Git Repository URL" + example: "https://github.com/organization/example-repository" type: string GithubWebhookTrigger: - description: Trigger a workflow from a GitHub webhook. To trigger a workflow - from GitHub, you must set a `webhookSecret`. In your GitHub Webhook Settings, - set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", - select application/json for the content type, and be highly recommend enabling - SSL verification for security. The workflow must be published. + description: 'Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a `webhookSecret`. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.' properties: rateLimit: - $ref: '#/components/schemas/TriggerRateLimit' + $ref: "#/components/schemas/TriggerRateLimit" type: object GithubWebhookTriggerWrapper: - description: Schema for a GitHub webhook-based trigger. + description: "Schema for a GitHub webhook-based trigger." properties: githubWebhookTrigger: - $ref: '#/components/schemas/GithubWebhookTrigger' + $ref: "#/components/schemas/GithubWebhookTrigger" startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - githubWebhookTrigger + - githubWebhookTrigger type: object GitlabAPIKey: description: The definition of the `GitlabAPIKey` object. properties: api_token: description: The `GitlabAPIKey` `api_token`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/GitlabAPIKeyType' + $ref: "#/components/schemas/GitlabAPIKeyType" required: - - type - - api_token + - type + - api_token type: object GitlabAPIKeyType: description: The definition of the `GitlabAPIKey` object. enum: - - GitlabAPIKey + - GitlabAPIKey example: GitlabAPIKey type: string x-enum-varnames: - - GITLABAPIKEY + - GITLABAPIKEY GitlabAPIKeyUpdate: description: The definition of the `GitlabAPIKey` object. properties: @@ -28785,46 +27659,46 @@ components: description: The `GitlabAPIKeyUpdate` `api_token`. type: string type: - $ref: '#/components/schemas/GitlabAPIKeyType' + $ref: "#/components/schemas/GitlabAPIKeyType" required: - - type + - type type: object GitlabCredentials: description: The definition of the `GitlabCredentials` object. oneOf: - - $ref: '#/components/schemas/GitlabAPIKey' + - $ref: "#/components/schemas/GitlabAPIKey" GitlabCredentialsUpdate: description: The definition of the `GitlabCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/GitlabAPIKeyUpdate' + - $ref: "#/components/schemas/GitlabAPIKeyUpdate" GitlabIntegration: description: The definition of the `GitlabIntegration` object. properties: credentials: - $ref: '#/components/schemas/GitlabCredentials' + $ref: "#/components/schemas/GitlabCredentials" type: - $ref: '#/components/schemas/GitlabIntegrationType' + $ref: "#/components/schemas/GitlabIntegrationType" required: - - type - - credentials + - type + - credentials type: object GitlabIntegrationType: description: The definition of the `GitlabIntegrationType` object. enum: - - Gitlab + - Gitlab example: Gitlab type: string x-enum-varnames: - - GITLAB + - GITLAB GitlabIntegrationUpdate: description: The definition of the `GitlabIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/GitlabCredentialsUpdate' + $ref: "#/components/schemas/GitlabCredentialsUpdate" type: - $ref: '#/components/schemas/GitlabIntegrationType' + $ref: "#/components/schemas/GitlabIntegrationType" required: - - type + - type type: object GlobalIncidentSettingsAttributesRequest: description: Global incident settings attributes @@ -28843,149 +27717,148 @@ components: type: string created: description: Timestamp when the settings were created - example: '2026-01-13T17:15:56.557278191Z' + example: "2026-01-13T17:15:56.557278191Z" format: date-time type: string modified: description: Timestamp when the settings were last modified - example: '2026-01-13T17:15:56.557278191Z' + example: "2026-01-13T17:15:56.557278191Z" format: date-time type: string required: - - created - - modified - - analytics_dashboard_id + - created + - modified + - analytics_dashboard_id type: object GlobalIncidentSettingsDataRequest: properties: attributes: - $ref: '#/components/schemas/GlobalIncidentSettingsAttributesRequest' + $ref: "#/components/schemas/GlobalIncidentSettingsAttributesRequest" type: - $ref: '#/components/schemas/GlobalIncidentSettingsType' + $ref: "#/components/schemas/GlobalIncidentSettingsType" required: - - type + - type type: object GlobalIncidentSettingsDataResponse: properties: attributes: - $ref: '#/components/schemas/GlobalIncidentSettingsAttributesResponse' + $ref: "#/components/schemas/GlobalIncidentSettingsAttributesResponse" id: description: The unique identifier for the global incident settings example: f8b9a915-ed85-48b4-9071-ceba567a3db5 type: string type: - $ref: '#/components/schemas/GlobalIncidentSettingsType' + $ref: "#/components/schemas/GlobalIncidentSettingsType" required: - - id - - type - - attributes + - id + - type + - attributes type: object GlobalIncidentSettingsRequest: properties: data: - $ref: '#/components/schemas/GlobalIncidentSettingsDataRequest' + $ref: "#/components/schemas/GlobalIncidentSettingsDataRequest" required: - - data + - data type: object GlobalIncidentSettingsResponse: properties: data: - $ref: '#/components/schemas/GlobalIncidentSettingsDataResponse' + $ref: "#/components/schemas/GlobalIncidentSettingsDataResponse" required: - - data + - data type: object GlobalIncidentSettingsType: description: Global incident settings resource type enum: - - incidents_global_settings + - incidents_global_settings example: incidents_global_settings type: string x-enum-varnames: - - INCIDENTS_GLOBAL_SETTINGS + - INCIDENTS_GLOBAL_SETTINGS GlobalVariableData: - description: Synthetics global variable data. Wrapper around the global variable - object. + description: Synthetics global variable data. Wrapper around the global variable object. properties: attributes: - $ref: '#/components/schemas/SyntheticsGlobalVariable' + $ref: "#/components/schemas/SyntheticsGlobalVariable" id: description: Global variable identifier. type: string type: - $ref: '#/components/schemas/GlobalVariableType' + $ref: "#/components/schemas/GlobalVariableType" type: object GlobalVariableJsonPatchRequest: description: JSON Patch request for global variable. properties: data: - $ref: '#/components/schemas/GlobalVariableJsonPatchRequestData' + $ref: "#/components/schemas/GlobalVariableJsonPatchRequestData" required: - - data + - data type: object GlobalVariableJsonPatchRequestData: properties: attributes: - $ref: '#/components/schemas/GlobalVariableJsonPatchRequestDataAttributes' + $ref: "#/components/schemas/GlobalVariableJsonPatchRequestDataAttributes" type: - $ref: '#/components/schemas/GlobalVariableJsonPatchType' + $ref: "#/components/schemas/GlobalVariableJsonPatchType" type: object GlobalVariableJsonPatchRequestDataAttributes: properties: json_patch: description: JSON Patch operations following RFC 6902. items: - $ref: '#/components/schemas/JsonPatchOperation' + $ref: "#/components/schemas/JsonPatchOperation" type: array type: object GlobalVariableJsonPatchType: description: Global variable JSON Patch type. enum: - - global_variables_json_patch + - global_variables_json_patch type: string x-enum-varnames: - - GLOBAL_VARIABLES_JSON_PATCH + - GLOBAL_VARIABLES_JSON_PATCH GlobalVariableResponse: description: Global variable response. properties: data: - $ref: '#/components/schemas/GlobalVariableData' + $ref: "#/components/schemas/GlobalVariableData" type: object GlobalVariableType: description: Global variable type. enum: - - global_variables + - global_variables type: string x-enum-varnames: - - GLOBAL_VARIABLES + - GLOBAL_VARIABLES GoogleChatAppNamedSpaceResponse: description: Response with Google Chat space information. properties: data: - $ref: '#/components/schemas/GoogleChatAppNamedSpaceResponseData' + $ref: "#/components/schemas/GoogleChatAppNamedSpaceResponseData" required: - - data + - data type: object GoogleChatAppNamedSpaceResponseAttributes: description: Google Chat space attributes. properties: display_name: description: Google space display name. - example: Fake Space Name + example: "Fake Space Name" maxLength: 255 type: string organization_binding_id: description: Organization binding ID. - example: 2f18a894-adb5-4c53-8248-39fd3f5386a5 + example: "2f18a894-adb5-4c53-8248-39fd3f5386a5" maxLength: 255 type: string resource_name: description: Google space resource name. - example: spaces/AAAAAAAAA + example: "spaces/AAAAAAAAA" maxLength: 255 type: string space_uri: description: Google space URI. - example: https://chat.google.com/room/AAAAAAAAA + example: "https://chat.google.com/room/AAAAAAAAA" maxLength: 255 type: string type: object @@ -28993,86 +27866,85 @@ components: description: Google Chat space data from a response. properties: attributes: - $ref: '#/components/schemas/GoogleChatAppNamedSpaceResponseAttributes' + $ref: "#/components/schemas/GoogleChatAppNamedSpaceResponseAttributes" id: description: The ID of the Google Chat space. - example: 596da4af-0563-4097-90ff-07230c3f9db3 + example: "596da4af-0563-4097-90ff-07230c3f9db3" maxLength: 100 minLength: 1 type: string type: - $ref: '#/components/schemas/GoogleChatAppNamedSpaceType' + $ref: "#/components/schemas/GoogleChatAppNamedSpaceType" type: object GoogleChatAppNamedSpaceType: default: google-chat-app-named-space description: Google Chat space resource type. enum: - - google-chat-app-named-space + - google-chat-app-named-space example: google-chat-app-named-space type: string x-enum-varnames: - - GOOGLE_CHAT_APP_NAMED_SPACE_TYPE + - GOOGLE_CHAT_APP_NAMED_SPACE_TYPE GoogleChatCreateOrganizationHandleRequest: description: Create organization handle request. properties: data: - $ref: '#/components/schemas/GoogleChatCreateOrganizationHandleRequestData' + $ref: "#/components/schemas/GoogleChatCreateOrganizationHandleRequestData" type: - $ref: '#/components/schemas/GoogleChatOrganizationHandleType' + $ref: "#/components/schemas/GoogleChatOrganizationHandleType" required: - - type - - data + - type + - data type: object GoogleChatCreateOrganizationHandleRequestAttributes: description: Organization handle attributes for a create request. properties: name: description: Organization handle name. - example: fake-handle-name + example: "fake-handle-name" maxLength: 255 type: string space_resource_name: description: Google space resource name. - example: spaces/AAAAAAAAA + example: "spaces/AAAAAAAAA" maxLength: 255 type: string required: - - name - - space_resource_name + - name + - space_resource_name type: object GoogleChatCreateOrganizationHandleRequestData: description: Organization handle data for a create request. properties: attributes: - $ref: '#/components/schemas/GoogleChatCreateOrganizationHandleRequestAttributes' + $ref: "#/components/schemas/GoogleChatCreateOrganizationHandleRequestAttributes" required: - - attributes + - attributes type: object GoogleChatOrganizationHandleResponse: - description: Organization handle for monitor notifications to a Google Chat - space within a Google organization. + description: Organization handle for monitor notifications to a Google Chat space within a Google organization. properties: data: - $ref: '#/components/schemas/GoogleChatOrganizationHandleResponseData' + $ref: "#/components/schemas/GoogleChatOrganizationHandleResponseData" required: - - data + - data type: object GoogleChatOrganizationHandleResponseAttributes: description: Organization handle attributes. properties: name: description: Organization handle name. - example: fake-handle-name + example: "fake-handle-name" maxLength: 255 type: string space_display_name: description: Google space display name. - example: Fake Space Name + example: "Fake Space Name" maxLength: 255 type: string space_resource_name: description: Google space resource name. - example: spaces/AAAAAAAAA + example: "spaces/AAAAAAAAA" maxLength: 255 type: string type: object @@ -29080,72 +27952,59 @@ components: description: Organization handle data from a response. properties: attributes: - $ref: '#/components/schemas/GoogleChatOrganizationHandleResponseAttributes' + $ref: "#/components/schemas/GoogleChatOrganizationHandleResponseAttributes" id: description: The ID of the organization handle. - example: 596da4af-0563-4097-90ff-07230c3f9db3 + example: "596da4af-0563-4097-90ff-07230c3f9db3" maxLength: 100 minLength: 1 type: string type: - $ref: '#/components/schemas/GoogleChatOrganizationHandleType' + $ref: "#/components/schemas/GoogleChatOrganizationHandleType" type: object GoogleChatOrganizationHandleType: default: google-chat-organization-handle description: Organization handle resource type. enum: - - google-chat-organization-handle + - google-chat-organization-handle example: google-chat-organization-handle type: string x-enum-varnames: - - GOOGLE_CHAT_ORGANIZATION_HANDLE_TYPE + - GOOGLE_CHAT_ORGANIZATION_HANDLE_TYPE GoogleChatOrganizationHandlesResponse: - description: List of organization handles for monitor notifications to Google - Chat spaces within a Google organization. + description: List of organization handles for monitor notifications to Google Chat spaces within a Google organization. properties: data: description: An array of organization handles. - example: - - attributes: - name: general-handle - space_display_name: General - space_resource_name: spaces/AAAAAAAAA - id: 596da4af-0563-4097-90ff-07230c3f9db3 - type: google-chat-organization-handle - - attributes: - name: general-handle-2 - space_display_name: General2 - space_resource_name: spaces/BBBBBBBBB - id: 596da4af-0563-4097-90ff-07230c3f9db4 - type: google-chat-organization-handle + example: [{"attributes": {"name": "general-handle", "space_display_name": "General", "space_resource_name": "spaces/AAAAAAAAA"}, "id": "596da4af-0563-4097-90ff-07230c3f9db3", "type": "google-chat-organization-handle"}, {"attributes": {"name": "general-handle-2", "space_display_name": "General2", "space_resource_name": "spaces/BBBBBBBBB"}, "id": "596da4af-0563-4097-90ff-07230c3f9db4", "type": "google-chat-organization-handle"}] items: - $ref: '#/components/schemas/GoogleChatOrganizationHandleResponseData' + $ref: "#/components/schemas/GoogleChatOrganizationHandleResponseData" type: array required: - - data + - data type: object GoogleChatUpdateOrganizationHandleRequest: description: Update organization handle request. properties: data: - $ref: '#/components/schemas/GoogleChatUpdateOrganizationHandleRequestData' + $ref: "#/components/schemas/GoogleChatUpdateOrganizationHandleRequestData" type: - $ref: '#/components/schemas/GoogleChatOrganizationHandleType' + $ref: "#/components/schemas/GoogleChatOrganizationHandleType" required: - - type - - data + - type + - data type: object GoogleChatUpdateOrganizationHandleRequestAttributes: description: Organization handle attributes for an update request. properties: name: description: Organization handle name. - example: fake-handle-name + example: "fake-handle-name" maxLength: 255 type: string space_resource_name: description: Google space resource name. - example: spaces/AAAAAAAAA + example: "spaces/AAAAAAAAA" maxLength: 255 type: string type: object @@ -29153,18 +28012,18 @@ components: description: Organization handle data for an update request. properties: attributes: - $ref: '#/components/schemas/GoogleChatUpdateOrganizationHandleRequestAttributes' + $ref: "#/components/schemas/GoogleChatUpdateOrganizationHandleRequestAttributes" required: - - attributes + - attributes type: object GoogleMeetConfigurationReference: description: A reference to a Google Meet Configuration resource. nullable: true properties: data: - $ref: '#/components/schemas/GoogleMeetConfigurationReferenceData' + $ref: "#/components/schemas/GoogleMeetConfigurationReferenceData" required: - - data + - data type: object GoogleMeetConfigurationReferenceData: description: The Google Meet configuration relationship data object. @@ -29172,37 +28031,37 @@ components: properties: id: description: The unique identifier of the Google Meet configuration. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string type: description: The type of the Google Meet configuration. - example: google_meet_configurations + example: "google_meet_configurations" type: string required: - - id - - type + - id + - type type: object GreyNoiseAPIKey: description: The definition of the `GreyNoiseAPIKey` object. properties: api_key: description: The `GreyNoiseAPIKey` `api_key`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/GreyNoiseAPIKeyType' + $ref: "#/components/schemas/GreyNoiseAPIKeyType" required: - - type - - api_key + - type + - api_key type: object GreyNoiseAPIKeyType: description: The definition of the `GreyNoiseAPIKey` object. enum: - - GreyNoiseAPIKey + - GreyNoiseAPIKey example: GreyNoiseAPIKey type: string x-enum-varnames: - - GREYNOISEAPIKEY + - GREYNOISEAPIKEY GreyNoiseAPIKeyUpdate: description: The definition of the `GreyNoiseAPIKey` object. properties: @@ -29210,46 +28069,46 @@ components: description: The `GreyNoiseAPIKeyUpdate` `api_key`. type: string type: - $ref: '#/components/schemas/GreyNoiseAPIKeyType' + $ref: "#/components/schemas/GreyNoiseAPIKeyType" required: - - type + - type type: object GreyNoiseCredentials: description: The definition of the `GreyNoiseCredentials` object. oneOf: - - $ref: '#/components/schemas/GreyNoiseAPIKey' + - $ref: "#/components/schemas/GreyNoiseAPIKey" GreyNoiseCredentialsUpdate: description: The definition of the `GreyNoiseCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/GreyNoiseAPIKeyUpdate' + - $ref: "#/components/schemas/GreyNoiseAPIKeyUpdate" GreyNoiseIntegration: description: The definition of the `GreyNoiseIntegration` object. properties: credentials: - $ref: '#/components/schemas/GreyNoiseCredentials' + $ref: "#/components/schemas/GreyNoiseCredentials" type: - $ref: '#/components/schemas/GreyNoiseIntegrationType' + $ref: "#/components/schemas/GreyNoiseIntegrationType" required: - - type - - credentials + - type + - credentials type: object GreyNoiseIntegrationType: description: The definition of the `GreyNoiseIntegrationType` object. enum: - - GreyNoise + - GreyNoise example: GreyNoise type: string x-enum-varnames: - - GREYNOISE + - GREYNOISE GreyNoiseIntegrationUpdate: description: The definition of the `GreyNoiseIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/GreyNoiseCredentialsUpdate' + $ref: "#/components/schemas/GreyNoiseCredentialsUpdate" type: - $ref: '#/components/schemas/GreyNoiseIntegrationType' + $ref: "#/components/schemas/GreyNoiseIntegrationType" required: - - type + - type type: object GroupScalarColumn: description: A column containing the tag keys and values in a group. @@ -29259,13 +28118,10 @@ components: example: env type: string type: - $ref: '#/components/schemas/ScalarColumnTypeGroup' + $ref: "#/components/schemas/ScalarColumnTypeGroup" values: - description: The array of tag values for each group found for the results - of the formulas or queries. - example: - - - production - - - staging + description: The array of tag values for each group found for the results of the formulas or queries. + example: [["production"], ["staging"]] items: description: An individual tag value for a given group column. items: @@ -29279,7 +28135,7 @@ components: description: List of tags that apply to a single response value. items: description: A single tag that applies to a single response value. - example: env:production + example: "env:production" type: string type: array HTTPBody: @@ -29300,7 +28156,7 @@ components: errors: description: Structured errors. items: - $ref: '#/components/schemas/HTTPCIAppError' + $ref: "#/components/schemas/HTTPCIAppError" type: array type: object HTTPCDGatesNotFoundResponse: @@ -29309,7 +28165,7 @@ components: errors: description: Structured errors. items: - $ref: '#/components/schemas/HTTPCIAppError' + $ref: "#/components/schemas/HTTPCIAppError" type: array type: object HTTPCDRulesNotFoundResponse: @@ -29318,7 +28174,7 @@ components: errors: description: Structured errors. items: - $ref: '#/components/schemas/HTTPCIAppError' + $ref: "#/components/schemas/HTTPCIAppError" type: array type: object HTTPCIAppError: @@ -29326,15 +28182,15 @@ components: properties: detail: description: Error message. - example: Malformed payload + example: "Malformed payload" type: string status: description: Error code. - example: '400' + example: "400" type: string title: description: Error title. - example: Bad Request + example: "Bad Request" type: string type: object HTTPCIAppErrors: @@ -29343,17 +28199,17 @@ components: errors: description: Structured errors. items: - $ref: '#/components/schemas/HTTPCIAppError' + $ref: "#/components/schemas/HTTPCIAppError" type: array type: object HTTPCredentials: description: The definition of `HTTPCredentials` object. oneOf: - - $ref: '#/components/schemas/HTTPTokenAuth' + - $ref: "#/components/schemas/HTTPTokenAuth" HTTPCredentialsUpdate: description: The definition of `HTTPCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/HTTPTokenAuthUpdate' + - $ref: "#/components/schemas/HTTPTokenAuthUpdate" HTTPHeader: description: The definition of `HTTPHeader` object. properties: @@ -29367,8 +28223,8 @@ components: example: Some header value type: string required: - - name - - value + - name + - value type: object HTTPHeaderUpdate: description: The definition of `HTTPHeaderUpdate` object. @@ -29386,7 +28242,7 @@ components: example: Updated Header Value type: string required: - - name + - name type: object HTTPIntegration: description: The definition of `HTTPIntegration` object. @@ -29396,22 +28252,22 @@ components: example: http://datadoghq.com type: string credentials: - $ref: '#/components/schemas/HTTPCredentials' + $ref: "#/components/schemas/HTTPCredentials" type: - $ref: '#/components/schemas/HTTPIntegrationType' + $ref: "#/components/schemas/HTTPIntegrationType" required: - - type - - base_url - - credentials + - type + - base_url + - credentials type: object HTTPIntegrationType: description: The definition of `HTTPIntegrationType` object. enum: - - HTTP + - HTTP example: HTTP type: string x-enum-varnames: - - HTTP + - HTTP HTTPIntegrationUpdate: description: The definition of `HTTPIntegrationUpdate` object. properties: @@ -29420,31 +28276,31 @@ components: example: http://datadoghq.com type: string credentials: - $ref: '#/components/schemas/HTTPCredentialsUpdate' + $ref: "#/components/schemas/HTTPCredentialsUpdate" type: - $ref: '#/components/schemas/HTTPIntegrationType' + $ref: "#/components/schemas/HTTPIntegrationType" required: - - type + - type type: object HTTPLog: description: Structured log message. items: - $ref: '#/components/schemas/HTTPLogItem' + $ref: "#/components/schemas/HTTPLogItem" type: array HTTPLogError: description: List of errors. properties: detail: description: Error message. - example: Malformed payload + example: "Malformed payload" type: string status: description: Error code. - example: '400' + example: "400" type: string title: description: Error title. - example: Bad Request + example: "Bad Request" type: string type: object HTTPLogErrors: @@ -29453,7 +28309,7 @@ components: errors: description: Structured errors. items: - $ref: '#/components/schemas/HTTPLogError' + $ref: "#/components/schemas/HTTPLogError" type: array type: object HTTPLogItem: @@ -29462,13 +28318,10 @@ components: description: Logs that are sent over HTTP. properties: ddsource: - description: 'The integration name associated with your log: the technology - from which the log originated. - - When it matches an integration name, Datadog automatically installs the - corresponding parsers and facets. - - See [reserved attributes](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes).' + description: |- + The integration name associated with your log: the technology from which the log originated. + When it matches an integration name, Datadog automatically installs the corresponding parsers and facets. + See [reserved attributes](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes). example: nginx type: string ddtags: @@ -29480,27 +28333,21 @@ components: example: i-012345678 type: string message: - description: 'The message [reserved attribute](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes) - - of your log. By default, Datadog ingests the value of the message attribute - as the body of the log entry. - - That value is then highlighted and displayed in the Logstream, where it - is indexed for full text search.' + description: |- + The message [reserved attribute](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes) + of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. + That value is then highlighted and displayed in the Logstream, where it is indexed for full text search. example: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World type: string service: - description: 'The name of the application or service generating the log - events. - - It is used to switch from Logs to APM, so make sure you define the same - value when you use both products. - - See [reserved attributes](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes).' + description: |- + The name of the application or service generating the log events. + It is used to switch from Logs to APM, so make sure you define the same value when you use both products. + See [reserved attributes](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes). example: payment type: string required: - - message + - message type: object HTTPToken: description: The definition of `HTTPToken` object. @@ -29511,73 +28358,73 @@ components: pattern: ^[A-Za-z][A-Za-z\\d]*$ type: string type: - $ref: '#/components/schemas/TokenType' + $ref: "#/components/schemas/TokenType" value: description: The `HTTPToken` `value`. example: Some Token Value type: string required: - - name - - value - - type + - name + - value + - type type: object HTTPTokenAuth: description: The definition of `HTTPTokenAuth` object. properties: body: - $ref: '#/components/schemas/HTTPBody' + $ref: "#/components/schemas/HTTPBody" headers: description: The `HTTPTokenAuth` `headers`. items: - $ref: '#/components/schemas/HTTPHeader' + $ref: "#/components/schemas/HTTPHeader" type: array tokens: description: The `HTTPTokenAuth` `tokens`. items: - $ref: '#/components/schemas/HTTPToken' + $ref: "#/components/schemas/HTTPToken" type: array type: - $ref: '#/components/schemas/HTTPTokenAuthType' + $ref: "#/components/schemas/HTTPTokenAuthType" url_parameters: description: The `HTTPTokenAuth` `url_parameters`. items: - $ref: '#/components/schemas/UrlParam' + $ref: "#/components/schemas/UrlParam" type: array required: - - type + - type type: object HTTPTokenAuthType: description: The definition of `HTTPTokenAuthType` object. enum: - - HTTPTokenAuth + - HTTPTokenAuth example: HTTPTokenAuth type: string x-enum-varnames: - - HTTPTOKENAUTH + - HTTPTOKENAUTH HTTPTokenAuthUpdate: description: The definition of `HTTPTokenAuthUpdate` object. properties: body: - $ref: '#/components/schemas/HTTPBody' + $ref: "#/components/schemas/HTTPBody" headers: description: The `HTTPTokenAuthUpdate` `headers`. items: - $ref: '#/components/schemas/HTTPHeaderUpdate' + $ref: "#/components/schemas/HTTPHeaderUpdate" type: array tokens: description: The `HTTPTokenAuthUpdate` `tokens`. items: - $ref: '#/components/schemas/HTTPTokenUpdate' + $ref: "#/components/schemas/HTTPTokenUpdate" type: array type: - $ref: '#/components/schemas/HTTPTokenAuthType' + $ref: "#/components/schemas/HTTPTokenAuthType" url_parameters: description: The `HTTPTokenAuthUpdate` `url_parameters`. items: - $ref: '#/components/schemas/UrlParamUpdate' + $ref: "#/components/schemas/UrlParamUpdate" type: array required: - - type + - type type: object HTTPTokenUpdate: description: The definition of `HTTPTokenUpdate` object. @@ -29591,195 +28438,179 @@ components: pattern: ^[A-Za-z][A-Za-z\\d]*$ type: string type: - $ref: '#/components/schemas/TokenType' + $ref: "#/components/schemas/TokenType" value: description: The `HTTPToken` `value`. example: Some Token Value type: string required: - - name - - type - - value + - name + - type + - value type: object HamrOrgConnectionAttributesRequest: properties: hamr_status: - $ref: '#/components/schemas/HamrOrgConnectionStatus' + $ref: "#/components/schemas/HamrOrgConnectionStatus" is_primary: - description: 'Indicates whether this organization is the primary organization - in the HAMR relationship. - - If true, this is the primary organization. If false, this is the secondary/backup - organization.' + description: |- + Indicates whether this organization is the primary organization in the HAMR relationship. + If true, this is the primary organization. If false, this is the secondary/backup organization. example: true type: boolean modified_by: - description: Username or identifier of the user who last modified this HAMR - connection. - example: admin@example.com + description: Username or identifier of the user who last modified this HAMR connection. + example: "admin@example.com" type: string target_org_datacenter: - description: Datacenter location of the target organization (e.g., us1, - eu1, us5). - example: us1 + description: Datacenter location of the target organization (e.g., us1, eu1, us5). + example: "us1" type: string target_org_name: description: Name of the target organization in the HAMR relationship. - example: Production Backup Org + example: "Production Backup Org" type: string target_org_uuid: description: UUID of the target organization in the HAMR relationship. - example: 660f9511-f3ac-52e5-b827-557766551111 + example: "660f9511-f3ac-52e5-b827-557766551111" type: string required: - - target_org_uuid - - target_org_name - - target_org_datacenter - - hamr_status - - is_primary - - modified_by + - target_org_uuid + - target_org_name + - target_org_datacenter + - hamr_status + - is_primary + - modified_by type: object HamrOrgConnectionAttributesResponse: properties: hamr_status: - $ref: '#/components/schemas/HamrOrgConnectionStatus' + $ref: "#/components/schemas/HamrOrgConnectionStatus" is_primary: - description: 'Indicates whether this organization is the primary organization - in the HAMR relationship. - - If true, this is the primary organization. If false, this is the secondary/backup - organization.' + description: |- + Indicates whether this organization is the primary organization in the HAMR relationship. + If true, this is the primary organization. If false, this is the secondary/backup organization. example: true type: boolean modified_at: - description: Timestamp of when this HAMR connection was last modified (RFC3339 - format). - example: '2026-01-13T17:26:48.830968Z' + description: Timestamp of when this HAMR connection was last modified (RFC3339 format). + example: "2026-01-13T17:26:48.830968Z" type: string modified_by: - description: Username or identifier of the user who last modified this HAMR - connection. - example: admin@example.com + description: Username or identifier of the user who last modified this HAMR connection. + example: "admin@example.com" type: string target_org_datacenter: - description: Datacenter location of the target organization (e.g., us1, - eu1, us5). - example: us1 + description: Datacenter location of the target organization (e.g., us1, eu1, us5). + example: "us1" type: string target_org_name: description: Name of the target organization in the HAMR relationship. - example: Production Backup Org + example: "Production Backup Org" type: string target_org_uuid: description: UUID of the target organization in the HAMR relationship. - example: 660f9511-f3ac-52e5-b827-557766551111 + example: "660f9511-f3ac-52e5-b827-557766551111" type: string required: - - target_org_uuid - - target_org_name - - target_org_datacenter - - hamr_status - - is_primary - - modified_at - - modified_by + - target_org_uuid + - target_org_name + - target_org_datacenter + - hamr_status + - is_primary + - modified_at + - modified_by type: object HamrOrgConnectionDataRequest: properties: attributes: - $ref: '#/components/schemas/HamrOrgConnectionAttributesRequest' + $ref: "#/components/schemas/HamrOrgConnectionAttributesRequest" id: - description: The organization UUID for this HAMR connection. Must match - the authenticated organization's UUID. - example: 550e8400-e29b-41d4-a716-446655440000 + description: The organization UUID for this HAMR connection. Must match the authenticated organization's UUID. + example: "550e8400-e29b-41d4-a716-446655440000" type: string type: - $ref: '#/components/schemas/HamrOrgConnectionType' + $ref: "#/components/schemas/HamrOrgConnectionType" required: - - id - - type - - attributes + - id + - type + - attributes type: object HamrOrgConnectionDataResponse: properties: attributes: - $ref: '#/components/schemas/HamrOrgConnectionAttributesResponse' + $ref: "#/components/schemas/HamrOrgConnectionAttributesResponse" id: description: The organization UUID for this HAMR connection. - example: 550e8400-e29b-41d4-a716-446655440000 + example: "550e8400-e29b-41d4-a716-446655440000" type: string type: - $ref: '#/components/schemas/HamrOrgConnectionType' + $ref: "#/components/schemas/HamrOrgConnectionType" required: - - id - - type - - attributes + - id + - type + - attributes type: object HamrOrgConnectionRequest: properties: data: - $ref: '#/components/schemas/HamrOrgConnectionDataRequest' + $ref: "#/components/schemas/HamrOrgConnectionDataRequest" required: - - data + - data type: object HamrOrgConnectionResponse: properties: data: - $ref: '#/components/schemas/HamrOrgConnectionDataResponse' + $ref: "#/components/schemas/HamrOrgConnectionDataResponse" required: - - data + - data type: object HamrOrgConnectionStatus: - description: 'Status of the HAMR connection: - + description: |- + Status of the HAMR connection: - 0: UNSPECIFIED - Connection status not specified - - 1: ONBOARDING - Initial setup of HAMR connection - - 2: PASSIVE - Secondary organization in passive standby mode - - 3: FAILOVER - Liminal status between PASSIVE and ACTIVE - - 4: ACTIVE - Organization is an active failover - - - 5: RECOVERY - Recovery operation in progress' - enum: - - 0 - - 1 - - 2 - - 3 - - 4 - - 5 + - 5: RECOVERY - Recovery operation in progress + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + - 5 example: 4 type: integer x-enum-varnames: - - UNSPECIFIED - - ONBOARDING - - PASSIVE - - FAILOVER - - ACTIVE - - RECOVERY + - UNSPECIFIED + - ONBOARDING + - PASSIVE + - FAILOVER + - ACTIVE + - RECOVERY HamrOrgConnectionType: description: Type of the HAMR organization connection resource. enum: - - hamr_org_connections + - hamr_org_connections example: hamr_org_connections type: string x-enum-varnames: - - HAMR_ORG_CONNECTIONS + - HAMR_ORG_CONNECTIONS HourlyUsage: description: Hourly usage for a product family for an org. properties: attributes: - $ref: '#/components/schemas/HourlyUsageAttributes' + $ref: "#/components/schemas/HourlyUsageAttributes" id: description: Unique ID of the response. type: string type: - $ref: '#/components/schemas/UsageTimeSeriesType' + $ref: "#/components/schemas/UsageTimeSeriesType" type: object HourlyUsageAttributes: - description: Attributes of hourly usage for a product family for an org for - a time period. + description: Attributes of hourly usage for a product family for an org for a time period. properties: account_name: description: The account name. @@ -29788,10 +28619,9 @@ components: description: The account public ID. type: string measurements: - description: List of the measured usage values for the product family for - the org for the time period. + description: List of the measured usage values for the product family for the org for the time period. items: - $ref: '#/components/schemas/HourlyUsageMeasurement' + $ref: "#/components/schemas/HourlyUsageMeasurement" type: array org_name: description: The organization name. @@ -29803,8 +28633,7 @@ components: description: The organization public ID. type: string region: - description: The region of the Datadog instance that the organization belongs - to. + description: The region of the Datadog instance that the organization belongs to. type: string timestamp: description: Datetime in ISO-8601 format, UTC. The hour for the usage. @@ -29818,8 +28647,7 @@ components: description: Type of usage. type: string value: - description: Contains the number measured for the given usage_type during - the hour. + description: Contains the number measured for the given usage_type during the hour. format: int64 nullable: true type: integer @@ -29828,14 +28656,13 @@ components: description: The object containing document metadata. properties: pagination: - $ref: '#/components/schemas/HourlyUsagePagination' + $ref: "#/components/schemas/HourlyUsagePagination" type: object HourlyUsagePagination: description: The metadata for the current pagination. properties: next_record_id: - description: The cursor to get the next results (if any). To make the next - request, use the same parameters and add `next_record_id`. + description: The cursor to get the next results (if any). To make the next request, use the same parameters and add `next_record_id`. nullable: true type: string type: object @@ -29845,23 +28672,23 @@ components: data: description: Response containing hourly usage. items: - $ref: '#/components/schemas/HourlyUsage' + $ref: "#/components/schemas/HourlyUsage" type: array meta: - $ref: '#/components/schemas/HourlyUsageMetadata' + $ref: "#/components/schemas/HourlyUsageMetadata" type: object HourlyUsageType: description: Usage type that is being measured. enum: - - app_sec_host_count - - observability_pipelines_bytes_processed - - lambda_traced_invocations_count + - app_sec_host_count + - observability_pipelines_bytes_processed + - lambda_traced_invocations_count example: observability_pipelines_bytes_processed type: string x-enum-varnames: - - APP_SEC_HOST_COUNT - - OBSERVABILITY_PIPELINES_BYTES_PROCESSSED - - LAMBDA_TRACED_INVOCATIONS_COUNT + - APP_SEC_HOST_COUNT + - OBSERVABILITY_PIPELINES_BYTES_PROCESSSED + - LAMBDA_TRACED_INVOCATIONS_COUNT ID: description: The ID of a notification rule. example: aaa-bbb-ccc @@ -29875,29 +28702,29 @@ components: entries: description: Array of entries in the IP allowlist. items: - $ref: '#/components/schemas/IPAllowlistEntry' + $ref: "#/components/schemas/IPAllowlistEntry" type: array type: object IPAllowlistData: description: IP allowlist data. properties: attributes: - $ref: '#/components/schemas/IPAllowlistAttributes' + $ref: "#/components/schemas/IPAllowlistAttributes" id: description: The unique identifier of the org. type: string type: - $ref: '#/components/schemas/IPAllowlistType' + $ref: "#/components/schemas/IPAllowlistType" required: - - type + - type type: object IPAllowlistEntry: description: IP allowlist entry object. properties: data: - $ref: '#/components/schemas/IPAllowlistEntryData' + $ref: "#/components/schemas/IPAllowlistEntryData" required: - - data + - data type: object IPAllowlistEntryAttributes: description: Attributes of the IP allowlist entry. @@ -29923,46 +28750,46 @@ components: description: Data of the IP allowlist entry object. properties: attributes: - $ref: '#/components/schemas/IPAllowlistEntryAttributes' + $ref: "#/components/schemas/IPAllowlistEntryAttributes" id: description: The unique identifier of the IP allowlist entry. type: string type: - $ref: '#/components/schemas/IPAllowlistEntryType' + $ref: "#/components/schemas/IPAllowlistEntryType" required: - - type + - type type: object IPAllowlistEntryType: default: ip_allowlist_entry description: IP allowlist Entry type. enum: - - ip_allowlist_entry + - ip_allowlist_entry example: ip_allowlist_entry type: string x-enum-varnames: - - IP_ALLOWLIST_ENTRY + - IP_ALLOWLIST_ENTRY IPAllowlistResponse: description: Response containing information about the IP allowlist. properties: data: - $ref: '#/components/schemas/IPAllowlistData' + $ref: "#/components/schemas/IPAllowlistData" type: object IPAllowlistType: default: ip_allowlist description: IP allowlist type. enum: - - ip_allowlist + - ip_allowlist example: ip_allowlist type: string x-enum-varnames: - - IP_ALLOWLIST + - IP_ALLOWLIST IPAllowlistUpdateRequest: description: Update the IP allowlist. properties: data: - $ref: '#/components/schemas/IPAllowlistData' + $ref: "#/components/schemas/IPAllowlistData" required: - - data + - data type: object IdPMetadataFormData: description: The form data submitted to upload IdP metadata @@ -29977,18 +28804,17 @@ components: default: incident_attachments description: The incident attachment resource type. enum: - - incident_attachments + - incident_attachments example: incident_attachments type: string x-enum-varnames: - - INCIDENT_ATTACHMENTS + - INCIDENT_ATTACHMENTS IncidentCreateAttributes: description: The incident's attributes for a create request. properties: customer_impact_scope: - description: Required if `customer_impacted:"true"`. A summary of the impact - customers experienced during the incident. - example: Example customer impact scope + description: Required if `customer_impacted:"true"`. A summary of the impact customers experienced during the incident. + example: "Example customer impact scope" type: string customer_impacted: description: A flag indicating whether the incident caused customer impact. @@ -29996,99 +28822,82 @@ components: type: boolean fields: additionalProperties: - $ref: '#/components/schemas/IncidentFieldAttributes' - description: A condensed view of the user-defined fields for which to create - initial selections. - example: - severity: - type: dropdown - value: SEV-5 + $ref: "#/components/schemas/IncidentFieldAttributes" + description: A condensed view of the user-defined fields for which to create initial selections. + example: {"severity": {"type": "dropdown", "value": "SEV-5"}} type: object incident_type_uuid: - description: A unique identifier that represents an incident type. The default - incident type will be used if this property is not provided. - example: 00000000-0000-0000-0000-000000000000 + description: A unique identifier that represents an incident type. The default incident type will be used if this property is not provided. + example: "00000000-0000-0000-0000-000000000000" type: string initial_cells: - description: An array of initial timeline cells to be placed at the beginning - of the incident timeline. + description: An array of initial timeline cells to be placed at the beginning of the incident timeline. items: - $ref: '#/components/schemas/IncidentTimelineCellCreateAttributes' + $ref: "#/components/schemas/IncidentTimelineCellCreateAttributes" type: array is_test: description: A flag indicating whether the incident is a test incident. example: false type: boolean notification_handles: - description: Notification handles that will be notified of the incident - at creation. - example: - - display_name: Jane Doe - handle: '@user@email.com' - - display_name: Slack Channel - handle: '@slack-channel' - - display_name: Incident Workflow - handle: '@workflow-from-incident' + description: Notification handles that will be notified of the incident at creation. + example: [{"display_name": "Jane Doe", "handle": "@user@email.com"}, {"display_name": "Slack Channel", "handle": "@slack-channel"}, {"display_name": "Incident Workflow", "handle": "@workflow-from-incident"}] items: - $ref: '#/components/schemas/IncidentNotificationHandle' + $ref: "#/components/schemas/IncidentNotificationHandle" type: array title: description: The title of the incident, which summarizes what happened. - example: A test incident title + example: "A test incident title" type: string required: - - title - - customer_impacted + - title + - customer_impacted type: object IncidentCreateData: description: Incident data for a create request. properties: attributes: - $ref: '#/components/schemas/IncidentCreateAttributes' + $ref: "#/components/schemas/IncidentCreateAttributes" relationships: - $ref: '#/components/schemas/IncidentCreateRelationships' + $ref: "#/components/schemas/IncidentCreateRelationships" type: - $ref: '#/components/schemas/IncidentType' + $ref: "#/components/schemas/IncidentType" required: - - type - - attributes + - type + - attributes type: object IncidentCreateRelationships: - description: The relationships the incident will have with other resources once - created. + description: The relationships the incident will have with other resources once created. properties: commander_user: - $ref: '#/components/schemas/NullableRelationshipToUser' + $ref: "#/components/schemas/NullableRelationshipToUser" required: - - commander_user + - commander_user type: object IncidentCreateRequest: description: Create request for an incident. properties: data: - $ref: '#/components/schemas/IncidentCreateData' + $ref: "#/components/schemas/IncidentCreateData" required: - - data + - data type: object IncidentFieldAttributes: - description: Dynamic fields for which selections can be made, with field names - as keys. + description: Dynamic fields for which selections can be made, with field names as keys. oneOf: - - $ref: '#/components/schemas/IncidentFieldAttributesSingleValue' - - $ref: '#/components/schemas/IncidentFieldAttributesMultipleValue' + - $ref: "#/components/schemas/IncidentFieldAttributesSingleValue" + - $ref: "#/components/schemas/IncidentFieldAttributesMultipleValue" IncidentFieldAttributesMultipleValue: description: A field with potentially multiple values selected. properties: type: - $ref: '#/components/schemas/IncidentFieldAttributesValueType' + $ref: "#/components/schemas/IncidentFieldAttributesValueType" value: description: The multiple values selected for this field. - example: - - '1.0' - - '1.1' + example: ["1.0", "1.1"] items: description: A value which has been selected for the parent field. - example: '1.1' + example: "1.1" type: string nullable: true type: array @@ -30097,10 +28906,10 @@ components: description: A field with a single value selected. properties: type: - $ref: '#/components/schemas/IncidentFieldAttributesSingleValueType' + $ref: "#/components/schemas/IncidentFieldAttributesSingleValueType" value: description: The single value selected for this field. - example: SEV-1 + example: "SEV-1" nullable: true type: string type: object @@ -30108,38 +28917,37 @@ components: default: dropdown description: Type of the single value field definitions. enum: - - dropdown - - textbox + - dropdown + - textbox example: dropdown type: string x-enum-varnames: - - DROPDOWN - - TEXTBOX + - DROPDOWN + - TEXTBOX IncidentFieldAttributesValueType: default: multiselect description: Type of the multiple value field definitions. enum: - - multiselect - - textarray - - metrictag - - autocomplete + - multiselect + - textarray + - metrictag + - autocomplete example: multiselect type: string x-enum-varnames: - - MULTISELECT - - TEXTARRAY - - METRICTAG - - AUTOCOMPLETE + - MULTISELECT + - TEXTARRAY + - METRICTAG + - AUTOCOMPLETE IncidentHandleAttributesFields: description: Dynamic fields associated with the handle example: - severity: - - SEV-1 + severity: ["SEV-1"] properties: severity: description: Severity levels associated with the handle items: - $ref: '#/components/schemas/IncidentHandleAttributesFieldsSeverity' + $ref: "#/components/schemas/IncidentHandleAttributesFieldsSeverity" type: array type: object IncidentHandleAttributesFieldsSeverity: @@ -30149,362 +28957,355 @@ components: description: Incident handle attributes for requests properties: fields: - $ref: '#/components/schemas/IncidentHandleAttributesFields' + $ref: "#/components/schemas/IncidentHandleAttributesFields" name: description: The handle name - example: '@incident-sev-1' + example: "@incident-sev-1" type: string required: - - name + - name type: object IncidentHandleAttributesResponse: description: Incident handle attributes for responses properties: created_at: description: Timestamp when the handle was created - example: '2026-01-13T17:15:52.726905Z' + example: "2026-01-13T17:15:52.726905Z" format: date-time type: string fields: - $ref: '#/components/schemas/IncidentHandleAttributesFields' + $ref: "#/components/schemas/IncidentHandleAttributesFields" modified_at: description: Timestamp when the handle was last modified - example: '2026-01-13T17:15:52.726905Z' + example: "2026-01-13T17:15:52.726905Z" format: date-time type: string name: description: The handle name - example: '@incident-sev-1' + example: "@incident-sev-1" type: string required: - - name - - fields - - created_at - - modified_at + - name + - fields + - created_at + - modified_at type: object IncidentHandleDataRequest: properties: attributes: - $ref: '#/components/schemas/IncidentHandleAttributesRequest' + $ref: "#/components/schemas/IncidentHandleAttributesRequest" id: description: The ID of the incident handle (required for PUT requests) - example: b2494081-cdf0-4205-b366-4e1dd4fdf0bf + example: "b2494081-cdf0-4205-b366-4e1dd4fdf0bf" type: string relationships: - $ref: '#/components/schemas/IncidentHandleRelationshipsRequest' + $ref: "#/components/schemas/IncidentHandleRelationshipsRequest" type: - $ref: '#/components/schemas/IncidentHandleType' + $ref: "#/components/schemas/IncidentHandleType" required: - - type - - attributes + - type + - attributes type: object IncidentHandleDataResponse: properties: attributes: - $ref: '#/components/schemas/IncidentHandleAttributesResponse' + $ref: "#/components/schemas/IncidentHandleAttributesResponse" id: description: The ID of the incident handle - example: 12ceee6d-a7c0-4407-bc54-30e54140d7f0 + example: "12ceee6d-a7c0-4407-bc54-30e54140d7f0" type: string relationships: - $ref: '#/components/schemas/IncidentHandleRelationships' + $ref: "#/components/schemas/IncidentHandleRelationships" type: - $ref: '#/components/schemas/IncidentHandleType' + $ref: "#/components/schemas/IncidentHandleType" required: - - id - - type - - attributes + - id + - type + - attributes type: object IncidentHandleIncludedItemResponse: oneOf: - - $ref: '#/components/schemas/IncidentUserData' - - $ref: '#/components/schemas/IncidentTypeObject' + - $ref: "#/components/schemas/IncidentUserData" + - $ref: "#/components/schemas/IncidentTypeObject" IncidentHandleIncludedResponse: description: Included related resources items: - $ref: '#/components/schemas/IncidentHandleIncludedItemResponse' + $ref: "#/components/schemas/IncidentHandleIncludedItemResponse" type: array IncidentHandleRelationship: properties: data: - $ref: '#/components/schemas/IncidentHandleRelationshipData' + $ref: "#/components/schemas/IncidentHandleRelationshipData" required: - - data + - data type: object IncidentHandleRelationshipData: properties: id: description: The ID of the related resource - example: f7b538b1-ed7c-4e84-82de-fdf84a539d40 + example: "f7b538b1-ed7c-4e84-82de-fdf84a539d40" type: string type: description: The type of the related resource - example: incident_types + example: "incident_types" type: string required: - - id - - type + - id + - type type: object IncidentHandleRelationships: nullable: true properties: commander_user: - $ref: '#/components/schemas/IncidentHandleRelationship' + $ref: "#/components/schemas/IncidentHandleRelationship" created_by_user: - $ref: '#/components/schemas/IncidentHandleRelationship' + $ref: "#/components/schemas/IncidentHandleRelationship" incident_type: - $ref: '#/components/schemas/IncidentHandleRelationship' + $ref: "#/components/schemas/IncidentHandleRelationship" last_modified_by_user: - $ref: '#/components/schemas/IncidentHandleRelationship' + $ref: "#/components/schemas/IncidentHandleRelationship" required: - - incident_type - - created_by_user - - last_modified_by_user + - incident_type + - created_by_user + - last_modified_by_user type: object IncidentHandleRelationshipsRequest: nullable: true properties: commander_user: - $ref: '#/components/schemas/IncidentHandleRelationship' + $ref: "#/components/schemas/IncidentHandleRelationship" incident_type: - $ref: '#/components/schemas/IncidentHandleRelationship' + $ref: "#/components/schemas/IncidentHandleRelationship" required: - - incident_type + - incident_type type: object IncidentHandleRequest: properties: data: - $ref: '#/components/schemas/IncidentHandleDataRequest' + $ref: "#/components/schemas/IncidentHandleDataRequest" required: - - data + - data type: object IncidentHandleResponse: properties: data: - $ref: '#/components/schemas/IncidentHandleDataResponse' + $ref: "#/components/schemas/IncidentHandleDataResponse" included: - $ref: '#/components/schemas/IncidentHandleIncludedResponse' + $ref: "#/components/schemas/IncidentHandleIncludedResponse" required: - - data + - data type: object IncidentHandleType: description: Incident handle resource type enum: - - incidents_handles + - incidents_handles example: incidents_handles type: string x-enum-varnames: - - INCIDENTS_HANDLES + - INCIDENTS_HANDLES IncidentHandlesResponse: properties: data: - $ref: '#/components/schemas/IncidentHandlesResponseData' + $ref: "#/components/schemas/IncidentHandlesResponseData" included: - $ref: '#/components/schemas/IncidentHandleIncludedResponse' + $ref: "#/components/schemas/IncidentHandleIncludedResponse" required: - - data + - data type: object IncidentHandlesResponseData: items: - $ref: '#/components/schemas/IncidentHandleDataResponse' + $ref: "#/components/schemas/IncidentHandleDataResponse" type: array IncidentImpactAttributes: description: The incident impact's attributes. properties: created: description: Timestamp when the impact was created. - example: '2025-08-29T13:17:00Z' + example: "2025-08-29T13:17:00Z" format: date-time readOnly: true type: string description: description: Description of the impact. - example: Service was unavailable for external users + example: "Service was unavailable for external users" type: string end_at: description: Timestamp when the impact ended. - example: '2025-08-29T13:17:00Z' + example: "2025-08-29T13:17:00Z" format: date-time nullable: true type: string fields: - $ref: '#/components/schemas/IncidentImpactFieldsObject' + $ref: "#/components/schemas/IncidentImpactFieldsObject" impact_type: description: The type of impact. - example: customer + example: "customer" type: string modified: description: Timestamp when the impact was last modified. - example: '2025-08-29T13:17:00Z' + example: "2025-08-29T13:17:00Z" format: date-time readOnly: true type: string start_at: description: Timestamp representing when the impact started. - example: '2025-08-28T13:17:00Z' + example: "2025-08-28T13:17:00Z" format: date-time type: string required: - - description - - start_at + - description + - start_at type: object IncidentImpactCreateAttributes: description: The incident impact's attributes for a create request. properties: description: description: Description of the impact. - example: Service was unavailable for external users + example: "Service was unavailable for external users" type: string end_at: description: Timestamp when the impact ended. - example: '2025-08-29T13:17:00Z' + example: "2025-08-29T13:17:00Z" format: date-time nullable: true type: string fields: - $ref: '#/components/schemas/IncidentImpactFieldsObject' + $ref: "#/components/schemas/IncidentImpactFieldsObject" start_at: description: Timestamp when the impact started. - example: '2025-08-28T13:17:00Z' + example: "2025-08-28T13:17:00Z" format: date-time type: string required: - - description - - start_at + - description + - start_at type: object IncidentImpactCreateData: description: Incident impact data for a create request. properties: attributes: - $ref: '#/components/schemas/IncidentImpactCreateAttributes' + $ref: "#/components/schemas/IncidentImpactCreateAttributes" type: - $ref: '#/components/schemas/IncidentImpactType' + $ref: "#/components/schemas/IncidentImpactType" required: - - type - - attributes + - type + - attributes type: object IncidentImpactCreateRequest: description: Create request for an incident impact. properties: data: - $ref: '#/components/schemas/IncidentImpactCreateData' + $ref: "#/components/schemas/IncidentImpactCreateData" required: - - data + - data type: object IncidentImpactFieldsObject: additionalProperties: {} description: An object mapping impact field names to field values. - example: - customers_impacted: all - products_impacted: - - shopping - - marketing + example: {"customers_impacted": "all", "products_impacted": ["shopping", "marketing"]} nullable: true type: object IncidentImpactRelatedObject: description: A reference to a resource related to an incident impact. enum: - - incident - - created_by_user - - last_modified_by_user + - incident + - created_by_user + - last_modified_by_user type: string x-enum-varnames: - - INCIDENT - - CREATED_BY_USER - - LAST_MODIFIED_BY_USER + - INCIDENT + - CREATED_BY_USER + - LAST_MODIFIED_BY_USER IncidentImpactRelationships: description: The incident impact's resource relationships. properties: created_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" incident: - $ref: '#/components/schemas/RelationshipToIncident' + $ref: "#/components/schemas/RelationshipToIncident" last_modified_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" type: object IncidentImpactResponse: description: Response with an incident impact. properties: data: - $ref: '#/components/schemas/IncidentImpactResponseData' + $ref: "#/components/schemas/IncidentImpactResponseData" included: description: Included related resources that the user requested. items: - $ref: '#/components/schemas/IncidentUserData' + $ref: "#/components/schemas/IncidentUserData" readOnly: true type: array required: - - data + - data type: object IncidentImpactResponseData: description: Incident impact data from a response. properties: attributes: - $ref: '#/components/schemas/IncidentImpactAttributes' + $ref: "#/components/schemas/IncidentImpactAttributes" id: description: The incident impact's ID. - example: 00000000-0000-0000-1234-000000000000 + example: "00000000-0000-0000-1234-000000000000" type: string relationships: - $ref: '#/components/schemas/IncidentImpactRelationships' + $ref: "#/components/schemas/IncidentImpactRelationships" type: - $ref: '#/components/schemas/IncidentImpactType' + $ref: "#/components/schemas/IncidentImpactType" required: - - id - - type + - id + - type type: object IncidentImpactType: default: incident_impacts description: Incident impact resource type. enum: - - incident_impacts + - incident_impacts example: incident_impacts type: string x-enum-varnames: - - INCIDENT_IMPACTS + - INCIDENT_IMPACTS IncidentImpactsResponse: description: Response with a list of incident impacts. properties: data: description: An array of incident impacts. items: - $ref: '#/components/schemas/IncidentImpactResponseData' + $ref: "#/components/schemas/IncidentImpactResponseData" type: array included: description: Included related resources that the user requested. items: - $ref: '#/components/schemas/IncidentUserData' + $ref: "#/components/schemas/IncidentUserData" readOnly: true type: array required: - - data + - data type: object IncidentImpactsType: description: The incident impacts type. enum: - - incident_impacts + - incident_impacts example: incident_impacts type: string x-enum-varnames: - - INCIDENT_IMPACTS + - INCIDENT_IMPACTS IncidentImportFieldAttributes: - description: Dynamic fields for which selections can be made, with field names - as keys. + description: Dynamic fields for which selections can be made, with field names as keys. oneOf: - - $ref: '#/components/schemas/IncidentImportFieldAttributesSingleValue' - - $ref: '#/components/schemas/IncidentImportFieldAttributesMultipleValue' + - $ref: "#/components/schemas/IncidentImportFieldAttributesSingleValue" + - $ref: "#/components/schemas/IncidentImportFieldAttributesMultipleValue" IncidentImportFieldAttributesMultipleValue: additionalProperties: false description: A field with potentially multiple values selected. properties: value: description: The multiple values selected for this field. - example: - - '1.0' - - '1.1' + example: ["1.0", "1.1"] items: description: A value which has been selected for the parent field. - example: '1.1' + example: "1.1" type: string nullable: true type: array @@ -30515,113 +29316,105 @@ components: properties: value: description: The single value selected for this field. - example: SEV-1 + example: "SEV-1" nullable: true type: string type: object IncidentImportRelatedObject: description: Object related to an incident that can be included in the response. enum: - - last_modified_by_user - - created_by_user - - commander_user - - declared_by_user - - incident_type + - last_modified_by_user + - created_by_user + - commander_user + - declared_by_user + - incident_type type: string x-enum-varnames: - - LAST_MODIFIED_BY_USER - - CREATED_BY_USER - - COMMANDER_USER - - DECLARED_BY_USER - - INCIDENT_TYPE + - LAST_MODIFIED_BY_USER + - CREATED_BY_USER + - COMMANDER_USER + - DECLARED_BY_USER + - INCIDENT_TYPE IncidentImportRelationships: description: The relationships for an incident import request. properties: commander_user: - $ref: '#/components/schemas/NullableRelationshipToUser' + $ref: "#/components/schemas/NullableRelationshipToUser" declared_by_user: - $ref: '#/components/schemas/NullableRelationshipToUser' + $ref: "#/components/schemas/NullableRelationshipToUser" type: object IncidentImportRequest: - description: Import request for an incident. Used to import historical incidents - from external systems. + description: Import request for an incident. Used to import historical incidents from external systems. properties: data: - $ref: '#/components/schemas/IncidentImportRequestData' + $ref: "#/components/schemas/IncidentImportRequestData" required: - - data + - data type: object IncidentImportRequestAttributes: description: The incident's attributes for an import request. properties: declared: description: Timestamp when the incident was declared. - example: '2025-01-01T00:00:00Z' + example: "2025-01-01T00:00:00Z" format: date-time type: string detected: description: Timestamp when the incident was detected. - example: '2025-01-01T00:00:00Z' + example: "2025-01-01T00:00:00Z" format: date-time type: string fields: additionalProperties: - $ref: '#/components/schemas/IncidentImportFieldAttributes' - description: A condensed view of the user-defined fields for which to create - initial selections. - example: - severity: - value: SEV-5 - state: - value: active + $ref: "#/components/schemas/IncidentImportFieldAttributes" + description: A condensed view of the user-defined fields for which to create initial selections. + example: {"severity": {"value": "SEV-5"}, "state": {"value": "active"}} type: object incident_type_uuid: - description: A unique identifier that represents the incident type. If not - provided, the default incident type is used. - example: 00000000-0000-0000-0000-000000000000 + description: A unique identifier that represents the incident type. If not provided, the default incident type is used. + example: "00000000-0000-0000-0000-000000000000" type: string resolved: - description: Timestamp when the incident was resolved. Can only be set when - the state field is set to 'resolved'. - example: '2025-01-01T01:00:00Z' + description: Timestamp when the incident was resolved. Can only be set when the state field is set to 'resolved'. + example: "2025-01-01T01:00:00Z" format: date-time type: string title: description: The title of the incident that summarizes what happened. - example: Imported incident from external system + example: "Imported incident from external system" maxLength: 1024 type: string visibility: - $ref: '#/components/schemas/IncidentImportVisibility' + $ref: "#/components/schemas/IncidentImportVisibility" required: - - title + - title type: object IncidentImportRequestData: description: Incident data for an import request. properties: attributes: - $ref: '#/components/schemas/IncidentImportRequestAttributes' + $ref: "#/components/schemas/IncidentImportRequestAttributes" relationships: - $ref: '#/components/schemas/IncidentImportRelationships' + $ref: "#/components/schemas/IncidentImportRelationships" type: - $ref: '#/components/schemas/IncidentType' + $ref: "#/components/schemas/IncidentType" required: - - type - - attributes + - type + - attributes type: object IncidentImportResponse: description: Response with an incident. properties: data: - $ref: '#/components/schemas/IncidentImportResponseData' + $ref: "#/components/schemas/IncidentImportResponseData" included: description: Included related resources that the user requested. items: - $ref: '#/components/schemas/IncidentImportResponseIncludedItem' + $ref: "#/components/schemas/IncidentImportResponseIncludedItem" readOnly: true type: array required: - - data + - data type: object IncidentImportResponseAttributes: description: The incident's attributes from an import response. @@ -30639,7 +29432,7 @@ components: type: integer created: description: Timestamp when the incident was created. - example: '2025-01-01T00:00:00Z' + example: "2025-01-01T00:00:00Z" format: date-time readOnly: true type: string @@ -30658,7 +29451,7 @@ components: type: string customer_impact_scope: description: A summary of the impact customers experienced during the incident. - example: An example customer impact scope + example: "An example customer impact scope" nullable: true type: string customer_impact_start: @@ -30668,7 +29461,7 @@ components: type: string declared: description: Timestamp when the incident was declared. - example: '2025-01-01T00:00:00Z' + example: "2025-01-01T00:00:00Z" format: date-time nullable: true type: string @@ -30678,22 +29471,19 @@ components: type: string detected: description: Timestamp when the incident was detected. - example: '2025-01-01T00:00:00Z' + example: "2025-01-01T00:00:00Z" format: date-time nullable: true type: string fields: additionalProperties: - $ref: '#/components/schemas/IncidentFieldAttributes' + $ref: "#/components/schemas/IncidentFieldAttributes" description: A condensed view of the user-defined fields attached to incidents. - example: - severity: - type: dropdown - value: SEV-5 + example: {"severity": {"type": "dropdown", "value": "SEV-5"}} type: object incident_type_uuid: description: A unique identifier that represents an incident type. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string is_test: description: A flag indicating whether the incident is a test incident. @@ -30709,12 +29499,11 @@ components: readOnly: true type: string non_datadog_creator: - $ref: '#/components/schemas/IncidentNonDatadogCreator' + $ref: "#/components/schemas/IncidentNonDatadogCreator" notification_handles: - description: Notification handles that are notified of the incident during - update. + description: Notification handles that are notified of the incident during update. items: - $ref: '#/components/schemas/IncidentNotificationHandle' + $ref: "#/components/schemas/IncidentNotificationHandle" nullable: true type: array public_id: @@ -30723,85 +29512,84 @@ components: format: int64 type: integer resolved: - description: Timestamp when the incident's state was last changed from active - or stable to resolved or completed. + description: Timestamp when the incident's state was last changed from active or stable to resolved or completed. format: date-time nullable: true type: string severity: - $ref: '#/components/schemas/IncidentSeverity' + $ref: "#/components/schemas/IncidentSeverity" state: description: The state of the incident. nullable: true type: string title: description: The title of the incident that summarizes what happened. - example: A test incident title + example: "A test incident title" type: string visibility: description: The incident visibility status. nullable: true type: string required: - - title + - title type: object IncidentImportResponseData: description: Incident data from an import response. properties: attributes: - $ref: '#/components/schemas/IncidentImportResponseAttributes' + $ref: "#/components/schemas/IncidentImportResponseAttributes" id: description: The incident's ID. - example: 00000000-0000-0000-1234-000000000000 + example: "00000000-0000-0000-1234-000000000000" type: string relationships: - $ref: '#/components/schemas/IncidentImportResponseRelationships' + $ref: "#/components/schemas/IncidentImportResponseRelationships" type: - $ref: '#/components/schemas/IncidentType' + $ref: "#/components/schemas/IncidentType" required: - - id - - type + - id + - type type: object IncidentImportResponseIncludedItem: description: An object related to an incident that is included in the response. oneOf: - - $ref: '#/components/schemas/IncidentUserData' - - $ref: '#/components/schemas/IncidentTypeObject' + - $ref: "#/components/schemas/IncidentUserData" + - $ref: "#/components/schemas/IncidentTypeObject" IncidentImportResponseRelationships: description: The incident's relationships from an import response. properties: attachments: - $ref: '#/components/schemas/RelationshipToIncidentAttachment' + $ref: "#/components/schemas/RelationshipToIncidentAttachment" commander_user: - $ref: '#/components/schemas/NullableRelationshipToUser' + $ref: "#/components/schemas/NullableRelationshipToUser" created_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" declared_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" impacts: - $ref: '#/components/schemas/RelationshipToIncidentImpacts' + $ref: "#/components/schemas/RelationshipToIncidentImpacts" incident_type: - $ref: '#/components/schemas/RelationshipToIncidentType' + $ref: "#/components/schemas/RelationshipToIncidentType" integrations: - $ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas' + $ref: "#/components/schemas/RelationshipToIncidentIntegrationMetadatas" last_modified_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" responders: - $ref: '#/components/schemas/RelationshipToIncidentResponders' + $ref: "#/components/schemas/RelationshipToIncidentResponders" user_defined_fields: - $ref: '#/components/schemas/RelationshipToIncidentUserDefinedFields' + $ref: "#/components/schemas/RelationshipToIncidentUserDefinedFields" type: object IncidentImportVisibility: default: organization description: The visibility of the incident. enum: - - organization - - private + - organization + - private example: organization type: string x-enum-varnames: - - ORGANIZATION - - PRIVATE + - ORGANIZATION + - PRIVATE IncidentIntegrationMetadataAttributes: description: Incident integration metadata's attributes for a create request. properties: @@ -30811,58 +29599,54 @@ components: readOnly: true type: string incident_id: - description: UUID of the incident this integration metadata is connected - to. - example: 00000000-aaaa-0000-0000-000000000000 + description: UUID of the incident this integration metadata is connected to. + example: "00000000-aaaa-0000-0000-000000000000" type: string integration_type: - description: 'A number indicating the type of integration this metadata - is for. 1 indicates Slack; - - 8 indicates Jira.' + description: |- + A number indicating the type of integration this metadata is for. 1 indicates Slack; + 8 indicates Jira. example: 1 format: int32 maximum: 100 type: integer metadata: - $ref: '#/components/schemas/IncidentIntegrationMetadataMetadata' + $ref: "#/components/schemas/IncidentIntegrationMetadataMetadata" modified: description: Timestamp when the incident todo was last modified. format: date-time readOnly: true type: string status: - description: 'A number indicating the status of this integration metadata. - 0 indicates unknown; - + description: |- + A number indicating the status of this integration metadata. 0 indicates unknown; 1 indicates pending; 2 indicates complete; 3 indicates manually created; - - 4 indicates manually updated; 5 indicates failed.' + 4 indicates manually updated; 5 indicates failed. format: int32 maximum: 5 type: integer required: - - integration_type - - metadata + - integration_type + - metadata type: object IncidentIntegrationMetadataCreateData: description: Incident integration metadata data for a create request. properties: attributes: - $ref: '#/components/schemas/IncidentIntegrationMetadataAttributes' + $ref: "#/components/schemas/IncidentIntegrationMetadataAttributes" type: - $ref: '#/components/schemas/IncidentIntegrationMetadataType' + $ref: "#/components/schemas/IncidentIntegrationMetadataType" required: - - type - - attributes + - type + - attributes type: object IncidentIntegrationMetadataCreateRequest: description: Create request for an incident integration metadata. properties: data: - $ref: '#/components/schemas/IncidentIntegrationMetadataCreateData' + $ref: "#/components/schemas/IncidentIntegrationMetadataCreateData" required: - - data + - data type: object IncidentIntegrationMetadataListResponse: description: Response with a list of incident integration metadata. @@ -30870,96 +29654,95 @@ components: data: description: An array of incident integration metadata. items: - $ref: '#/components/schemas/IncidentIntegrationMetadataResponseData' + $ref: "#/components/schemas/IncidentIntegrationMetadataResponseData" type: array included: description: Included related resources that the user requested. items: - $ref: '#/components/schemas/IncidentIntegrationMetadataResponseIncludedItem' + $ref: "#/components/schemas/IncidentIntegrationMetadataResponseIncludedItem" readOnly: true type: array meta: - $ref: '#/components/schemas/IncidentResponseMeta' + $ref: "#/components/schemas/IncidentResponseMeta" required: - - data + - data type: object IncidentIntegrationMetadataMetadata: description: Incident integration metadata's metadata attribute. oneOf: - - $ref: '#/components/schemas/SlackIntegrationMetadata' - - $ref: '#/components/schemas/JiraIntegrationMetadata' - - $ref: '#/components/schemas/MSTeamsIntegrationMetadata' + - $ref: "#/components/schemas/SlackIntegrationMetadata" + - $ref: "#/components/schemas/JiraIntegrationMetadata" + - $ref: "#/components/schemas/MSTeamsIntegrationMetadata" IncidentIntegrationMetadataPatchData: description: Incident integration metadata data for a patch request. properties: attributes: - $ref: '#/components/schemas/IncidentIntegrationMetadataAttributes' + $ref: "#/components/schemas/IncidentIntegrationMetadataAttributes" type: - $ref: '#/components/schemas/IncidentIntegrationMetadataType' + $ref: "#/components/schemas/IncidentIntegrationMetadataType" required: - - type - - attributes + - type + - attributes type: object IncidentIntegrationMetadataPatchRequest: description: Patch request for an incident integration metadata. properties: data: - $ref: '#/components/schemas/IncidentIntegrationMetadataPatchData' + $ref: "#/components/schemas/IncidentIntegrationMetadataPatchData" required: - - data + - data type: object IncidentIntegrationMetadataResponse: description: Response with an incident integration metadata. properties: data: - $ref: '#/components/schemas/IncidentIntegrationMetadataResponseData' + $ref: "#/components/schemas/IncidentIntegrationMetadataResponseData" included: description: Included related resources that the user requested. items: - $ref: '#/components/schemas/IncidentIntegrationMetadataResponseIncludedItem' + $ref: "#/components/schemas/IncidentIntegrationMetadataResponseIncludedItem" readOnly: true type: array required: - - data + - data type: object IncidentIntegrationMetadataResponseData: description: Incident integration metadata from a response. properties: attributes: - $ref: '#/components/schemas/IncidentIntegrationMetadataAttributes' + $ref: "#/components/schemas/IncidentIntegrationMetadataAttributes" id: description: The incident integration metadata's ID. - example: 00000000-0000-0000-1234-000000000000 + example: "00000000-0000-0000-1234-000000000000" type: string relationships: - $ref: '#/components/schemas/IncidentIntegrationRelationships' + $ref: "#/components/schemas/IncidentIntegrationRelationships" type: - $ref: '#/components/schemas/IncidentIntegrationMetadataType' + $ref: "#/components/schemas/IncidentIntegrationMetadataType" required: - - id - - type + - id + - type type: object IncidentIntegrationMetadataResponseIncludedItem: - description: An object related to an incident integration metadata that is included - in the response. + description: An object related to an incident integration metadata that is included in the response. oneOf: - - $ref: '#/components/schemas/User' + - $ref: "#/components/schemas/User" IncidentIntegrationMetadataType: default: incident_integrations description: Integration metadata resource type. enum: - - incident_integrations + - incident_integrations example: incident_integrations type: string x-enum-varnames: - - INCIDENT_INTEGRATIONS + - INCIDENT_INTEGRATIONS IncidentIntegrationRelationships: description: The incident's integration relationships from a response. properties: created_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" last_modified_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" type: object IncidentNonDatadogCreator: description: Incident's non Datadog creator. @@ -30980,23 +29763,22 @@ components: example: Jane Doe type: string handle: - description: The handle used for the notification. This includes an email - address, Slack channel, or workflow. - example: '@test.user@test.com' + description: The handle used for the notification. This includes an email address, Slack channel, or workflow. + example: "@test.user@test.com" type: string type: object IncidentNotificationRule: description: Response with a notification rule. properties: data: - $ref: '#/components/schemas/IncidentNotificationRuleResponseData' + $ref: "#/components/schemas/IncidentNotificationRuleResponseData" included: description: Related objects that are included in the response. items: - $ref: '#/components/schemas/IncidentNotificationRuleIncludedItems' + $ref: "#/components/schemas/IncidentNotificationRuleIncludedItems" type: array required: - - data + - data type: object IncidentNotificationRuleArray: description: Response with notification rules. @@ -31004,23 +29786,23 @@ components: data: description: The `NotificationRuleArray` `data`. items: - $ref: '#/components/schemas/IncidentNotificationRuleResponseData' + $ref: "#/components/schemas/IncidentNotificationRuleResponseData" type: array included: description: Related objects that are included in the response. items: - $ref: '#/components/schemas/IncidentNotificationRuleIncludedItems' + $ref: "#/components/schemas/IncidentNotificationRuleIncludedItems" type: array meta: - $ref: '#/components/schemas/IncidentNotificationRuleArrayMeta' + $ref: "#/components/schemas/IncidentNotificationRuleArrayMeta" required: - - data + - data type: object IncidentNotificationRuleArrayMeta: description: Response metadata. properties: pagination: - $ref: '#/components/schemas/IncidentNotificationRuleArrayMetaPage' + $ref: "#/components/schemas/IncidentNotificationRuleArrayMetaPage" type: object IncidentNotificationRuleArrayMetaPage: description: Pagination metadata. @@ -31045,10 +29827,10 @@ components: description: The notification rule's attributes. properties: conditions: - $ref: '#/components/schemas/IncidentNotificationRuleConditions' + $ref: "#/components/schemas/IncidentNotificationRuleConditions" created: description: Timestamp when the notification rule was created. - example: '2025-01-15T10:30:00Z' + example: "2025-01-15T10:30:00Z" format: date-time readOnly: true type: string @@ -31057,135 +29839,120 @@ components: example: true type: boolean handles: - $ref: '#/components/schemas/IncidentNotificationRuleHandles' + $ref: "#/components/schemas/IncidentNotificationRuleHandles" modified: description: Timestamp when the notification rule was last modified. - example: '2025-01-15T14:45:00Z' + example: "2025-01-15T14:45:00Z" format: date-time readOnly: true type: string renotify_on: - $ref: '#/components/schemas/IncidentNotificationRuleRenotifyOn' + $ref: "#/components/schemas/IncidentNotificationRuleRenotifyOn" trigger: description: The trigger event for this notification rule. - example: incident_created_trigger + example: "incident_created_trigger" type: string visibility: - $ref: '#/components/schemas/IncidentNotificationRuleAttributesVisibility' + $ref: "#/components/schemas/IncidentNotificationRuleAttributesVisibility" required: - - conditions - - handles - - visibility - - trigger - - enabled - - created - - modified + - conditions + - handles + - visibility + - trigger + - enabled + - created + - modified type: object IncidentNotificationRuleAttributesVisibility: description: The visibility of the notification rule. - enum: - - all - - organization - - private - example: organization + enum: ["all", "organization", "private"] + example: "organization" type: string x-enum-varnames: - - ALL - - ORGANIZATION - - PRIVATE + - ALL + - ORGANIZATION + - PRIVATE IncidentNotificationRuleConditions: description: The conditions that trigger this notification rule. - example: - - field: severity - values: - - SEV-1 - - SEV-2 + example: [{"field": "severity", "values": ["SEV-1", "SEV-2"]}] items: - $ref: '#/components/schemas/IncidentNotificationRuleConditionsItems' + $ref: "#/components/schemas/IncidentNotificationRuleConditionsItems" type: array IncidentNotificationRuleConditionsItems: description: A condition that must be met to trigger the notification rule. properties: field: description: The incident field to evaluate - example: severity + example: "severity" type: string values: - description: The value(s) to compare against. Multiple values are `ORed` - together. - example: - - SEV-1 - - SEV-2 + description: The value(s) to compare against. Multiple values are `ORed` together. + example: ["SEV-1", "SEV-2"] items: type: string type: array required: - - field - - values + - field + - values type: object IncidentNotificationRuleCreateAttributes: description: The attributes for creating a notification rule. properties: conditions: - $ref: '#/components/schemas/IncidentNotificationRuleConditions' + $ref: "#/components/schemas/IncidentNotificationRuleConditions" enabled: default: false description: Whether the notification rule is enabled. example: true type: boolean handles: - $ref: '#/components/schemas/IncidentNotificationRuleHandles' + $ref: "#/components/schemas/IncidentNotificationRuleHandles" renotify_on: - $ref: '#/components/schemas/IncidentNotificationRuleRenotifyOn' + $ref: "#/components/schemas/IncidentNotificationRuleRenotifyOn" trigger: description: The trigger event for this notification rule. - example: incident_created_trigger + example: "incident_created_trigger" type: string visibility: - $ref: '#/components/schemas/IncidentNotificationRuleCreateAttributesVisibility' + $ref: "#/components/schemas/IncidentNotificationRuleCreateAttributesVisibility" required: - - conditions - - handles - - trigger + - conditions + - handles + - trigger type: object IncidentNotificationRuleCreateAttributesVisibility: description: The visibility of the notification rule. - enum: - - all - - organization - - private - example: organization + enum: ["all", "organization", "private"] + example: "organization" type: string x-enum-varnames: - - ALL - - ORGANIZATION - - PRIVATE + - ALL + - ORGANIZATION + - PRIVATE IncidentNotificationRuleCreateData: description: Notification rule data for a create request. properties: attributes: - $ref: '#/components/schemas/IncidentNotificationRuleCreateAttributes' + $ref: "#/components/schemas/IncidentNotificationRuleCreateAttributes" relationships: - $ref: '#/components/schemas/IncidentNotificationRuleCreateDataRelationships' + $ref: "#/components/schemas/IncidentNotificationRuleCreateDataRelationships" type: - $ref: '#/components/schemas/IncidentNotificationRuleType' + $ref: "#/components/schemas/IncidentNotificationRuleType" required: - - type - - attributes + - type + - attributes type: object IncidentNotificationRuleCreateDataRelationships: description: The definition of `NotificationRuleCreateDataRelationships` object. properties: incident_type: - $ref: '#/components/schemas/RelationshipToIncidentType' + $ref: "#/components/schemas/RelationshipToIncidentType" notification_template: - $ref: '#/components/schemas/RelationshipToIncidentNotificationTemplate' + $ref: "#/components/schemas/RelationshipToIncidentNotificationTemplate" type: object IncidentNotificationRuleHandles: description: The notification handles (targets) for this rule. - example: - - '@team-email@company.com' - - '@slack-channel' + example: ["@team-email@company.com", "@slack-channel"] items: description: A notification handle (email, Slack channel, etc.). type: string @@ -31193,26 +29960,24 @@ components: IncidentNotificationRuleIncludedItems: description: Objects related to a notification rule. oneOf: - - $ref: '#/components/schemas/User' - - $ref: '#/components/schemas/IncidentTypeObject' - - $ref: '#/components/schemas/IncidentNotificationTemplateObject' + - $ref: "#/components/schemas/User" + - $ref: "#/components/schemas/IncidentTypeObject" + - $ref: "#/components/schemas/IncidentNotificationTemplateObject" IncidentNotificationRuleRelationships: description: The notification rule's resource relationships. properties: created_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" incident_type: - $ref: '#/components/schemas/RelationshipToIncidentType' + $ref: "#/components/schemas/RelationshipToIncidentType" last_modified_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" notification_template: - $ref: '#/components/schemas/RelationshipToIncidentNotificationTemplate' + $ref: "#/components/schemas/RelationshipToIncidentNotificationTemplate" type: object IncidentNotificationRuleRenotifyOn: description: List of incident fields that trigger re-notification when changed. - example: - - status - - severity + example: ["status", "severity"] items: description: An incident field name. type: string @@ -31221,59 +29986,59 @@ components: description: Notification rule data from a response. properties: attributes: - $ref: '#/components/schemas/IncidentNotificationRuleAttributes' + $ref: "#/components/schemas/IncidentNotificationRuleAttributes" id: description: The unique identifier of the notification rule. - example: 00000000-0000-0000-0000-000000000001 + example: "00000000-0000-0000-0000-000000000001" format: uuid type: string relationships: - $ref: '#/components/schemas/IncidentNotificationRuleRelationships' + $ref: "#/components/schemas/IncidentNotificationRuleRelationships" type: - $ref: '#/components/schemas/IncidentNotificationRuleType' + $ref: "#/components/schemas/IncidentNotificationRuleType" required: - - id - - type + - id + - type type: object IncidentNotificationRuleType: description: Notification rules resource type. enum: - - incident_notification_rules + - incident_notification_rules example: incident_notification_rules type: string x-enum-varnames: - - INCIDENT_NOTIFICATION_RULES + - INCIDENT_NOTIFICATION_RULES IncidentNotificationRuleUpdateData: description: Notification rule data for an update request. properties: attributes: - $ref: '#/components/schemas/IncidentNotificationRuleCreateAttributes' + $ref: "#/components/schemas/IncidentNotificationRuleCreateAttributes" id: description: The unique identifier of the notification rule. - example: 00000000-0000-0000-0000-000000000001 + example: "00000000-0000-0000-0000-000000000001" format: uuid type: string relationships: - $ref: '#/components/schemas/IncidentNotificationRuleCreateDataRelationships' + $ref: "#/components/schemas/IncidentNotificationRuleCreateDataRelationships" type: - $ref: '#/components/schemas/IncidentNotificationRuleType' + $ref: "#/components/schemas/IncidentNotificationRuleType" required: - - id - - type - - attributes + - id + - type + - attributes type: object IncidentNotificationTemplate: description: Response with a notification template. properties: data: - $ref: '#/components/schemas/IncidentNotificationTemplateResponseData' + $ref: "#/components/schemas/IncidentNotificationTemplateResponseData" included: description: Related objects that are included in the response. items: - $ref: '#/components/schemas/IncidentNotificationTemplateIncludedItems' + $ref: "#/components/schemas/IncidentNotificationTemplateIncludedItems" type: array required: - - data + - data type: object IncidentNotificationTemplateArray: description: Response with notification templates. @@ -31281,23 +30046,23 @@ components: data: description: The `NotificationTemplateArray` `data`. items: - $ref: '#/components/schemas/IncidentNotificationTemplateResponseData' + $ref: "#/components/schemas/IncidentNotificationTemplateResponseData" type: array included: description: Related objects that are included in the response. items: - $ref: '#/components/schemas/IncidentNotificationTemplateIncludedItems' + $ref: "#/components/schemas/IncidentNotificationTemplateIncludedItems" type: array meta: - $ref: '#/components/schemas/IncidentNotificationTemplateArrayMeta' + $ref: "#/components/schemas/IncidentNotificationTemplateArrayMeta" required: - - data + - data type: object IncidentNotificationTemplateArrayMeta: description: Response metadata. properties: page: - $ref: '#/components/schemas/IncidentNotificationTemplateArrayMetaPage' + $ref: "#/components/schemas/IncidentNotificationTemplateArrayMetaPage" type: object IncidentNotificationTemplateArrayMetaPage: description: Pagination metadata. @@ -31318,278 +30083,239 @@ components: properties: category: description: The category of the notification template. - example: alert + example: "alert" type: string content: description: The content body of the notification template. - example: 'An incident has been declared. - - - Title: {{incident.title}} - - Severity: {{incident.severity}} - - Affected Services: {{incident.services}} - - Status: {{incident.state}} - - - Please join the incident channel for updates.' + example: "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates." type: string created: description: Timestamp when the notification template was created. - example: '2025-01-15T10:30:00Z' + example: "2025-01-15T10:30:00Z" format: date-time readOnly: true type: string modified: description: Timestamp when the notification template was last modified. - example: '2025-01-15T14:45:00Z' + example: "2025-01-15T14:45:00Z" format: date-time readOnly: true type: string name: description: The name of the notification template. - example: Incident Alert Template + example: "Incident Alert Template" type: string subject: description: The subject line of the notification template. - example: '{{incident.severity}} Incident: {{incident.title}}' + example: "{{incident.severity}} Incident: {{incident.title}}" type: string required: - - name - - subject - - content - - category - - created - - modified + - name + - subject + - content + - category + - created + - modified type: object IncidentNotificationTemplateCreateAttributes: description: The attributes for creating a notification template. properties: category: description: The category of the notification template. - example: alert + example: "alert" type: string content: description: The content body of the notification template. - example: 'An incident has been declared. - - - Title: {{incident.title}} - - Severity: {{incident.severity}} - - Affected Services: {{incident.services}} - - Status: {{incident.state}} - - - Please join the incident channel for updates.' + example: "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates." type: string name: description: The name of the notification template. - example: Incident Alert Template + example: "Incident Alert Template" type: string subject: description: The subject line of the notification template. - example: '{{incident.severity}} Incident: {{incident.title}}' + example: "{{incident.severity}} Incident: {{incident.title}}" type: string required: - - name - - subject - - content - - category + - name + - subject + - content + - category type: object IncidentNotificationTemplateCreateData: description: Notification template data for a create request. properties: attributes: - $ref: '#/components/schemas/IncidentNotificationTemplateCreateAttributes' + $ref: "#/components/schemas/IncidentNotificationTemplateCreateAttributes" relationships: - $ref: '#/components/schemas/IncidentNotificationTemplateCreateDataRelationships' + $ref: "#/components/schemas/IncidentNotificationTemplateCreateDataRelationships" type: - $ref: '#/components/schemas/IncidentNotificationTemplateType' + $ref: "#/components/schemas/IncidentNotificationTemplateType" required: - - type - - attributes + - type + - attributes type: object IncidentNotificationTemplateCreateDataRelationships: - description: The definition of `NotificationTemplateCreateDataRelationships` - object. + description: The definition of `NotificationTemplateCreateDataRelationships` object. properties: incident_type: - $ref: '#/components/schemas/RelationshipToIncidentType' + $ref: "#/components/schemas/RelationshipToIncidentType" type: object IncidentNotificationTemplateIncludedItems: description: Objects related to a notification template. oneOf: - - $ref: '#/components/schemas/User' - - $ref: '#/components/schemas/IncidentTypeObject' + - $ref: "#/components/schemas/User" + - $ref: "#/components/schemas/IncidentTypeObject" IncidentNotificationTemplateObject: description: A notification template object for inclusion in other resources. properties: attributes: - $ref: '#/components/schemas/IncidentNotificationTemplateAttributes' + $ref: "#/components/schemas/IncidentNotificationTemplateAttributes" id: description: The unique identifier of the notification template. - example: 00000000-0000-0000-0000-000000000001 + example: "00000000-0000-0000-0000-000000000001" format: uuid type: string relationships: - $ref: '#/components/schemas/IncidentNotificationTemplateRelationships' + $ref: "#/components/schemas/IncidentNotificationTemplateRelationships" type: - $ref: '#/components/schemas/IncidentNotificationTemplateType' + $ref: "#/components/schemas/IncidentNotificationTemplateType" required: - - id - - type + - id + - type type: object IncidentNotificationTemplateRelationships: description: The notification template's resource relationships. properties: created_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" incident_type: - $ref: '#/components/schemas/RelationshipToIncidentType' + $ref: "#/components/schemas/RelationshipToIncidentType" last_modified_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" type: object IncidentNotificationTemplateResponseData: description: Notification template data from a response. properties: attributes: - $ref: '#/components/schemas/IncidentNotificationTemplateAttributes' + $ref: "#/components/schemas/IncidentNotificationTemplateAttributes" id: description: The unique identifier of the notification template. - example: 00000000-0000-0000-0000-000000000001 + example: "00000000-0000-0000-0000-000000000001" format: uuid type: string relationships: - $ref: '#/components/schemas/IncidentNotificationTemplateRelationships' + $ref: "#/components/schemas/IncidentNotificationTemplateRelationships" type: - $ref: '#/components/schemas/IncidentNotificationTemplateType' + $ref: "#/components/schemas/IncidentNotificationTemplateType" required: - - id - - type + - id + - type type: object IncidentNotificationTemplateType: description: Notification templates resource type. enum: - - notification_templates + - notification_templates example: notification_templates type: string x-enum-varnames: - - NOTIFICATION_TEMPLATES + - NOTIFICATION_TEMPLATES IncidentNotificationTemplateUpdateAttributes: description: The attributes to update on a notification template. properties: category: description: The category of the notification template. - example: update + example: "update" type: string content: description: The content body of the notification template. - example: 'Incident Status Update: - - - Title: {{incident.title}} - - New Status: {{incident.state}} - - Severity: {{incident.severity}} - - Services: {{incident.services}} - - Commander: {{incident.commander}} - - - For more details, visit the incident page.' + example: "Incident Status Update:\n\nTitle: {{incident.title}}\nNew Status: {{incident.state}}\nSeverity: {{incident.severity}}\nServices: {{incident.services}}\nCommander: {{incident.commander}}\n\nFor more details, visit the incident page." type: string name: description: The name of the notification template. - example: Incident Status Update Template + example: "Incident Status Update Template" type: string subject: description: The subject line of the notification template. - example: 'Incident Update: {{incident.title}} - {{incident.state}}' + example: "Incident Update: {{incident.title}} - {{incident.state}}" type: string type: object IncidentNotificationTemplateUpdateData: description: Notification template data for an update request. properties: attributes: - $ref: '#/components/schemas/IncidentNotificationTemplateUpdateAttributes' + $ref: "#/components/schemas/IncidentNotificationTemplateUpdateAttributes" id: description: The unique identifier of the notification template. - example: 00000000-0000-0000-0000-000000000001 + example: "00000000-0000-0000-0000-000000000001" format: uuid type: string type: - $ref: '#/components/schemas/IncidentNotificationTemplateType' + $ref: "#/components/schemas/IncidentNotificationTemplateType" required: - - id - - type + - id + - type type: object IncidentPostmortemType: default: incident_postmortems description: Incident postmortem resource type. enum: - - incident_postmortems + - incident_postmortems example: incident_postmortems type: string x-enum-varnames: - - INCIDENT_POSTMORTEMS + - INCIDENT_POSTMORTEMS IncidentRelatedObject: description: Object related to an incident. enum: - - users - - attachments + - users + - attachments type: string x-enum-varnames: - - USERS - - ATTACHMENTS + - USERS + - ATTACHMENTS IncidentRelationshipData: description: Incident relationship data properties: id: description: Incident identifier - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string type: - $ref: '#/components/schemas/IncidentResourceType' + $ref: "#/components/schemas/IncidentResourceType" required: - - type - - id + - type + - id type: object IncidentResourceType: description: Incident resource type enum: - - incidents + - incidents example: incidents type: string x-enum-varnames: - - INCIDENTS + - INCIDENTS IncidentRespondersType: description: The incident responders type. enum: - - incident_responders + - incident_responders example: incident_responders type: string x-enum-varnames: - - INCIDENT_RESPONDERS + - INCIDENT_RESPONDERS IncidentResponse: description: Response with an incident. properties: data: - $ref: '#/components/schemas/IncidentResponseData' + $ref: "#/components/schemas/IncidentResponseData" included: description: Included related resources that the user requested. items: - $ref: '#/components/schemas/IncidentResponseIncludedItem' + $ref: "#/components/schemas/IncidentResponseIncludedItem" readOnly: true type: array required: - - data + - data type: object IncidentResponseAttributes: additionalProperties: {} @@ -31612,9 +30338,9 @@ components: readOnly: true type: string customer_impact_duration: - description: 'Length of the incident''s customer impact in seconds. - - Equals the difference between `customer_impact_start` and `customer_impact_end`.' + description: |- + Length of the incident's customer impact in seconds. + Equals the difference between `customer_impact_start` and `customer_impact_end`. format: int64 readOnly: true type: integer @@ -31625,7 +30351,7 @@ components: type: string customer_impact_scope: description: A summary of the impact customers experienced during the incident. - example: An example customer impact scope + example: "An example customer impact scope" nullable: true type: string customer_impact_start: @@ -31643,7 +30369,7 @@ components: readOnly: true type: string declared_by: - $ref: '#/components/schemas/IncidentNonDatadogCreator' + $ref: "#/components/schemas/IncidentNonDatadogCreator" declared_by_uuid: description: UUID of the user who declared the incident. nullable: true @@ -31655,16 +30381,13 @@ components: type: string fields: additionalProperties: - $ref: '#/components/schemas/IncidentFieldAttributes' + $ref: "#/components/schemas/IncidentFieldAttributes" description: A condensed view of the user-defined fields attached to incidents. - example: - severity: - type: dropdown - value: SEV-5 + example: {"severity": {"type": "dropdown", "value": "SEV-5"}} type: object incident_type_uuid: description: A unique identifier that represents an incident type. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string is_test: description: A flag indicating whether the incident is a test incident. @@ -31676,19 +30399,12 @@ components: readOnly: true type: string non_datadog_creator: - $ref: '#/components/schemas/IncidentNonDatadogCreator' + $ref: "#/components/schemas/IncidentNonDatadogCreator" notification_handles: - description: Notification handles that will be notified of the incident - during update. - example: - - display_name: Jane Doe - handle: '@user@email.com' - - display_name: Slack Channel - handle: '@slack-channel' - - display_name: Incident Workflow - handle: '@workflow-from-incident' - items: - $ref: '#/components/schemas/IncidentNotificationHandle' + description: Notification handles that will be notified of the incident during update. + example: [{"display_name": "Jane Doe", "handle": "@user@email.com"}, {"display_name": "Slack Channel", "handle": "@slack-channel"}, {"display_name": "Incident Workflow", "handle": "@workflow-from-incident"}] + items: + $ref: "#/components/schemas/IncidentNotificationHandle" nullable: true type: array public_id: @@ -31697,89 +30413,87 @@ components: format: int64 type: integer resolved: - description: Timestamp when the incident's state was last changed from active - or stable to resolved or completed. + description: |- + Timestamp when the incident's state was last changed from active or stable to resolved or completed. format: date-time nullable: true type: string severity: - $ref: '#/components/schemas/IncidentSeverity' + $ref: "#/components/schemas/IncidentSeverity" state: description: The state incident. nullable: true type: string time_to_detect: - description: 'The amount of time in seconds to detect the incident. - - Equals the difference between `customer_impact_start` and `detected`.' + description: |- + The amount of time in seconds to detect the incident. + Equals the difference between `customer_impact_start` and `detected`. format: int64 readOnly: true type: integer time_to_internal_response: - description: The amount of time in seconds to call incident after detection. - Equals the difference of `detected` and `created`. + description: >- + The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`. format: int64 readOnly: true type: integer time_to_repair: - description: The amount of time in seconds to resolve customer impact after - detecting the issue. Equals the difference between `customer_impact_end` - and `detected`. + description: >- + The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`. format: int64 readOnly: true type: integer time_to_resolve: - description: The amount of time in seconds to resolve the incident after - it was created. Equals the difference between `created` and `resolved`. + description: >- + The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`. format: int64 readOnly: true type: integer title: description: The title of the incident, which summarizes what happened. - example: A test incident title + example: "A test incident title" type: string visibility: description: The incident visibility status. nullable: true type: string required: - - title + - title type: object IncidentResponseData: description: Incident data from a response. properties: attributes: - $ref: '#/components/schemas/IncidentResponseAttributes' + $ref: "#/components/schemas/IncidentResponseAttributes" id: description: The incident's ID. - example: 00000000-0000-0000-1234-000000000000 + example: "00000000-0000-0000-1234-000000000000" type: string relationships: - $ref: '#/components/schemas/IncidentResponseRelationships' + $ref: "#/components/schemas/IncidentResponseRelationships" type: - $ref: '#/components/schemas/IncidentType' + $ref: "#/components/schemas/IncidentType" required: - - id - - type + - id + - type type: object IncidentResponseIncludedItem: description: An object related to an incident that is included in the response. oneOf: - - $ref: '#/components/schemas/IncidentUserData' - - $ref: '#/components/schemas/AttachmentData' + - $ref: "#/components/schemas/IncidentUserData" + - $ref: "#/components/schemas/AttachmentData" IncidentResponseMeta: description: The metadata object containing pagination metadata. properties: pagination: - $ref: '#/components/schemas/IncidentResponseMetaPagination' + $ref: "#/components/schemas/IncidentResponseMetaPagination" readOnly: true type: object IncidentResponseMetaPagination: description: Pagination properties. properties: next_offset: - description: The index of the first element in the next page of results. - Equal to page size added to the current offset. + description: The index of the first element in the next page of results. Equal to page size added to the current offset. example: 1000 format: int64 type: integer @@ -31798,49 +30512,49 @@ components: description: The incident's relationships from a response. properties: attachments: - $ref: '#/components/schemas/RelationshipToIncidentAttachment' + $ref: "#/components/schemas/RelationshipToIncidentAttachment" commander_user: - $ref: '#/components/schemas/NullableRelationshipToUser' + $ref: "#/components/schemas/NullableRelationshipToUser" created_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" declared_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" impacts: - $ref: '#/components/schemas/RelationshipToIncidentImpacts' + $ref: "#/components/schemas/RelationshipToIncidentImpacts" integrations: - $ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas' + $ref: "#/components/schemas/RelationshipToIncidentIntegrationMetadatas" last_modified_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" responders: - $ref: '#/components/schemas/RelationshipToIncidentResponders' + $ref: "#/components/schemas/RelationshipToIncidentResponders" user_defined_fields: - $ref: '#/components/schemas/RelationshipToIncidentUserDefinedFields' + $ref: "#/components/schemas/RelationshipToIncidentUserDefinedFields" type: object IncidentSearchResponse: description: Response with incidents and facets. properties: data: - $ref: '#/components/schemas/IncidentSearchResponseData' + $ref: "#/components/schemas/IncidentSearchResponseData" included: description: Included related resources that the user requested. items: - $ref: '#/components/schemas/IncidentResponseIncludedItem' + $ref: "#/components/schemas/IncidentResponseIncludedItem" readOnly: true type: array meta: - $ref: '#/components/schemas/IncidentSearchResponseMeta' + $ref: "#/components/schemas/IncidentSearchResponseMeta" required: - - data + - data type: object IncidentSearchResponseAttributes: description: Attributes returned by an incident search. properties: facets: - $ref: '#/components/schemas/IncidentSearchResponseFacetsData' + $ref: "#/components/schemas/IncidentSearchResponseFacetsData" incidents: description: Incidents returned by the search. items: - $ref: '#/components/schemas/IncidentSearchResponseIncidentsData' + $ref: "#/components/schemas/IncidentSearchResponseIncidentsData" type: array total: description: Number of incidents returned by the search. @@ -31849,17 +30563,17 @@ components: maximum: 2147483647 type: integer required: - - facets - - incidents - - total + - facets + - incidents + - total type: object IncidentSearchResponseData: description: Data returned by an incident search. properties: attributes: - $ref: '#/components/schemas/IncidentSearchResponseAttributes' + $ref: "#/components/schemas/IncidentSearchResponseAttributes" type: - $ref: '#/components/schemas/IncidentSearchResultsType' + $ref: "#/components/schemas/IncidentSearchResultsType" type: object IncidentSearchResponseFacetCount: description: Count of the facet value appearing in search results. @@ -31873,65 +30587,64 @@ components: commander: description: Facet data for incident commander users. items: - $ref: '#/components/schemas/IncidentSearchResponseUserFacetData' + $ref: "#/components/schemas/IncidentSearchResponseUserFacetData" type: array created_by: description: Facet data for incident creator users. items: - $ref: '#/components/schemas/IncidentSearchResponseUserFacetData' + $ref: "#/components/schemas/IncidentSearchResponseUserFacetData" type: array fields: description: Facet data for incident property fields. items: - $ref: '#/components/schemas/IncidentSearchResponsePropertyFieldFacetData' + $ref: "#/components/schemas/IncidentSearchResponsePropertyFieldFacetData" type: array impact: description: Facet data for incident impact attributes. items: - $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData' + $ref: "#/components/schemas/IncidentSearchResponseFieldFacetData" type: array last_modified_by: description: Facet data for incident last modified by users. items: - $ref: '#/components/schemas/IncidentSearchResponseUserFacetData' + $ref: "#/components/schemas/IncidentSearchResponseUserFacetData" type: array postmortem: description: Facet data for incident postmortem existence. items: - $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData' + $ref: "#/components/schemas/IncidentSearchResponseFieldFacetData" type: array responder: description: Facet data for incident responder users. items: - $ref: '#/components/schemas/IncidentSearchResponseUserFacetData' + $ref: "#/components/schemas/IncidentSearchResponseUserFacetData" type: array severity: description: Facet data for incident severity attributes. items: - $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData' + $ref: "#/components/schemas/IncidentSearchResponseFieldFacetData" type: array state: description: Facet data for incident state attributes. items: - $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData' + $ref: "#/components/schemas/IncidentSearchResponseFieldFacetData" type: array time_to_repair: description: Facet data for incident time to repair metrics. items: - $ref: '#/components/schemas/IncidentSearchResponseNumericFacetData' + $ref: "#/components/schemas/IncidentSearchResponseNumericFacetData" type: array time_to_resolve: description: Facet data for incident time to resolve metrics. items: - $ref: '#/components/schemas/IncidentSearchResponseNumericFacetData' + $ref: "#/components/schemas/IncidentSearchResponseNumericFacetData" type: array type: object IncidentSearchResponseFieldFacetData: - description: Facet value and number of occurrences for a property field of an - incident. + description: Facet value and number of occurrences for a property field of an incident. properties: count: - $ref: '#/components/schemas/IncidentSearchResponseFacetCount' + $ref: "#/components/schemas/IncidentSearchResponseFacetCount" name: description: The facet value appearing in search results. example: SEV-2 @@ -31941,29 +30654,29 @@ components: description: Incident returned by the search. properties: data: - $ref: '#/components/schemas/IncidentResponseData' + $ref: "#/components/schemas/IncidentResponseData" required: - - data + - data type: object IncidentSearchResponseMeta: description: The metadata object containing pagination metadata. properties: pagination: - $ref: '#/components/schemas/IncidentResponseMetaPagination' + $ref: "#/components/schemas/IncidentResponseMetaPagination" readOnly: true type: object IncidentSearchResponseNumericFacetData: description: Facet data numeric attributes of an incident. properties: aggregates: - $ref: '#/components/schemas/IncidentSearchResponseNumericFacetDataAggregates' + $ref: "#/components/schemas/IncidentSearchResponseNumericFacetDataAggregates" name: description: Name of the incident property field. example: time_to_repair type: string required: - - name - - aggregates + - name + - aggregates type: object IncidentSearchResponseNumericFacetDataAggregates: description: Aggregate information for numeric incident data. @@ -31985,32 +30698,32 @@ components: description: Facet data for the incident property fields. properties: aggregates: - $ref: '#/components/schemas/IncidentSearchResponseNumericFacetDataAggregates' + $ref: "#/components/schemas/IncidentSearchResponseNumericFacetDataAggregates" facets: description: Facet data for the property field of an incident. items: - $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData' + $ref: "#/components/schemas/IncidentSearchResponseFieldFacetData" type: array name: description: Name of the incident property field. example: Severity type: string required: - - facets - - name + - facets + - name type: object IncidentSearchResponseUserFacetData: description: Facet data for user attributes of an incident. properties: count: - $ref: '#/components/schemas/IncidentSearchResponseFacetCount' + $ref: "#/components/schemas/IncidentSearchResponseFacetCount" email: description: Email of the user. example: datadog.user@example.com type: string handle: description: Handle of the user. - example: '@datadog.user@example.com' + example: "@datadog.user@example.com" type: string name: description: Name of the user. @@ -32025,77 +30738,76 @@ components: default: incidents_search_results description: Incident search result type. enum: - - incidents_search_results + - incidents_search_results example: incidents_search_results type: string x-enum-varnames: - - INCIDENTS_SEARCH_RESULTS + - INCIDENTS_SEARCH_RESULTS IncidentSearchSortOrder: description: The ways searched incidents can be sorted. enum: - - created - - -created + - created + - -created type: string x-enum-varnames: - - CREATED_ASCENDING - - CREATED_DESCENDING + - CREATED_ASCENDING + - CREATED_DESCENDING IncidentServiceCreateAttributes: description: The incident service's attributes for a create request. properties: name: description: Name of the incident service. - example: an example service name + example: "an example service name" type: string required: - - name + - name type: object IncidentServiceCreateData: description: Incident Service payload for create requests. properties: attributes: - $ref: '#/components/schemas/IncidentServiceCreateAttributes' + $ref: "#/components/schemas/IncidentServiceCreateAttributes" relationships: - $ref: '#/components/schemas/IncidentServiceRelationships' + $ref: "#/components/schemas/IncidentServiceRelationships" type: - $ref: '#/components/schemas/IncidentServiceType' + $ref: "#/components/schemas/IncidentServiceType" required: - - type + - type type: object IncidentServiceCreateRequest: description: Create request with an incident service payload. properties: data: - $ref: '#/components/schemas/IncidentServiceCreateData' + $ref: "#/components/schemas/IncidentServiceCreateData" required: - - data + - data type: object IncidentServiceIncludedItems: - description: An object related to an incident service which is present in the - included payload. + description: An object related to an incident service which is present in the included payload. oneOf: - - $ref: '#/components/schemas/User' + - $ref: "#/components/schemas/User" IncidentServiceRelationships: description: The incident service's relationships. properties: created_by: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" last_modified_by: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" readOnly: true type: object IncidentServiceResponse: description: Response with an incident service payload. properties: data: - $ref: '#/components/schemas/IncidentServiceResponseData' + $ref: "#/components/schemas/IncidentServiceResponseData" included: description: Included objects from relationships. items: - $ref: '#/components/schemas/IncidentServiceIncludedItems' + $ref: "#/components/schemas/IncidentServiceIncludedItems" readOnly: true type: array required: - - data + - data type: object IncidentServiceResponseAttributes: description: The incident service's attributes from a response. @@ -32112,168 +30824,165 @@ components: type: string name: description: Name of the incident service. - example: service name + example: "service name" type: string type: object IncidentServiceResponseData: description: Incident Service data from responses. properties: attributes: - $ref: '#/components/schemas/IncidentServiceResponseAttributes' + $ref: "#/components/schemas/IncidentServiceResponseAttributes" id: description: The incident service's ID. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string relationships: - $ref: '#/components/schemas/IncidentServiceRelationships' + $ref: "#/components/schemas/IncidentServiceRelationships" type: - $ref: '#/components/schemas/IncidentServiceType' + $ref: "#/components/schemas/IncidentServiceType" required: - - id - - type + - id + - type type: object IncidentServiceType: default: services description: Incident service resource type. enum: - - services + - services example: services type: string x-enum-varnames: - - SERVICES + - SERVICES IncidentServiceUpdateAttributes: description: The incident service's attributes for an update request. properties: name: description: Name of the incident service. - example: an example service name + example: "an example service name" type: string required: - - name + - name type: object IncidentServiceUpdateData: description: Incident Service payload for update requests. properties: attributes: - $ref: '#/components/schemas/IncidentServiceUpdateAttributes' + $ref: "#/components/schemas/IncidentServiceUpdateAttributes" id: description: The incident service's ID. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string relationships: - $ref: '#/components/schemas/IncidentServiceRelationships' + $ref: "#/components/schemas/IncidentServiceRelationships" type: - $ref: '#/components/schemas/IncidentServiceType' + $ref: "#/components/schemas/IncidentServiceType" required: - - type + - type type: object IncidentServiceUpdateRequest: description: Update request with an incident service payload. properties: data: - $ref: '#/components/schemas/IncidentServiceUpdateData' + $ref: "#/components/schemas/IncidentServiceUpdateData" required: - - data + - data type: object IncidentServicesResponse: description: Response with a list of incident service payloads. properties: data: description: An array of incident services. - example: - - id: 00000000-0000-0000-0000-000000000000 - type: services + example: [{"id": "00000000-0000-0000-0000-000000000000", "type": "services"}] items: - $ref: '#/components/schemas/IncidentServiceResponseData' + $ref: "#/components/schemas/IncidentServiceResponseData" type: array included: description: Included related resources which the user requested. items: - $ref: '#/components/schemas/IncidentServiceIncludedItems' + $ref: "#/components/schemas/IncidentServiceIncludedItems" readOnly: true type: array meta: - $ref: '#/components/schemas/IncidentResponseMeta' + $ref: "#/components/schemas/IncidentResponseMeta" required: - - data - type: object + - data + type: "object" IncidentSeverity: description: The incident severity. enum: - - UNKNOWN - - SEV-0 - - SEV-1 - - SEV-2 - - SEV-3 - - SEV-4 - - SEV-5 + - UNKNOWN + - SEV-0 + - SEV-1 + - SEV-2 + - SEV-3 + - SEV-4 + - SEV-5 example: UNKNOWN type: string x-enum-varnames: - - UNKNOWN - - SEV_0 - - SEV_1 - - SEV_2 - - SEV_3 - - SEV_4 - - SEV_5 + - UNKNOWN + - SEV_0 + - SEV_1 + - SEV_2 + - SEV_3 + - SEV_4 + - SEV_5 IncidentTeamCreateAttributes: description: The incident team's attributes for a create request. properties: name: description: Name of the incident team. - example: team name + example: "team name" type: string required: - - name + - name type: object IncidentTeamCreateData: description: Incident Team data for a create request. properties: attributes: - $ref: '#/components/schemas/IncidentTeamCreateAttributes' + $ref: "#/components/schemas/IncidentTeamCreateAttributes" relationships: - $ref: '#/components/schemas/IncidentTeamRelationships' + $ref: "#/components/schemas/IncidentTeamRelationships" type: - $ref: '#/components/schemas/IncidentTeamType' + $ref: "#/components/schemas/IncidentTeamType" required: - - type + - type type: object IncidentTeamCreateRequest: description: Create request with an incident team payload. properties: data: - $ref: '#/components/schemas/IncidentTeamCreateData' + $ref: "#/components/schemas/IncidentTeamCreateData" required: - - data + - data type: object IncidentTeamIncludedItems: - description: An object related to an incident team which is present in the included - payload. + description: An object related to an incident team which is present in the included payload. oneOf: - - $ref: '#/components/schemas/User' + - $ref: "#/components/schemas/User" IncidentTeamRelationships: description: The incident team's relationships. properties: created_by: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" last_modified_by: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" readOnly: true type: object IncidentTeamResponse: description: Response with an incident team payload. properties: data: - $ref: '#/components/schemas/IncidentTeamResponseData' + $ref: "#/components/schemas/IncidentTeamResponseData" included: description: Included objects from relationships. items: - $ref: '#/components/schemas/IncidentTeamIncludedItems' + $ref: "#/components/schemas/IncidentTeamIncludedItems" readOnly: true type: array required: - - data + - data type: object IncidentTeamResponseAttributes: description: The incident team's attributes from a response. @@ -32290,126 +30999,121 @@ components: type: string name: description: Name of the incident team. - example: team name + example: "team name" type: string type: object IncidentTeamResponseData: description: Incident Team data from a response. properties: attributes: - $ref: '#/components/schemas/IncidentTeamResponseAttributes' + $ref: "#/components/schemas/IncidentTeamResponseAttributes" id: description: The incident team's ID. - example: 00000000-7ea3-0000-000a-000000000000 + example: "00000000-7ea3-0000-000a-000000000000" type: string relationships: - $ref: '#/components/schemas/IncidentTeamRelationships' + $ref: "#/components/schemas/IncidentTeamRelationships" type: - $ref: '#/components/schemas/IncidentTeamType' + $ref: "#/components/schemas/IncidentTeamType" type: object IncidentTeamType: default: teams description: Incident Team resource type. enum: - - teams + - teams example: teams type: string x-enum-varnames: - - TEAMS + - TEAMS IncidentTeamUpdateAttributes: description: The incident team's attributes for an update request. properties: name: description: Name of the incident team. - example: team name + example: "team name" type: string required: - - name + - name type: object IncidentTeamUpdateData: description: Incident Team data for an update request. properties: attributes: - $ref: '#/components/schemas/IncidentTeamUpdateAttributes' + $ref: "#/components/schemas/IncidentTeamUpdateAttributes" id: description: The incident team's ID. - example: 00000000-7ea3-0000-0001-000000000000 + example: "00000000-7ea3-0000-0001-000000000000" type: string relationships: - $ref: '#/components/schemas/IncidentTeamRelationships' + $ref: "#/components/schemas/IncidentTeamRelationships" type: - $ref: '#/components/schemas/IncidentTeamType' + $ref: "#/components/schemas/IncidentTeamType" required: - - type + - type type: object IncidentTeamUpdateRequest: description: Update request with an incident team payload. properties: data: - $ref: '#/components/schemas/IncidentTeamUpdateData' + $ref: "#/components/schemas/IncidentTeamUpdateData" required: - - data + - data type: object IncidentTeamsResponse: description: Response with a list of incident team payloads. properties: data: description: An array of incident teams. - example: - - attributes: - name: team name - id: 00000000-7ea3-0000-0000-000000000000 - type: teams + example: [{"attributes": {"name": "team name"}, "id": "00000000-7ea3-0000-0000-000000000000", "type": "teams"}] items: - $ref: '#/components/schemas/IncidentTeamResponseData' + $ref: "#/components/schemas/IncidentTeamResponseData" type: array included: description: Included related resources which the user requested. items: - $ref: '#/components/schemas/IncidentTeamIncludedItems' + $ref: "#/components/schemas/IncidentTeamIncludedItems" readOnly: true type: array meta: - $ref: '#/components/schemas/IncidentResponseMeta' + $ref: "#/components/schemas/IncidentResponseMeta" required: - - data - type: object + - data + type: "object" IncidentTimelineCellCreateAttributes: description: The timeline cell's attributes for a create request. oneOf: - - $ref: '#/components/schemas/IncidentTimelineCellMarkdownCreateAttributes' + - $ref: "#/components/schemas/IncidentTimelineCellMarkdownCreateAttributes" IncidentTimelineCellMarkdownContentType: default: markdown description: Type of the Markdown timeline cell. enum: - - markdown + - markdown example: markdown type: string x-enum-varnames: - - MARKDOWN + - MARKDOWN IncidentTimelineCellMarkdownCreateAttributes: description: Timeline cell data for Markdown timeline cells for a create request. properties: cell_type: - $ref: '#/components/schemas/IncidentTimelineCellMarkdownContentType' + $ref: "#/components/schemas/IncidentTimelineCellMarkdownContentType" content: - $ref: '#/components/schemas/IncidentTimelineCellMarkdownCreateAttributesContent' + $ref: "#/components/schemas/IncidentTimelineCellMarkdownCreateAttributesContent" important: default: false - description: A flag indicating whether the timeline cell is important and - should be highlighted. + description: A flag indicating whether the timeline cell is important and should be highlighted. example: false type: boolean required: - - content - - cell_type + - content + - cell_type type: object IncidentTimelineCellMarkdownCreateAttributesContent: description: The Markdown timeline cell contents. properties: content: description: The Markdown content of the cell. - example: An example timeline cell message. + example: "An example timeline cell message." nullable: false type: string type: object @@ -32429,49 +31133,49 @@ components: example: Slackbot type: string source: - $ref: '#/components/schemas/IncidentTodoAnonymousAssigneeSource' + $ref: "#/components/schemas/IncidentTodoAnonymousAssigneeSource" required: - - id - - icon - - name - - source + - id + - icon + - name + - source type: object IncidentTodoAnonymousAssigneeSource: default: slack description: The source of the anonymous assignee. enum: - - slack - - microsoft_teams + - slack + - microsoft_teams example: slack type: string x-enum-varnames: - - SLACK - - MICROSOFT_TEAMS + - SLACK + - MICROSOFT_TEAMS IncidentTodoAssignee: description: A todo assignee. - example: '@test.user@test.com' + example: "@test.user@test.com" oneOf: - - $ref: '#/components/schemas/IncidentTodoAssigneeHandle' - - $ref: '#/components/schemas/IncidentTodoAnonymousAssignee' + - $ref: "#/components/schemas/IncidentTodoAssigneeHandle" + - $ref: "#/components/schemas/IncidentTodoAnonymousAssignee" IncidentTodoAssigneeArray: description: Array of todo assignees. example: - - '@test.user@test.com' + - "@test.user@test.com" items: - $ref: '#/components/schemas/IncidentTodoAssignee' + $ref: "#/components/schemas/IncidentTodoAssignee" type: array IncidentTodoAssigneeHandle: description: Assignee's @-handle. - example: '@test.user@test.com' + example: "@test.user@test.com" type: string IncidentTodoAttributes: description: Incident todo's attributes. properties: assignees: - $ref: '#/components/schemas/IncidentTodoAssigneeArray' + $ref: "#/components/schemas/IncidentTodoAssigneeArray" completed: description: Timestamp when the todo was completed. - example: '2023-03-06T22:00:00.000000+00:00' + example: "2023-03-06T22:00:00.000000+00:00" nullable: true type: string content: @@ -32485,12 +31189,12 @@ components: type: string due_date: description: Timestamp when the todo should be completed by. - example: '2023-07-10T05:00:00.000000+00:00' + example: "2023-07-10T05:00:00.000000+00:00" nullable: true type: string incident_id: description: UUID of the incident this todo is connected to. - example: 00000000-aaaa-0000-0000-000000000000 + example: "00000000-aaaa-0000-0000-000000000000" type: string modified: description: Timestamp when the incident todo was last modified. @@ -32498,27 +31202,27 @@ components: readOnly: true type: string required: - - content - - assignees + - content + - assignees type: object IncidentTodoCreateData: description: Incident todo data for a create request. properties: attributes: - $ref: '#/components/schemas/IncidentTodoAttributes' + $ref: "#/components/schemas/IncidentTodoAttributes" type: - $ref: '#/components/schemas/IncidentTodoType' + $ref: "#/components/schemas/IncidentTodoType" required: - - type - - attributes + - type + - attributes type: object IncidentTodoCreateRequest: description: Create request for an incident todo. properties: data: - $ref: '#/components/schemas/IncidentTodoCreateData' + $ref: "#/components/schemas/IncidentTodoCreateData" required: - - data + - data type: object IncidentTodoListResponse: description: Response with a list of incident todos. @@ -32526,116 +31230,115 @@ components: data: description: An array of incident todos. items: - $ref: '#/components/schemas/IncidentTodoResponseData' + $ref: "#/components/schemas/IncidentTodoResponseData" type: array included: description: Included related resources that the user requested. items: - $ref: '#/components/schemas/IncidentTodoResponseIncludedItem' + $ref: "#/components/schemas/IncidentTodoResponseIncludedItem" readOnly: true type: array meta: - $ref: '#/components/schemas/IncidentResponseMeta' + $ref: "#/components/schemas/IncidentResponseMeta" required: - - data + - data type: object IncidentTodoPatchData: description: Incident todo data for a patch request. properties: attributes: - $ref: '#/components/schemas/IncidentTodoAttributes' + $ref: "#/components/schemas/IncidentTodoAttributes" type: - $ref: '#/components/schemas/IncidentTodoType' + $ref: "#/components/schemas/IncidentTodoType" required: - - type - - attributes + - type + - attributes type: object IncidentTodoPatchRequest: description: Patch request for an incident todo. properties: data: - $ref: '#/components/schemas/IncidentTodoPatchData' + $ref: "#/components/schemas/IncidentTodoPatchData" required: - - data + - data type: object IncidentTodoRelationships: description: The incident's relationships from a response. properties: created_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" last_modified_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" type: object IncidentTodoResponse: description: Response with an incident todo. properties: data: - $ref: '#/components/schemas/IncidentTodoResponseData' + $ref: "#/components/schemas/IncidentTodoResponseData" included: description: Included related resources that the user requested. items: - $ref: '#/components/schemas/IncidentTodoResponseIncludedItem' + $ref: "#/components/schemas/IncidentTodoResponseIncludedItem" readOnly: true type: array required: - - data + - data type: object IncidentTodoResponseData: description: Incident todo response data. properties: attributes: - $ref: '#/components/schemas/IncidentTodoAttributes' + $ref: "#/components/schemas/IncidentTodoAttributes" id: description: The incident todo's ID. - example: 00000000-0000-0000-1234-000000000000 + example: "00000000-0000-0000-1234-000000000000" type: string relationships: - $ref: '#/components/schemas/IncidentTodoRelationships' + $ref: "#/components/schemas/IncidentTodoRelationships" type: - $ref: '#/components/schemas/IncidentTodoType' + $ref: "#/components/schemas/IncidentTodoType" required: - - id - - type + - id + - type type: object IncidentTodoResponseIncludedItem: description: An object related to an incident todo that is included in the response. oneOf: - - $ref: '#/components/schemas/User' + - $ref: "#/components/schemas/User" IncidentTodoType: default: incident_todos description: Todo resource type. enum: - - incident_todos + - incident_todos example: incident_todos type: string x-enum-varnames: - - INCIDENT_TODOS + - INCIDENT_TODOS IncidentTrigger: - description: Trigger a workflow from an Incident. For automatic triggering a - handle must be configured and the workflow must be published. + description: "Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published." properties: rateLimit: - $ref: '#/components/schemas/TriggerRateLimit' + $ref: "#/components/schemas/TriggerRateLimit" type: object IncidentTriggerWrapper: - description: Schema for an Incident-based trigger. + description: "Schema for an Incident-based trigger." properties: incidentTrigger: - $ref: '#/components/schemas/IncidentTrigger' + $ref: "#/components/schemas/IncidentTrigger" startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - incidentTrigger + - incidentTrigger type: object IncidentType: default: incidents description: Incident resource type. enum: - - incidents + - incidents example: incidents type: string x-enum-varnames: - - INCIDENTS + - INCIDENTS IncidentTypeAttributes: description: Incident type's attributes. properties: @@ -32645,26 +31348,22 @@ components: readOnly: true type: string createdBy: - description: A unique identifier that represents the user that created the - incident type. - example: 00000000-0000-0000-0000-000000000000 + description: A unique identifier that represents the user that created the incident type. + example: "00000000-0000-0000-0000-000000000000" readOnly: true type: string description: description: Text that describes the incident type. - example: Any incidents that harm (or have the potential to) the confidentiality, - integrity, or availability of our data. + example: "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data." type: string is_default: default: false - description: If true, this incident type will be used as the default incident - type if a type is not specified during the creation of incident resources. + description: If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources. example: false type: boolean lastModifiedBy: - description: A unique identifier that represents the user that last modified - the incident type. - example: 00000000-0000-0000-0000-000000000000 + description: A unique identifier that represents the user that last modified the incident type. + example: "00000000-0000-0000-0000-000000000000" readOnly: true type: string modifiedAt: @@ -32674,35 +31373,34 @@ components: type: string name: description: The name of the incident type. - example: Security Incident + example: "Security Incident" type: string prefix: - description: The string that will be prepended to the incident title across - the Datadog app. - example: IR + description: The string that will be prepended to the incident title across the Datadog app. + example: "IR" readOnly: true type: string required: - - name + - name type: object IncidentTypeCreateData: description: Incident type data for a create request. properties: attributes: - $ref: '#/components/schemas/IncidentTypeAttributes' + $ref: "#/components/schemas/IncidentTypeAttributes" type: - $ref: '#/components/schemas/IncidentTypeType' + $ref: "#/components/schemas/IncidentTypeType" required: - - type - - attributes + - type + - attributes type: object IncidentTypeCreateRequest: description: Create request for an incident type. properties: data: - $ref: '#/components/schemas/IncidentTypeCreateData' + $ref: "#/components/schemas/IncidentTypeCreateData" required: - - data + - data type: object IncidentTypeListResponse: description: Response with a list of incident types. @@ -32710,84 +31408,84 @@ components: data: description: An array of incident type objects. items: - $ref: '#/components/schemas/IncidentTypeObject' + $ref: "#/components/schemas/IncidentTypeObject" type: array required: - - data + - data type: object IncidentTypeObject: description: Incident type response data. properties: attributes: - $ref: '#/components/schemas/IncidentTypeAttributes' + $ref: "#/components/schemas/IncidentTypeAttributes" id: description: The incident type's ID. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string relationships: - $ref: '#/components/schemas/IncidentTypeRelationships' + $ref: "#/components/schemas/IncidentTypeRelationships" type: - $ref: '#/components/schemas/IncidentTypeType' + $ref: "#/components/schemas/IncidentTypeType" required: - - id - - type + - id + - type type: object IncidentTypePatchData: description: Incident type data for a patch request. properties: attributes: - $ref: '#/components/schemas/IncidentTypeUpdateAttributes' + $ref: "#/components/schemas/IncidentTypeUpdateAttributes" id: description: The incident type's ID. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string type: - $ref: '#/components/schemas/IncidentTypeType' + $ref: "#/components/schemas/IncidentTypeType" required: - - id - - type - - attributes + - id + - type + - attributes type: object IncidentTypePatchRequest: description: Patch request for an incident type. properties: data: - $ref: '#/components/schemas/IncidentTypePatchData' + $ref: "#/components/schemas/IncidentTypePatchData" required: - - data + - data type: object IncidentTypeRelationships: additionalProperties: {} description: The incident type's resource relationships. properties: created_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" google_meet_configuration: - $ref: '#/components/schemas/GoogleMeetConfigurationReference' + $ref: "#/components/schemas/GoogleMeetConfigurationReference" last_modified_by_user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" microsoft_teams_configuration: - $ref: '#/components/schemas/MicrosoftTeamsConfigurationReference' + $ref: "#/components/schemas/MicrosoftTeamsConfigurationReference" zoom_configuration: - $ref: '#/components/schemas/ZoomConfigurationReference' + $ref: "#/components/schemas/ZoomConfigurationReference" type: object IncidentTypeResponse: description: Incident type response data. properties: data: - $ref: '#/components/schemas/IncidentTypeObject' + $ref: "#/components/schemas/IncidentTypeObject" required: - - data + - data type: object IncidentTypeType: default: incident_types description: Incident type resource type. enum: - - incident_types + - incident_types example: incident_types type: string x-enum-varnames: - - INCIDENT_TYPES + - INCIDENT_TYPES IncidentTypeUpdateAttributes: description: Incident type's attributes for updates. properties: @@ -32797,26 +31495,21 @@ components: readOnly: true type: string createdBy: - description: A unique identifier that represents the user that created the - incident type. - example: 00000000-0000-0000-0000-000000000000 + description: A unique identifier that represents the user that created the incident type. + example: "00000000-0000-0000-0000-000000000000" readOnly: true type: string description: description: Text that describes the incident type. - example: 'Any incidents that harm (or have the potential to) the confidentiality, - integrity, or availability of our data. Note: This will notify the security - team.' + example: "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team." type: string is_default: - description: When true, this incident type will be used as the default type - when an incident type is not specified. + description: When true, this incident type will be used as the default type when an incident type is not specified. example: false type: boolean lastModifiedBy: - description: A unique identifier that represents the user that last modified - the incident type. - example: 00000000-0000-0000-0000-000000000000 + description: A unique identifier that represents the user that last modified the incident type. + example: "00000000-0000-0000-0000-000000000000" readOnly: true type: string modifiedAt: @@ -32826,12 +31519,11 @@ components: type: string name: description: The name of the incident type. - example: Security Incident + example: "Security Incident" type: string prefix: - description: The string that will be prepended to the incident title across - the Datadog app. - example: IR + description: The string that will be prepended to the incident title across the Datadog app. + example: "IR" readOnly: true type: string type: object @@ -32845,7 +31537,7 @@ components: type: string customer_impact_scope: description: A summary of the impact customers experienced during the incident. - example: Example customer impact scope + example: "Example customer impact scope" type: string customer_impact_start: description: Timestamp when customers began being impacted by the incident. @@ -32863,66 +31555,55 @@ components: type: string fields: additionalProperties: - $ref: '#/components/schemas/IncidentFieldAttributes' - description: A condensed view of the user-defined fields for which to update - selections. - example: - severity: - type: dropdown - value: SEV-5 + $ref: "#/components/schemas/IncidentFieldAttributes" + description: A condensed view of the user-defined fields for which to update selections. + example: {"severity": {"type": "dropdown", "value": "SEV-5"}} type: object notification_handles: - description: Notification handles that will be notified of the incident - during update. - example: - - display_name: Jane Doe - handle: '@user@email.com' - - display_name: Slack Channel - handle: '@slack-channel' - - display_name: Incident Workflow - handle: '@workflow-from-incident' + description: Notification handles that will be notified of the incident during update. + example: [{"display_name": "Jane Doe", "handle": "@user@email.com"}, {"display_name": "Slack Channel", "handle": "@slack-channel"}, {"display_name": "Incident Workflow", "handle": "@workflow-from-incident"}] items: - $ref: '#/components/schemas/IncidentNotificationHandle' + $ref: "#/components/schemas/IncidentNotificationHandle" type: array title: description: The title of the incident, which summarizes what happened. - example: A test incident title + example: "A test incident title" type: string type: object IncidentUpdateData: description: Incident data for an update request. properties: attributes: - $ref: '#/components/schemas/IncidentUpdateAttributes' + $ref: "#/components/schemas/IncidentUpdateAttributes" id: description: The incident's ID. - example: 00000000-0000-0000-4567-000000000000 + example: "00000000-0000-0000-4567-000000000000" type: string relationships: - $ref: '#/components/schemas/IncidentUpdateRelationships' + $ref: "#/components/schemas/IncidentUpdateRelationships" type: - $ref: '#/components/schemas/IncidentType' + $ref: "#/components/schemas/IncidentType" required: - - id - - type + - id + - type type: object IncidentUpdateRelationships: description: The incident's relationships for an update request. properties: commander_user: - $ref: '#/components/schemas/NullableRelationshipToUser' + $ref: "#/components/schemas/NullableRelationshipToUser" integrations: - $ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas' + $ref: "#/components/schemas/RelationshipToIncidentIntegrationMetadatas" postmortem: - $ref: '#/components/schemas/RelationshipToIncidentPostmortem' + $ref: "#/components/schemas/RelationshipToIncidentPostmortem" type: object IncidentUpdateRequest: description: Update request for an incident. properties: data: - $ref: '#/components/schemas/IncidentUpdateData' + $ref: "#/components/schemas/IncidentUpdateData" required: - - data + - data type: object IncidentUserAttributes: description: Attributes of user object returned by the API. @@ -32948,154 +31629,65 @@ components: description: User object returned by the API. properties: attributes: - $ref: '#/components/schemas/IncidentUserAttributes' + $ref: "#/components/schemas/IncidentUserAttributes" id: description: ID of the user. type: string type: - $ref: '#/components/schemas/UsersType' + $ref: "#/components/schemas/UsersType" type: object IncidentUserDefinedFieldType: description: The incident user defined fields type. enum: - - user_defined_field + - user_defined_field example: user_defined_field type: string x-enum-varnames: - - USER_DEFINED_FIELD + - USER_DEFINED_FIELD IncidentsResponse: description: Response with a list of incidents. properties: data: description: An array of incidents. - example: - - attributes: - created: '2020-04-21T15:34:08.627205+00:00' - creation_idempotency_key: null - customer_impact_duration: 0 - customer_impact_end: null - customer_impact_scope: null - customer_impact_start: null - customer_impacted: false - detected: '2020-04-14T00:00:00+00:00' - incident_type_uuid: 00000000-0000-0000-0000-000000000001 - modified: '2020-09-17T14:16:58.696424+00:00' - public_id: 1 - resolved: null - severity: SEV-1 - time_to_detect: 0 - time_to_internal_response: 0 - time_to_repair: 0 - time_to_resolve: 0 - title: Example Incident - id: 00000000-aaaa-0000-0000-000000000000 - relationships: - attachments: - data: - - id: 00000000-9999-0000-0000-000000000000 - type: incident_attachments - - id: 00000000-1234-0000-0000-000000000000 - type: incident_attachments - commander_user: - data: - id: 00000000-0000-0000-cccc-000000000000 - type: users - created_by_user: - data: - id: 00000000-0000-0000-cccc-000000000000 - type: users - integrations: - data: - - id: 00000000-0000-0000-4444-000000000000 - type: incident_integrations - - id: 00000000-0000-0000-5555-000000000000 - type: incident_integrations - last_modified_by_user: - data: - id: 00000000-0000-0000-cccc-000000000000 - type: users - type: incidents - - attributes: - created: '2020-04-21T15:34:08.627205+00:00' - creation_idempotency_key: null - customer_impact_duration: 0 - customer_impact_end: null - customer_impact_scope: null - customer_impact_start: null - customer_impacted: false - detected: '2020-04-14T00:00:00+00:00' - incident_type_uuid: 00000000-0000-0000-0000-000000000002 - modified: '2020-09-17T14:16:58.696424+00:00' - public_id: 2 - resolved: null - severity: SEV-5 - time_to_detect: 0 - time_to_internal_response: 0 - time_to_repair: 0 - time_to_resolve: 0 - title: Example Incident 2 - id: 00000000-1111-0000-0000-000000000000 - relationships: - attachments: - data: - - id: 00000000-9999-0000-0000-000000000000 - type: incident_attachments - commander_user: - data: - id: 00000000-aaaa-0000-0000-000000000000 - type: users - created_by_user: - data: - id: 00000000-aaaa-0000-0000-000000000000 - type: users - integrations: - data: - - id: 00000000-0000-0000-0001-000000000000 - type: incident_integrations - - id: 00000000-0000-0000-0002-000000000000 - type: incident_integrations - last_modified_by_user: - data: - id: 00000000-aaaa-0000-0000-000000000000 - type: users - type: incidents + example: [{"attributes": {"created": "2020-04-21T15:34:08.627205+00:00", "creation_idempotency_key": null, "customer_impact_duration": 0, "customer_impact_end": null, "customer_impact_scope": null, "customer_impact_start": null, "customer_impacted": false, "detected": "2020-04-14T00:00:00+00:00", "incident_type_uuid": "00000000-0000-0000-0000-000000000001", "modified": "2020-09-17T14:16:58.696424+00:00", "public_id": 1, "resolved": null, "severity": "SEV-1", "time_to_detect": 0, "time_to_internal_response": 0, "time_to_repair": 0, "time_to_resolve": 0, "title": "Example Incident"}, "id": "00000000-aaaa-0000-0000-000000000000", "relationships": {"attachments": {"data": [{"id": "00000000-9999-0000-0000-000000000000", "type": "incident_attachments"}, {"id": "00000000-1234-0000-0000-000000000000", "type": "incident_attachments"}]}, "commander_user": {"data": {"id": "00000000-0000-0000-cccc-000000000000", "type": "users"}}, "created_by_user": {"data": {"id": "00000000-0000-0000-cccc-000000000000", + "type": "users"}}, "integrations": {"data": [{"id": "00000000-0000-0000-4444-000000000000", "type": "incident_integrations"}, {"id": "00000000-0000-0000-5555-000000000000", "type": "incident_integrations"}]}, "last_modified_by_user": {"data": {"id": "00000000-0000-0000-cccc-000000000000", "type": "users"}}}, "type": "incidents"}, {"attributes": {"created": "2020-04-21T15:34:08.627205+00:00", "creation_idempotency_key": null, "customer_impact_duration": 0, "customer_impact_end": null, "customer_impact_scope": null, "customer_impact_start": null, "customer_impacted": false, "detected": "2020-04-14T00:00:00+00:00", "incident_type_uuid": "00000000-0000-0000-0000-000000000002", "modified": "2020-09-17T14:16:58.696424+00:00", "public_id": 2, "resolved": null, "severity": "SEV-5", "time_to_detect": 0, "time_to_internal_response": 0, "time_to_repair": 0, "time_to_resolve": 0, "title": "Example Incident 2"}, "id": "00000000-1111-0000-0000-000000000000", "relationships": {"attachments": { + "data": [{"id": "00000000-9999-0000-0000-000000000000", "type": "incident_attachments"}]}, "commander_user": {"data": {"id": "00000000-aaaa-0000-0000-000000000000", "type": "users"}}, "created_by_user": {"data": {"id": "00000000-aaaa-0000-0000-000000000000", "type": "users"}}, "integrations": {"data": [{"id": "00000000-0000-0000-0001-000000000000", "type": "incident_integrations"}, {"id": "00000000-0000-0000-0002-000000000000", "type": "incident_integrations"}]}, "last_modified_by_user": {"data": {"id": "00000000-aaaa-0000-0000-000000000000", "type": "users"}}}, "type": "incidents"}] items: - $ref: '#/components/schemas/IncidentResponseData' + $ref: "#/components/schemas/IncidentResponseData" type: array included: description: Included related resources that the user requested. items: - $ref: '#/components/schemas/IncidentResponseIncludedItem' + $ref: "#/components/schemas/IncidentResponseIncludedItem" readOnly: true type: array meta: - $ref: '#/components/schemas/IncidentResponseMeta' + $ref: "#/components/schemas/IncidentResponseMeta" required: - - data + - data type: object IncludeType: description: Supported include types. enum: - - schema - - raw_schema - - oncall - - incident - - relation + - schema + - raw_schema + - oncall + - incident + - relation type: string x-enum-varnames: - - SCHEMA - - RAW_SCHEMA - - ONCALL - - INCIDENT - - RELATION + - SCHEMA + - RAW_SCHEMA + - ONCALL + - INCIDENT + - RELATION InputSchema: - description: A list of input parameters for the workflow. These can be used - as dynamic runtime values in your workflow. + description: "A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow." properties: parameters: description: The `InputSchema` `parameters`. items: - $ref: '#/components/schemas/InputSchemaParameters' + $ref: "#/components/schemas/InputSchemaParameters" type: array type: object InputSchemaParameters: @@ -33116,36 +31708,36 @@ components: type: string name: description: The `InputSchemaParameters` `name`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/InputSchemaParametersType' + $ref: "#/components/schemas/InputSchemaParametersType" required: - - name - - type + - name + - type type: object InputSchemaParametersType: description: The definition of `InputSchemaParametersType` object. enum: - - STRING - - NUMBER - - BOOLEAN - - OBJECT - - ARRAY_STRING - - ARRAY_NUMBER - - ARRAY_BOOLEAN - - ARRAY_OBJECT + - STRING + - NUMBER + - BOOLEAN + - OBJECT + - ARRAY_STRING + - ARRAY_NUMBER + - ARRAY_BOOLEAN + - ARRAY_OBJECT example: STRING type: string x-enum-varnames: - - STRING - - NUMBER - - BOOLEAN - - OBJECT - - ARRAY_STRING - - ARRAY_NUMBER - - ARRAY_BOOLEAN - - ARRAY_OBJECT + - STRING + - NUMBER + - BOOLEAN + - OBJECT + - ARRAY_STRING + - ARRAY_NUMBER + - ARRAY_BOOLEAN + - ARRAY_OBJECT IntakePayloadAccepted: description: The payload accepted for intake. properties: @@ -33160,19 +31752,19 @@ components: description: Integration resource object. properties: attributes: - $ref: '#/components/schemas/IntegrationAttributes' + $ref: "#/components/schemas/IntegrationAttributes" id: description: The unique identifier of the integration. - example: calico + example: "calico" type: string links: - $ref: '#/components/schemas/IntegrationLinks' + $ref: "#/components/schemas/IntegrationLinks" type: - $ref: '#/components/schemas/IntegrationType' + $ref: "#/components/schemas/IntegrationType" required: - - type - - id - - attributes + - type + - id + - attributes type: object IntegrationAttributes: description: Attributes for an integration. @@ -33180,14 +31772,14 @@ components: categories: description: List of categories associated with the integration. example: - - Category::Kubernetes - - Category::Log Collection + - "Category::Kubernetes" + - "Category::Log Collection" items: type: string type: array description: description: A description of the integration. - example: Calico is a networking and network security solution for containers. + example: "Calico is a networking and network security solution for containers." type: string installed: description: Whether the integration is installed. @@ -33195,13 +31787,13 @@ components: type: boolean title: description: The name of the integration. - example: calico + example: "calico" type: string required: - - title - - description - - categories - - installed + - title + - description + - categories + - installed type: object IntegrationIncident: description: Incident integration settings @@ -33217,13 +31809,13 @@ components: type: boolean field_mappings: items: - $ref: '#/components/schemas/IntegrationIncidentFieldMappingsItems' + $ref: "#/components/schemas/IntegrationIncidentFieldMappingsItems" type: array incident_type: description: Incident type type: string severity_config: - $ref: '#/components/schemas/IntegrationIncidentSeverityConfig' + $ref: "#/components/schemas/IntegrationIncidentSeverityConfig" type: object IntegrationIncidentFieldMappingsItems: properties: @@ -33243,14 +31835,14 @@ components: description: Jira integration settings properties: auto_creation: - $ref: '#/components/schemas/IntegrationJiraAutoCreation' + $ref: "#/components/schemas/IntegrationJiraAutoCreation" enabled: description: Whether Jira integration is enabled type: boolean metadata: - $ref: '#/components/schemas/IntegrationJiraMetadata' + $ref: "#/components/schemas/IntegrationJiraMetadata" sync: - $ref: '#/components/schemas/IntegrationJiraSync' + $ref: "#/components/schemas/IntegrationJiraSync" type: object IntegrationJiraAutoCreation: properties: @@ -33271,7 +31863,7 @@ components: enabled: type: boolean properties: - $ref: '#/components/schemas/IntegrationJiraSyncProperties' + $ref: "#/components/schemas/IntegrationJiraSyncProperties" type: object IntegrationJiraSyncDueDate: properties: @@ -33283,37 +31875,37 @@ components: IntegrationJiraSyncProperties: properties: assignee: - $ref: '#/components/schemas/SyncProperty' + $ref: "#/components/schemas/SyncProperty" comments: - $ref: '#/components/schemas/SyncProperty' + $ref: "#/components/schemas/SyncProperty" custom_fields: additionalProperties: - $ref: '#/components/schemas/IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties' + $ref: "#/components/schemas/IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties" type: object description: - $ref: '#/components/schemas/SyncProperty' + $ref: "#/components/schemas/SyncProperty" due_date: - $ref: '#/components/schemas/IntegrationJiraSyncDueDate' + $ref: "#/components/schemas/IntegrationJiraSyncDueDate" priority: - $ref: '#/components/schemas/SyncPropertyWithMapping' + $ref: "#/components/schemas/SyncPropertyWithMapping" status: - $ref: '#/components/schemas/SyncPropertyWithMapping' + $ref: "#/components/schemas/SyncPropertyWithMapping" title: - $ref: '#/components/schemas/SyncProperty' + $ref: "#/components/schemas/SyncProperty" type: object IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties: properties: sync_type: type: string value: - $ref: '#/components/schemas/AnyValue' + $ref: "#/components/schemas/AnyValue" type: object IntegrationLinks: description: Links for the integration resource. properties: self: description: Link to the integration resource. - example: /integrations?integrationId=calico + example: "/integrations?integrationId=calico" type: string type: object IntegrationMonitor: @@ -33343,7 +31935,7 @@ components: type: boolean escalation_queries: items: - $ref: '#/components/schemas/IntegrationOnCallEscalationQueriesItems' + $ref: "#/components/schemas/IntegrationOnCallEscalationQueriesItems" type: array type: object IntegrationOnCallEscalationQueriesItems: @@ -33355,7 +31947,7 @@ components: query: type: string target: - $ref: '#/components/schemas/IntegrationOnCallEscalationQueriesItemsTarget' + $ref: "#/components/schemas/IntegrationOnCallEscalationQueriesItemsTarget" type: object IntegrationOnCallEscalationQueriesItemsTarget: properties: @@ -33373,7 +31965,7 @@ components: description: Assignment group type: string auto_creation: - $ref: '#/components/schemas/IntegrationServiceNowAutoCreation' + $ref: "#/components/schemas/IntegrationServiceNowAutoCreation" enabled: description: Whether ServiceNow integration is enabled type: boolean @@ -33381,7 +31973,7 @@ components: description: ServiceNow instance name type: string sync_config: - $ref: '#/components/schemas/IntegrationServiceNowSyncConfig' + $ref: "#/components/schemas/IntegrationServiceNowSyncConfig" type: object IntegrationServiceNowAutoCreation: properties: @@ -33393,16 +31985,16 @@ components: enabled: type: boolean properties: - $ref: '#/components/schemas/IntegrationServiceNowSyncConfig139772721534496' + $ref: "#/components/schemas/IntegrationServiceNowSyncConfig139772721534496" type: object IntegrationServiceNowSyncConfig139772721534496: properties: comments: - $ref: '#/components/schemas/SyncProperty' + $ref: "#/components/schemas/SyncProperty" priority: - $ref: '#/components/schemas/IntegrationServiceNowSyncConfigPriority' + $ref: "#/components/schemas/IntegrationServiceNowSyncConfigPriority" status: - $ref: '#/components/schemas/SyncPropertyWithMapping' + $ref: "#/components/schemas/SyncPropertyWithMapping" type: object IntegrationServiceNowSyncConfigPriority: properties: @@ -33421,11 +32013,11 @@ components: default: integration description: Integration resource type. enum: - - integration + - integration example: integration type: string x-enum-varnames: - - INTEGRATION + - INTEGRATION InterfaceAttributes: description: The interface attributes properties: @@ -33444,9 +32036,7 @@ components: type: integer ip_addresses: description: The interface IP addresses - example: - - 1.1.1.1 - - 1.1.1.2 + example: ["1.1.1.1", "1.1.1.2"] items: type: string type: array @@ -33459,77 +32049,75 @@ components: example: if0 type: string status: - $ref: '#/components/schemas/InterfaceAttributesStatus' + $ref: "#/components/schemas/InterfaceAttributesStatus" type: object InterfaceAttributesStatus: description: The interface status enum: - - up - - down - - warning - - 'off' + - up + - down + - warning + - "off" example: up type: string x-enum-varnames: - - UP - - DOWN - - WARNING - - 'OFF' + - UP + - DOWN + - WARNING + - "OFF" Issue: description: The issue matching the request. properties: attributes: - $ref: '#/components/schemas/IssueAttributes' + $ref: "#/components/schemas/IssueAttributes" id: description: Issue identifier. - example: c1726a66-1f64-11ee-b338-da7ad0900002 + example: "c1726a66-1f64-11ee-b338-da7ad0900002" type: string relationships: - $ref: '#/components/schemas/IssueRelationships' + $ref: "#/components/schemas/IssueRelationships" type: - $ref: '#/components/schemas/IssueType' + $ref: "#/components/schemas/IssueType" required: - - id - - type - - attributes + - id + - type + - attributes type: object IssueAssigneeRelationship: description: Relationship between the issue and assignee. properties: data: - $ref: '#/components/schemas/IssueUserReference' + $ref: "#/components/schemas/IssueUserReference" required: - - data + - data type: object IssueAttributes: description: Object containing the information of an issue. properties: error_message: description: Error message associated with the issue. - example: object of type 'NoneType' has no len() + example: "object of type 'NoneType' has no len()" type: string error_type: description: Type of the error that matches the issue. - example: builtins.TypeError + example: "builtins.TypeError" type: string file_path: description: Path of the file where the issue occurred. - example: /django-email/conduit/apps/core/utils.py + example: "/django-email/conduit/apps/core/utils.py" type: string first_seen: - description: Timestamp of the first seen error in milliseconds since the - Unix epoch. + description: Timestamp of the first seen error in milliseconds since the Unix epoch. example: 1671612804001 format: int64 type: integer first_seen_version: - description: The application version (for example, git commit hash) where - the issue was first observed. - example: aaf65cd0 + description: The application version (for example, git commit hash) where the issue was first observed. + example: "aaf65cd0" type: string function_name: description: Name of the function where the issue occurred. - example: filter_forbidden_tags + example: "filter_forbidden_tags" type: string is_crash: description: Error is a crash. @@ -33537,106 +32125,102 @@ components: type: boolean languages: description: Array of programming languages associated with the issue. - example: - - PYTHON - - GO + example: ["PYTHON", "GO"] items: - $ref: '#/components/schemas/IssueLanguage' + $ref: "#/components/schemas/IssueLanguage" type: array last_seen: - description: Timestamp of the last seen error in milliseconds since the - Unix epoch. + description: Timestamp of the last seen error in milliseconds since the Unix epoch. example: 1671620003100 format: int64 type: integer last_seen_version: - description: The application version (for example, git commit hash) where - the issue was last observed. - example: b6199f80 + description: The application version (for example, git commit hash) where the issue was last observed. + example: "b6199f80" type: string platform: - $ref: '#/components/schemas/IssuePlatform' + $ref: "#/components/schemas/IssuePlatform" service: description: Service name. - example: email-api-py + example: "email-api-py" type: string state: - $ref: '#/components/schemas/IssueState' + $ref: "#/components/schemas/IssueState" type: object IssueCase: description: The case attached to the issue. properties: attributes: - $ref: '#/components/schemas/IssueCaseAttributes' + $ref: "#/components/schemas/IssueCaseAttributes" id: description: Case identifier. - example: 2841440d-e780-4fe2-96cd-6a8c1d194da5 + example: "2841440d-e780-4fe2-96cd-6a8c1d194da5" type: string relationships: - $ref: '#/components/schemas/IssueCaseRelationships' + $ref: "#/components/schemas/IssueCaseRelationships" type: - $ref: '#/components/schemas/IssueCaseResourceType' + $ref: "#/components/schemas/IssueCaseResourceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object IssueCaseAttributes: description: Object containing the information of a case. properties: archived_at: description: Timestamp of when the case was archived. - example: '2025-01-01T00:00:00Z' + example: "2025-01-01T00:00:00Z" format: date-time type: string closed_at: description: Timestamp of when the case was closed. - example: '2025-01-01T00:00:00Z' + example: "2025-01-01T00:00:00Z" format: date-time type: string created_at: description: Timestamp of when the case was created. - example: '2025-01-01T00:00:00Z' + example: "2025-01-01T00:00:00Z" format: date-time type: string creation_source: description: Source of the case creation. - example: ERROR_TRACKING + example: "ERROR_TRACKING" type: string description: description: Description of the case. type: string due_date: description: Due date of the case. - example: '2025-01-01' + example: "2025-01-01" type: string insights: description: Insights of the case. items: - $ref: '#/components/schemas/IssueCaseInsight' + $ref: "#/components/schemas/IssueCaseInsight" type: array jira_issue: - $ref: '#/components/schemas/IssueCaseJiraIssue' + $ref: "#/components/schemas/IssueCaseJiraIssue" key: description: Key of the case. - example: ET-123 + example: "ET-123" type: string modified_at: description: Timestamp of when the case was last modified. - example: '2025-01-01T00:00:00Z' + example: "2025-01-01T00:00:00Z" format: date-time type: string priority: - $ref: '#/components/schemas/CasePriority' + $ref: "#/components/schemas/CasePriority" status: - $ref: '#/components/schemas/CaseStatus' + $ref: "#/components/schemas/CaseStatus" title: description: Title of the case. - example: 'Error: HTTP error' + example: "Error: HTTP error" type: string type: description: Type of the case. - example: ERROR_TRACKING_ISSUE + example: "ERROR_TRACKING_ISSUE" type: string type: object IssueCaseInsight: @@ -33644,46 +32228,45 @@ components: properties: ref: description: Reference of the insight. - example: /error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5 + example: "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5" type: string resource_id: description: Insight identifier. - example: 2841440d-e780-4fe2-96cd-6a8c1d194da5 + example: "2841440d-e780-4fe2-96cd-6a8c1d194da5" type: string type: description: Type of the insight. - example: ERROR_TRACKING + example: "ERROR_TRACKING" type: string type: object IssueCaseJiraIssue: description: Jira issue of the case. properties: result: - $ref: '#/components/schemas/IssueCaseJiraIssueResult' + $ref: "#/components/schemas/IssueCaseJiraIssueResult" status: description: Creation status of the Jira issue. - example: COMPLETED + example: "COMPLETED" type: string type: object IssueCaseJiraIssueResult: - description: Contains the identifiers and URL for a successfully created Jira - issue. + description: Contains the identifiers and URL for a successfully created Jira issue. properties: issue_id: description: Jira issue identifier. - example: '1904866' + example: "1904866" type: string issue_key: description: Jira issue key. - example: ET-123 + example: "ET-123" type: string issue_url: description: Jira issue URL. - example: https://your-jira-instance.atlassian.net/browse/ET-123 + example: "https://your-jira-instance.atlassian.net/browse/ET-123" type: string project_key: description: Jira project key. - example: ET + example: "ET" type: string type: object IssueCaseReference: @@ -33691,211 +32274,209 @@ components: properties: id: description: Case identifier. - example: 2841440d-e780-4fe2-96cd-6a8c1d194da5 + example: "2841440d-e780-4fe2-96cd-6a8c1d194da5" type: string type: - $ref: '#/components/schemas/IssueCaseResourceType' + $ref: "#/components/schemas/IssueCaseResourceType" required: - - id - - type + - id + - type type: object IssueCaseRelationship: description: Relationship between the issue and case. properties: data: - $ref: '#/components/schemas/IssueCaseReference' + $ref: "#/components/schemas/IssueCaseReference" required: - - data + - data type: object IssueCaseRelationships: description: Resources related to a case. properties: assignee: - $ref: '#/components/schemas/NullableUserRelationship' + $ref: "#/components/schemas/NullableUserRelationship" created_by: - $ref: '#/components/schemas/NullableUserRelationship' + $ref: "#/components/schemas/NullableUserRelationship" modified_by: - $ref: '#/components/schemas/NullableUserRelationship' + $ref: "#/components/schemas/NullableUserRelationship" project: - $ref: '#/components/schemas/ProjectRelationship' + $ref: "#/components/schemas/ProjectRelationship" type: object IssueCaseResourceType: description: Type of the object. - enum: - - case - example: case + enum: ["case"] + example: "case" type: string x-enum-varnames: - - CASE + - CASE IssueIncluded: - description: An array of related resources, returned when the `include` query - parameter is used. + description: An array of related resources, returned when the `include` query parameter is used. oneOf: - - $ref: '#/components/schemas/IssueCase' - - $ref: '#/components/schemas/IssueUser' - - $ref: '#/components/schemas/IssueTeam' + - $ref: "#/components/schemas/IssueCase" + - $ref: "#/components/schemas/IssueUser" + - $ref: "#/components/schemas/IssueTeam" IssueLanguage: description: Programming language associated with the issue. enum: - - BRIGHTSCRIPT - - C - - C_PLUS_PLUS - - C_SHARP - - CLOJURE - - DOT_NET - - ELIXIR - - ERLANG - - GO - - GROOVY - - HASKELL - - HCL - - JAVA - - JAVASCRIPT - - JVM - - KOTLIN - - OBJECTIVE_C - - PERL - - PHP - - PYTHON - - RUBY - - RUST - - SCALA - - SWIFT - - TERRAFORM - - TYPESCRIPT - - UNKNOWN - example: PYTHON - type: string - x-enum-varnames: - - BRIGHTSCRIPT - - C - - C_PLUS_PLUS - - C_SHARP - - CLOJURE - - DOT_NET - - ELIXIR - - ERLANG - - GO - - GROOVY - - HASKELL - - HCL - - JAVA - - JAVASCRIPT - - JVM - - KOTLIN - - OBJECTIVE_C - - PERL - - PHP - - PYTHON - - RUBY - - RUST - - SCALA - - SWIFT - - TERRAFORM - - TYPESCRIPT - - UNKNOWN + - BRIGHTSCRIPT + - C + - C_PLUS_PLUS + - C_SHARP + - CLOJURE + - DOT_NET + - ELIXIR + - ERLANG + - GO + - GROOVY + - HASKELL + - HCL + - JAVA + - JAVASCRIPT + - JVM + - KOTLIN + - OBJECTIVE_C + - PERL + - PHP + - PYTHON + - RUBY + - RUST + - SCALA + - SWIFT + - TERRAFORM + - TYPESCRIPT + - UNKNOWN + example: "PYTHON" + type: string + x-enum-varnames: + - BRIGHTSCRIPT + - C + - C_PLUS_PLUS + - C_SHARP + - CLOJURE + - DOT_NET + - ELIXIR + - ERLANG + - GO + - GROOVY + - HASKELL + - HCL + - JAVA + - JAVASCRIPT + - JVM + - KOTLIN + - OBJECTIVE_C + - PERL + - PHP + - PYTHON + - RUBY + - RUST + - SCALA + - SWIFT + - TERRAFORM + - TYPESCRIPT + - UNKNOWN IssuePlatform: description: Platform associated with the issue. enum: - - ANDROID - - BACKEND - - BROWSER - - FLUTTER - - IOS - - REACT_NATIVE - - ROKU - - UNKNOWN - example: BACKEND - type: string - x-enum-varnames: - - ANDROID - - BACKEND - - BROWSER - - FLUTTER - - IOS - - REACT_NATIVE - - ROKU - - UNKNOWN + - ANDROID + - BACKEND + - BROWSER + - FLUTTER + - IOS + - REACT_NATIVE + - ROKU + - UNKNOWN + example: "BACKEND" + type: string + x-enum-varnames: + - ANDROID + - BACKEND + - BROWSER + - FLUTTER + - IOS + - REACT_NATIVE + - ROKU + - UNKNOWN IssueReference: description: The issue the search result corresponds to. properties: id: description: Issue identifier. - example: c1726a66-1f64-11ee-b338-da7ad0900002 + example: "c1726a66-1f64-11ee-b338-da7ad0900002" type: string type: - $ref: '#/components/schemas/IssueType' + $ref: "#/components/schemas/IssueType" required: - - id - - type + - id + - type type: object IssueRelationships: description: Relationship between the issue and an assignee, case and/or teams. properties: assignee: - $ref: '#/components/schemas/IssueAssigneeRelationship' + $ref: "#/components/schemas/IssueAssigneeRelationship" case: - $ref: '#/components/schemas/IssueCaseRelationship' + $ref: "#/components/schemas/IssueCaseRelationship" team_owners: - $ref: '#/components/schemas/IssueTeamOwnersRelationship' + $ref: "#/components/schemas/IssueTeamOwnersRelationship" type: object IssueResponse: description: Response containing error tracking issue data. properties: data: - $ref: '#/components/schemas/Issue' + $ref: "#/components/schemas/Issue" included: description: Array of resources related to the issue. items: - $ref: '#/components/schemas/IssueIncluded' + $ref: "#/components/schemas/IssueIncluded" type: array type: object IssueState: description: State of the issue enum: - - OPEN - - ACKNOWLEDGED - - RESOLVED - - IGNORED - - EXCLUDED - example: RESOLVED + - OPEN + - ACKNOWLEDGED + - RESOLVED + - IGNORED + - EXCLUDED + example: "RESOLVED" type: string x-enum-varnames: - - OPEN - - ACKNOWLEDGED - - RESOLVED - - IGNORED - - EXCLUDED + - OPEN + - ACKNOWLEDGED + - RESOLVED + - IGNORED + - EXCLUDED IssueTeam: description: A team that owns an issue. properties: attributes: - $ref: '#/components/schemas/IssueTeamAttributes' + $ref: "#/components/schemas/IssueTeamAttributes" id: description: Team identifier. - example: 221b0179-6447-4d03-91c3-3ca98bf60e8a + example: "221b0179-6447-4d03-91c3-3ca98bf60e8a" type: string type: - $ref: '#/components/schemas/IssueTeamType' + $ref: "#/components/schemas/IssueTeamType" required: - - id - - type - - attributes + - id + - type + - attributes type: object IssueTeamAttributes: description: Object containing the information of a team. properties: handle: description: The team's identifier. - example: team-handle + example: "team-handle" type: string name: description: The name of the team. - example: Team Name + example: "Team Name" type: string summary: description: A brief summary of the team, derived from its description. - example: This is a team. + example: "This is a team." type: string type: object IssueTeamOwnersRelationship: @@ -33904,139 +32485,135 @@ components: data: description: Array of teams that are owners of the issue. items: - $ref: '#/components/schemas/IssueTeamReference' + $ref: "#/components/schemas/IssueTeamReference" type: array required: - - data + - data type: object IssueTeamReference: description: A team that owns the issue. properties: id: description: Team identifier. - example: 221b0179-6447-4d03-91c3-3ca98bf60e8a + example: "221b0179-6447-4d03-91c3-3ca98bf60e8a" type: string type: - $ref: '#/components/schemas/IssueTeamType' + $ref: "#/components/schemas/IssueTeamType" required: - - id - - type + - id + - type type: object IssueTeamType: description: Type of the object. - enum: - - team - example: team + enum: ["team"] + example: "team" type: string x-enum-varnames: - - TEAM + - TEAM IssueType: description: Type of the object. - enum: - - issue - example: issue + enum: ["issue"] + example: "issue" type: string x-enum-varnames: - - ISSUE + - ISSUE IssueUpdateAssigneeRequest: description: Update issue assignee request payload. properties: data: - $ref: '#/components/schemas/IssueUpdateAssigneeRequestData' + $ref: "#/components/schemas/IssueUpdateAssigneeRequestData" required: - - data + - data type: object IssueUpdateAssigneeRequestData: description: Update issue assignee request. properties: id: description: User identifier. - example: 87cb11a0-278c-440a-99fe-701223c80296 + example: "87cb11a0-278c-440a-99fe-701223c80296" type: string type: - $ref: '#/components/schemas/IssueUpdateAssigneeRequestDataType' + $ref: "#/components/schemas/IssueUpdateAssigneeRequestDataType" required: - - id - - type + - id + - type type: object IssueUpdateAssigneeRequestDataType: description: Type of the object. - enum: - - assignee - example: assignee + enum: ["assignee"] + example: "assignee" type: string x-enum-varnames: - - ASSIGNEE + - ASSIGNEE IssueUpdateStateRequest: description: Update issue state request payload. properties: data: - $ref: '#/components/schemas/IssueUpdateStateRequestData' + $ref: "#/components/schemas/IssueUpdateStateRequestData" required: - - data + - data type: object IssueUpdateStateRequestData: description: Update issue state request. properties: attributes: - $ref: '#/components/schemas/IssueUpdateStateRequestDataAttributes' + $ref: "#/components/schemas/IssueUpdateStateRequestDataAttributes" id: description: Issue identifier. - example: c1726a66-1f64-11ee-b338-da7ad0900002 + example: "c1726a66-1f64-11ee-b338-da7ad0900002" type: string type: - $ref: '#/components/schemas/IssueUpdateStateRequestDataType' + $ref: "#/components/schemas/IssueUpdateStateRequestDataType" required: - - id - - type - - attributes + - id + - type + - attributes type: object IssueUpdateStateRequestDataAttributes: description: Object describing an issue state update request. properties: state: - $ref: '#/components/schemas/IssueState' + $ref: "#/components/schemas/IssueState" required: - - state + - state type: object IssueUpdateStateRequestDataType: description: Type of the object. - enum: - - error_tracking_issue - example: error_tracking_issue + enum: ["error_tracking_issue"] + example: "error_tracking_issue" type: string x-enum-varnames: - - ERROR_TRACKING_ISSUE + - ERROR_TRACKING_ISSUE IssueUser: description: The user to whom the issue is assigned. properties: attributes: - $ref: '#/components/schemas/IssueUserAttributes' + $ref: "#/components/schemas/IssueUserAttributes" id: description: User identifier. - example: 87cb11a0-278c-440a-99fe-701223c80296 + example: "87cb11a0-278c-440a-99fe-701223c80296" type: string type: - $ref: '#/components/schemas/IssueUserType' + $ref: "#/components/schemas/IssueUserType" required: - - id - - type - - attributes + - id + - type + - attributes type: object IssueUserAttributes: description: Object containing the information of a user. properties: email: description: Email of the user. - example: user@company.com + example: "user@company.com" type: string handle: description: Handle of the user. - example: User Handle + example: "User Handle" type: string name: description: Name of the user. - example: User Name + example: "User Name" type: string type: object IssueUserReference: @@ -34044,209 +32621,192 @@ components: properties: id: description: User identifier. - example: 87cb11a0-278c-440a-99fe-701223c80296 + example: "87cb11a0-278c-440a-99fe-701223c80296" type: string type: - $ref: '#/components/schemas/IssueUserType' + $ref: "#/components/schemas/IssueUserType" required: - - id - - type + - id + - type type: object IssueUserType: description: Type of the object - enum: - - user - example: user + enum: ["user"] + example: "user" type: string x-enum-varnames: - - USER + - USER IssuesSearchRequest: description: Search issues request payload. properties: data: - $ref: '#/components/schemas/IssuesSearchRequestData' + $ref: "#/components/schemas/IssuesSearchRequestData" required: - - data + - data type: object IssuesSearchRequestData: description: Search issues request. properties: attributes: - $ref: '#/components/schemas/IssuesSearchRequestDataAttributes' + $ref: "#/components/schemas/IssuesSearchRequestDataAttributes" type: - $ref: '#/components/schemas/IssuesSearchRequestDataType' + $ref: "#/components/schemas/IssuesSearchRequestDataType" required: - - type - - attributes + - type + - attributes type: object IssuesSearchRequestDataAttributes: description: Object describing a search issue request. properties: from: - description: Start date (inclusive) of the query in milliseconds since the - Unix epoch. + description: Start date (inclusive) of the query in milliseconds since the Unix epoch. example: 1671612804000 format: int64 type: integer order_by: - $ref: '#/components/schemas/IssuesSearchRequestDataAttributesOrderBy' + $ref: "#/components/schemas/IssuesSearchRequestDataAttributesOrderBy" persona: - $ref: '#/components/schemas/IssuesSearchRequestDataAttributesPersona' + $ref: "#/components/schemas/IssuesSearchRequestDataAttributesPersona" query: description: Search query following the event search syntax. - example: service:orders-* AND @language:go + example: "service:orders-* AND @language:go" type: string to: - description: End date (exclusive) of the query in milliseconds since the - Unix epoch. + description: End date (exclusive) of the query in milliseconds since the Unix epoch. example: 1671620004000 format: int64 type: integer track: - $ref: '#/components/schemas/IssuesSearchRequestDataAttributesTrack' + $ref: "#/components/schemas/IssuesSearchRequestDataAttributesTrack" required: - - query - - from - - to + - query + - from + - to type: object IssuesSearchRequestDataAttributesOrderBy: description: The attribute to sort the search results by. enum: - - TOTAL_COUNT - - FIRST_SEEN - - IMPACTED_SESSIONS - - PRIORITY - example: IMPACTED_SESSIONS + - TOTAL_COUNT + - FIRST_SEEN + - IMPACTED_SESSIONS + - PRIORITY + example: "IMPACTED_SESSIONS" type: string x-enum-varnames: - - TOTAL_COUNT - - FIRST_SEEN - - IMPACTED_SESSIONS - - PRIORITY + - TOTAL_COUNT + - FIRST_SEEN + - IMPACTED_SESSIONS + - PRIORITY IssuesSearchRequestDataAttributesPersona: description: Persona for the search. Either track(s) or persona(s) must be specified. - enum: - - ALL - - BROWSER - - MOBILE - - BACKEND - example: BACKEND + enum: ["ALL", "BROWSER", "MOBILE", "BACKEND"] + example: "BACKEND" type: string x-enum-varnames: - - ALL - - BROWSER - - MOBILE - - BACKEND + - ALL + - BROWSER + - MOBILE + - BACKEND IssuesSearchRequestDataAttributesTrack: - description: Track of the events to query. Either track(s) or persona(s) must - be specified. - enum: - - trace - - logs - - rum - example: trace + description: Track of the events to query. Either track(s) or persona(s) must be specified. + enum: ["trace", "logs", "rum"] + example: "trace" type: string x-enum-varnames: - - TRACE - - LOGS - - RUM + - TRACE + - LOGS + - RUM IssuesSearchRequestDataType: description: Type of the object. - enum: - - search_request - example: search_request + enum: ["search_request"] + example: "search_request" type: string x-enum-varnames: - - SEARCH_REQUEST + - SEARCH_REQUEST IssuesSearchResponse: description: Search issues response payload. properties: data: description: Array of results matching the search query. items: - $ref: '#/components/schemas/IssuesSearchResult' + $ref: "#/components/schemas/IssuesSearchResult" type: array included: description: Array of resources related to the search results. items: - $ref: '#/components/schemas/IssuesSearchResultIncluded' + $ref: "#/components/schemas/IssuesSearchResultIncluded" type: array type: object IssuesSearchResult: description: Result matching the search query. properties: attributes: - $ref: '#/components/schemas/IssuesSearchResultAttributes' + $ref: "#/components/schemas/IssuesSearchResultAttributes" id: description: Search result identifier (matches the nested issue's identifier). - example: c1726a66-1f64-11ee-b338-da7ad0900002 + example: "c1726a66-1f64-11ee-b338-da7ad0900002" type: string relationships: - $ref: '#/components/schemas/IssuesSearchResultRelationships' + $ref: "#/components/schemas/IssuesSearchResultRelationships" type: - $ref: '#/components/schemas/IssuesSearchResultType' + $ref: "#/components/schemas/IssuesSearchResultType" required: - - id - - type - - attributes + - id + - type + - attributes type: object IssuesSearchResultAttributes: description: Object containing the information of a search result. properties: impacted_sessions: - description: Count of sessions impacted by the issue over the queried time - window. + description: Count of sessions impacted by the issue over the queried time window. example: 12 format: int64 type: integer impacted_users: - description: Count of users impacted by the issue over the queried time - window. + description: Count of users impacted by the issue over the queried time window. example: 4 format: int64 type: integer total_count: - description: Total count of errors that match the issue over the queried - time window. + description: Total count of errors that match the issue over the queried time window. example: 82 format: int64 type: integer type: object IssuesSearchResultIncluded: - description: An array of related resources, returned when the `include` query - parameter is used. + description: An array of related resources, returned when the `include` query parameter is used. oneOf: - - $ref: '#/components/schemas/Issue' - - $ref: '#/components/schemas/Case' - - $ref: '#/components/schemas/IssueUser' - - $ref: '#/components/schemas/IssueTeam' + - $ref: "#/components/schemas/Issue" + - $ref: "#/components/schemas/Case" + - $ref: "#/components/schemas/IssueUser" + - $ref: "#/components/schemas/IssueTeam" IssuesSearchResultIssueRelationship: description: Relationship between the search result and the corresponding issue. properties: data: - $ref: '#/components/schemas/IssueReference' + $ref: "#/components/schemas/IssueReference" required: - - data + - data type: object IssuesSearchResultRelationships: description: Relationships between the search result and other resources. properties: issue: - $ref: '#/components/schemas/IssuesSearchResultIssueRelationship' + $ref: "#/components/schemas/IssuesSearchResultIssueRelationship" type: object IssuesSearchResultType: description: Type of the object. - enum: - - error_tracking_search_result - example: error_tracking_search_result + enum: ["error_tracking_search_result"] + example: "error_tracking_search_result" type: string x-enum-varnames: - - ERROR_TRACKING_SEARCH_RESULT + - ERROR_TRACKING_SEARCH_RESULT ItemApiPayload: description: A single datastore item with its content and metadata. properties: data: - $ref: '#/components/schemas/ItemApiPayloadData' + $ref: "#/components/schemas/ItemApiPayloadData" type: object ItemApiPayloadArray: description: A collection of datastore items with pagination and schema metadata. @@ -34254,28 +32814,27 @@ components: data: description: An array of datastore items with their content and metadata. items: - $ref: '#/components/schemas/ItemApiPayloadData' + $ref: "#/components/schemas/ItemApiPayloadData" maxItems: 100 type: array meta: - $ref: '#/components/schemas/ItemApiPayloadMeta' - description: Metadata about the included items, including pagination info - and datastore schema. + $ref: "#/components/schemas/ItemApiPayloadMeta" + description: Metadata about the included items, including pagination info and datastore schema. required: - - data + - data type: object ItemApiPayloadData: description: Core data and metadata for a single datastore item. properties: attributes: - $ref: '#/components/schemas/ItemApiPayloadDataAttributes' + $ref: "#/components/schemas/ItemApiPayloadDataAttributes" id: description: The unique identifier of the datastore. type: string type: - $ref: '#/components/schemas/DatastoreItemsDataType' + $ref: "#/components/schemas/DatastoreItemsDataType" required: - - type + - type type: object ItemApiPayloadDataAttributes: description: Metadata and content of a datastore item. @@ -34293,7 +32852,7 @@ components: format: int64 type: integer primary_column_name: - $ref: '#/components/schemas/DatastoreAttributesPrimaryColumnName' + $ref: "#/components/schemas/DatastoreAttributesPrimaryColumnName" signature: description: A unique signature identifying this item version. type: string @@ -34301,27 +32860,25 @@ components: description: The unique identifier of the datastore containing this item. type: string value: - $ref: '#/components/schemas/ItemApiPayloadDataAttributesValue' + $ref: "#/components/schemas/ItemApiPayloadDataAttributesValue" type: object ItemApiPayloadDataAttributesValue: additionalProperties: {} description: The data content (as key-value pairs) of a datastore item. type: object ItemApiPayloadMeta: - description: Additional metadata about a collection of datastore items, including - pagination and schema information. + description: Additional metadata about a collection of datastore items, including pagination and schema information. properties: page: - $ref: '#/components/schemas/ItemApiPayloadMetaPage' + $ref: "#/components/schemas/ItemApiPayloadMetaPage" schema: - $ref: '#/components/schemas/ItemApiPayloadMetaSchema' + $ref: "#/components/schemas/ItemApiPayloadMetaSchema" type: object ItemApiPayloadMetaPage: description: Pagination information for a collection of datastore items. properties: hasMore: - description: Whether there are additional pages of items beyond the current - page. + description: Whether there are additional pages of items beyond the current page. type: boolean totalCount: description: The total number of items in the datastore, ignoring any filters. @@ -34333,13 +32890,12 @@ components: type: integer type: object ItemApiPayloadMetaSchema: - description: Schema information about the datastore, including its primary key - and field definitions. + description: Schema information about the datastore, including its primary key and field definitions. properties: fields: description: An array describing the columns available in this datastore. items: - $ref: '#/components/schemas/ItemApiPayloadMetaSchemaField' + $ref: "#/components/schemas/ItemApiPayloadMetaSchemaField" type: array primary_key: description: The name of the primary key column for this datastore. @@ -34350,23 +32906,21 @@ components: properties: name: description: The name of this column in the datastore. - example: '' + example: "" type: string type: - description: The data type of this column. For example, 'string', 'number', - or 'boolean'. - example: '' + description: The data type of this column. For example, 'string', 'number', or 'boolean'. + example: "" type: string required: - - name - - type + - name + - type type: object JSONAPIErrorItem: description: API error response body properties: detail: - description: A human-readable explanation specific to this occurrence of - the error. + description: A human-readable explanation specific to this occurrence of the error. example: Missing required attribute in body type: string meta: @@ -34374,10 +32928,10 @@ components: description: Non-standard meta-information about the error type: object source: - $ref: '#/components/schemas/JSONAPIErrorItemSource' + $ref: "#/components/schemas/JSONAPIErrorItemSource" status: description: Status code of the response. - example: '400' + example: "400" type: string title: description: Short human-readable summary of the error. @@ -34388,18 +32942,16 @@ components: description: References to the source of the error. properties: header: - description: A string indicating the name of a single request header which - caused the error. - example: Authorization + description: A string indicating the name of a single request header which caused the error. + example: "Authorization" type: string parameter: description: A string indicating which URI query parameter caused the error. - example: limit + example: "limit" type: string pointer: - description: A JSON pointer to the value in the request document that caused - the error. - example: /data/attributes/title + description: A JSON pointer to the value in the request document that caused the error. + example: "/data/attributes/title" type: string type: object JSONAPIErrorResponse: @@ -34408,85 +32960,85 @@ components: errors: description: A list of errors. items: - $ref: '#/components/schemas/JSONAPIErrorItem' + $ref: "#/components/schemas/JSONAPIErrorItem" type: array required: - - errors + - errors type: object JiraAccountAttributes: description: Attributes of a Jira account properties: consumer_key: description: The consumer key for the Jira account - example: consumer-key-1 + example: "consumer-key-1" type: string instance_url: description: The URL of the Jira instance - example: https://example.atlassian.net + example: "https://example.atlassian.net" type: string last_webhook_timestamp: description: Timestamp of the last webhook received - example: '2024-01-15T10:30:00Z' + example: "2024-01-15T10:30:00Z" format: date-time type: string required: - - consumer_key - - instance_url + - consumer_key + - instance_url type: object JiraAccountData: description: Data object for a Jira account properties: attributes: - $ref: '#/components/schemas/JiraAccountAttributes' + $ref: "#/components/schemas/JiraAccountAttributes" id: description: Unique identifier for the Jira account - example: account-1 + example: "account-1" type: string type: - $ref: '#/components/schemas/JiraAccountType' + $ref: "#/components/schemas/JiraAccountType" required: - - id - - type - - attributes + - id + - type + - attributes type: object JiraAccountRelationship: description: Relationship to a Jira account properties: data: - $ref: '#/components/schemas/JiraAccountData' + $ref: "#/components/schemas/JiraAccountData" required: - - data + - data type: object JiraAccountType: description: Type identifier for Jira account resources enum: - - jira-account + - jira-account example: jira-account type: string x-enum-varnames: - - JIRA_ACCOUNT + - JIRA_ACCOUNT JiraAccountsData: description: Array of Jira account data objects items: - $ref: '#/components/schemas/JiraAccountData' + $ref: "#/components/schemas/JiraAccountData" type: array JiraAccountsMeta: description: Metadata for Jira accounts response properties: public_key: description: Public key for the Jira integration - example: c29tZSBkYXRhIHdpdGggACBhbmQg77u/ + example: "c29tZSBkYXRhIHdpdGggACBhbmQg77u/" type: string type: object JiraAccountsResponse: description: Response containing Jira accounts properties: data: - $ref: '#/components/schemas/JiraAccountsData' + $ref: "#/components/schemas/JiraAccountsData" meta: - $ref: '#/components/schemas/JiraAccountsMeta' + $ref: "#/components/schemas/JiraAccountsMeta" required: - - data + - data type: object JiraIntegrationMetadata: description: Incident integration metadata for the Jira integration. @@ -34495,10 +33047,10 @@ components: description: Array of Jira issues in this integration metadata. example: [] items: - $ref: '#/components/schemas/JiraIntegrationMetadataIssuesItem' + $ref: "#/components/schemas/JiraIntegrationMetadataIssuesItem" type: array required: - - issues + - issues type: object JiraIntegrationMetadataIssuesItem: description: Item in the Jira integration metadata issue array. @@ -34513,7 +33065,7 @@ components: type: string issuetype_id: description: Jira issue's issue type. - example: '1000' + example: "1000" type: string project_key: description: Jira issue's project keys. @@ -34524,17 +33076,17 @@ components: example: https://example.atlassian.net/browse/PROJ-123 type: string required: - - project_key - - account + - project_key + - account type: object JiraIssue: description: Jira issue attached to case nullable: true properties: result: - $ref: '#/components/schemas/JiraIssueResult' + $ref: "#/components/schemas/JiraIssueResult" status: - $ref: '#/components/schemas/Case3rdPartyTicketStatus' + $ref: "#/components/schemas/Case3rdPartyTicketStatus" readOnly: true type: object JiraIssueCreateAttributes: @@ -34547,77 +33099,77 @@ components: type: object issue_type_id: description: Jira issue type ID - example: '10001' + example: "10001" type: string jira_account_id: description: Jira account ID - example: '1234' + example: "1234" type: string project_id: description: Jira project ID - example: '5678' + example: "5678" type: string required: - - jira_account_id - - project_id - - issue_type_id + - jira_account_id + - project_id + - issue_type_id type: object JiraIssueCreateData: description: Jira issue creation data properties: attributes: - $ref: '#/components/schemas/JiraIssueCreateAttributes' + $ref: "#/components/schemas/JiraIssueCreateAttributes" type: - $ref: '#/components/schemas/JiraIssueResourceType' + $ref: "#/components/schemas/JiraIssueResourceType" required: - - type - - attributes + - type + - attributes type: object JiraIssueCreateRequest: description: Jira issue creation request properties: data: - $ref: '#/components/schemas/JiraIssueCreateData' + $ref: "#/components/schemas/JiraIssueCreateData" required: - - data + - data type: object JiraIssueLinkAttributes: description: Jira issue link attributes properties: jira_issue_url: description: URL of the Jira issue - example: https://jira.example.com/browse/PROJ-123 + example: "https://jira.example.com/browse/PROJ-123" type: string required: - - jira_issue_url + - jira_issue_url type: object JiraIssueLinkData: description: Jira issue link data properties: attributes: - $ref: '#/components/schemas/JiraIssueLinkAttributes' + $ref: "#/components/schemas/JiraIssueLinkAttributes" type: - $ref: '#/components/schemas/JiraIssueResourceType' + $ref: "#/components/schemas/JiraIssueResourceType" required: - - type - - attributes + - type + - attributes type: object JiraIssueLinkRequest: description: Jira issue link request properties: data: - $ref: '#/components/schemas/JiraIssueLinkData' + $ref: "#/components/schemas/JiraIssueLinkData" required: - - data + - data type: object JiraIssueResourceType: description: Jira issue resource type enum: - - issues + - issues example: issues type: string x-enum-varnames: - - ISSUES + - ISSUES JiraIssueResult: description: Jira issue information properties: @@ -34638,7 +33190,7 @@ components: description: Request to create a Jira issue template properties: data: - $ref: '#/components/schemas/JiraIssueTemplateCreateRequestData' + $ref: "#/components/schemas/JiraIssueTemplateCreateRequestData" type: object JiraIssueTemplateCreateRequestAttributes: description: Attributes for creating a Jira issue template @@ -34648,22 +33200,22 @@ components: description: Custom fields for the Jira issue template example: description: - payload: Test - type: json + payload: "Test" + type: "json" type: object issue_type_id: description: The ID of the Jira issue type - example: '12730' + example: "12730" type: string jira-account: - $ref: '#/components/schemas/JiraIssueTemplateCreateRequestAttributesJiraAccount' + $ref: "#/components/schemas/JiraIssueTemplateCreateRequestAttributesJiraAccount" name: description: The name of the issue template - example: test-template + example: "test-template" type: string project_id: description: The ID of the Jira project - example: '10772' + example: "10772" type: string type: object JiraIssueTemplateCreateRequestAttributesJiraAccount: @@ -34671,38 +33223,38 @@ components: properties: id: description: The ID of the Jira account - example: 80f16d40-1fba-486e-b1fc-983e6ca19bec + example: "80f16d40-1fba-486e-b1fc-983e6ca19bec" format: uuid type: string required: - - id + - id type: object JiraIssueTemplateCreateRequestData: description: Data object for creating a Jira issue template properties: attributes: - $ref: '#/components/schemas/JiraIssueTemplateCreateRequestAttributes' + $ref: "#/components/schemas/JiraIssueTemplateCreateRequestAttributes" type: - $ref: '#/components/schemas/JiraIssueTemplateType' + $ref: "#/components/schemas/JiraIssueTemplateType" type: object JiraIssueTemplateData: description: Data object for a Jira issue template properties: attributes: - $ref: '#/components/schemas/JiraIssueTemplateDataAttributes' + $ref: "#/components/schemas/JiraIssueTemplateDataAttributes" id: description: Unique identifier for the Jira issue template - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string relationships: - $ref: '#/components/schemas/JiraIssueTemplateDataRelationships' + $ref: "#/components/schemas/JiraIssueTemplateDataRelationships" type: - $ref: '#/components/schemas/JiraIssueTemplateType' + $ref: "#/components/schemas/JiraIssueTemplateType" required: - - id - - type - - attributes + - id + - type + - attributes type: object JiraIssueTemplateDataAttributes: description: Attributes of a Jira issue template @@ -34712,60 +33264,60 @@ components: description: Custom fields for the Jira issue template example: description: - payload: Test Description - type: json + payload: "Test Description" + type: "json" type: object issue_type_id: description: The ID of the Jira issue type - example: '456' + example: "456" type: string name: description: The name of the issue template - example: Test Template + example: "Test Template" type: string project_id: description: The ID of the Jira project - example: '123' + example: "123" type: string required: - - name - - project_id - - issue_type_id - - fields + - name + - project_id + - issue_type_id + - fields type: object JiraIssueTemplateDataRelationships: description: Relationships of a Jira issue template properties: jira-account: - $ref: '#/components/schemas/JiraAccountRelationship' + $ref: "#/components/schemas/JiraAccountRelationship" required: - - jira-account + - jira-account type: object JiraIssueTemplateResponse: description: Response containing a single Jira issue template properties: data: - $ref: '#/components/schemas/JiraIssueTemplateData' + $ref: "#/components/schemas/JiraIssueTemplateData" included: - $ref: '#/components/schemas/JiraAccountsData' + $ref: "#/components/schemas/JiraAccountsData" required: - - data + - data type: object JiraIssueTemplateType: description: Type identifier for Jira issue template resources enum: - - jira-issue-template + - jira-issue-template example: jira-issue-template type: string x-enum-varnames: - - JIRA_ISSUE_TEMPLATE + - JIRA_ISSUE_TEMPLATE JiraIssueTemplateUpdateRequest: description: Request to update a Jira issue template properties: data: - $ref: '#/components/schemas/JiraIssueTemplateUpdateRequestData' + $ref: "#/components/schemas/JiraIssueTemplateUpdateRequestData" required: - - data + - data type: object JiraIssueTemplateUpdateRequestAttributes: description: Attributes for updating a Jira issue template @@ -34775,54 +33327,54 @@ components: description: Custom fields for the Jira issue template example: description: - payload: Updated Description - type: json + payload: "Updated Description" + type: "json" type: object name: description: The name of the issue template - example: test_template_updated + example: "test_template_updated" type: string type: object JiraIssueTemplateUpdateRequestData: description: Data object for updating a Jira issue template properties: attributes: - $ref: '#/components/schemas/JiraIssueTemplateUpdateRequestAttributes' + $ref: "#/components/schemas/JiraIssueTemplateUpdateRequestAttributes" type: - $ref: '#/components/schemas/JiraIssueTemplateType' + $ref: "#/components/schemas/JiraIssueTemplateType" required: - - type - - attributes + - type + - attributes type: object JiraIssueTemplatesData: description: Array of Jira issue template data objects items: - $ref: '#/components/schemas/JiraIssueTemplateData' + $ref: "#/components/schemas/JiraIssueTemplateData" type: array JiraIssueTemplatesResponse: description: Response containing Jira issue templates properties: data: - $ref: '#/components/schemas/JiraIssueTemplatesData' + $ref: "#/components/schemas/JiraIssueTemplatesData" included: - $ref: '#/components/schemas/JiraAccountsData' + $ref: "#/components/schemas/JiraAccountsData" required: - - data + - data type: object JiraIssuesDataType: default: jira_issues description: Jira issues resource type. enum: - - jira_issues + - jira_issues example: jira_issues type: string x-enum-varnames: - - JIRA_ISSUES + - JIRA_ISSUES JobCreateResponse: description: Run a threat hunting job response. properties: data: - $ref: '#/components/schemas/JobCreateResponseData' + $ref: "#/components/schemas/JobCreateResponseData" type: object JobCreateResponseData: description: The definition of `JobCreateResponseData` object. @@ -34831,7 +33383,7 @@ components: description: ID of the created job. type: string type: - $ref: '#/components/schemas/ThreatHuntingJobDataType' + $ref: "#/components/schemas/ThreatHuntingJobDataType" type: object JobDefinition: description: Definition of a threat hunting job. @@ -34839,12 +33391,12 @@ components: calculatedFields: description: Calculated fields. items: - $ref: '#/components/schemas/CalculatedField' + $ref: "#/components/schemas/CalculatedField" type: array cases: description: Cases used for generating job results. items: - $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate' + $ref: "#/components/schemas/SecurityMonitoringRuleCaseCreate" type: array from: description: Starting time of data analyzed by the job. @@ -34852,10 +33404,9 @@ components: format: int64 type: integer groupSignalsBy: - description: Additional grouping to perform on top of the existing groups - in the query section. Must be a subset of the existing groups. + description: Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups. example: - - service + - service items: description: Field to group by. type: string @@ -34873,16 +33424,16 @@ components: example: Excessive number of failed attempts. type: string options: - $ref: '#/components/schemas/ThreatHuntingJobOptions' + $ref: "#/components/schemas/ThreatHuntingJobOptions" queries: description: Queries for selecting logs analyzed by the job. items: - $ref: '#/components/schemas/ThreatHuntingJobQuery' + $ref: "#/components/schemas/ThreatHuntingJobQuery" type: array referenceTables: description: Reference tables used in the queries. items: - $ref: '#/components/schemas/SecurityMonitoringReferenceTable' + $ref: "#/components/schemas/SecurityMonitoringReferenceTable" type: array tags: description: Tags for generated signals. @@ -34890,11 +33441,10 @@ components: type: string type: array thirdPartyCases: - description: Cases for generating results from third-party detection method. - Only available for third-party detection method. + description: Cases for generating results from third-party detection method. Only available for third-party detection method. example: [] items: - $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate' + $ref: "#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate" type: array to: description: Ending time of data analyzed by the job. @@ -34905,17 +33455,16 @@ components: description: Job type. type: string required: - - from - - to - - index - - name - - cases - - queries - - message + - from + - to + - index + - name + - cases + - queries + - message type: object JobDefinitionFromRule: - description: Definition of a threat hunting job based on a security monitoring - rule. + description: Definition of a threat hunting job based on a security monitoring rule. properties: from: description: Starting time of data analyzed by the job. @@ -34933,7 +33482,7 @@ components: notifications: description: Notifications sent when the job is completed. example: - - '@sns-cloudtrail-results' + - "@sns-cloudtrail-results" items: type: string type: array @@ -34943,45 +33492,44 @@ components: format: int64 type: integer required: - - id - - from - - to - - index + - id + - from + - to + - index type: object JsonPatchOperation: description: A JSON Patch operation as per RFC 6902. properties: op: - $ref: '#/components/schemas/JsonPatchOperationOp' + $ref: "#/components/schemas/JsonPatchOperationOp" path: description: A JSON Pointer path (e.g., "/name", "/value/secure"). - example: /name + example: "/name" type: string value: - description: The value to use for the operation (not applicable for "remove" - and "test" operations). + description: The value to use for the operation (not applicable for "remove" and "test" operations). required: - - op - - path + - op + - path type: object JsonPatchOperationOp: description: The operation to perform. enum: - - add - - remove - - replace - - move - - copy - - test + - add + - remove + - replace + - move + - copy + - test example: add type: string x-enum-varnames: - - ADD - - REMOVE - - REPLACE - - MOVE - - COPY - - TEST + - ADD + - REMOVE + - REPLACE + - MOVE + - COPY + - TEST KindAttributes: description: Kind attributes. properties: @@ -34998,19 +33546,17 @@ components: type: string type: object KindData: - description: Schema that defines the structure of a Kind object in the Software - Catalog. + description: Schema that defines the structure of a Kind object in the Software Catalog. properties: attributes: - $ref: '#/components/schemas/KindAttributes' + $ref: "#/components/schemas/KindAttributes" id: - description: A read-only globally unique identifier for the entity generated - by Datadog. User supplied values are ignored. + description: A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored. example: 4b163705-23c0-4573-b2fb-f6cea2163fcb minLength: 1 type: string meta: - $ref: '#/components/schemas/KindMetadata' + $ref: "#/components/schemas/KindMetadata" type: description: Kind. type: string @@ -35032,29 +33578,26 @@ components: description: Short description of the kind. type: string displayName: - description: The display name of the kind. Automatically generated if not - provided. + description: The display name of the kind. Automatically generated if not provided. type: string kind: - description: The name of the kind to create or update. This must be in kebab-case - format. - example: my-job + description: The name of the kind to create or update. This must be in kebab-case format. + example: "my-job" type: string required: - - kind + - kind type: object KindRaw: description: Kind definition in raw JSON or YAML representation. - example: 'kind: service - + example: |- + kind: service displayName: Service - - description: A service entity in the catalog.' + description: A service entity in the catalog. type: string KindResponseData: description: List of kind responses. items: - $ref: '#/components/schemas/KindData' + $ref: "#/components/schemas/KindData" type: array KindResponseMeta: description: Kind response metadata. @@ -35084,17 +33627,17 @@ components: type: object name: description: Name of the dataset. - example: My LLM Dataset + example: "My LLM Dataset" type: string required: - - name + - name type: object LLMObsDatasetDataAttributesResponse: description: Attributes of an LLM Observability dataset. properties: created_at: description: Timestamp when the dataset was created. - example: '2024-01-15T10:30:00Z' + example: "2024-01-15T10:30:00Z" format: date-time type: string current_version: @@ -35104,7 +33647,7 @@ components: type: integer description: description: Description of the dataset. - example: '' + example: "" nullable: true type: string metadata: @@ -35114,68 +33657,68 @@ components: type: object name: description: Name of the dataset. - example: My LLM Dataset + example: "My LLM Dataset" type: string updated_at: description: Timestamp when the dataset was last updated. - example: '2024-01-15T10:30:00Z' + example: "2024-01-15T10:30:00Z" format: date-time type: string required: - - name - - description - - metadata - - current_version - - created_at - - updated_at + - name + - description + - metadata + - current_version + - created_at + - updated_at type: object LLMObsDatasetDataRequest: description: Data object for creating an LLM Observability dataset. properties: attributes: - $ref: '#/components/schemas/LLMObsDatasetDataAttributesRequest' + $ref: "#/components/schemas/LLMObsDatasetDataAttributesRequest" type: - $ref: '#/components/schemas/LLMObsDatasetType' + $ref: "#/components/schemas/LLMObsDatasetType" required: - - type - - attributes + - type + - attributes type: object LLMObsDatasetDataResponse: description: Data object for an LLM Observability dataset. properties: attributes: - $ref: '#/components/schemas/LLMObsDatasetDataAttributesResponse' + $ref: "#/components/schemas/LLMObsDatasetDataAttributesResponse" id: description: Unique identifier of the dataset. - example: 9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d + example: "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d" type: string type: - $ref: '#/components/schemas/LLMObsDatasetType' + $ref: "#/components/schemas/LLMObsDatasetType" required: - - id - - type - - attributes + - id + - type + - attributes type: object LLMObsDatasetRecordDataResponse: description: A single LLM Observability dataset record. properties: created_at: description: Timestamp when the record was created. - example: '2024-01-15T10:30:00Z' + example: "2024-01-15T10:30:00Z" format: date-time type: string dataset_id: description: Identifier of the dataset this record belongs to. - example: 9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d + example: "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d" type: string expected_output: - $ref: '#/components/schemas/AnyValue' + $ref: "#/components/schemas/AnyValue" id: description: Unique identifier of the record. - example: rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c + example: "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c" type: string input: - $ref: '#/components/schemas/AnyValue' + $ref: "#/components/schemas/AnyValue" metadata: additionalProperties: {} description: Arbitrary metadata associated with the record. @@ -35183,89 +33726,87 @@ components: type: object updated_at: description: Timestamp when the record was last updated. - example: '2024-01-15T10:30:00Z' + example: "2024-01-15T10:30:00Z" format: date-time type: string required: - - id - - dataset_id - - input - - expected_output - - metadata - - created_at - - updated_at + - id + - dataset_id + - input + - expected_output + - metadata + - created_at + - updated_at type: object LLMObsDatasetRecordItem: description: A single record to append to an LLM Observability dataset. properties: expected_output: - $ref: '#/components/schemas/AnyValue' + $ref: "#/components/schemas/AnyValue" input: - $ref: '#/components/schemas/AnyValue' + $ref: "#/components/schemas/AnyValue" metadata: additionalProperties: {} description: Arbitrary metadata associated with the record. type: object required: - - input + - input type: object LLMObsDatasetRecordUpdateItem: description: A record update payload for an LLM Observability dataset. properties: expected_output: - $ref: '#/components/schemas/AnyValue' + $ref: "#/components/schemas/AnyValue" id: description: Unique identifier of the record to update. - example: rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c + example: "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c" type: string input: - $ref: '#/components/schemas/AnyValue' + $ref: "#/components/schemas/AnyValue" metadata: additionalProperties: {} description: Updated metadata associated with the record. type: object required: - - id + - id type: object LLMObsDatasetRecordsDataAttributesRequest: description: Attributes for appending records to an LLM Observability dataset. properties: deduplicate: - description: Whether to deduplicate records before appending. Defaults to - `true`. + description: Whether to deduplicate records before appending. Defaults to `true`. type: boolean records: description: List of records to append to the dataset. items: - $ref: '#/components/schemas/LLMObsDatasetRecordItem' + $ref: "#/components/schemas/LLMObsDatasetRecordItem" type: array required: - - records + - records type: object LLMObsDatasetRecordsDataRequest: description: Data object for appending records to an LLM Observability dataset. properties: attributes: - $ref: '#/components/schemas/LLMObsDatasetRecordsDataAttributesRequest' + $ref: "#/components/schemas/LLMObsDatasetRecordsDataAttributesRequest" type: - $ref: '#/components/schemas/LLMObsRecordType' + $ref: "#/components/schemas/LLMObsRecordType" required: - - type - - attributes + - type + - attributes type: object LLMObsDatasetRecordsListResponse: - description: Response containing a paginated list of LLM Observability dataset - records. + description: Response containing a paginated list of LLM Observability dataset records. properties: data: description: List of dataset records. items: - $ref: '#/components/schemas/LLMObsDatasetRecordDataResponse' + $ref: "#/components/schemas/LLMObsDatasetRecordDataResponse" type: array meta: - $ref: '#/components/schemas/LLMObsCursorMeta' + $ref: "#/components/schemas/LLMObsCursorMeta" required: - - data + - data type: object LLMObsDatasetRecordsMutationData: description: Response containing records after a create or update operation. @@ -35273,10 +33814,10 @@ components: records: description: List of affected dataset records. items: - $ref: '#/components/schemas/LLMObsDatasetRecordDataResponse' + $ref: "#/components/schemas/LLMObsDatasetRecordDataResponse" type: array required: - - records + - records type: object LLMObsDatasetRecordsMutationResponse: description: Response containing records after a create or update operation. @@ -35284,18 +33825,18 @@ components: data: description: List of affected dataset records. items: - $ref: '#/components/schemas/LLMObsDatasetRecordsMutationData' + $ref: "#/components/schemas/LLMObsDatasetRecordsMutationData" type: array required: - - data + - data type: object LLMObsDatasetRecordsRequest: description: Request to append records to an LLM Observability dataset. properties: data: - $ref: '#/components/schemas/LLMObsDatasetRecordsDataRequest' + $ref: "#/components/schemas/LLMObsDatasetRecordsDataRequest" required: - - data + - data type: object LLMObsDatasetRecordsUpdateDataAttributesRequest: description: Attributes for updating records in an LLM Observability dataset. @@ -35303,54 +33844,54 @@ components: records: description: List of records to update. items: - $ref: '#/components/schemas/LLMObsDatasetRecordUpdateItem' + $ref: "#/components/schemas/LLMObsDatasetRecordUpdateItem" type: array required: - - records + - records type: object LLMObsDatasetRecordsUpdateDataRequest: description: Data object for updating records in an LLM Observability dataset. properties: attributes: - $ref: '#/components/schemas/LLMObsDatasetRecordsUpdateDataAttributesRequest' + $ref: "#/components/schemas/LLMObsDatasetRecordsUpdateDataAttributesRequest" type: - $ref: '#/components/schemas/LLMObsRecordType' + $ref: "#/components/schemas/LLMObsRecordType" required: - - type - - attributes + - type + - attributes type: object LLMObsDatasetRecordsUpdateRequest: description: Request to update records in an LLM Observability dataset. properties: data: - $ref: '#/components/schemas/LLMObsDatasetRecordsUpdateDataRequest' + $ref: "#/components/schemas/LLMObsDatasetRecordsUpdateDataRequest" required: - - data + - data type: object LLMObsDatasetRequest: description: Request to create an LLM Observability dataset. properties: data: - $ref: '#/components/schemas/LLMObsDatasetDataRequest' + $ref: "#/components/schemas/LLMObsDatasetDataRequest" required: - - data + - data type: object LLMObsDatasetResponse: description: Response containing a single LLM Observability dataset. properties: data: - $ref: '#/components/schemas/LLMObsDatasetDataResponse' + $ref: "#/components/schemas/LLMObsDatasetDataResponse" required: - - data + - data type: object LLMObsDatasetType: description: Resource type of an LLM Observability dataset. enum: - - datasets + - datasets example: datasets type: string x-enum-varnames: - - DATASETS + - DATASETS LLMObsDatasetUpdateDataAttributesRequest: description: Attributes for updating an LLM Observability dataset. properties: @@ -35369,20 +33910,20 @@ components: description: Data object for updating an LLM Observability dataset. properties: attributes: - $ref: '#/components/schemas/LLMObsDatasetUpdateDataAttributesRequest' + $ref: "#/components/schemas/LLMObsDatasetUpdateDataAttributesRequest" type: - $ref: '#/components/schemas/LLMObsDatasetType' + $ref: "#/components/schemas/LLMObsDatasetType" required: - - type - - attributes + - type + - attributes type: object LLMObsDatasetUpdateRequest: description: Request to partially update an LLM Observability dataset. properties: data: - $ref: '#/components/schemas/LLMObsDatasetUpdateDataRequest' + $ref: "#/components/schemas/LLMObsDatasetUpdateDataRequest" required: - - data + - data type: object LLMObsDatasetsResponse: description: Response containing a list of LLM Observability datasets. @@ -35390,12 +33931,12 @@ components: data: description: List of datasets. items: - $ref: '#/components/schemas/LLMObsDatasetDataResponse' + $ref: "#/components/schemas/LLMObsDatasetDataResponse" type: array meta: - $ref: '#/components/schemas/LLMObsCursorMeta' + $ref: "#/components/schemas/LLMObsCursorMeta" required: - - data + - data type: object LLMObsDeleteDatasetRecordsDataAttributesRequest: description: Attributes for deleting records from an LLM Observability dataset. @@ -35403,31 +33944,31 @@ components: record_ids: description: List of record IDs to delete. example: - - rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c + - "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c" items: type: string type: array required: - - record_ids + - record_ids type: object LLMObsDeleteDatasetRecordsDataRequest: description: Data object for deleting records from an LLM Observability dataset. properties: attributes: - $ref: '#/components/schemas/LLMObsDeleteDatasetRecordsDataAttributesRequest' + $ref: "#/components/schemas/LLMObsDeleteDatasetRecordsDataAttributesRequest" type: - $ref: '#/components/schemas/LLMObsRecordType' + $ref: "#/components/schemas/LLMObsRecordType" required: - - type - - attributes + - type + - attributes type: object LLMObsDeleteDatasetRecordsRequest: description: Request to delete records from an LLM Observability dataset. properties: data: - $ref: '#/components/schemas/LLMObsDeleteDatasetRecordsDataRequest' + $ref: "#/components/schemas/LLMObsDeleteDatasetRecordsDataRequest" required: - - data + - data type: object LLMObsDeleteDatasetsDataAttributesRequest: description: Attributes for deleting LLM Observability datasets. @@ -35435,31 +33976,31 @@ components: dataset_ids: description: List of dataset IDs to delete. example: - - 9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d + - "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d" items: type: string type: array required: - - dataset_ids + - dataset_ids type: object LLMObsDeleteDatasetsDataRequest: description: Data object for deleting LLM Observability datasets. properties: attributes: - $ref: '#/components/schemas/LLMObsDeleteDatasetsDataAttributesRequest' + $ref: "#/components/schemas/LLMObsDeleteDatasetsDataAttributesRequest" type: - $ref: '#/components/schemas/LLMObsDatasetType' + $ref: "#/components/schemas/LLMObsDatasetType" required: - - type - - attributes + - type + - attributes type: object LLMObsDeleteDatasetsRequest: description: Request to delete one or more LLM Observability datasets. properties: data: - $ref: '#/components/schemas/LLMObsDeleteDatasetsDataRequest' + $ref: "#/components/schemas/LLMObsDeleteDatasetsDataRequest" required: - - data + - data type: object LLMObsDeleteExperimentsDataAttributesRequest: description: Attributes for deleting LLM Observability experiments. @@ -35467,31 +34008,31 @@ components: experiment_ids: description: List of experiment IDs to delete. example: - - 3fd6b5e0-8910-4b1c-a7d0-5b84de329012 + - "3fd6b5e0-8910-4b1c-a7d0-5b84de329012" items: type: string type: array required: - - experiment_ids + - experiment_ids type: object LLMObsDeleteExperimentsDataRequest: description: Data object for deleting LLM Observability experiments. properties: attributes: - $ref: '#/components/schemas/LLMObsDeleteExperimentsDataAttributesRequest' + $ref: "#/components/schemas/LLMObsDeleteExperimentsDataAttributesRequest" type: - $ref: '#/components/schemas/LLMObsExperimentType' + $ref: "#/components/schemas/LLMObsExperimentType" required: - - type - - attributes + - type + - attributes type: object LLMObsDeleteExperimentsRequest: description: Request to delete one or more LLM Observability experiments. properties: data: - $ref: '#/components/schemas/LLMObsDeleteExperimentsDataRequest' + $ref: "#/components/schemas/LLMObsDeleteExperimentsDataRequest" required: - - data + - data type: object LLMObsDeleteProjectsDataAttributesRequest: description: Attributes for deleting LLM Observability projects. @@ -35499,40 +34040,40 @@ components: project_ids: description: List of project IDs to delete. example: - - a33671aa-24fd-4dcd-9b33-a8ec7dde7751 + - "a33671aa-24fd-4dcd-9b33-a8ec7dde7751" items: type: string type: array required: - - project_ids + - project_ids type: object LLMObsDeleteProjectsDataRequest: description: Data object for deleting LLM Observability projects. properties: attributes: - $ref: '#/components/schemas/LLMObsDeleteProjectsDataAttributesRequest' + $ref: "#/components/schemas/LLMObsDeleteProjectsDataAttributesRequest" type: - $ref: '#/components/schemas/LLMObsProjectType' + $ref: "#/components/schemas/LLMObsProjectType" required: - - type - - attributes + - type + - attributes type: object LLMObsDeleteProjectsRequest: description: Request to delete one or more LLM Observability projects. properties: data: - $ref: '#/components/schemas/LLMObsDeleteProjectsDataRequest' + $ref: "#/components/schemas/LLMObsDeleteProjectsDataRequest" required: - - data + - data type: object LLMObsEventType: description: Resource type for LLM Observability experiment events. enum: - - events + - events example: events type: string x-enum-varnames: - - EVENTS + - EVENTS LLMObsExperimentDataAttributesRequest: description: Attributes for creating an LLM Observability experiment. properties: @@ -35542,19 +34083,17 @@ components: type: object dataset_id: description: Identifier of the dataset used in this experiment. - example: 9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d + example: "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d" type: string dataset_version: - description: Version of the dataset to use. Defaults to the current version - if not specified. + description: Version of the dataset to use. Defaults to the current version if not specified. format: int64 type: integer description: description: Description of the experiment. type: string ensure_unique: - description: Whether to ensure the experiment name is unique. Defaults to - `true`. + description: Whether to ensure the experiment name is unique. Defaults to `true`. type: boolean metadata: additionalProperties: {} @@ -35562,16 +34101,16 @@ components: type: object name: description: Name of the experiment. - example: My Experiment v1 + example: "My Experiment v1" type: string project_id: description: Identifier of the project this experiment belongs to. - example: a33671aa-24fd-4dcd-9b33-a8ec7dde7751 + example: "a33671aa-24fd-4dcd-9b33-a8ec7dde7751" type: string required: - - project_id - - dataset_id - - name + - project_id + - dataset_id + - name type: object LLMObsExperimentDataAttributesResponse: description: Attributes of an LLM Observability experiment. @@ -35583,16 +34122,16 @@ components: type: object created_at: description: Timestamp when the experiment was created. - example: '2024-01-15T10:30:00Z' + example: "2024-01-15T10:30:00Z" format: date-time type: string dataset_id: description: Identifier of the dataset used in this experiment. - example: 9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d + example: "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d" type: string description: description: Description of the experiment. - example: '' + example: "" nullable: true type: string metadata: @@ -35602,53 +34141,53 @@ components: type: object name: description: Name of the experiment. - example: My Experiment v1 + example: "My Experiment v1" type: string project_id: description: Identifier of the project this experiment belongs to. - example: a33671aa-24fd-4dcd-9b33-a8ec7dde7751 + example: "a33671aa-24fd-4dcd-9b33-a8ec7dde7751" type: string updated_at: description: Timestamp when the experiment was last updated. - example: '2024-01-15T10:30:00Z' + example: "2024-01-15T10:30:00Z" format: date-time type: string required: - - project_id - - dataset_id - - name - - description - - metadata - - config - - created_at - - updated_at + - project_id + - dataset_id + - name + - description + - metadata + - config + - created_at + - updated_at type: object LLMObsExperimentDataRequest: description: Data object for creating an LLM Observability experiment. properties: attributes: - $ref: '#/components/schemas/LLMObsExperimentDataAttributesRequest' + $ref: "#/components/schemas/LLMObsExperimentDataAttributesRequest" type: - $ref: '#/components/schemas/LLMObsExperimentType' + $ref: "#/components/schemas/LLMObsExperimentType" required: - - type - - attributes + - type + - attributes type: object LLMObsExperimentDataResponse: description: Data object for an LLM Observability experiment. properties: attributes: - $ref: '#/components/schemas/LLMObsExperimentDataAttributesResponse' + $ref: "#/components/schemas/LLMObsExperimentDataAttributesResponse" id: description: Unique identifier of the experiment. - example: 3fd6b5e0-8910-4b1c-a7d0-5b84de329012 + example: "3fd6b5e0-8910-4b1c-a7d0-5b84de329012" type: string type: - $ref: '#/components/schemas/LLMObsExperimentType' + $ref: "#/components/schemas/LLMObsExperimentType" required: - - id - - type - - attributes + - id + - type + - attributes type: object LLMObsExperimentEventsDataAttributesRequest: description: Attributes for pushing experiment events including spans and metrics. @@ -35656,38 +34195,38 @@ components: metrics: description: List of metrics to push for the experiment. items: - $ref: '#/components/schemas/LLMObsExperimentMetric' + $ref: "#/components/schemas/LLMObsExperimentMetric" type: array spans: description: List of spans to push for the experiment. items: - $ref: '#/components/schemas/LLMObsExperimentSpan' + $ref: "#/components/schemas/LLMObsExperimentSpan" type: array type: object LLMObsExperimentEventsDataRequest: description: Data object for pushing experiment events. properties: attributes: - $ref: '#/components/schemas/LLMObsExperimentEventsDataAttributesRequest' + $ref: "#/components/schemas/LLMObsExperimentEventsDataAttributesRequest" type: - $ref: '#/components/schemas/LLMObsEventType' + $ref: "#/components/schemas/LLMObsEventType" required: - - type - - attributes + - type + - attributes type: object LLMObsExperimentEventsRequest: description: Request to push spans and metrics for an LLM Observability experiment. properties: data: - $ref: '#/components/schemas/LLMObsExperimentEventsDataRequest' + $ref: "#/components/schemas/LLMObsExperimentEventsDataRequest" required: - - data + - data type: object LLMObsExperimentMetric: description: A metric associated with an LLM Observability experiment span. properties: assessment: - $ref: '#/components/schemas/LLMObsMetricAssessment' + $ref: "#/components/schemas/LLMObsMetricAssessment" boolean_value: description: Boolean value. Used when `metric_type` is `boolean`. type: boolean @@ -35695,21 +34234,21 @@ components: description: Categorical value. Used when `metric_type` is `categorical`. type: string error: - $ref: '#/components/schemas/LLMObsExperimentMetricError' + $ref: "#/components/schemas/LLMObsExperimentMetricError" json_value: additionalProperties: {} description: JSON value. Used when `metric_type` is `json`. type: object label: description: Label or name for the metric. - example: faithfulness + example: "faithfulness" type: string metadata: additionalProperties: {} description: Arbitrary metadata associated with the metric. type: object metric_type: - $ref: '#/components/schemas/LLMObsMetricScoreType' + $ref: "#/components/schemas/LLMObsMetricScoreType" reasoning: description: Human-readable reasoning for the metric value. type: string @@ -35719,7 +34258,7 @@ components: type: number span_id: description: The ID of the span this metric measures. - example: span-7a1b2c3d + example: "span-7a1b2c3d" type: string tags: description: List of tags associated with the metric. @@ -35727,16 +34266,15 @@ components: type: string type: array timestamp_ms: - description: Timestamp when the metric was recorded, in milliseconds since - Unix epoch. + description: Timestamp when the metric was recorded, in milliseconds since Unix epoch. example: 1705314600000 format: int64 type: integer required: - - span_id - - metric_type - - timestamp_ms - - label + - span_id + - metric_type + - timestamp_ms + - label type: object LLMObsExperimentMetricError: description: Error details for an experiment metric evaluation. @@ -35749,24 +34287,24 @@ components: description: Request to create an LLM Observability experiment. properties: data: - $ref: '#/components/schemas/LLMObsExperimentDataRequest' + $ref: "#/components/schemas/LLMObsExperimentDataRequest" required: - - data + - data type: object LLMObsExperimentResponse: description: Response containing a single LLM Observability experiment. properties: data: - $ref: '#/components/schemas/LLMObsExperimentDataResponse' + $ref: "#/components/schemas/LLMObsExperimentDataResponse" required: - - data + - data type: object LLMObsExperimentSpan: description: A span associated with an LLM Observability experiment. properties: dataset_id: description: Dataset ID associated with this span. - example: 9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d + example: "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d" type: string duration: description: Duration of the span in nanoseconds. @@ -35774,18 +34312,18 @@ components: format: int64 type: integer meta: - $ref: '#/components/schemas/LLMObsExperimentSpanMeta' + $ref: "#/components/schemas/LLMObsExperimentSpanMeta" name: description: Name of the span. - example: llm_call + example: "llm_call" type: string project_id: description: Project ID associated with this span. - example: a33671aa-24fd-4dcd-9b33-a8ec7dde7751 + example: "a33671aa-24fd-4dcd-9b33-a8ec7dde7751" type: string span_id: description: Unique identifier of the span. - example: span-7a1b2c3d + example: "span-7a1b2c3d" type: string start_ns: description: Start time of the span in nanoseconds since Unix epoch. @@ -35793,7 +34331,7 @@ components: format: int64 type: integer status: - $ref: '#/components/schemas/LLMObsExperimentSpanStatus' + $ref: "#/components/schemas/LLMObsExperimentSpanStatus" tags: description: List of tags associated with the span. items: @@ -35801,69 +34339,66 @@ components: type: array trace_id: description: Trace ID for the span. - example: abc123def456 + example: "abc123def456" type: string required: - - trace_id - - span_id - - project_id - - dataset_id - - name - - start_ns - - duration - - status + - trace_id + - span_id + - project_id + - dataset_id + - name + - start_ns + - duration + - status type: object LLMObsExperimentSpanError: description: Error details for an experiment span. properties: message: description: Error message. - example: Model response timed out + example: "Model response timed out" type: string stack: description: Stack trace of the error. - example: "Traceback (most recent call last):\n File \"main.py\", line 10, - in \n response = model.generate(input)\n File \"model.py\", - line 45, in generate\n raise TimeoutError(\"Model response timed out\")\nTimeoutError: - Model response timed out" + example: "Traceback (most recent call last):\n File \"main.py\", line 10, in \n response = model.generate(input)\n File \"model.py\", line 45, in generate\n raise TimeoutError(\"Model response timed out\")\nTimeoutError: Model response timed out" type: string type: description: The error type or exception class name. - example: TimeoutError + example: "TimeoutError" type: string type: object LLMObsExperimentSpanMeta: description: Metadata associated with an experiment span. properties: error: - $ref: '#/components/schemas/LLMObsExperimentSpanError' + $ref: "#/components/schemas/LLMObsExperimentSpanError" expected_output: additionalProperties: {} description: Expected output for the span, used for evaluation. type: object input: - $ref: '#/components/schemas/AnyValue' + $ref: "#/components/schemas/AnyValue" output: - $ref: '#/components/schemas/AnyValue' + $ref: "#/components/schemas/AnyValue" type: object LLMObsExperimentSpanStatus: description: Status of the span. enum: - - ok - - error - example: ok + - ok + - error + example: "ok" type: string x-enum-varnames: - - OK - - ERROR + - OK + - ERROR LLMObsExperimentType: description: Resource type of an LLM Observability experiment. enum: - - experiments + - experiments example: experiments type: string x-enum-varnames: - - EXPERIMENTS + - EXPERIMENTS LLMObsExperimentUpdateDataAttributesRequest: description: Attributes for updating an LLM Observability experiment. properties: @@ -35878,20 +34413,20 @@ components: description: Data object for updating an LLM Observability experiment. properties: attributes: - $ref: '#/components/schemas/LLMObsExperimentUpdateDataAttributesRequest' + $ref: "#/components/schemas/LLMObsExperimentUpdateDataAttributesRequest" type: - $ref: '#/components/schemas/LLMObsExperimentType' + $ref: "#/components/schemas/LLMObsExperimentType" required: - - type - - attributes + - type + - attributes type: object LLMObsExperimentUpdateRequest: description: Request to partially update an LLM Observability experiment. properties: data: - $ref: '#/components/schemas/LLMObsExperimentUpdateDataRequest' + $ref: "#/components/schemas/LLMObsExperimentUpdateDataRequest" required: - - data + - data type: object LLMObsExperimentsResponse: description: Response containing a list of LLM Observability experiments. @@ -35899,37 +34434,37 @@ components: data: description: List of experiments. items: - $ref: '#/components/schemas/LLMObsExperimentDataResponse' + $ref: "#/components/schemas/LLMObsExperimentDataResponse" type: array meta: - $ref: '#/components/schemas/LLMObsCursorMeta' + $ref: "#/components/schemas/LLMObsCursorMeta" required: - - data + - data type: object LLMObsMetricAssessment: description: Assessment result for an LLM Observability experiment metric. enum: - - pass - - fail + - pass + - fail example: pass type: string x-enum-varnames: - - PASS - - FAIL + - PASS + - FAIL LLMObsMetricScoreType: description: Type of metric recorded for an LLM Observability experiment. enum: - - score - - categorical - - boolean - - json + - score + - categorical + - boolean + - json example: score type: string x-enum-varnames: - - SCORE - - CATEGORICAL - - BOOLEAN - - JSON + - SCORE + - CATEGORICAL + - BOOLEAN + - JSON LLMObsProjectDataAttributesRequest: description: Attributes for creating an LLM Observability project. properties: @@ -35938,90 +34473,90 @@ components: type: string name: description: Name of the project. - example: My LLM Project + example: "My LLM Project" type: string required: - - name + - name type: object LLMObsProjectDataAttributesResponse: description: Attributes of an LLM Observability project. properties: created_at: description: Timestamp when the project was created. - example: '2024-01-15T10:30:00Z' + example: "2024-01-15T10:30:00Z" format: date-time type: string description: description: Description of the project. - example: '' + example: "" nullable: true type: string name: description: Name of the project. - example: My LLM Project + example: "My LLM Project" type: string updated_at: description: Timestamp when the project was last updated. - example: '2024-01-15T10:30:00Z' + example: "2024-01-15T10:30:00Z" format: date-time type: string required: - - name - - description - - created_at - - updated_at + - name + - description + - created_at + - updated_at type: object LLMObsProjectDataRequest: description: Data object for creating an LLM Observability project. properties: attributes: - $ref: '#/components/schemas/LLMObsProjectDataAttributesRequest' + $ref: "#/components/schemas/LLMObsProjectDataAttributesRequest" type: - $ref: '#/components/schemas/LLMObsProjectType' + $ref: "#/components/schemas/LLMObsProjectType" required: - - type - - attributes + - type + - attributes type: object LLMObsProjectDataResponse: description: Data object for an LLM Observability project. properties: attributes: - $ref: '#/components/schemas/LLMObsProjectDataAttributesResponse' + $ref: "#/components/schemas/LLMObsProjectDataAttributesResponse" id: description: Unique identifier of the project. - example: a33671aa-24fd-4dcd-9b33-a8ec7dde7751 + example: "a33671aa-24fd-4dcd-9b33-a8ec7dde7751" type: string type: - $ref: '#/components/schemas/LLMObsProjectType' + $ref: "#/components/schemas/LLMObsProjectType" required: - - id - - type - - attributes + - id + - type + - attributes type: object LLMObsProjectRequest: description: Request to create an LLM Observability project. properties: data: - $ref: '#/components/schemas/LLMObsProjectDataRequest' + $ref: "#/components/schemas/LLMObsProjectDataRequest" required: - - data + - data type: object LLMObsProjectResponse: description: Response containing a single LLM Observability project. properties: data: - $ref: '#/components/schemas/LLMObsProjectDataResponse' + $ref: "#/components/schemas/LLMObsProjectDataResponse" required: - - data + - data type: object LLMObsProjectType: description: Resource type of an LLM Observability project. enum: - - projects + - projects example: projects type: string x-enum-varnames: - - PROJECTS + - PROJECTS LLMObsProjectUpdateDataAttributesRequest: description: Attributes for updating an LLM Observability project. properties: @@ -36036,20 +34571,20 @@ components: description: Data object for updating an LLM Observability project. properties: attributes: - $ref: '#/components/schemas/LLMObsProjectUpdateDataAttributesRequest' + $ref: "#/components/schemas/LLMObsProjectUpdateDataAttributesRequest" type: - $ref: '#/components/schemas/LLMObsProjectType' + $ref: "#/components/schemas/LLMObsProjectType" required: - - type - - attributes + - type + - attributes type: object LLMObsProjectUpdateRequest: description: Request to partially update an LLM Observability project. properties: data: - $ref: '#/components/schemas/LLMObsProjectUpdateDataRequest' + $ref: "#/components/schemas/LLMObsProjectUpdateDataRequest" required: - - data + - data type: object LLMObsProjectsResponse: description: Response containing a list of LLM Observability projects. @@ -36057,70 +34592,70 @@ components: data: description: List of projects. items: - $ref: '#/components/schemas/LLMObsProjectDataResponse' + $ref: "#/components/schemas/LLMObsProjectDataResponse" type: array meta: - $ref: '#/components/schemas/LLMObsCursorMeta' + $ref: "#/components/schemas/LLMObsCursorMeta" required: - - data + - data type: object LLMObsRecordType: description: Resource type of LLM Observability dataset records. enum: - - records + - records example: records type: string x-enum-varnames: - - RECORDS + - RECORDS Language: description: Programming language enum: - - PYTHON - - JAVASCRIPT - - TYPESCRIPT - - JAVA - - GO - - YAML - - RUBY - - CSHARP - - PHP - - KOTLIN - - SWIFT + - PYTHON + - JAVASCRIPT + - TYPESCRIPT + - JAVA + - GO + - YAML + - RUBY + - CSHARP + - PHP + - KOTLIN + - SWIFT example: PYTHON type: string x-enum-varnames: - - PYTHON - - JAVASCRIPT - - TYPESCRIPT - - JAVA - - GO - - YAML - - RUBY - - CSHARP - - PHP - - KOTLIN - - SWIFT + - PYTHON + - JAVASCRIPT + - TYPESCRIPT + - JAVA + - GO + - YAML + - RUBY + - CSHARP + - PHP + - KOTLIN + - SWIFT LaunchDarklyAPIKey: description: The definition of the `LaunchDarklyAPIKey` object. properties: api_token: description: The `LaunchDarklyAPIKey` `api_token`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/LaunchDarklyAPIKeyType' + $ref: "#/components/schemas/LaunchDarklyAPIKeyType" required: - - type - - api_token + - type + - api_token type: object LaunchDarklyAPIKeyType: description: The definition of the `LaunchDarklyAPIKey` object. enum: - - LaunchDarklyAPIKey + - LaunchDarklyAPIKey example: LaunchDarklyAPIKey type: string x-enum-varnames: - - LAUNCHDARKLYAPIKEY + - LAUNCHDARKLYAPIKEY LaunchDarklyAPIKeyUpdate: description: The definition of the `LaunchDarklyAPIKey` object. properties: @@ -36128,66 +34663,64 @@ components: description: The `LaunchDarklyAPIKeyUpdate` `api_token`. type: string type: - $ref: '#/components/schemas/LaunchDarklyAPIKeyType' + $ref: "#/components/schemas/LaunchDarklyAPIKeyType" required: - - type + - type type: object LaunchDarklyCredentials: description: The definition of the `LaunchDarklyCredentials` object. oneOf: - - $ref: '#/components/schemas/LaunchDarklyAPIKey' + - $ref: "#/components/schemas/LaunchDarklyAPIKey" LaunchDarklyCredentialsUpdate: description: The definition of the `LaunchDarklyCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/LaunchDarklyAPIKeyUpdate' + - $ref: "#/components/schemas/LaunchDarklyAPIKeyUpdate" LaunchDarklyIntegration: description: The definition of the `LaunchDarklyIntegration` object. properties: credentials: - $ref: '#/components/schemas/LaunchDarklyCredentials' + $ref: "#/components/schemas/LaunchDarklyCredentials" type: - $ref: '#/components/schemas/LaunchDarklyIntegrationType' + $ref: "#/components/schemas/LaunchDarklyIntegrationType" required: - - type - - credentials + - type + - credentials type: object LaunchDarklyIntegrationType: description: The definition of the `LaunchDarklyIntegrationType` object. enum: - - LaunchDarkly + - LaunchDarkly example: LaunchDarkly type: string x-enum-varnames: - - LAUNCHDARKLY + - LAUNCHDARKLY LaunchDarklyIntegrationUpdate: description: The definition of the `LaunchDarklyIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/LaunchDarklyCredentialsUpdate' + $ref: "#/components/schemas/LaunchDarklyCredentialsUpdate" type: - $ref: '#/components/schemas/LaunchDarklyIntegrationType' + $ref: "#/components/schemas/LaunchDarklyIntegrationType" required: - - type + - type type: object Layer: - description: Encapsulates a layer resource, holding attributes like rotation - details, plus relationships to the members covering that layer. + description: Encapsulates a layer resource, holding attributes like rotation details, plus relationships to the members covering that layer. properties: attributes: - $ref: '#/components/schemas/LayerAttributes' + $ref: "#/components/schemas/LayerAttributes" id: description: A unique identifier for this layer. type: string relationships: - $ref: '#/components/schemas/LayerRelationships' + $ref: "#/components/schemas/LayerRelationships" type: - $ref: '#/components/schemas/LayerType' + $ref: "#/components/schemas/LayerType" required: - - type + - type type: object LayerAttributes: - description: Describes key properties of a Layer, including rotation details, - name, start/end times, and any restrictions. + description: Describes key properties of a Layer, including rotation details, name, start/end times, and any restrictions. properties: effective_date: description: When the layer becomes active (ISO 8601). @@ -36198,16 +34731,15 @@ components: format: date-time type: string interval: - $ref: '#/components/schemas/LayerAttributesInterval' + $ref: "#/components/schemas/LayerAttributesInterval" name: description: The name of this layer. example: Weekend Layer type: string restrictions: - description: An optional list of time restrictions for when this layer is - in effect. + description: An optional list of time restrictions for when this layer is in effect. items: - $ref: '#/components/schemas/TimeRestriction' + $ref: "#/components/schemas/TimeRestriction" type: array rotation_start: description: The date/time when the rotation starts (ISO 8601). @@ -36215,12 +34747,11 @@ components: type: string time_zone: description: The time zone for this layer. - example: America/New_York + example: "America/New_York" type: string type: object LayerAttributesInterval: - description: Defines how often the rotation repeats, using a combination of - days and optional seconds. Should be at least 1 hour. + description: Defines how often the rotation repeats, using a combination of days and optional seconds. Should be at least 1 hour. properties: days: description: The number of days in each rotation cycle. @@ -36236,101 +34767,99 @@ components: type: integer type: object LayerRelationships: - description: Holds references to objects related to the Layer entity, such as - its members. + description: Holds references to objects related to the Layer entity, such as its members. properties: members: - $ref: '#/components/schemas/LayerRelationshipsMembers' + $ref: "#/components/schemas/LayerRelationshipsMembers" type: object LayerRelationshipsMembers: - description: Holds an array of references to the members of a Layer, each containing - member IDs. + description: Holds an array of references to the members of a Layer, each containing member IDs. properties: data: description: The list of members who belong to this layer. items: - $ref: '#/components/schemas/LayerRelationshipsMembersDataItems' + $ref: "#/components/schemas/LayerRelationshipsMembersDataItems" type: array type: object LayerRelationshipsMembersDataItems: - description: 'Represents a single member object in a layer''s `members` array, - referencing - - a unique Datadog user ID.' + description: |- + Represents a single member object in a layer's `members` array, referencing + a unique Datadog user ID. properties: id: description: The unique user ID of the layer member. - example: 00000000-0000-0000-0000-000000000002 + example: "00000000-0000-0000-0000-000000000002" type: string type: - $ref: '#/components/schemas/LayerRelationshipsMembersDataItemsType' + $ref: "#/components/schemas/LayerRelationshipsMembersDataItemsType" required: - - type - - id + - type + - id type: object LayerRelationshipsMembersDataItemsType: default: members - description: Members resource type. + description: |- + Members resource type. enum: - - members + - members example: members type: string x-enum-varnames: - - MEMBERS + - MEMBERS LayerType: default: layers - description: Layers resource type. + description: |- + Layers resource type. enum: - - layers + - layers example: layers type: string x-enum-varnames: - - LAYERS + - LAYERS LeakedKey: description: The definition of LeakedKey object. properties: attributes: - $ref: '#/components/schemas/LeakedKeyAttributes' + $ref: "#/components/schemas/LeakedKeyAttributes" id: description: The LeakedKey id. - example: id + example: "id" type: string type: - $ref: '#/components/schemas/LeakedKeyType' + $ref: "#/components/schemas/LeakedKeyType" required: - - attributes - - id - - type + - attributes + - id + - type type: object LeakedKeyAttributes: description: The definition of LeakedKeyAttributes object. properties: date: description: The LeakedKeyAttributes date. - example: '2017-07-21T17:32:28Z' + example: "2017-07-21T17:32:28Z" format: date-time type: string leak_source: description: The LeakedKeyAttributes leak_source. type: string required: - - date + - date type: object LeakedKeyType: default: leaked_keys description: The definition of LeakedKeyType object. enum: - - leaked_keys + - leaked_keys example: leaked_keys type: string x-enum-varnames: - - LEAKED_KEYS + - LEAKED_KEYS Library: description: Vulnerability library. properties: additional_names: - description: Related library or package names (such as child packages or - affected binary paths). + description: Related library or package names (such as child packages or affected binary paths). items: example: linux-tools-common type: string @@ -36344,35 +34873,35 @@ components: example: 5.15.0 type: string required: - - name + - name type: object Links: description: The JSON:API links related to pagination. properties: first: description: First page link. - example: https://api.datadoghq.com/api/v2/security/vulnerabilities?page%5Bnumber%5D=1&page%5Btoken%5D=b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4 + example: "https://api.datadoghq.com/api/v2/security/vulnerabilities?page%5Bnumber%5D=1&page%5Btoken%5D=b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4" type: string last: description: Last page link. - example: https://api.datadoghq.com/api/v2/security/vulnerabilities?page%5Bnumber%5D=15&page%5Btoken%5D=b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4 + example: "https://api.datadoghq.com/api/v2/security/vulnerabilities?page%5Bnumber%5D=15&page%5Btoken%5D=b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4" type: string next: description: Next page link. - example: https://api.datadoghq.com/api/v2/security/vulnerabilities?page%5Bnumber%5D=16&page%5Btoken%5D=b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4 + example: "https://api.datadoghq.com/api/v2/security/vulnerabilities?page%5Bnumber%5D=16&page%5Btoken%5D=b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4" type: string previous: description: Previous page link. - example: https://api.datadoghq.com/api/v2/security/vulnerabilities?page%5Bnumber%5D=14&page%5Btoken%5D=b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4 + example: "https://api.datadoghq.com/api/v2/security/vulnerabilities?page%5Bnumber%5D=14&page%5Btoken%5D=b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4" type: string self: description: Request link. example: https://api.datadoghq.com/api/v2/security/vulnerabilities?filter%5Btool%5D=Infra type: string required: - - self - - first - - last + - self + - first + - last type: object ListAPIsResponse: description: Response for `ListAPIs`. @@ -36380,32 +34909,32 @@ components: data: description: List of API items. items: - $ref: '#/components/schemas/ListAPIsResponseData' + $ref: "#/components/schemas/ListAPIsResponseData" type: array meta: - $ref: '#/components/schemas/ListAPIsResponseMeta' + $ref: "#/components/schemas/ListAPIsResponseMeta" type: object ListAPIsResponseData: description: Data envelope for `ListAPIsResponse`. properties: attributes: - $ref: '#/components/schemas/ListAPIsResponseDataAttributes' + $ref: "#/components/schemas/ListAPIsResponseDataAttributes" id: - $ref: '#/components/schemas/ApiID' + $ref: "#/components/schemas/ApiID" type: object ListAPIsResponseDataAttributes: description: Attributes for `ListAPIsResponseData`. properties: name: description: API name. - example: Payments API + example: "Payments API" type: string type: object ListAPIsResponseMeta: description: Metadata for `ListAPIsResponse`. properties: pagination: - $ref: '#/components/schemas/ListAPIsResponseMetaPagination' + $ref: "#/components/schemas/ListAPIsResponseMetaPagination" type: object ListAPIsResponseMetaPagination: description: Pagination metadata information for `ListAPIsResponse`. @@ -36432,10 +34961,10 @@ components: data: description: An array of app key registrations. items: - $ref: '#/components/schemas/AppKeyRegistrationData' + $ref: "#/components/schemas/AppKeyRegistrationData" type: array meta: - $ref: '#/components/schemas/ListAppKeyRegistrationsResponseMeta' + $ref: "#/components/schemas/ListAppKeyRegistrationsResponseMeta" type: object ListAppKeyRegistrationsResponseMeta: description: The definition of `ListAppKeyRegistrationsResponseMeta` object. @@ -36446,8 +34975,7 @@ components: format: int64 type: integer total_filtered: - description: The total number of app key registrations that match the specified - filters. + description: The total number of app key registrations that match the specified filters. example: 1 format: int64 type: integer @@ -36458,15 +34986,15 @@ components: data: description: Array of application keys. items: - $ref: '#/components/schemas/PartialApplicationKey' + $ref: "#/components/schemas/PartialApplicationKey" type: array included: description: Array of objects related to the application key. items: - $ref: '#/components/schemas/ApplicationKeyResponseIncludedItem' + $ref: "#/components/schemas/ApplicationKeyResponseIncludedItem" type: array meta: - $ref: '#/components/schemas/ApplicationKeyResponseMeta' + $ref: "#/components/schemas/ApplicationKeyResponseMeta" type: object ListAppsResponse: description: A paginated list of apps matching the specified filters and sorting. @@ -36474,41 +35002,39 @@ components: data: description: An array of app definitions. items: - $ref: '#/components/schemas/ListAppsResponseDataItems' + $ref: "#/components/schemas/ListAppsResponseDataItems" type: array included: description: Data on the version of the app that was published. items: - $ref: '#/components/schemas/Deployment' + $ref: "#/components/schemas/Deployment" type: array meta: - $ref: '#/components/schemas/ListAppsResponseMeta' + $ref: "#/components/schemas/ListAppsResponseMeta" type: object ListAppsResponseDataItems: - description: An app definition object. This contains only basic information - about the app such as ID, name, and tags. + description: An app definition object. This contains only basic information about the app such as ID, name, and tags. properties: attributes: - $ref: '#/components/schemas/ListAppsResponseDataItemsAttributes' + $ref: "#/components/schemas/ListAppsResponseDataItemsAttributes" id: description: The ID of the app. example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 format: uuid type: string meta: - $ref: '#/components/schemas/AppMeta' + $ref: "#/components/schemas/AppMeta" relationships: - $ref: '#/components/schemas/ListAppsResponseDataItemsRelationships' + $ref: "#/components/schemas/ListAppsResponseDataItemsRelationships" type: - $ref: '#/components/schemas/AppDefinitionType' + $ref: "#/components/schemas/AppDefinitionType" required: - - id - - type - - attributes + - id + - type + - attributes type: object ListAppsResponseDataItemsAttributes: - description: Basic information about the app such as name, description, and - tags. + description: Basic information about the app such as name, description, and tags. properties: description: description: A human-readable description for the app. @@ -36520,14 +35046,13 @@ components: description: The name of the app. type: string selfService: - description: Whether the app is enabled for use in the Datadog self-service - hub. + description: Whether the app is enabled for use in the Datadog self-service hub. type: boolean tags: description: A list of tags for the app, which can be used to filter apps. example: - - service:webshop-backend - - team:webshop + - "service:webshop-backend" + - "team:webshop" items: description: An individual tag for the app. type: string @@ -36537,20 +35062,19 @@ components: description: The app's publication information. properties: deployment: - $ref: '#/components/schemas/DeploymentRelationship' + $ref: "#/components/schemas/DeploymentRelationship" type: object ListAppsResponseMeta: description: Pagination metadata. properties: page: - $ref: '#/components/schemas/ListAppsResponseMetaPage' + $ref: "#/components/schemas/ListAppsResponseMetaPage" type: object ListAppsResponseMetaPage: description: Information on the total number of apps, to be used for pagination. properties: totalCount: - description: The total number of apps under the Datadog organization, disregarding - any filters applied. + description: The total number of apps under the Datadog organization, disregarding any filters applied. format: int64 type: integer totalFilteredCount: @@ -36564,68 +35088,68 @@ components: data: description: List of assets SBOMs. items: - $ref: '#/components/schemas/SBOM' + $ref: "#/components/schemas/SBOM" type: array links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" meta: - $ref: '#/components/schemas/Metadata' + $ref: "#/components/schemas/Metadata" required: - - data + - data type: object ListConnectionsResponse: example: data: attributes: connections: - - created_at: '0001-01-01T00:00:00Z' - created_by: 00000000-0000-0000-0000-000000000000 - fields: - - description: Customer subscription tier - display_name: Customer Tier - groups: - - Business - - Subscription - id: customer_tier - source_name: subscription_tier - type: string - - description: Channel through which user signed up - display_name: Signup Source - groups: - - Marketing - - Attribution - id: signup_source - source_name: acquisition_channel - type: string - id: user-profiles-connection - join: - attribute: user_email - type: email - type: ref_table - updated_at: '0001-01-01T00:00:00Z' - updated_by: 00000000-0000-0000-0000-000000000000 + - created_at: "0001-01-01T00:00:00Z" + created_by: 00000000-0000-0000-0000-000000000000 + fields: + - description: Customer subscription tier + display_name: Customer Tier + groups: + - Business + - Subscription + id: customer_tier + source_name: subscription_tier + type: string + - description: Channel through which user signed up + display_name: Signup Source + groups: + - Marketing + - Attribution + id: signup_source + source_name: acquisition_channel + type: string + id: user-profiles-connection + join: + attribute: user_email + type: email + type: ref_table + updated_at: "0001-01-01T00:00:00Z" + updated_by: 00000000-0000-0000-0000-000000000000 id: list_connections_response type: list_connections_response properties: data: - $ref: '#/components/schemas/ListConnectionsResponseData' + $ref: "#/components/schemas/ListConnectionsResponseData" type: object ListConnectionsResponseData: properties: attributes: - $ref: '#/components/schemas/ListConnectionsResponseDataAttributes' + $ref: "#/components/schemas/ListConnectionsResponseDataAttributes" id: type: string type: - $ref: '#/components/schemas/ListConnectionsResponseDataType' + $ref: "#/components/schemas/ListConnectionsResponseDataType" required: - - type + - type type: object ListConnectionsResponseDataAttributes: properties: connections: items: - $ref: '#/components/schemas/ListConnectionsResponseDataAttributesConnectionsItems' + $ref: "#/components/schemas/ListConnectionsResponseDataAttributesConnectionsItems" type: array type: object ListConnectionsResponseDataAttributesConnectionsItems: @@ -36637,12 +35161,12 @@ components: type: string fields: items: - $ref: '#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems' + $ref: "#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems" type: array id: type: string join: - $ref: '#/components/schemas/ListConnectionsResponseDataAttributesConnectionsItemsJoin' + $ref: "#/components/schemas/ListConnectionsResponseDataAttributesConnectionsItemsJoin" metadata: additionalProperties: type: string @@ -36666,40 +35190,40 @@ components: default: list_connections_response description: List connections response resource type. enum: - - list_connections_response + - list_connections_response example: list_connections_response type: string x-enum-varnames: - - LIST_CONNECTIONS_RESPONSE + - LIST_CONNECTIONS_RESPONSE ListDeploymentRuleResponseData: description: Data for a list of deployment rules. properties: attributes: - $ref: '#/components/schemas/ListDeploymentRulesResponseDataAttributes' + $ref: "#/components/schemas/ListDeploymentRulesResponseDataAttributes" id: description: Unique identifier of the deployment rule. - example: 1111-2222-3333-4444-555566667777 + example: "1111-2222-3333-4444-555566667777" type: string type: - $ref: '#/components/schemas/ListDeploymentRulesDataType' + $ref: "#/components/schemas/ListDeploymentRulesDataType" required: - - type - - attributes - - id + - type + - attributes + - id type: object ListDeploymentRulesDataType: description: List deployment rule resource type. enum: - - list_deployment_rules + - list_deployment_rules example: list_deployment_rules type: string x-enum-varnames: - - LIST_DEPLOYMENT_RULES + - LIST_DEPLOYMENT_RULES ListDeploymentRulesResponseDataAttributes: properties: rules: items: - $ref: '#/components/schemas/DeploymentRuleResponseDataAttributes' + $ref: "#/components/schemas/DeploymentRuleResponseDataAttributes" type: array type: object ListDevicesResponse: @@ -36708,16 +35232,16 @@ components: data: description: The list devices response data. items: - $ref: '#/components/schemas/DevicesListData' + $ref: "#/components/schemas/DevicesListData" type: array meta: - $ref: '#/components/schemas/ListDevicesResponseMetadata' + $ref: "#/components/schemas/ListDevicesResponseMetadata" type: object ListDevicesResponseMetadata: description: Object describing meta attributes of response. properties: page: - $ref: '#/components/schemas/ListDevicesResponseMetadataPage' + $ref: "#/components/schemas/ListDevicesResponseMetadataPage" type: object ListDevicesResponseMetadataPage: description: Pagination object. @@ -36734,41 +35258,41 @@ components: data: description: An array of downtimes. items: - $ref: '#/components/schemas/DowntimeResponseData' + $ref: "#/components/schemas/DowntimeResponseData" type: array included: description: Array of objects related to the downtimes. items: - $ref: '#/components/schemas/DowntimeResponseIncludedItem' + $ref: "#/components/schemas/DowntimeResponseIncludedItem" type: array meta: - $ref: '#/components/schemas/DowntimeMeta' + $ref: "#/components/schemas/DowntimeMeta" type: object ListEntityCatalogResponse: description: List entity response. properties: data: - $ref: '#/components/schemas/EntityResponseData' + $ref: "#/components/schemas/EntityResponseData" included: - $ref: '#/components/schemas/ListEntityCatalogResponseIncluded' + $ref: "#/components/schemas/ListEntityCatalogResponseIncluded" links: - $ref: '#/components/schemas/ListEntityCatalogResponseLinks' + $ref: "#/components/schemas/ListEntityCatalogResponseLinks" meta: - $ref: '#/components/schemas/EntityResponseMeta' + $ref: "#/components/schemas/EntityResponseMeta" type: object ListEntityCatalogResponseIncluded: description: List entity response included. items: - $ref: '#/components/schemas/ListEntityCatalogResponseIncludedItem' + $ref: "#/components/schemas/ListEntityCatalogResponseIncludedItem" type: array ListEntityCatalogResponseIncludedItem: description: List entity response included item. oneOf: - - $ref: '#/components/schemas/EntityResponseIncludedSchema' - - $ref: '#/components/schemas/EntityResponseIncludedRawSchema' - - $ref: '#/components/schemas/EntityResponseIncludedRelatedEntity' - - $ref: '#/components/schemas/EntityResponseIncludedOncall' - - $ref: '#/components/schemas/EntityResponseIncludedIncident' + - $ref: "#/components/schemas/EntityResponseIncludedSchema" + - $ref: "#/components/schemas/EntityResponseIncludedRawSchema" + - $ref: "#/components/schemas/EntityResponseIncludedRelatedEntity" + - $ref: "#/components/schemas/EntityResponseIncludedOncall" + - $ref: "#/components/schemas/EntityResponseIncludedIncident" ListEntityCatalogResponseLinks: description: List entity response links. properties: @@ -36785,14 +35309,14 @@ components: ListFindingsData: description: Array of findings. items: - $ref: '#/components/schemas/Finding' + $ref: "#/components/schemas/Finding" type: array ListFindingsMeta: additionalProperties: false description: Metadata for pagination. properties: page: - $ref: '#/components/schemas/ListFindingsPage' + $ref: "#/components/schemas/ListFindingsPage" snapshot_timestamp: description: The point in time corresponding to the listed findings. example: 1678721573794 @@ -36806,7 +35330,7 @@ components: properties: cursor: description: The cursor used to paginate requests. - example: eyJhZnRlciI6IkFRQUFBWWJiaEJXQS1OY1dqUUFBQUFCQldXSmlhRUpYUVVGQlJFSktkbTlDTUdaWFRVbDNRVUUiLCJ2YWx1ZXMiOlsiY3JpdGljYWwiXX0= + example: "eyJhZnRlciI6IkFRQUFBWWJiaEJXQS1OY1dqUUFBQUFCQldXSmlhRUpYUVVGQlJFSktkbTlDTUdaWFRVbDNRVUUiLCJ2YWx1ZXMiOlsiY3JpdGljYWwiXX0=" type: string total_filtered_count: description: The total count of findings after the filter has been applied. @@ -36818,12 +35342,12 @@ components: description: The expected response schema when listing findings. properties: data: - $ref: '#/components/schemas/ListFindingsData' + $ref: "#/components/schemas/ListFindingsData" meta: - $ref: '#/components/schemas/ListFindingsMeta' + $ref: "#/components/schemas/ListFindingsMeta" required: - - data - - meta + - data + - meta type: object ListIntegrationsResponse: description: Response containing information about multiple integrations. @@ -36831,22 +35355,22 @@ components: data: description: Array of integration objects. items: - $ref: '#/components/schemas/Integration' + $ref: "#/components/schemas/Integration" type: array required: - - data + - data type: object ListInterfaceTagsResponse: description: Response for listing interface tags. properties: data: - $ref: '#/components/schemas/ListInterfaceTagsResponseData' + $ref: "#/components/schemas/ListInterfaceTagsResponseData" type: object ListInterfaceTagsResponseData: description: Response data for listing interface tags. properties: attributes: - $ref: '#/components/schemas/ListTagsResponseDataAttributes' + $ref: "#/components/schemas/ListTagsResponseDataAttributes" id: description: The interface ID example: example:1.2.3.4:1 @@ -36859,16 +35383,16 @@ components: description: List kind response. properties: data: - $ref: '#/components/schemas/KindResponseData' + $ref: "#/components/schemas/KindResponseData" meta: - $ref: '#/components/schemas/KindResponseMeta' + $ref: "#/components/schemas/KindResponseMeta" type: object ListNotificationChannelsResponse: description: Response type for listing notification channels for a user properties: data: items: - $ref: '#/components/schemas/NotificationChannelData' + $ref: "#/components/schemas/NotificationChannelData" type: array type: object ListOnCallNotificationRulesResponse: @@ -36876,26 +35400,25 @@ components: properties: data: items: - $ref: '#/components/schemas/OnCallNotificationRuleData' + $ref: "#/components/schemas/OnCallNotificationRuleData" type: array included: items: - $ref: '#/components/schemas/OnCallNotificationRulesIncluded' + $ref: "#/components/schemas/OnCallNotificationRulesIncluded" type: array type: object ListPipelinesResponse: - description: Represents the response payload containing a list of pipelines - and associated metadata. + description: Represents the response payload containing a list of pipelines and associated metadata. properties: data: description: The `schema` `data`. items: - $ref: '#/components/schemas/ObservabilityPipelineData' + $ref: "#/components/schemas/ObservabilityPipelineData" type: array meta: - $ref: '#/components/schemas/ListPipelinesResponseMeta' + $ref: "#/components/schemas/ListPipelinesResponseMeta" required: - - data + - data type: object ListPipelinesResponseMeta: description: Metadata about the response. @@ -36912,81 +35435,82 @@ components: data: description: List of powerpack definitions. items: - $ref: '#/components/schemas/PowerpackData' + $ref: "#/components/schemas/PowerpackData" type: array included: description: Array of objects related to the users. items: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" type: array links: - $ref: '#/components/schemas/PowerpackResponseLinks' + $ref: "#/components/schemas/PowerpackResponseLinks" meta: - $ref: '#/components/schemas/PowerpacksResponseMeta' + $ref: "#/components/schemas/PowerpacksResponseMeta" type: object ListRelationCatalogResponse: description: List entity relation response. properties: data: - $ref: '#/components/schemas/RelationResponseData' + $ref: "#/components/schemas/RelationResponseData" included: - $ref: '#/components/schemas/ListRelationCatalogResponseIncluded' + $ref: "#/components/schemas/ListRelationCatalogResponseIncluded" links: - $ref: '#/components/schemas/ListRelationCatalogResponseLinks' + $ref: "#/components/schemas/ListRelationCatalogResponseLinks" meta: - $ref: '#/components/schemas/RelationResponseMeta' + $ref: "#/components/schemas/RelationResponseMeta" type: object ListRelationCatalogResponseIncluded: description: List relation response included entities. items: - $ref: '#/components/schemas/EntityData' + $ref: "#/components/schemas/EntityData" type: array ListRelationCatalogResponseLinks: description: List relation response links. properties: next: description: Next link. - example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=2 + example: "/api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=2" type: string previous: description: Previous link. type: string self: description: Current link. - example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=0 + example: "/api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=0" type: string type: object ListRulesResponse: description: Scorecard rules response. properties: data: - $ref: '#/components/schemas/ListRulesResponseData' + $ref: "#/components/schemas/ListRulesResponseData" links: - $ref: '#/components/schemas/ListRulesResponseLinks' + $ref: "#/components/schemas/ListRulesResponseLinks" type: object ListRulesResponseData: description: Array of rule details. items: - $ref: '#/components/schemas/ListRulesResponseDataItem' + $ref: "#/components/schemas/ListRulesResponseDataItem" type: array ListRulesResponseDataItem: description: Rule details. properties: attributes: - $ref: '#/components/schemas/RuleAttributes' + $ref: "#/components/schemas/RuleAttributes" id: - $ref: '#/components/schemas/RuleId' + $ref: "#/components/schemas/RuleId" relationships: - $ref: '#/components/schemas/RelationshipToRule' + $ref: "#/components/schemas/RelationshipToRule" type: - $ref: '#/components/schemas/RuleType' + $ref: "#/components/schemas/RuleType" type: object ListRulesResponseLinks: description: Links attributes. properties: next: - description: Link for the next set of rules. - example: /api/v2/scorecard/rules?page%5Blimit%5D=2&page%5Boffset%5D=2&page%5Bsize%5D=2 + description: |- + Link for the next set of rules. + example: "/api/v2/scorecard/rules?page%5Blimit%5D=2&page%5Boffset%5D=2&page%5Bsize%5D=2" type: string type: object ListSecurityFindingsResponse: @@ -36995,24 +35519,24 @@ components: data: description: Array of security findings matching the search query. items: - $ref: '#/components/schemas/SecurityFindingsData' + $ref: "#/components/schemas/SecurityFindingsData" type: array links: - $ref: '#/components/schemas/SecurityFindingsLinks' + $ref: "#/components/schemas/SecurityFindingsLinks" meta: - $ref: '#/components/schemas/SecurityFindingsMeta' + $ref: "#/components/schemas/SecurityFindingsMeta" type: object ListTagsResponse: description: List tags response. properties: data: - $ref: '#/components/schemas/ListTagsResponseData' + $ref: "#/components/schemas/ListTagsResponseData" type: object ListTagsResponseData: description: The list tags response data. properties: attributes: - $ref: '#/components/schemas/ListTagsResponseDataAttributes' + $ref: "#/components/schemas/ListTagsResponseDataAttributes" id: description: The device ID example: example:1.2.3.4 @@ -37026,9 +35550,7 @@ components: properties: tags: description: The list of tags - example: - - tag:test - - tag:testbis + example: ["tag:test", "tag:testbis"] items: type: string type: array @@ -37036,35 +35558,35 @@ components: ListTeamsInclude: description: Included related resources optionally requested. enum: - - team_links - - user_team_permissions + - team_links + - user_team_permissions type: string x-enum-varnames: - - TEAM_LINKS - - USER_TEAM_PERMISSIONS + - TEAM_LINKS + - USER_TEAM_PERMISSIONS ListTeamsSort: description: Specifies the order of the returned teams enum: - - name - - -name - - user_count - - -user_count + - name + - -name + - user_count + - -user_count type: string x-enum-varnames: - - NAME - - _NAME - - USER_COUNT - - _USER_COUNT + - NAME + - _NAME + - USER_COUNT + - _USER_COUNT ListThreatHuntingJobsResponse: description: List of threat hunting jobs. properties: data: description: Array containing the list of threat hunting jobs. items: - $ref: '#/components/schemas/ThreatHuntingJobResponseData' + $ref: "#/components/schemas/ThreatHuntingJobResponseData" type: array meta: - $ref: '#/components/schemas/ThreatHuntingJobListMeta' + $ref: "#/components/schemas/ThreatHuntingJobListMeta" type: object ListVulnerabilitiesResponse: description: The expected response schema when listing vulnerabilities. @@ -37072,14 +35594,14 @@ components: data: description: List of vulnerabilities. items: - $ref: '#/components/schemas/Vulnerability' + $ref: "#/components/schemas/Vulnerability" type: array links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" meta: - $ref: '#/components/schemas/Metadata' + $ref: "#/components/schemas/Metadata" required: - - data + - data type: object ListVulnerableAssetsResponse: description: The expected response schema when listing vulnerable assets. @@ -37087,77 +35609,69 @@ components: data: description: List of vulnerable assets. items: - $ref: '#/components/schemas/Asset' + $ref: "#/components/schemas/Asset" type: array links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" meta: - $ref: '#/components/schemas/Metadata' + $ref: "#/components/schemas/Metadata" required: - - data + - data type: object Log: - description: Object description of a log after being processed and stored by - Datadog. + description: Object description of a log after being processed and stored by Datadog. properties: attributes: - $ref: '#/components/schemas/LogAttributes' + $ref: "#/components/schemas/LogAttributes" id: description: Unique ID of the Log. - example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA" type: string type: - $ref: '#/components/schemas/LogType' + $ref: "#/components/schemas/LogType" type: object LogAttributes: - description: JSON object containing all log attributes and their associated - values. + description: JSON object containing all log attributes and their associated values. properties: attributes: additionalProperties: {} description: JSON object of attributes from your log. - example: - customAttribute: 123 - duration: 2345 + example: {"customAttribute": 123, "duration": 2345} type: object host: - description: Name of the machine from where the logs are being sent. - example: i-0123 + description: |- + Name of the machine from where the logs are being sent. + example: "i-0123" type: string message: - description: 'The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes) - - of your log. By default, Datadog ingests the value of the message attribute - as the body of the log entry. - - That value is then highlighted and displayed in the Logstream, where it - is indexed for full text search.' - example: Host connected to remote + description: |- + The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes) + of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. + That value is then highlighted and displayed in the Logstream, where it is indexed for full text search. + example: "Host connected to remote" type: string service: - description: 'The name of the application or service generating the log - events. - + description: |- + The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same - - value when you use both products.' - example: agent + value when you use both products. + example: "agent" type: string status: - description: Status of the message associated with your log. - example: INFO + description: |- + Status of the message associated with your log. + example: "INFO" type: string tags: description: Array of tags associated with your log. - example: - - team:A + example: ["team:A"] items: description: Tag associated with your log. type: string type: array timestamp: description: Timestamp of your log. - example: '2019-01-02T09:42:36.320Z' + example: "2019-01-02T09:42:36.320Z" format: date-time type: string type: object @@ -37165,11 +35679,11 @@ components: default: log description: Type of the event. enum: - - log - example: log + - log + example: "log" type: string x-enum-varnames: - - LOG + - LOG LogsAggregateBucket: description: A bucket values properties: @@ -37177,23 +35691,20 @@ components: additionalProperties: description: The values for each group by description: The key, value pairs for each group by - example: - '@state': success - '@version': abc + example: {"@state": "success", "@version": "abc"} type: object computes: additionalProperties: - $ref: '#/components/schemas/LogsAggregateBucketValue' - description: A map of the metric name -> value for regular compute or list - of values for a timeseries + $ref: "#/components/schemas/LogsAggregateBucketValue" + description: A map of the metric name -> value for regular compute or list of values for a timeseries type: object type: object LogsAggregateBucketValue: description: A bucket value, can be either a timeseries or a single value oneOf: - - $ref: '#/components/schemas/LogsAggregateBucketValueSingleString' - - $ref: '#/components/schemas/LogsAggregateBucketValueSingleNumber' - - $ref: '#/components/schemas/LogsAggregateBucketValueTimeseries' + - $ref: "#/components/schemas/LogsAggregateBucketValueSingleString" + - $ref: "#/components/schemas/LogsAggregateBucketValueSingleNumber" + - $ref: "#/components/schemas/LogsAggregateBucketValueTimeseries" LogsAggregateBucketValueSingleNumber: description: A single number value format: double @@ -37204,7 +35715,7 @@ components: LogsAggregateBucketValueTimeseries: description: A timeseries array items: - $ref: '#/components/schemas/LogsAggregateBucketValueTimeseriesPoint' + $ref: "#/components/schemas/LogsAggregateBucketValueTimeseriesPoint" type: array x-generate-alias-as-model: true LogsAggregateBucketValueTimeseriesPoint: @@ -37212,7 +35723,7 @@ components: properties: time: description: The time value for this point - example: '2020-06-08T11:55:00Z' + example: "2020-06-08T11:55:00Z" type: string value: description: The value for this point @@ -37221,43 +35732,41 @@ components: type: number type: object LogsAggregateRequest: - description: The object sent with the request to retrieve a list of logs from - your organization. + description: The object sent with the request to retrieve a list of logs from your organization. properties: compute: - description: The list of metrics or timeseries to compute for the retrieved - buckets. + description: The list of metrics or timeseries to compute for the retrieved buckets. items: - $ref: '#/components/schemas/LogsCompute' + $ref: "#/components/schemas/LogsCompute" type: array filter: - $ref: '#/components/schemas/LogsQueryFilter' + $ref: "#/components/schemas/LogsQueryFilter" group_by: description: The rules for the group by items: - $ref: '#/components/schemas/LogsGroupBy' + $ref: "#/components/schemas/LogsGroupBy" type: array options: - $ref: '#/components/schemas/LogsQueryOptions' + $ref: "#/components/schemas/LogsQueryOptions" page: - $ref: '#/components/schemas/LogsAggregateRequestPage' + $ref: "#/components/schemas/LogsAggregateRequestPage" type: object LogsAggregateRequestPage: description: Paging settings properties: cursor: - description: 'The returned paging point to use to get the next results. - Note: at most 1000 results can be paged.' - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + The returned paging point to use to get the next results. Note: at most 1000 results can be paged. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string type: object LogsAggregateResponse: description: The response object for the logs aggregate API endpoint properties: data: - $ref: '#/components/schemas/LogsAggregateResponseData' + $ref: "#/components/schemas/LogsAggregateResponseData" meta: - $ref: '#/components/schemas/LogsResponseMetadata' + $ref: "#/components/schemas/LogsResponseMetadata" type: object LogsAggregateResponseData: description: The query results @@ -37265,93 +35774,58 @@ components: buckets: description: The list of matching buckets, one item per bucket items: - $ref: '#/components/schemas/LogsAggregateBucket' + $ref: "#/components/schemas/LogsAggregateBucket" type: array type: object LogsAggregateResponseStatus: description: The status of the response - enum: - - done - - timeout - example: done + enum: ["done", "timeout"] + example: "done" type: string - x-enum-varnames: - - DONE - - TIMEOUT + x-enum-varnames: ["DONE", "TIMEOUT"] LogsAggregateSort: description: A sort rule - example: - aggregation: count - order: asc + example: {"aggregation": "count", "order": "asc"} properties: aggregation: - $ref: '#/components/schemas/LogsAggregationFunction' + $ref: "#/components/schemas/LogsAggregationFunction" metric: description: The metric to sort by (only used for `type=measure`) - example: '@duration' + example: "@duration" type: string order: - $ref: '#/components/schemas/LogsSortOrder' + $ref: "#/components/schemas/LogsSortOrder" type: - $ref: '#/components/schemas/LogsAggregateSortType' + $ref: "#/components/schemas/LogsAggregateSortType" type: object LogsAggregateSortType: - default: alphabetical + default: "alphabetical" description: The type of sorting algorithm - enum: - - alphabetical - - measure + enum: ["alphabetical", "measure"] type: string - x-enum-varnames: - - ALPHABETICAL - - MEASURE + x-enum-varnames: ["ALPHABETICAL", "MEASURE"] LogsAggregationFunction: description: An aggregation function - enum: - - count - - cardinality - - pc75 - - pc90 - - pc95 - - pc98 - - pc99 - - sum - - min - - max - - avg - - median - example: pc90 - type: string - x-enum-varnames: - - COUNT - - CARDINALITY - - PERCENTILE_75 - - PERCENTILE_90 - - PERCENTILE_95 - - PERCENTILE_98 - - PERCENTILE_99 - - SUM - - MIN - - MAX - - AVG - - MEDIAN + enum: ["count", "cardinality", "pc75", "pc90", "pc95", "pc98", "pc99", "sum", "min", "max", "avg", "median"] + example: "pc90" + type: string + x-enum-varnames: ["COUNT", "CARDINALITY", "PERCENTILE_75", "PERCENTILE_90", "PERCENTILE_95", "PERCENTILE_98", "PERCENTILE_99", "SUM", "MIN", "MAX", "AVG", "MEDIAN"] LogsArchive: description: The logs archive. properties: data: - $ref: '#/components/schemas/LogsArchiveDefinition' + $ref: "#/components/schemas/LogsArchiveDefinition" type: object LogsArchiveAttributes: description: The attributes associated with the archive. properties: destination: - $ref: '#/components/schemas/LogsArchiveDestination' + $ref: "#/components/schemas/LogsArchiveDestination" include_tags: default: false - description: 'To store the tags in the archive, set the value "true". - - If it is set to "false", the tags will be deleted when the logs are sent - to the archive.' + description: |- + To store the tags in the archive, set the value "true". + If it is set to "false", the tags will be deleted when the logs are sent to the archive. example: false type: boolean name: @@ -37359,8 +35833,7 @@ components: example: Nginx Archive type: string query: - description: The archive query/filter. Logs matching this query are included - in the archive. + description: The archive query/filter. Logs matching this query are included in the archive. example: source:nginx type: string rehydration_max_scan_size_in_gb: @@ -37371,37 +35844,34 @@ components: type: integer rehydration_tags: description: An array of tags to add to rehydrated logs from an archive. - example: - - team:intake - - team:app + example: ["team:intake", "team:app"] items: description: A given tag in the `:` format. type: string type: array state: - $ref: '#/components/schemas/LogsArchiveState' + $ref: "#/components/schemas/LogsArchiveState" required: - - name - - query - - destination + - name + - query + - destination type: object LogsArchiveCreateRequest: description: The logs archive. properties: data: - $ref: '#/components/schemas/LogsArchiveCreateRequestDefinition' + $ref: "#/components/schemas/LogsArchiveCreateRequestDefinition" type: object LogsArchiveCreateRequestAttributes: description: The attributes associated with the archive. properties: destination: - $ref: '#/components/schemas/LogsArchiveCreateRequestDestination' + $ref: "#/components/schemas/LogsArchiveCreateRequestDestination" include_tags: default: false - description: 'To store the tags in the archive, set the value "true". - - If it is set to "false", the tags will be deleted when the logs are sent - to the archive.' + description: |- + To store the tags in the archive, set the value "true". + If it is set to "false", the tags will be deleted when the logs are sent to the archive. example: false type: boolean name: @@ -37409,8 +35879,7 @@ components: example: Nginx Archive type: string query: - description: The archive query/filter. Logs matching this query are included - in the archive. + description: The archive query/filter. Logs matching this query are included in the archive. example: source:nginx type: string rehydration_max_scan_size_in_gb: @@ -37421,42 +35890,40 @@ components: type: integer rehydration_tags: description: An array of tags to add to rehydrated logs from an archive. - example: - - team:intake - - team:app + example: ["team:intake", "team:app"] items: description: A given tag in the `:` format. type: string type: array required: - - name - - query - - destination + - name + - query + - destination type: object LogsArchiveCreateRequestDefinition: description: The definition of an archive. properties: attributes: - $ref: '#/components/schemas/LogsArchiveCreateRequestAttributes' + $ref: "#/components/schemas/LogsArchiveCreateRequestAttributes" type: default: archives description: The type of the resource. The value should always be archives. example: archives type: string required: - - type + - type type: object LogsArchiveCreateRequestDestination: description: An archive's destination. oneOf: - - $ref: '#/components/schemas/LogsArchiveDestinationAzure' - - $ref: '#/components/schemas/LogsArchiveDestinationGCS' - - $ref: '#/components/schemas/LogsArchiveDestinationS3' + - $ref: "#/components/schemas/LogsArchiveDestinationAzure" + - $ref: "#/components/schemas/LogsArchiveDestinationGCS" + - $ref: "#/components/schemas/LogsArchiveDestinationS3" LogsArchiveDefinition: description: The definition of an archive. properties: attributes: - $ref: '#/components/schemas/LogsArchiveAttributes' + $ref: "#/components/schemas/LogsArchiveAttributes" id: description: The archive ID. example: a2zcMylnM4OCHpYusxIi3g @@ -37469,15 +35936,15 @@ components: readOnly: true type: string required: - - type + - type type: object LogsArchiveDestination: description: An archive's destination. nullable: true oneOf: - - $ref: '#/components/schemas/LogsArchiveDestinationAzure' - - $ref: '#/components/schemas/LogsArchiveDestinationGCS' - - $ref: '#/components/schemas/LogsArchiveDestinationS3' + - $ref: "#/components/schemas/LogsArchiveDestinationAzure" + - $ref: "#/components/schemas/LogsArchiveDestinationGCS" + - $ref: "#/components/schemas/LogsArchiveDestinationS3" type: object LogsArchiveDestinationAzure: description: The Azure archive destination. @@ -37487,7 +35954,7 @@ components: example: container-name type: string integration: - $ref: '#/components/schemas/LogsArchiveIntegrationAzure' + $ref: "#/components/schemas/LogsArchiveIntegrationAzure" path: description: The archive path. type: string @@ -37499,22 +35966,22 @@ components: example: account-name type: string type: - $ref: '#/components/schemas/LogsArchiveDestinationAzureType' + $ref: "#/components/schemas/LogsArchiveDestinationAzureType" required: - - storage_account - - container - - integration - - type + - storage_account + - container + - integration + - type type: object LogsArchiveDestinationAzureType: default: azure description: Type of the Azure archive destination. enum: - - azure + - azure example: azure type: string x-enum-varnames: - - AZURE + - AZURE LogsArchiveDestinationGCS: description: The GCS archive destination. properties: @@ -37523,26 +35990,26 @@ components: example: bucket-name type: string integration: - $ref: '#/components/schemas/LogsArchiveIntegrationGCS' + $ref: "#/components/schemas/LogsArchiveIntegrationGCS" path: description: The archive path. type: string type: - $ref: '#/components/schemas/LogsArchiveDestinationGCSType' + $ref: "#/components/schemas/LogsArchiveDestinationGCSType" required: - - bucket - - integration - - type + - bucket + - integration + - type type: object LogsArchiveDestinationGCSType: default: gcs description: Type of the GCS archive destination. enum: - - gcs + - gcs example: gcs type: string x-enum-varnames: - - GCS + - GCS LogsArchiveDestinationS3: description: The S3 archive destination. properties: @@ -37551,30 +36018,30 @@ components: example: bucket-name type: string encryption: - $ref: '#/components/schemas/LogsArchiveEncryptionS3' + $ref: "#/components/schemas/LogsArchiveEncryptionS3" integration: - $ref: '#/components/schemas/LogsArchiveIntegrationS3' + $ref: "#/components/schemas/LogsArchiveIntegrationS3" path: description: The archive path. type: string storage_class: - $ref: '#/components/schemas/LogsArchiveStorageClassS3Type' + $ref: "#/components/schemas/LogsArchiveStorageClassS3Type" type: - $ref: '#/components/schemas/LogsArchiveDestinationS3Type' + $ref: "#/components/schemas/LogsArchiveDestinationS3Type" required: - - bucket - - integration - - type + - bucket + - integration + - type type: object LogsArchiveDestinationS3Type: default: s3 description: Type of the S3 archive destination. enum: - - s3 + - s3 example: s3 type: string x-enum-varnames: - - S3 + - S3 LogsArchiveEncryptionS3: description: The S3 encryption settings. properties: @@ -37583,22 +36050,22 @@ components: example: arn:aws:kms:us-east-1:012345678901:key/DatadogIntegrationRoleKms type: string type: - $ref: '#/components/schemas/LogsArchiveEncryptionS3Type' + $ref: "#/components/schemas/LogsArchiveEncryptionS3Type" required: - - type + - type type: object LogsArchiveEncryptionS3Type: description: Type of S3 encryption for a destination. enum: - - NO_OVERRIDE - - SSE_S3 - - SSE_KMS + - NO_OVERRIDE + - SSE_S3 + - SSE_KMS example: SSE_S3 type: string x-enum-varnames: - - NO_OVERRIDE - - SSE_S3 - - SSE_KMS + - NO_OVERRIDE + - SSE_S3 + - SSE_KMS LogsArchiveIntegrationAzure: description: The Azure archive's integration destination. properties: @@ -37611,8 +36078,8 @@ components: example: aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa type: string required: - - tenant_id - - client_id + - tenant_id + - client_id type: object LogsArchiveIntegrationGCS: description: The GCS archive's integration destination. @@ -37626,169 +36093,159 @@ components: example: project-id type: string required: - - client_email + - client_email type: object LogsArchiveIntegrationS3: description: The S3 Archive's integration destination. properties: account_id: description: The account ID for the integration. - example: '123456789012' + example: "123456789012" type: string role_name: description: The path of the integration. example: role-name type: string required: - - role_name - - account_id + - role_name + - account_id type: object LogsArchiveOrder: description: A ordered list of archive IDs. properties: data: - $ref: '#/components/schemas/LogsArchiveOrderDefinition' + $ref: "#/components/schemas/LogsArchiveOrderDefinition" type: object LogsArchiveOrderAttributes: description: The attributes associated with the archive order. properties: archive_ids: - description: 'An ordered array of `` strings, the order of archive - IDs in the array - - define the overall archives order for Datadog.' - example: - - a2zcMylnM4OCHpYusxIi1g - - a2zcMylnM4OCHpYusxIi2g - - a2zcMylnM4OCHpYusxIi3g + description: |- + An ordered array of `` strings, the order of archive IDs in the array + define the overall archives order for Datadog. + example: ["a2zcMylnM4OCHpYusxIi1g", "a2zcMylnM4OCHpYusxIi2g", "a2zcMylnM4OCHpYusxIi3g"] items: description: A given archive ID. type: string type: array required: - - archive_ids + - archive_ids type: object LogsArchiveOrderDefinition: description: The definition of an archive order. properties: attributes: - $ref: '#/components/schemas/LogsArchiveOrderAttributes' + $ref: "#/components/schemas/LogsArchiveOrderAttributes" type: - $ref: '#/components/schemas/LogsArchiveOrderDefinitionType' + $ref: "#/components/schemas/LogsArchiveOrderDefinitionType" required: - - type - - attributes + - type + - attributes type: object LogsArchiveOrderDefinitionType: default: archive_order description: Type of the archive order definition. enum: - - archive_order + - archive_order example: archive_order type: string x-enum-varnames: - - ARCHIVE_ORDER + - ARCHIVE_ORDER LogsArchiveState: description: The state of the archive. enum: - - UNKNOWN - - WORKING - - FAILING - - WORKING_AUTH_LEGACY + - UNKNOWN + - WORKING + - FAILING + - WORKING_AUTH_LEGACY example: WORKING type: string x-enum-varnames: - - UNKNOWN - - WORKING - - FAILING - - WORKING_AUTH_LEGACY + - UNKNOWN + - WORKING + - FAILING + - WORKING_AUTH_LEGACY LogsArchiveStorageClassS3Type: default: STANDARD description: The storage class where the archive will be stored. enum: - - STANDARD - - STANDARD_IA - - ONEZONE_IA - - INTELLIGENT_TIERING - - GLACIER_IR + - STANDARD + - STANDARD_IA + - ONEZONE_IA + - INTELLIGENT_TIERING + - GLACIER_IR example: STANDARD type: string x-enum-varnames: - - STANDARD - - STANDARD_IA - - ONEZONE_IA - - INTELLIGENT_TIERING - - GLACIER_IR + - STANDARD + - STANDARD_IA + - ONEZONE_IA + - INTELLIGENT_TIERING + - GLACIER_IR LogsArchives: description: The available archives. properties: data: description: A list of archives. items: - $ref: '#/components/schemas/LogsArchiveDefinition' + $ref: "#/components/schemas/LogsArchiveDefinition" type: array type: object LogsCompute: description: A compute rule to compute metrics or timeseries properties: aggregation: - $ref: '#/components/schemas/LogsAggregationFunction' + $ref: "#/components/schemas/LogsAggregationFunction" interval: - description: 'The time buckets'' size (only used for type=timeseries) - - Defaults to a resolution of 150 points' - example: 5m + description: |- + The time buckets' size (only used for type=timeseries) + Defaults to a resolution of 150 points + example: "5m" type: string metric: description: The metric to use - example: '@duration' + example: "@duration" type: string type: - $ref: '#/components/schemas/LogsComputeType' + $ref: "#/components/schemas/LogsComputeType" required: - - aggregation + - aggregation type: object LogsComputeType: - default: total + default: "total" description: The type of compute - enum: - - timeseries - - total + enum: ["timeseries", "total"] type: string - x-enum-varnames: - - TIMESERIES - - TOTAL + x-enum-varnames: ["TIMESERIES", "TOTAL"] LogsGroupBy: description: A group by rule properties: facet: description: The name of the facet to use (required) - example: host + example: "host" type: string histogram: - $ref: '#/components/schemas/LogsGroupByHistogram' + $ref: "#/components/schemas/LogsGroupByHistogram" limit: default: 10 - description: 'The maximum buckets to return for this group by. Note: at - most 10000 buckets are allowed. - - If grouping by multiple facets, the product of limits must not exceed - 10000.' + description: |- + The maximum buckets to return for this group by. Note: at most 10000 buckets are allowed. + If grouping by multiple facets, the product of limits must not exceed 10000. format: int64 type: integer missing: - $ref: '#/components/schemas/LogsGroupByMissing' + $ref: "#/components/schemas/LogsGroupByMissing" sort: - $ref: '#/components/schemas/LogsAggregateSort' + $ref: "#/components/schemas/LogsAggregateSort" total: - $ref: '#/components/schemas/LogsGroupByTotal' + $ref: "#/components/schemas/LogsGroupByTotal" required: - - facet + - facet type: object LogsGroupByHistogram: - description: 'Used to perform a histogram computation (only for measure facets). - - Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval.' + description: |- + Used to perform a histogram computation (only for measure facets). + Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval. properties: interval: description: The bin size of the histogram buckets @@ -37796,30 +36253,29 @@ components: format: double type: number max: - description: 'The maximum value for the measure used in the histogram - - (values greater than this one are filtered out)' + description: |- + The maximum value for the measure used in the histogram + (values greater than this one are filtered out) example: 100 format: double type: number min: - description: 'The minimum value for the measure used in the histogram - - (values smaller than this one are filtered out)' + description: |- + The minimum value for the measure used in the histogram + (values smaller than this one are filtered out) example: 50 format: double type: number required: - - interval - - min - - max + - interval + - min + - max type: object LogsGroupByMissing: - description: The value to use for logs that don't have the facet used to group - by + description: The value to use for logs that don't have the facet used to group by oneOf: - - $ref: '#/components/schemas/LogsGroupByMissingString' - - $ref: '#/components/schemas/LogsGroupByMissingNumber' + - $ref: "#/components/schemas/LogsGroupByMissingString" + - $ref: "#/components/schemas/LogsGroupByMissingNumber" LogsGroupByMissingNumber: description: The missing value to use if there is a number valued facet. format: double @@ -37829,12 +36285,12 @@ components: type: string LogsGroupByTotal: default: false - description: A resulting object to put the given computes in over all the matching - records. + description: |- + A resulting object to put the given computes in over all the matching records. oneOf: - - $ref: '#/components/schemas/LogsGroupByTotalBoolean' - - $ref: '#/components/schemas/LogsGroupByTotalString' - - $ref: '#/components/schemas/LogsGroupByTotalNumber' + - $ref: "#/components/schemas/LogsGroupByTotalBoolean" + - $ref: "#/components/schemas/LogsGroupByTotalString" + - $ref: "#/components/schemas/LogsGroupByTotalNumber" LogsGroupByTotalBoolean: description: If set to true, creates an additional bucket labeled "$facet_total" type: boolean @@ -37849,21 +36305,21 @@ components: description: The request for a logs list. properties: filter: - $ref: '#/components/schemas/LogsQueryFilter' + $ref: "#/components/schemas/LogsQueryFilter" options: - $ref: '#/components/schemas/LogsQueryOptions' + $ref: "#/components/schemas/LogsQueryOptions" page: - $ref: '#/components/schemas/LogsListRequestPage' + $ref: "#/components/schemas/LogsListRequestPage" sort: - $ref: '#/components/schemas/LogsSort' + $ref: "#/components/schemas/LogsSort" type: object LogsListRequestPage: description: Paging attributes for listing logs. properties: cursor: - description: List following results with a cursor provided in the previous - query. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + List following results with a cursor provided in the previous query. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string limit: default: 10 @@ -37874,250 +36330,230 @@ components: type: integer type: object LogsListResponse: - description: Response object with all logs matching the request and pagination - information. + description: Response object with all logs matching the request and pagination information. properties: data: description: Array of logs matching the request. items: - $ref: '#/components/schemas/Log' + $ref: "#/components/schemas/Log" type: array links: - $ref: '#/components/schemas/LogsListResponseLinks' + $ref: "#/components/schemas/LogsListResponseLinks" meta: - $ref: '#/components/schemas/LogsResponseMetadata' + $ref: "#/components/schemas/LogsResponseMetadata" type: object LogsListResponseLinks: description: Links attributes. properties: next: - description: 'Link for the next set of results. Note that the request can - also be made using the - - POST endpoint.' - example: https://app.datadoghq.com/api/v2/logs/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + Link for the next set of results. Note that the request can also be made using the + POST endpoint. + example: "https://app.datadoghq.com/api/v2/logs/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string type: object LogsMetricCompute: description: The compute rule to compute the log-based metric. properties: aggregation_type: - $ref: '#/components/schemas/LogsMetricComputeAggregationType' + $ref: "#/components/schemas/LogsMetricComputeAggregationType" include_percentiles: - $ref: '#/components/schemas/LogsMetricComputeIncludePercentiles' + $ref: "#/components/schemas/LogsMetricComputeIncludePercentiles" path: - description: The path to the value the log-based metric will aggregate on - (only used if the aggregation type is a "distribution"). - example: '@duration' + description: The path to the value the log-based metric will aggregate on (only used if the aggregation type is a "distribution"). + example: "@duration" type: string required: - - aggregation_type + - aggregation_type type: object LogsMetricComputeAggregationType: description: The type of aggregation to use. - enum: - - count - - distribution - example: distribution + enum: ["count", "distribution"] + example: "distribution" type: string - x-enum-varnames: - - COUNT - - DISTRIBUTION + x-enum-varnames: ["COUNT", "DISTRIBUTION"] LogsMetricComputeIncludePercentiles: - description: 'Toggle to include or exclude percentile aggregations for distribution - metrics. - - Only present when the `aggregation_type` is `distribution`.' + description: |- + Toggle to include or exclude percentile aggregations for distribution metrics. + Only present when the `aggregation_type` is `distribution`. example: true type: boolean LogsMetricCreateAttributes: description: The object describing the Datadog log-based metric to create. properties: compute: - $ref: '#/components/schemas/LogsMetricCompute' + $ref: "#/components/schemas/LogsMetricCompute" filter: - $ref: '#/components/schemas/LogsMetricFilter' + $ref: "#/components/schemas/LogsMetricFilter" group_by: description: The rules for the group by. items: - $ref: '#/components/schemas/LogsMetricGroupBy' + $ref: "#/components/schemas/LogsMetricGroupBy" type: array required: - - compute + - compute type: object LogsMetricCreateData: description: The new log-based metric properties. properties: attributes: - $ref: '#/components/schemas/LogsMetricCreateAttributes' + $ref: "#/components/schemas/LogsMetricCreateAttributes" id: - $ref: '#/components/schemas/LogsMetricID' + $ref: "#/components/schemas/LogsMetricID" type: - $ref: '#/components/schemas/LogsMetricType' + $ref: "#/components/schemas/LogsMetricType" required: - - id - - type - - attributes + - id + - type + - attributes type: object LogsMetricCreateRequest: description: The new log-based metric body. properties: data: - $ref: '#/components/schemas/LogsMetricCreateData' + $ref: "#/components/schemas/LogsMetricCreateData" required: - - data + - data type: object LogsMetricFilter: - description: The log-based metric filter. Logs matching this filter will be - aggregated in this metric. + description: The log-based metric filter. Logs matching this filter will be aggregated in this metric. properties: query: - default: '*' + default: "*" description: The search query - following the log search syntax. - example: service:web* AND @http.status_code:[200 TO 299] + example: "service:web* AND @http.status_code:[200 TO 299]" type: string type: object LogsMetricGroupBy: description: A group by rule. properties: path: - description: The path to the value the log-based metric will be aggregated - over. - example: '@http.status_code' + description: The path to the value the log-based metric will be aggregated over. + example: "@http.status_code" type: string tag_name: - description: Eventual name of the tag that gets created. By default, the - path attribute is used as the tag name. - example: status_code + description: Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. + example: "status_code" type: string required: - - path + - path type: object LogsMetricID: description: The name of the log-based metric. - example: logs.page.load.count + example: "logs.page.load.count" type: string LogsMetricResponse: description: The log-based metric object. properties: data: - $ref: '#/components/schemas/LogsMetricResponseData' + $ref: "#/components/schemas/LogsMetricResponseData" type: object LogsMetricResponseAttributes: description: The object describing a Datadog log-based metric. properties: compute: - $ref: '#/components/schemas/LogsMetricResponseCompute' + $ref: "#/components/schemas/LogsMetricResponseCompute" filter: - $ref: '#/components/schemas/LogsMetricResponseFilter' + $ref: "#/components/schemas/LogsMetricResponseFilter" group_by: description: The rules for the group by. items: - $ref: '#/components/schemas/LogsMetricResponseGroupBy' + $ref: "#/components/schemas/LogsMetricResponseGroupBy" type: array type: object LogsMetricResponseCompute: description: The compute rule to compute the log-based metric. properties: aggregation_type: - $ref: '#/components/schemas/LogsMetricResponseComputeAggregationType' + $ref: "#/components/schemas/LogsMetricResponseComputeAggregationType" include_percentiles: - $ref: '#/components/schemas/LogsMetricComputeIncludePercentiles' + $ref: "#/components/schemas/LogsMetricComputeIncludePercentiles" path: - description: The path to the value the log-based metric will aggregate on - (only used if the aggregation type is a "distribution"). - example: '@duration' + description: The path to the value the log-based metric will aggregate on (only used if the aggregation type is a "distribution"). + example: "@duration" type: string type: object LogsMetricResponseComputeAggregationType: description: The type of aggregation to use. - enum: - - count - - distribution - example: distribution + enum: ["count", "distribution"] + example: "distribution" type: string - x-enum-varnames: - - COUNT - - DISTRIBUTION + x-enum-varnames: ["COUNT", "DISTRIBUTION"] LogsMetricResponseData: description: The log-based metric properties. properties: attributes: - $ref: '#/components/schemas/LogsMetricResponseAttributes' + $ref: "#/components/schemas/LogsMetricResponseAttributes" id: - $ref: '#/components/schemas/LogsMetricID' + $ref: "#/components/schemas/LogsMetricID" type: - $ref: '#/components/schemas/LogsMetricType' + $ref: "#/components/schemas/LogsMetricType" type: object LogsMetricResponseFilter: - description: The log-based metric filter. Logs matching this filter will be - aggregated in this metric. + description: The log-based metric filter. Logs matching this filter will be aggregated in this metric. properties: query: description: The search query - following the log search syntax. - example: service:web* AND @http.status_code:[200 TO 299] + example: "service:web* AND @http.status_code:[200 TO 299]" type: string type: object LogsMetricResponseGroupBy: description: A group by rule. properties: path: - description: The path to the value the log-based metric will be aggregated - over. - example: '@http.status_code' + description: The path to the value the log-based metric will be aggregated over. + example: "@http.status_code" type: string tag_name: - description: Eventual name of the tag that gets created. By default, the - path attribute is used as the tag name. - example: status_code + description: Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. + example: "status_code" type: string type: object LogsMetricType: default: logs_metrics description: The type of the resource. The value should always be logs_metrics. enum: - - logs_metrics + - logs_metrics example: logs_metrics type: string - x-enum-varnames: - - LOGS_METRICS + x-enum-varnames: ["LOGS_METRICS"] LogsMetricUpdateAttributes: description: The log-based metric properties that will be updated. properties: compute: - $ref: '#/components/schemas/LogsMetricUpdateCompute' + $ref: "#/components/schemas/LogsMetricUpdateCompute" filter: - $ref: '#/components/schemas/LogsMetricFilter' + $ref: "#/components/schemas/LogsMetricFilter" group_by: description: The rules for the group by. items: - $ref: '#/components/schemas/LogsMetricGroupBy' + $ref: "#/components/schemas/LogsMetricGroupBy" type: array type: object LogsMetricUpdateCompute: description: The compute rule to compute the log-based metric. properties: include_percentiles: - $ref: '#/components/schemas/LogsMetricComputeIncludePercentiles' + $ref: "#/components/schemas/LogsMetricComputeIncludePercentiles" type: object LogsMetricUpdateData: description: The new log-based metric properties. properties: attributes: - $ref: '#/components/schemas/LogsMetricUpdateAttributes' + $ref: "#/components/schemas/LogsMetricUpdateAttributes" type: - $ref: '#/components/schemas/LogsMetricType' + $ref: "#/components/schemas/LogsMetricType" required: - - type - - attributes + - type + - attributes type: object LogsMetricUpdateRequest: description: The new log-based metric body. properties: data: - $ref: '#/components/schemas/LogsMetricUpdateData' + $ref: "#/components/schemas/LogsMetricUpdateData" required: - - data + - data type: object LogsMetricsResponse: description: All the available log-based metric objects. @@ -38125,59 +36561,53 @@ components: data: description: A list of log-based metric objects. items: - $ref: '#/components/schemas/LogsMetricResponseData' + $ref: "#/components/schemas/LogsMetricResponseData" type: array type: object LogsQueryFilter: description: The search and filter query settings properties: from: - default: now-15m - description: The minimum time for the requested logs, supports date math - and regular timestamps (milliseconds). - example: now-15m + default: "now-15m" + description: The minimum time for the requested logs, supports date math and regular timestamps (milliseconds). + example: "now-15m" type: string indexes: - default: - - '*' - description: For customers with multiple indexes, the indexes to search. - Defaults to ['*'] which means all indexes. - example: - - main - - web + default: ["*"] + description: For customers with multiple indexes, the indexes to search. Defaults to ['*'] which means all indexes. + example: ["main", "web"] items: description: The name of a log index. type: string type: array query: - default: '*' + default: "*" description: The search query - following the log search syntax. - example: service:web* AND @http.status_code:[200 TO 299] + example: "service:web* AND @http.status_code:[200 TO 299]" type: string storage_tier: - $ref: '#/components/schemas/LogsStorageTier' + $ref: "#/components/schemas/LogsStorageTier" to: - default: now - description: The maximum time for the requested logs, supports date math - and regular timestamps (milliseconds). - example: now + default: "now" + description: The maximum time for the requested logs, supports date math and regular timestamps (milliseconds). + example: "now" type: string type: object LogsQueryOptions: deprecated: true - description: 'Global query options that are used during the query. - - Note: These fields are currently deprecated and do not affect the query results.' + description: |- + Global query options that are used during the query. + Note: These fields are currently deprecated and do not affect the query results. properties: timeOffset: description: The time offset (in seconds) to apply to the query. format: int64 type: integer timezone: - default: UTC - description: The timezone can be specified as GMT, UTC, an offset from UTC - (like UTC+1), or as a Timezone Database identifier (like America/New_York). - example: GMT + default: "UTC" + description: |- + The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York). + example: "GMT" type: string type: object LogsResponseMetadata: @@ -38189,90 +36619,80 @@ components: format: int64 type: integer page: - $ref: '#/components/schemas/LogsResponseMetadataPage' + $ref: "#/components/schemas/LogsResponseMetadataPage" request_id: description: The identifier of the request - example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR + example: "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR" type: string status: - $ref: '#/components/schemas/LogsAggregateResponseStatus' + $ref: "#/components/schemas/LogsAggregateResponseStatus" warnings: - description: 'A list of warnings (non fatal errors) encountered, partial - results might be returned if - - warnings are present in the response.' + description: |- + A list of warnings (non fatal errors) encountered, partial results might be returned if + warnings are present in the response. items: - $ref: '#/components/schemas/LogsWarning' + $ref: "#/components/schemas/LogsWarning" type: array type: object LogsResponseMetadataPage: description: Paging attributes. properties: after: - description: 'The cursor to use to get the next results, if any. To make - the next request, use the same - - parameters with the addition of the `page[cursor]`.' - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + The cursor to use to get the next results, if any. To make the next request, use the same + parameters with the addition of the `page[cursor]`. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string type: object LogsRestrictionQueriesType: default: logs_restriction_queries description: Restriction query resource type. enum: - - logs_restriction_queries + - logs_restriction_queries example: logs_restriction_queries type: string x-enum-varnames: - - LOGS_RESTRICTION_QUERIES + - LOGS_RESTRICTION_QUERIES LogsSort: description: Sort parameters when querying logs. enum: - - timestamp - - -timestamp + - timestamp + - -timestamp type: string x-enum-varnames: - - TIMESTAMP_ASCENDING - - TIMESTAMP_DESCENDING + - TIMESTAMP_ASCENDING + - TIMESTAMP_DESCENDING LogsSortOrder: description: The order to use, ascending or descending enum: - - asc - - desc - example: asc + - "asc" + - "desc" + example: "asc" type: string x-enum-varnames: - - ASCENDING - - DESCENDING + - "ASCENDING" + - "DESCENDING" LogsStorageTier: - default: indexes + default: "indexes" description: Specifies storage type as indexes, online-archives or flex - enum: - - indexes - - online-archives - - flex - example: indexes + enum: ["indexes", "online-archives", "flex"] + example: "indexes" type: string - x-enum-varnames: - - INDEXES - - ONLINE_ARCHIVES - - FLEX + x-enum-varnames: ["INDEXES", "ONLINE_ARCHIVES", "FLEX"] LogsWarning: - description: A warning message indicating something that went wrong with the - query + description: A warning message indicating something that went wrong with the query properties: code: description: A unique code for this type of warning - example: unknown_index + example: "unknown_index" type: string detail: description: A detailed explanation of this specific warning - example: 'indexes: foo, bar' + example: "indexes: foo, bar" type: string title: description: A short human-readable summary of the warning - example: One or several indexes are missing or invalid, results hold data - from the other indexes + example: "One or several indexes are missing or invalid, results hold data from the other indexes" type: string type: object MSTeamsIntegrationMetadata: @@ -38282,10 +36702,10 @@ components: description: Array of Microsoft Teams in this integration metadata. example: [] items: - $ref: '#/components/schemas/MSTeamsIntegrationMetadataTeamsItem' + $ref: "#/components/schemas/MSTeamsIntegrationMetadataTeamsItem" type: array required: - - teams + - teams type: object MSTeamsIntegrationMetadataTeamsItem: description: Item in the Microsoft Teams integration metadata teams array. @@ -38307,53 +36727,51 @@ components: example: https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000 type: string required: - - ms_tenant_id - - ms_channel_id - - ms_channel_name - - redirect_url + - ms_tenant_id + - ms_channel_id + - ms_channel_name + - redirect_url type: object Maintenance: properties: data: - $ref: '#/components/schemas/MaintenanceData' + $ref: "#/components/schemas/MaintenanceData" included: - description: The included related resources of a maintenance. Client must - explicitly request these resources by name in the `include` query parameter. + description: The included related resources of a maintenance. Client must explicitly request these resources by name in the `include` query parameter. items: - $ref: '#/components/schemas/DegradationIncluded' + $ref: "#/components/schemas/DegradationIncluded" type: array type: object MaintenanceArray: properties: data: items: - $ref: '#/components/schemas/MaintenanceData' + $ref: "#/components/schemas/MaintenanceData" type: array included: - description: The included related resources of a maintenance. Client must - explicitly request these resources by name in the `include` query parameter. + description: The included related resources of a maintenance. Client must explicitly request these resources by name in the `include` query parameter. items: - $ref: '#/components/schemas/DegradationIncluded' + $ref: "#/components/schemas/DegradationIncluded" type: array meta: - $ref: '#/components/schemas/PaginationMeta' + $ref: "#/components/schemas/PaginationMeta" required: - - data + - data type: object MaintenanceData: properties: attributes: - $ref: '#/components/schemas/MaintenanceDataAttributes' + $ref: "#/components/schemas/MaintenanceDataAttributes" id: description: The ID of the maintenance. format: uuid type: string relationships: - $ref: '#/components/schemas/MaintenanceDataRelationships' + $ref: "#/components/schemas/MaintenanceDataRelationships" type: - $ref: '#/components/schemas/PatchMaintenanceRequestDataType' + $ref: "#/components/schemas/PatchMaintenanceRequestDataType" required: - - type + - type type: object MaintenanceDataAttributes: description: The attributes of a maintenance. @@ -38368,7 +36786,7 @@ components: components_affected: description: Components affected by the maintenance. items: - $ref: '#/components/schemas/MaintenanceDataAttributesComponentsAffectedItems' + $ref: "#/components/schemas/MaintenanceDataAttributesComponentsAffectedItems" type: array in_progress_description: description: The description shown while the maintenance is in progress. @@ -38389,7 +36807,7 @@ components: format: date-time type: string status: - $ref: '#/components/schemas/MaintenanceDataAttributesStatus' + $ref: "#/components/schemas/MaintenanceDataAttributesStatus" description: The status of the maintenance. title: description: Title of the maintenance. @@ -38397,14 +36815,14 @@ components: updates: description: Past updates made to the maintenance. items: - $ref: '#/components/schemas/MaintenanceDataAttributesUpdatesItems' + $ref: "#/components/schemas/MaintenanceDataAttributesUpdatesItems" type: array type: object MaintenanceDataAttributesComponentsAffectedItems: properties: id: description: The ID of the component. Must be a component of type `component`. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string name: @@ -38412,28 +36830,28 @@ components: readOnly: true type: string status: - $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus' + $ref: "#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus" required: - - id - - status + - id + - status type: object MaintenanceDataAttributesStatus: description: The status of the maintenance. enum: - - scheduled - - in_progress - - completed + - scheduled + - in_progress + - completed type: string x-enum-varnames: - - SCHEDULED - - IN_PROGRESS - - COMPLETED + - SCHEDULED + - IN_PROGRESS + - COMPLETED MaintenanceDataAttributesUpdatesItems: properties: components_affected: description: The components affected at the time of the update. items: - $ref: '#/components/schemas/MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems' + $ref: "#/components/schemas/MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems" type: array created_at: description: Timestamp of when the update was created. @@ -38449,8 +36867,7 @@ components: readOnly: true type: string manual_transition: - description: Whether the update was applied manually by a user (true) or - automatically by the system (false). + description: Whether the update was applied manually by a user (true) or automatically by the system (false). readOnly: true type: boolean modified_at: @@ -38470,7 +36887,7 @@ components: properties: id: description: Identifier of the component affected at the time of the update. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string name: @@ -38478,84 +36895,84 @@ components: readOnly: true type: string status: - $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus' + $ref: "#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus" description: The status of the component affected at the time of the update. required: - - id - - status + - id + - status type: object MaintenanceDataRelationships: description: The relationships of a maintenance. properties: created_by_user: - $ref: '#/components/schemas/MaintenanceDataRelationshipsCreatedByUser' + $ref: "#/components/schemas/MaintenanceDataRelationshipsCreatedByUser" description: The Datadog user who created the maintenance. last_modified_by_user: - $ref: '#/components/schemas/MaintenanceDataRelationshipsLastModifiedByUser' + $ref: "#/components/schemas/MaintenanceDataRelationshipsLastModifiedByUser" description: The Datadog user who last modified the maintenance. status_page: - $ref: '#/components/schemas/MaintenanceDataRelationshipsStatusPage' + $ref: "#/components/schemas/MaintenanceDataRelationshipsStatusPage" description: The status page the maintenance belongs to. type: object MaintenanceDataRelationshipsCreatedByUser: properties: data: - $ref: '#/components/schemas/MaintenanceDataRelationshipsCreatedByUserData' + $ref: "#/components/schemas/MaintenanceDataRelationshipsCreatedByUserData" required: - - data + - data type: object MaintenanceDataRelationshipsCreatedByUserData: properties: id: description: The ID of the Datadog user who created the maintenance. - example: '' + example: "" format: uuid type: string type: - $ref: '#/components/schemas/StatusPagesUserType' + $ref: "#/components/schemas/StatusPagesUserType" required: - - type - - id + - type + - id type: object MaintenanceDataRelationshipsLastModifiedByUser: properties: data: - $ref: '#/components/schemas/MaintenanceDataRelationshipsLastModifiedByUserData' + $ref: "#/components/schemas/MaintenanceDataRelationshipsLastModifiedByUserData" required: - - data + - data type: object MaintenanceDataRelationshipsLastModifiedByUserData: properties: id: description: The ID of the Datadog user who last modified the maintenance. - example: '' + example: "" format: uuid type: string type: - $ref: '#/components/schemas/StatusPagesUserType' + $ref: "#/components/schemas/StatusPagesUserType" required: - - type - - id + - type + - id type: object MaintenanceDataRelationshipsStatusPage: properties: data: - $ref: '#/components/schemas/MaintenanceDataRelationshipsStatusPageData' + $ref: "#/components/schemas/MaintenanceDataRelationshipsStatusPageData" required: - - data + - data type: object MaintenanceDataRelationshipsStatusPageData: properties: id: description: The ID of the status page. - example: '' + example: "" format: uuid type: string type: - $ref: '#/components/schemas/StatusPageDataType' + $ref: "#/components/schemas/StatusPageDataType" required: - - type - - id + - type + - id type: object MemberTeam: description: A member team @@ -38565,20 +36982,20 @@ components: example: aeadc05e-98a8-11ec-ac2c-da7ad0900001 type: string type: - $ref: '#/components/schemas/MemberTeamType' + $ref: "#/components/schemas/MemberTeamType" required: - - id - - type + - id + - type type: object MemberTeamType: default: member_teams description: Member team type enum: - - member_teams + - member_teams example: member_teams type: string x-enum-varnames: - - MEMBER_TEAMS + - MEMBER_TEAMS Metadata: description: The metadata related to this request. properties: @@ -38589,7 +37006,7 @@ components: type: integer token: description: The token that identifies the request. - example: b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4 + example: "b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4" type: string total: description: Total number of entities across all pages. @@ -38597,9 +37014,9 @@ components: format: int64 type: integer required: - - count - - total - - token + - count + - total + - token type: object Metric: description: Object for a single metric tag configuration. @@ -38608,60 +37025,52 @@ components: type: metrics properties: id: - $ref: '#/components/schemas/MetricName' + $ref: "#/components/schemas/MetricName" type: - $ref: '#/components/schemas/MetricType' + $ref: "#/components/schemas/MetricType" type: object MetricActiveConfigurationType: default: actively_queried_configurations description: The metric actively queried configuration resource type. enum: - - actively_queried_configurations + - actively_queried_configurations example: actively_queried_configurations type: string x-enum-varnames: - - ACTIVELY_QUERIED_CONFIGURATIONS + - ACTIVELY_QUERIED_CONFIGURATIONS MetricAllTags: description: Object for a single metric's indexed and ingested tags. properties: attributes: - $ref: '#/components/schemas/MetricAllTagsAttributes' + $ref: "#/components/schemas/MetricAllTagsAttributes" id: - $ref: '#/components/schemas/MetricName' + $ref: "#/components/schemas/MetricName" type: - $ref: '#/components/schemas/MetricType' + $ref: "#/components/schemas/MetricType" type: object MetricAllTagsAttributes: - description: Object containing the definition of a metric's indexed and ingested - tags. + description: Object containing the definition of a metric's indexed and ingested tags. properties: ingested_tags: description: List of ingested tags that are not indexed. - example: - - env:prod - - service:web - - version:1.0 + example: ["env:prod", "service:web", "version:1.0"] items: description: Ingested tags for the metric. type: string type: array tags: description: List of indexed tags. - example: - - sport:golf - - sport:football - - animal:dog + example: ["sport:golf", "sport:football", "animal:dog"] items: description: Indexed tags for the metric. type: string type: array type: object MetricAllTagsResponse: - description: Response object that includes a single metric's indexed and ingested - tags. + description: Response object that includes a single metric's indexed and ingested tags. properties: data: - $ref: '#/components/schemas/MetricAllTags' + $ref: "#/components/schemas/MetricAllTags" readOnly: true type: object MetricAssetAttributes: @@ -38669,11 +37078,7 @@ components: properties: tags: description: List of tag keys used in the asset. - example: - - env - - service - - host - - datacenter + example: ["env", "service", "host", "datacenter"] items: description: Tag key used in assets. type: string @@ -38686,287 +37091,257 @@ components: type: string type: object MetricAssetDashboardRelationship: - description: An object of type `dashboard` that can be referenced in the `included` - data. + description: An object of type `dashboard` that can be referenced in the `included` data. properties: id: - $ref: '#/components/schemas/MetricDashboardID' + $ref: "#/components/schemas/MetricDashboardID" type: - $ref: '#/components/schemas/MetricDashboardType' + $ref: "#/components/schemas/MetricDashboardType" type: object MetricAssetDashboardRelationships: - description: An object containing the list of dashboards that can be referenced - in the `included` data. + description: An object containing the list of dashboards that can be referenced in the `included` data. properties: data: - description: A list of dashboards that can be referenced in the `included` - data. + description: A list of dashboards that can be referenced in the `included` data. items: - $ref: '#/components/schemas/MetricAssetDashboardRelationship' + $ref: "#/components/schemas/MetricAssetDashboardRelationship" type: array type: object MetricAssetMonitorRelationship: - description: An object of type `monitor` that can be referenced in the `included` - data. + description: An object of type `monitor` that can be referenced in the `included` data. properties: id: - $ref: '#/components/schemas/MetricMonitorID' + $ref: "#/components/schemas/MetricMonitorID" type: - $ref: '#/components/schemas/MetricMonitorType' + $ref: "#/components/schemas/MetricMonitorType" type: object MetricAssetMonitorRelationships: - description: A object containing the list of monitors that can be referenced - in the `included` data. + description: A object containing the list of monitors that can be referenced in the `included` data. properties: data: - description: A list of monitors that can be referenced in the `included` - data. + description: A list of monitors that can be referenced in the `included` data. items: - $ref: '#/components/schemas/MetricAssetMonitorRelationship' + $ref: "#/components/schemas/MetricAssetMonitorRelationship" type: array type: object MetricAssetNotebookRelationship: - description: An object of type `notebook` that can be referenced in the `included` - data. + description: An object of type `notebook` that can be referenced in the `included` data. properties: id: - $ref: '#/components/schemas/MetricNotebookID' + $ref: "#/components/schemas/MetricNotebookID" type: - $ref: '#/components/schemas/MetricNotebookType' + $ref: "#/components/schemas/MetricNotebookType" type: object MetricAssetNotebookRelationships: - description: An object containing the list of notebooks that can be referenced - in the `included` data. + description: An object containing the list of notebooks that can be referenced in the `included` data. properties: data: - description: A list of notebooks that can be referenced in the `included` - data. + description: A list of notebooks that can be referenced in the `included` data. items: - $ref: '#/components/schemas/MetricAssetNotebookRelationship' + $ref: "#/components/schemas/MetricAssetNotebookRelationship" type: array type: object MetricAssetResponseData: description: Metric assets response data. properties: id: - $ref: '#/components/schemas/MetricName' + $ref: "#/components/schemas/MetricName" relationships: - $ref: '#/components/schemas/MetricAssetResponseRelationships' + $ref: "#/components/schemas/MetricAssetResponseRelationships" type: - $ref: '#/components/schemas/MetricType' + $ref: "#/components/schemas/MetricType" required: - - id - - type + - id + - type type: object MetricAssetResponseIncluded: description: List of included assets with full set of attributes. oneOf: - - $ref: '#/components/schemas/MetricDashboardAsset' - - $ref: '#/components/schemas/MetricMonitorAsset' - - $ref: '#/components/schemas/MetricNotebookAsset' - - $ref: '#/components/schemas/MetricSLOAsset' + - $ref: "#/components/schemas/MetricDashboardAsset" + - $ref: "#/components/schemas/MetricMonitorAsset" + - $ref: "#/components/schemas/MetricNotebookAsset" + - $ref: "#/components/schemas/MetricSLOAsset" MetricAssetResponseRelationships: description: Relationships to assets related to the metric. properties: dashboards: - $ref: '#/components/schemas/MetricAssetDashboardRelationships' + $ref: "#/components/schemas/MetricAssetDashboardRelationships" monitors: - $ref: '#/components/schemas/MetricAssetMonitorRelationships' + $ref: "#/components/schemas/MetricAssetMonitorRelationships" notebooks: - $ref: '#/components/schemas/MetricAssetNotebookRelationships' + $ref: "#/components/schemas/MetricAssetNotebookRelationships" slos: - $ref: '#/components/schemas/MetricAssetSLORelationships' + $ref: "#/components/schemas/MetricAssetSLORelationships" type: object MetricAssetSLORelationship: - description: An object of type `slos` that can be referenced in the `included` - data. + description: An object of type `slos` that can be referenced in the `included` data. properties: id: - $ref: '#/components/schemas/MetricSLOID' + $ref: "#/components/schemas/MetricSLOID" type: - $ref: '#/components/schemas/MetricSLOType' + $ref: "#/components/schemas/MetricSLOType" type: object MetricAssetSLORelationships: - description: An object containing a list of SLOs that can be referenced in the - `included` data. + description: An object containing a list of SLOs that can be referenced in the `included` data. properties: data: description: A list of SLOs that can be referenced in the `included` data. items: - $ref: '#/components/schemas/MetricAssetSLORelationship' + $ref: "#/components/schemas/MetricAssetSLORelationship" type: array type: object MetricAssetsResponse: - description: Response object that includes related dashboards, monitors, notebooks, - and SLOs. + description: Response object that includes related dashboards, monitors, notebooks, and SLOs. properties: data: - $ref: '#/components/schemas/MetricAssetResponseData' + $ref: "#/components/schemas/MetricAssetResponseData" included: description: Array of objects related to the metric assets. items: - $ref: '#/components/schemas/MetricAssetResponseIncluded' + $ref: "#/components/schemas/MetricAssetResponseIncluded" type: array type: object MetricBulkConfigureTagsType: default: metric_bulk_configure_tags description: The metric bulk configure tags resource. enum: - - metric_bulk_configure_tags + - metric_bulk_configure_tags example: metric_bulk_configure_tags type: string x-enum-varnames: - - BULK_MANAGE_TAGS + - BULK_MANAGE_TAGS MetricBulkTagConfigCreate: - description: Request object to bulk configure tags for metrics matching the - given prefix. + description: Request object to bulk configure tags for metrics matching the given prefix. properties: attributes: - $ref: '#/components/schemas/MetricBulkTagConfigCreateAttributes' + $ref: "#/components/schemas/MetricBulkTagConfigCreateAttributes" id: - $ref: '#/components/schemas/MetricBulkTagConfigNamePrefix' + $ref: "#/components/schemas/MetricBulkTagConfigNamePrefix" type: - $ref: '#/components/schemas/MetricBulkConfigureTagsType' + $ref: "#/components/schemas/MetricBulkConfigureTagsType" required: - - id - - type + - id + - type type: object MetricBulkTagConfigCreateAttributes: description: Optional parameters for bulk creating metric tag configurations. properties: emails: - $ref: '#/components/schemas/MetricBulkTagConfigEmailList' + $ref: "#/components/schemas/MetricBulkTagConfigEmailList" exclude_tags_mode: - description: 'When set to true, the configuration will exclude the configured - tags and include any other submitted tags. - - When set to false, the configuration will include the configured tags - and exclude any other submitted tags. - - Defaults to false.' + description: |- + When set to true, the configuration will exclude the configured tags and include any other submitted tags. + When set to false, the configuration will include the configured tags and exclude any other submitted tags. + Defaults to false. type: boolean include_actively_queried_tags_window: - description: 'When provided, all tags that have been actively queried are - + description: |- + When provided, all tags that have been actively queried are configured (and, therefore, remain queryable) for each metric that - matches the given prefix. Minimum value is 1 second, and maximum - - value is 7,776,000 seconds (90 days).' + value is 7,776,000 seconds (90 days). format: double maximum: 7776000 minimum: 1 type: number override_existing_configurations: - description: 'When set to true, the configuration overrides any existing - + description: |- + When set to true, the configuration overrides any existing configurations for the given metric with the new set of tags in this - configuration request. If false, old configurations are kept and - are merged with the set of tags in this configuration request. - - Defaults to true.' + Defaults to true. type: boolean tags: - $ref: '#/components/schemas/MetricBulkTagConfigTagNameList' + $ref: "#/components/schemas/MetricBulkTagConfigTagNameList" type: object MetricBulkTagConfigCreateRequest: description: Wrapper object for a single bulk tag configuration request. properties: data: - $ref: '#/components/schemas/MetricBulkTagConfigCreate' + $ref: "#/components/schemas/MetricBulkTagConfigCreate" required: - - data + - data type: object MetricBulkTagConfigDelete: - description: Request object to bulk delete all tag configurations for metrics - matching the given prefix. + description: Request object to bulk delete all tag configurations for metrics matching the given prefix. properties: attributes: - $ref: '#/components/schemas/MetricBulkTagConfigDeleteAttributes' + $ref: "#/components/schemas/MetricBulkTagConfigDeleteAttributes" id: - $ref: '#/components/schemas/MetricBulkTagConfigNamePrefix' + $ref: "#/components/schemas/MetricBulkTagConfigNamePrefix" type: - $ref: '#/components/schemas/MetricBulkConfigureTagsType' + $ref: "#/components/schemas/MetricBulkConfigureTagsType" required: - - id - - type + - id + - type type: object MetricBulkTagConfigDeleteAttributes: description: Optional parameters for bulk deleting metric tag configurations. properties: emails: - $ref: '#/components/schemas/MetricBulkTagConfigEmailList' + $ref: "#/components/schemas/MetricBulkTagConfigEmailList" type: object MetricBulkTagConfigDeleteRequest: description: Wrapper object for a single bulk tag deletion request. properties: data: - $ref: '#/components/schemas/MetricBulkTagConfigDelete' + $ref: "#/components/schemas/MetricBulkTagConfigDelete" required: - - data + - data type: object MetricBulkTagConfigEmailList: description: A list of account emails to notify when the configuration is applied. - example: - - sue@example.com - - bob@example.com + example: ["sue@example.com", "bob@example.com"] items: description: An email address. type: string type: array MetricBulkTagConfigNamePrefix: description: A text prefix to match against metric names. - example: kafka.lag + example: "kafka.lag" type: string MetricBulkTagConfigResponse: description: Wrapper for a single bulk tag configuration status response. properties: data: - $ref: '#/components/schemas/MetricBulkTagConfigStatus' + $ref: "#/components/schemas/MetricBulkTagConfigStatus" type: object MetricBulkTagConfigStatus: - description: 'The status of a request to bulk configure metric tags. - - It contains the fields from the original request for reference.' + description: |- + The status of a request to bulk configure metric tags. + It contains the fields from the original request for reference. properties: attributes: - $ref: '#/components/schemas/MetricBulkTagConfigStatusAttributes' + $ref: "#/components/schemas/MetricBulkTagConfigStatusAttributes" id: - $ref: '#/components/schemas/MetricBulkTagConfigNamePrefix' + $ref: "#/components/schemas/MetricBulkTagConfigNamePrefix" type: - $ref: '#/components/schemas/MetricBulkConfigureTagsType' + $ref: "#/components/schemas/MetricBulkConfigureTagsType" required: - - id - - type + - id + - type type: object MetricBulkTagConfigStatusAttributes: - description: Optional attributes for the status of a bulk tag configuration - request. + description: Optional attributes for the status of a bulk tag configuration request. properties: emails: - $ref: '#/components/schemas/MetricBulkTagConfigEmailList' + $ref: "#/components/schemas/MetricBulkTagConfigEmailList" exclude_tags_mode: - description: 'When set to true, the configuration will exclude the configured - tags and include any other submitted tags. - - When set to false, the configuration will include the configured tags - and exclude any other submitted tags.' + description: |- + When set to true, the configuration will exclude the configured tags and include any other submitted tags. + When set to false, the configuration will include the configured tags and exclude any other submitted tags. type: boolean status: description: The status of the request. - example: Accepted + example: "Accepted" type: string tags: - $ref: '#/components/schemas/MetricBulkTagConfigTagNameList' + $ref: "#/components/schemas/MetricBulkTagConfigTagNameList" type: object MetricBulkTagConfigTagNameList: description: A list of tag names to apply to the configuration. - example: - - host - - pod_name - - is_shadow + example: ["host", "pod_name", "is_shadow"] items: description: A metric tag name. maxLength: 200 @@ -38977,86 +37352,86 @@ components: default: deflate description: HTTP header used to compress the media-type. enum: - - deflate - - zstd1 - - gzip + - deflate + - zstd1 + - gzip example: deflate type: string x-enum-varnames: - - DEFLATE - - ZSTD1 - - GZIP + - DEFLATE + - ZSTD1 + - GZIP MetricCustomAggregation: - description: A time and space aggregation combination for use in query. + description: |- + A time and space aggregation combination for use in query. example: space: sum time: sum properties: space: - $ref: '#/components/schemas/MetricCustomSpaceAggregation' + $ref: "#/components/schemas/MetricCustomSpaceAggregation" time: - $ref: '#/components/schemas/MetricCustomTimeAggregation' + $ref: "#/components/schemas/MetricCustomTimeAggregation" required: - - time - - space + - time + - space type: object MetricCustomAggregations: - description: Deprecated. You no longer need to configure specific time and space - aggregations for Metrics Without Limits. + description: |- + Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits. example: - - space: sum - time: sum - - space: sum - time: count + - space: sum + time: sum + - space: sum + time: count items: - $ref: '#/components/schemas/MetricCustomAggregation' + $ref: "#/components/schemas/MetricCustomAggregation" type: array MetricCustomSpaceAggregation: description: A space aggregation for use in query. enum: - - avg - - max - - min - - sum + - avg + - max + - min + - sum example: sum type: string x-enum-varnames: - - AVG - - MAX - - MIN - - SUM + - AVG + - MAX + - MIN + - SUM MetricCustomTimeAggregation: description: A time aggregation for use in query. enum: - - avg - - count - - max - - min - - sum + - avg + - count + - max + - min + - sum example: sum type: string x-enum-varnames: - - AVG - - COUNT - - MAX - - MIN - - SUM + - AVG + - COUNT + - MAX + - MIN + - SUM MetricDashboardAsset: description: A dashboard object with title and popularity. properties: attributes: - $ref: '#/components/schemas/MetricDashboardAttributes' + $ref: "#/components/schemas/MetricDashboardAttributes" id: - $ref: '#/components/schemas/MetricDashboardID' + $ref: "#/components/schemas/MetricDashboardID" type: - $ref: '#/components/schemas/MetricDashboardType' + $ref: "#/components/schemas/MetricDashboardType" required: - - id - - type + - id + - type type: object MetricDashboardAttributes: - description: Attributes related to the dashboard, including title, popularity, - and url. + description: Attributes related to the dashboard, including title, popularity, and url. properties: popularity: description: Value from 0 to 5 that ranks popularity of the dashboard. @@ -39066,11 +37441,7 @@ components: type: number tags: description: List of tag keys used in the asset. - example: - - env - - service - - host - - datacenter + example: ["env", "service", "host", "datacenter"] items: description: Tag key used in assets. type: string @@ -39084,25 +37455,25 @@ components: type: object MetricDashboardID: description: The related dashboard's ID. - example: xxx-yyy-zzz + example: "xxx-yyy-zzz" type: string MetricDashboardType: description: Dashboard resource type. enum: - - dashboards - example: dashboards + - dashboards + example: "dashboards" type: string x-enum-varnames: - - DASHBOARDS + - DASHBOARDS MetricDistinctVolume: description: Object for a single metric's distinct volume. properties: attributes: - $ref: '#/components/schemas/MetricDistinctVolumeAttributes' + $ref: "#/components/schemas/MetricDistinctVolumeAttributes" id: - $ref: '#/components/schemas/MetricName' + $ref: "#/components/schemas/MetricName" type: - $ref: '#/components/schemas/MetricDistinctVolumeType' + $ref: "#/components/schemas/MetricDistinctVolumeType" type: object MetricDistinctVolumeAttributes: description: Object containing the definition of a metric's distinct volume. @@ -39117,29 +37488,29 @@ components: default: distinct_metric_volumes description: The metric distinct volume type. enum: - - distinct_metric_volumes + - distinct_metric_volumes example: distinct_metric_volumes type: string x-enum-varnames: - - DISTINCT_METRIC_VOLUMES + - DISTINCT_METRIC_VOLUMES MetricEstimate: description: Object for a metric cardinality estimate. properties: attributes: - $ref: '#/components/schemas/MetricEstimateAttributes' + $ref: "#/components/schemas/MetricEstimateAttributes" id: - $ref: '#/components/schemas/MetricName' + $ref: "#/components/schemas/MetricName" type: - $ref: '#/components/schemas/MetricEstimateResourceType' + $ref: "#/components/schemas/MetricEstimateResourceType" type: object MetricEstimateAttributes: description: Object containing the definition of a metric estimate attribute. properties: estimate_type: - $ref: '#/components/schemas/MetricEstimateType' + $ref: "#/components/schemas/MetricEstimateType" estimated_at: description: Timestamp when the cardinality estimate was requested. - example: '2022-04-27T09:48:37.463835Z' + example: "2022-04-27T09:48:37.463835Z" format: date-time type: string estimated_output_series: @@ -39152,46 +37523,43 @@ components: default: metric_cardinality_estimate description: The metric estimate resource type. enum: - - metric_cardinality_estimate + - metric_cardinality_estimate example: metric_cardinality_estimate type: string x-enum-varnames: - - METRIC_CARDINALITY_ESTIMATE + - METRIC_CARDINALITY_ESTIMATE MetricEstimateResponse: description: Response object that includes metric cardinality estimates. properties: data: - $ref: '#/components/schemas/MetricEstimate' + $ref: "#/components/schemas/MetricEstimate" type: object MetricEstimateType: default: count_or_gauge - description: Estimate type based on the queried configuration. By default, `count_or_gauge` - is returned. `distribution` is returned for distribution metrics without percentiles - enabled. Lastly, `percentile` is returned if `filter[pct]=true` is queried - with a distribution metric. - enum: - - count_or_gauge - - distribution - - percentile + description: |- + Estimate type based on the queried configuration. By default, `count_or_gauge` is returned. `distribution` is returned for distribution metrics without percentiles enabled. Lastly, `percentile` is returned if `filter[pct]=true` is queried with a distribution metric. + enum: + - count_or_gauge + - distribution + - percentile example: distribution type: string x-enum-varnames: - - COUNT_OR_GAUGE - - DISTRIBUTION - - PERCENTILE + - COUNT_OR_GAUGE + - DISTRIBUTION + - PERCENTILE MetricIngestedIndexedVolume: description: Object for a single metric's ingested and indexed volume. properties: attributes: - $ref: '#/components/schemas/MetricIngestedIndexedVolumeAttributes' + $ref: "#/components/schemas/MetricIngestedIndexedVolumeAttributes" id: - $ref: '#/components/schemas/MetricName' + $ref: "#/components/schemas/MetricName" type: - $ref: '#/components/schemas/MetricIngestedIndexedVolumeType' + $ref: "#/components/schemas/MetricIngestedIndexedVolumeType" type: object MetricIngestedIndexedVolumeAttributes: - description: Object containing the definition of a metric's ingested and indexed - volume. + description: Object containing the definition of a metric's ingested and indexed volume. properties: indexed_volume: description: Indexed volume for the given metric. @@ -39208,29 +37576,27 @@ components: default: metric_volumes description: The metric ingested and indexed volume type. enum: - - metric_volumes + - metric_volumes example: metric_volumes type: string x-enum-varnames: - - METRIC_VOLUMES + - METRIC_VOLUMES MetricIntakeType: - description: The type of metric. The available types are `0` (unspecified), - `1` (count), `2` (rate), and `3` (gauge). + description: The type of metric. The available types are `0` (unspecified), `1` (count), `2` (rate), and `3` (gauge). enum: - - 0 - - 1 - - 2 - - 3 + - 0 + - 1 + - 2 + - 3 format: int32 type: integer x-enum-varnames: - - UNSPECIFIED - - COUNT - - RATE - - GAUGE + - UNSPECIFIED + - COUNT + - RATE + - GAUGE MetricMetaPage: - description: Paging attributes. Only present if pagination query parameters - were provided. + description: Paging attributes. Only present if pagination query parameters were provided. properties: cursor: description: The cursor used to get the current results, if any. @@ -39247,48 +37613,48 @@ components: nullable: true type: string type: - $ref: '#/components/schemas/MetricMetaPageType' + $ref: "#/components/schemas/MetricMetaPageType" type: object MetricMetaPageType: default: cursor_limit description: Type of metric pagination. enum: - - cursor_limit + - cursor_limit example: cursor_limit type: string x-enum-varnames: - - CURSOR_LIMIT + - CURSOR_LIMIT MetricMetadata: description: Metadata for the metric. properties: origin: - $ref: '#/components/schemas/MetricOrigin' + $ref: "#/components/schemas/MetricOrigin" type: object MetricMonitorAsset: description: A monitor object with title. properties: attributes: - $ref: '#/components/schemas/MetricAssetAttributes' + $ref: "#/components/schemas/MetricAssetAttributes" id: - $ref: '#/components/schemas/MetricMonitorID' + $ref: "#/components/schemas/MetricMonitorID" type: - $ref: '#/components/schemas/MetricMonitorType' + $ref: "#/components/schemas/MetricMonitorType" required: - - id - - type + - id + - type type: object MetricMonitorID: description: The related monitor's ID. - example: '1775073' + example: "1775073" type: string MetricMonitorType: description: Monitor resource type. enum: - - monitors - example: monitors + - monitors + example: "monitors" type: string x-enum-varnames: - - MONITORS + - MONITORS MetricName: description: The metric name for this resource. example: test.metric.latency @@ -39297,27 +37663,27 @@ components: description: A notebook object with title. properties: attributes: - $ref: '#/components/schemas/MetricAssetAttributes' + $ref: "#/components/schemas/MetricAssetAttributes" id: - $ref: '#/components/schemas/MetricNotebookID' + $ref: "#/components/schemas/MetricNotebookID" type: - $ref: '#/components/schemas/MetricNotebookType' + $ref: "#/components/schemas/MetricNotebookType" required: - - id - - type + - id + - type type: object MetricNotebookID: description: The related notebook's ID. - example: '12345' + example: "12345" type: string MetricNotebookType: description: Notebook resource type. enum: - - notebooks - example: notebooks + - notebooks + example: "notebooks" type: string x-enum-varnames: - - NOTEBOOKS + - NOTEBOOKS MetricOrigin: description: Metric origin information. properties: @@ -39344,7 +37710,7 @@ components: description: Response metadata object. properties: pagination: - $ref: '#/components/schemas/MetricMetaPage' + $ref: "#/components/schemas/MetricMetaPage" type: object MetricPayload: description: The metrics' payload. @@ -39352,43 +37718,35 @@ components: series: description: A list of timeseries to submit to Datadog. example: - - metric: system.load.1 - points: - - timestamp: 1475317847 - value: 0.7 - resources: - - name: dummyhost - type: host + - metric: "system.load.1" + points: + - {timestamp: 1475317847, value: 0.7} + resources: + - {name: "dummyhost", type: "host"} items: - $ref: '#/components/schemas/MetricSeries' + $ref: "#/components/schemas/MetricSeries" type: array required: - - series + - series type: object MetricPoint: description: A point object is of the form `{POSIX_timestamp, numeric_value}`. - example: - timestamp: 1575317847 - value: 0.5 + example: {timestamp: 1575317847, value: 0.5} properties: timestamp: - description: 'The timestamp should be in seconds and current. - - Current is defined as not more than 10 minutes in the future or more than - 1 hour in the past.' + description: |- + The timestamp should be in seconds and current. + Current is defined as not more than 10 minutes in the future or more than 1 hour in the past. format: int64 type: integer value: - description: The numeric value format should be a 64bit float gauge-type - value. + description: The numeric value format should be a 64bit float gauge-type value. format: double type: number type: object MetricResource: description: Metric resource. - example: - name: dummyhost - type: host + example: {name: "dummyhost", type: "host"} properties: name: description: The name of the resource. @@ -39401,121 +37759,112 @@ components: description: A SLO object with title. properties: attributes: - $ref: '#/components/schemas/MetricAssetAttributes' + $ref: "#/components/schemas/MetricAssetAttributes" id: - $ref: '#/components/schemas/MetricSLOID' + $ref: "#/components/schemas/MetricSLOID" type: - $ref: '#/components/schemas/MetricSLOType' + $ref: "#/components/schemas/MetricSLOType" required: - - id - - type + - id + - type type: object MetricSLOID: description: The SLO ID. - example: 9ffef113b389520db54391d67d652dfb + example: "9ffef113b389520db54391d67d652dfb" type: string MetricSLOType: description: SLO resource type. enum: - - slos - example: slos + - slos + example: "slos" type: string x-enum-varnames: - - SLOS + - SLOS MetricSeries: - description: 'A metric to submit to Datadog. - - See [Datadog metrics](https://docs.datadoghq.com/developers/metrics/#custom-metrics-properties).' + description: |- + A metric to submit to Datadog. + See [Datadog metrics](https://docs.datadoghq.com/developers/metrics/#custom-metrics-properties). properties: interval: - description: If the type of the metric is rate or count, define the corresponding - interval in seconds. + description: If the type of the metric is rate or count, define the corresponding interval in seconds. example: 20 format: int64 type: integer metadata: - $ref: '#/components/schemas/MetricMetadata' + $ref: "#/components/schemas/MetricMetadata" metric: description: The name of the timeseries. example: system.load.1 type: string points: - description: Points relating to a metric. All points must be objects with - timestamp and a scalar value (cannot be a string). Timestamps should be - in POSIX time in seconds, and cannot be more than ten minutes in the future - or more than one hour in the past. + description: Points relating to a metric. All points must be objects with timestamp and a scalar value (cannot be a string). Timestamps should be in POSIX time in seconds, and cannot be more than ten minutes in the future or more than one hour in the past. example: - - timestamp: 1575317847 - value: 0.5 + - {timestamp: 1575317847, value: 0.5} items: - $ref: '#/components/schemas/MetricPoint' + $ref: "#/components/schemas/MetricPoint" type: array resources: description: A list of resources to associate with this metric. items: - $ref: '#/components/schemas/MetricResource' + $ref: "#/components/schemas/MetricResource" type: array source_type_name: description: The source type name. - example: datadog + example: "datadog" type: string tags: description: A list of tags associated with the metric. - example: - - environment:test + example: ["environment:test"] items: description: Individual tags. type: string type: array type: - $ref: '#/components/schemas/MetricIntakeType' + $ref: "#/components/schemas/MetricIntakeType" unit: description: The unit of point value. - example: second + example: "second" type: string required: - - metric - - points + - metric + - points type: object MetricSuggestedAggregations: - description: List of aggregation combinations that have been actively queried. + description: |- + List of aggregation combinations that have been actively queried. example: - - space: sum - time: sum - - space: sum - time: count + - space: sum + time: sum + - space: sum + time: count items: - $ref: '#/components/schemas/MetricCustomAggregation' + $ref: "#/components/schemas/MetricCustomAggregation" type: array MetricSuggestedTagsAndAggregations: description: Object for a single metric's actively queried tags and aggregations. properties: attributes: - $ref: '#/components/schemas/MetricSuggestedTagsAttributes' + $ref: "#/components/schemas/MetricSuggestedTagsAttributes" id: - $ref: '#/components/schemas/MetricName' + $ref: "#/components/schemas/MetricName" type: - $ref: '#/components/schemas/MetricActiveConfigurationType' + $ref: "#/components/schemas/MetricActiveConfigurationType" type: object MetricSuggestedTagsAndAggregationsResponse: - description: Response object that includes a single metric's actively queried - tags and aggregations. + description: Response object that includes a single metric's actively queried tags and aggregations. properties: data: - $ref: '#/components/schemas/MetricSuggestedTagsAndAggregations' + $ref: "#/components/schemas/MetricSuggestedTagsAndAggregations" readOnly: true type: object MetricSuggestedTagsAttributes: - description: Object containing the definition of a metric's actively queried - tags and aggregations. + description: Object containing the definition of a metric's actively queried tags and aggregations. properties: active_aggregations: - $ref: '#/components/schemas/MetricSuggestedAggregations' + $ref: "#/components/schemas/MetricSuggestedAggregations" active_tags: description: List of tag keys that have been actively queried. - example: - - app - - datacenter + example: ["app", "datacenter"] items: description: Actively queried tag keys. type: string @@ -39524,30 +37873,29 @@ components: MetricTagCardinalitiesData: description: A list of tag cardinalities associated with the given metric. items: - $ref: '#/components/schemas/MetricTagCardinality' + $ref: "#/components/schemas/MetricTagCardinality" type: array MetricTagCardinalitiesMeta: description: Response metadata object. properties: metric_name: - description: 'The name of metric for which the tag cardinalities are returned. - - This matches the metric name provided in the request.' + description: |- + The name of metric for which the tag cardinalities are returned. + This matches the metric name provided in the request. type: string type: object MetricTagCardinalitiesResponse: - description: Response object that includes an array of objects representing - the cardinality details of a metric's tags. + description: |- + Response object that includes an array of objects representing the cardinality details of a metric's tags. properties: data: - $ref: '#/components/schemas/MetricTagCardinalitiesData' + $ref: "#/components/schemas/MetricTagCardinalitiesData" meta: - $ref: '#/components/schemas/MetricTagCardinalitiesMeta' + $ref: "#/components/schemas/MetricTagCardinalitiesMeta" readOnly: true type: object MetricTagCardinality: - description: Object containing metadata and attributes related to a specific - tag key associated with the metric. + description: Object containing metadata and attributes related to a specific tag key associated with the metric. example: attributes: cardinality_delta: 25 @@ -39555,7 +37903,7 @@ components: type: tag_cardinality properties: attributes: - $ref: '#/components/schemas/MetricTagCardinalityAttributes' + $ref: "#/components/schemas/MetricTagCardinalityAttributes" id: description: The name of the tag key. type: string @@ -39576,106 +37924,88 @@ components: description: Object for a single metric tag configuration. example: attributes: - aggregations: - - space: avg - time: avg - created_at: '2020-03-25T09:48:37.463835Z' + aggregations: [{"space": "avg", "time": "avg"}] + created_at: "2020-03-25T09:48:37.463835Z" metric_type: gauge - modified_at: '2020-04-25T09:48:37.463835Z' - tags: - - app - - datacenter + modified_at: "2020-04-25T09:48:37.463835Z" + tags: ["app", "datacenter"] id: http.request.latency type: manage_tags properties: attributes: - $ref: '#/components/schemas/MetricTagConfigurationAttributes' + $ref: "#/components/schemas/MetricTagConfigurationAttributes" id: - $ref: '#/components/schemas/MetricName' + $ref: "#/components/schemas/MetricName" type: - $ref: '#/components/schemas/MetricTagConfigurationType' + $ref: "#/components/schemas/MetricTagConfigurationType" type: object MetricTagConfigurationAttributes: - description: Object containing the definition of a metric tag configuration - attributes. + description: Object containing the definition of a metric tag configuration attributes. properties: aggregations: - $ref: '#/components/schemas/MetricCustomAggregations' + $ref: "#/components/schemas/MetricCustomAggregations" created_at: description: Timestamp when the tag configuration was created. - example: '2020-03-25T09:48:37.463835Z' + example: "2020-03-25T09:48:37.463835Z" format: date-time type: string exclude_tags_mode: - description: 'When set to true, the configuration will exclude the configured - tags and include any other submitted tags. - - When set to false, the configuration will include the configured tags - and exclude any other submitted tags. - - Defaults to false. Requires `tags` property.' + description: |- + When set to true, the configuration will exclude the configured tags and include any other submitted tags. + When set to false, the configuration will include the configured tags and exclude any other submitted tags. + Defaults to false. Requires `tags` property. type: boolean include_percentiles: - description: 'Toggle to include or exclude percentile aggregations for distribution - metrics. - - Only present when the `metric_type` is `distribution`.' + description: |- + Toggle to include or exclude percentile aggregations for distribution metrics. + Only present when the `metric_type` is `distribution`. example: true type: boolean metric_type: - $ref: '#/components/schemas/MetricTagConfigurationMetricTypes' + $ref: "#/components/schemas/MetricTagConfigurationMetricTypes" modified_at: description: Timestamp when the tag configuration was last modified. - example: '2020-03-25T09:48:37.463835Z' + example: "2020-03-25T09:48:37.463835Z" format: date-time type: string tags: description: List of tag keys on which to group. - example: - - app - - datacenter + example: ["app", "datacenter"] items: description: Tag keys to group by. type: string type: array type: object MetricTagConfigurationCreateAttributes: - description: Object containing the definition of a metric tag configuration - to be created. + description: Object containing the definition of a metric tag configuration to be created. properties: aggregations: - $ref: '#/components/schemas/MetricCustomAggregations' + $ref: "#/components/schemas/MetricCustomAggregations" exclude_tags_mode: - description: 'When set to true, the configuration will exclude the configured - tags and include any other submitted tags. - - When set to false, the configuration will include the configured tags - and exclude any other submitted tags. - - Defaults to false. Requires `tags` property.' + description: |- + When set to true, the configuration will exclude the configured tags and include any other submitted tags. + When set to false, the configuration will include the configured tags and exclude any other submitted tags. + Defaults to false. Requires `tags` property. type: boolean include_percentiles: - description: 'Toggle to include/exclude percentiles for a distribution metric. - - Defaults to false. Can only be applied to metrics that have a `metric_type` - of `distribution`.' + description: |- + Toggle to include/exclude percentiles for a distribution metric. + Defaults to false. Can only be applied to metrics that have a `metric_type` of `distribution`. example: true type: boolean metric_type: - $ref: '#/components/schemas/MetricTagConfigurationMetricTypes' + $ref: "#/components/schemas/MetricTagConfigurationMetricTypes" tags: default: [] description: A list of tag keys that will be queryable for your metric. - example: - - app - - datacenter + example: ["app", "datacenter"] items: description: Tag keys to group by. type: string type: array required: - - tags - - metric_type + - tags + - metric_type type: object MetricTagConfigurationCreateData: description: Object for a single metric to be configure tags on. @@ -39684,100 +38014,92 @@ components: include_percentiles: false metric_type: distribution tags: - - app - - datacenter + - app + - datacenter id: http.endpoint.request type: manage_tags properties: attributes: - $ref: '#/components/schemas/MetricTagConfigurationCreateAttributes' + $ref: "#/components/schemas/MetricTagConfigurationCreateAttributes" id: - $ref: '#/components/schemas/MetricName' + $ref: "#/components/schemas/MetricName" type: - $ref: '#/components/schemas/MetricTagConfigurationType' + $ref: "#/components/schemas/MetricTagConfigurationType" required: - - id - - type + - id + - type type: object MetricTagConfigurationCreateRequest: - description: Request object that includes the metric that you would like to - configure tags for. + description: Request object that includes the metric that you would like to configure tags for. properties: data: - $ref: '#/components/schemas/MetricTagConfigurationCreateData' + $ref: "#/components/schemas/MetricTagConfigurationCreateData" required: - - data + - data type: object MetricTagConfigurationMetricTypeCategory: default: distribution description: The metric's type category. enum: - - non_distribution - - distribution + - non_distribution + - distribution example: distribution type: string x-enum-varnames: - - NON_DISTRIBUTION - - DISTRIBUTION + - NON_DISTRIBUTION + - DISTRIBUTION MetricTagConfigurationMetricTypes: default: gauge description: The metric's type. enum: - - gauge - - count - - rate - - distribution + - gauge + - count + - rate + - distribution example: count type: string x-enum-varnames: - - GAUGE - - COUNT - - RATE - - DISTRIBUTION + - GAUGE + - COUNT + - RATE + - DISTRIBUTION MetricTagConfigurationResponse: description: Response object which includes a single metric's tag configuration. properties: data: - $ref: '#/components/schemas/MetricTagConfiguration' + $ref: "#/components/schemas/MetricTagConfiguration" readOnly: true type: object MetricTagConfigurationType: default: manage_tags description: The metric tag configuration resource type. enum: - - manage_tags + - manage_tags example: manage_tags type: string x-enum-varnames: - - MANAGE_TAGS + - MANAGE_TAGS MetricTagConfigurationUpdateAttributes: - description: Object containing the definition of a metric tag configuration - to be updated. + description: Object containing the definition of a metric tag configuration to be updated. properties: aggregations: - $ref: '#/components/schemas/MetricCustomAggregations' + $ref: "#/components/schemas/MetricCustomAggregations" exclude_tags_mode: - description: 'When set to true, the configuration will exclude the configured - tags and include any other submitted tags. - - When set to false, the configuration will include the configured tags - and exclude any other submitted tags. - - Defaults to false. Requires `tags` property.' + description: |- + When set to true, the configuration will exclude the configured tags and include any other submitted tags. + When set to false, the configuration will include the configured tags and exclude any other submitted tags. + Defaults to false. Requires `tags` property. type: boolean include_percentiles: - description: 'Toggle to include/exclude percentiles for a distribution metric. - - Defaults to false. Can only be applied to metrics that have a `metric_type` - of `distribution`.' + description: |- + Toggle to include/exclude percentiles for a distribution metric. + Defaults to false. Can only be applied to metrics that have a `metric_type` of `distribution`. example: true type: boolean tags: default: [] description: A list of tag keys that will be queryable for your metric. - example: - - app - - datacenter + example: ["app", "datacenter"] items: description: Tag keys to group by. type: string @@ -39788,111 +38110,108 @@ components: example: attributes: group_by: - - app - - datacenter + - app + - datacenter include_percentiles: false id: http.endpoint.request type: manage_tags properties: attributes: - $ref: '#/components/schemas/MetricTagConfigurationUpdateAttributes' + $ref: "#/components/schemas/MetricTagConfigurationUpdateAttributes" id: - $ref: '#/components/schemas/MetricName' + $ref: "#/components/schemas/MetricName" type: - $ref: '#/components/schemas/MetricTagConfigurationType' + $ref: "#/components/schemas/MetricTagConfigurationType" required: - - id - - type + - id + - type type: object MetricTagConfigurationUpdateRequest: - description: Request object that includes the metric that you would like to - edit the tag configuration on. + description: Request object that includes the metric that you would like to edit the tag configuration on. properties: data: - $ref: '#/components/schemas/MetricTagConfigurationUpdateData' + $ref: "#/components/schemas/MetricTagConfigurationUpdateData" required: - - data + - data type: object MetricType: default: metrics description: The metric resource type. enum: - - metrics + - metrics example: metrics type: string x-enum-varnames: - - METRICS + - METRICS MetricVolumes: description: Possible response objects for a metric's volume. oneOf: - - $ref: '#/components/schemas/MetricDistinctVolume' - - $ref: '#/components/schemas/MetricIngestedIndexedVolume' + - $ref: "#/components/schemas/MetricDistinctVolume" + - $ref: "#/components/schemas/MetricIngestedIndexedVolume" MetricVolumesResponse: description: Response object which includes a single metric's volume. properties: data: - $ref: '#/components/schemas/MetricVolumes' + $ref: "#/components/schemas/MetricVolumes" readOnly: true type: object MetricsAggregator: - default: avg - description: The type of aggregation that can be performed on metrics-based - queries. - enum: - - avg - - min - - max - - sum - - last - - percentile - - mean - - l2norm - - area - example: avg - type: string - x-enum-varnames: - - AVG - - MIN - - MAX - - SUM - - LAST - - PERCENTILE - - MEAN - - L2NORM - - AREA + default: "avg" + description: The type of aggregation that can be performed on metrics-based queries. + enum: + - avg + - min + - max + - sum + - last + - percentile + - mean + - l2norm + - area + example: "avg" + type: string + x-enum-varnames: + - AVG + - MIN + - MAX + - SUM + - LAST + - PERCENTILE + - MEAN + - L2NORM + - AREA MetricsAndMetricTagConfigurations: description: Object for a metrics and metric tag configurations. oneOf: - - $ref: '#/components/schemas/Metric' - - $ref: '#/components/schemas/MetricTagConfiguration' + - $ref: "#/components/schemas/Metric" + - $ref: "#/components/schemas/MetricTagConfiguration" MetricsAndMetricTagConfigurationsResponse: description: Response object that includes metrics and metric tag configurations. properties: data: description: Array of metrics and metric tag configurations. items: - $ref: '#/components/schemas/MetricsAndMetricTagConfigurations' + $ref: "#/components/schemas/MetricsAndMetricTagConfigurations" type: array links: - $ref: '#/components/schemas/MetricsListResponseLinks' + $ref: "#/components/schemas/MetricsListResponseLinks" meta: - $ref: '#/components/schemas/MetricPaginationMeta' + $ref: "#/components/schemas/MetricPaginationMeta" readOnly: true type: object MetricsDataSource: default: metrics description: A data source that is powered by the Metrics platform. enum: - - metrics - - cloud_cost + - metrics + - cloud_cost example: metrics type: string x-enum-varnames: - - METRICS - - CLOUD_COST + - METRICS + - CLOUD_COST MetricsListResponseLinks: - description: Pagination links. Only present if pagination query parameters were - provided. + description: Pagination links. Only present if pagination query parameters were provided. properties: first: description: Link to the first page. @@ -39917,9 +38236,9 @@ components: description: An individual scalar metrics query. properties: aggregator: - $ref: '#/components/schemas/MetricsAggregator' + $ref: "#/components/schemas/MetricsAggregator" data_source: - $ref: '#/components/schemas/MetricsDataSource' + $ref: "#/components/schemas/MetricsDataSource" name: description: The variable name for use in formulas. type: string @@ -39928,15 +38247,15 @@ components: example: avg:system.cpu.user{*} by {env} type: string required: - - data_source - - query - - aggregator + - data_source + - query + - aggregator type: object MetricsTimeseriesQuery: description: An individual timeseries metrics query. properties: data_source: - $ref: '#/components/schemas/MetricsDataSource' + $ref: "#/components/schemas/MetricsDataSource" name: description: The variable name for use in formulas. type: string @@ -39945,78 +38264,72 @@ components: example: avg:system.cpu.user{*} by {env} type: string required: - - data_source - - query + - data_source + - query type: object MicrosoftSentinelDestination: - description: 'The `microsoft_sentinel` destination forwards logs to Microsoft - Sentinel. - + description: |- + The `microsoft_sentinel` destination forwards logs to Microsoft Sentinel. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" client_id: description: Azure AD client ID used for authentication. - example: a1b2c3d4-5678-90ab-cdef-1234567890ab + example: "a1b2c3d4-5678-90ab-cdef-1234567890ab" type: string client_secret_key: - description: Name of the environment variable or secret that holds the Azure - AD client secret. + description: Name of the environment variable or secret that holds the Azure AD client secret. example: AZURE_CLIENT_SECRET type: string dce_uri_key: - description: Name of the environment variable or secret that holds the Data - Collection Endpoint (DCE) URI. + description: Name of the environment variable or secret that holds the Data Collection Endpoint (DCE) URI. example: DCE_URI type: string dcr_immutable_id: description: The immutable ID of the Data Collection Rule (DCR). - example: dcr-uuid-1234 + example: "dcr-uuid-1234" type: string id: description: The unique identifier for this component. - example: sentinel-destination + example: "sentinel-destination" type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array table: description: The name of the Log Analytics table where logs are sent. - example: CustomLogsTable + example: "CustomLogsTable" type: string tenant_id: description: Azure AD tenant ID. - example: abcdef12-3456-7890-abcd-ef1234567890 + example: "abcdef12-3456-7890-abcd-ef1234567890" type: string type: - $ref: '#/components/schemas/MicrosoftSentinelDestinationType' + $ref: "#/components/schemas/MicrosoftSentinelDestinationType" required: - - id - - type - - inputs - - client_id - - tenant_id - - dcr_immutable_id - - table + - id + - type + - inputs + - client_id + - tenant_id + - dcr_immutable_id + - table type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] MicrosoftSentinelDestinationType: default: microsoft_sentinel description: The destination type. The value should always be `microsoft_sentinel`. enum: - - microsoft_sentinel + - microsoft_sentinel example: microsoft_sentinel type: string x-enum-varnames: - - MICROSOFT_SENTINEL + - MICROSOFT_SENTINEL MicrosoftTeamsChannelInfoResponseAttributes: description: Channel attributes. properties: @@ -40027,12 +38340,12 @@ components: type: boolean team_id: description: Team id. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" maxLength: 255 type: string tenant_id: description: Tenant id. - example: 00000000-0000-0000-0000-000000000001 + example: "00000000-0000-0000-0000-000000000001" maxLength: 255 type: string type: object @@ -40040,33 +38353,33 @@ components: description: Channel data from a response. properties: attributes: - $ref: '#/components/schemas/MicrosoftTeamsChannelInfoResponseAttributes' + $ref: "#/components/schemas/MicrosoftTeamsChannelInfoResponseAttributes" id: description: The ID of the channel. - example: 19:b41k24b14bn1nwffkernfkwrnfneubgkr@thread.tacv2 + example: "19:b41k24b14bn1nwffkernfkwrnfneubgkr@thread.tacv2" maxLength: 255 minLength: 1 type: string type: - $ref: '#/components/schemas/MicrosoftTeamsChannelInfoType' + $ref: "#/components/schemas/MicrosoftTeamsChannelInfoType" type: object MicrosoftTeamsChannelInfoType: default: ms-teams-channel-info description: Channel info resource type. enum: - - ms-teams-channel-info + - ms-teams-channel-info example: ms-teams-channel-info type: string x-enum-varnames: - - MS_TEAMS_CHANNEL_INFO + - MS_TEAMS_CHANNEL_INFO MicrosoftTeamsConfigurationReference: description: A reference to a Microsoft Teams Configuration resource. nullable: true properties: data: - $ref: '#/components/schemas/MicrosoftTeamsConfigurationReferenceData' + $ref: "#/components/schemas/MicrosoftTeamsConfigurationReferenceData" required: - - data + - data type: object MicrosoftTeamsConfigurationReferenceData: description: The Microsoft Teams configuration relationship data object. @@ -40074,59 +38387,59 @@ components: properties: id: description: The unique identifier of the Microsoft Teams configuration. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string type: description: The type of the Microsoft Teams configuration. - example: microsoft_teams_configurations + example: "microsoft_teams_configurations" type: string required: - - id - - type + - id + - type type: object MicrosoftTeamsCreateTenantBasedHandleRequest: description: Create tenant-based handle request. properties: data: - $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleRequestData' + $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleRequestData" required: - - data + - data type: object MicrosoftTeamsCreateWorkflowsWebhookHandleRequest: description: Create Workflows webhook handle request. properties: data: - $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleRequestData' + $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleRequestData" required: - - data + - data type: object MicrosoftTeamsGetChannelByNameResponse: description: Response with channel, team, and tenant ID information. properties: data: - $ref: '#/components/schemas/MicrosoftTeamsChannelInfoResponseData' + $ref: "#/components/schemas/MicrosoftTeamsChannelInfoResponseData" type: object MicrosoftTeamsTenantBasedHandleAttributes: description: Tenant-based handle attributes. properties: channel_id: description: Channel id. - example: fake-channel-id + example: "fake-channel-id" maxLength: 255 type: string name: description: Tenant-based handle name. - example: fake-handle-name + example: "fake-handle-name" maxLength: 255 type: string team_id: description: Team id. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" maxLength: 255 type: string tenant_id: description: Tenant id. - example: 00000000-0000-0000-0000-000000000001 + example: "00000000-0000-0000-0000-000000000001" maxLength: 255 type: string type: object @@ -40135,37 +38448,37 @@ components: properties: channel_id: description: Channel id. - example: fake-channel-id + example: "fake-channel-id" maxLength: 255 type: string channel_name: description: Channel name. - example: fake-channel-name + example: "fake-channel-name" maxLength: 255 type: string name: description: Tenant-based handle name. - example: fake-handle-name + example: "fake-handle-name" maxLength: 255 type: string team_id: description: Team id. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" maxLength: 255 type: string team_name: description: Team name. - example: fake-team-name + example: "fake-team-name" maxLength: 255 type: string tenant_id: description: Tenant id. - example: 00000000-0000-0000-0000-000000000001 + example: "00000000-0000-0000-0000-000000000001" maxLength: 255 type: string tenant_name: description: Tenant name. - example: fake-tenant-name + example: "fake-tenant-name" maxLength: 255 type: string type: object @@ -40173,177 +38486,157 @@ components: description: Tenant-based handle data from a response. properties: attributes: - $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoResponseAttributes' + $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoResponseAttributes" id: description: The ID of the tenant-based handle. - example: 596da4af-0563-4097-90ff-07230c3f9db3 + example: "596da4af-0563-4097-90ff-07230c3f9db3" maxLength: 100 minLength: 1 type: string type: - $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoType' + $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoType" type: object MicrosoftTeamsTenantBasedHandleInfoType: default: ms-teams-tenant-based-handle-info description: Tenant-based handle resource type. enum: - - ms-teams-tenant-based-handle-info + - ms-teams-tenant-based-handle-info example: ms-teams-tenant-based-handle-info type: string x-enum-varnames: - - MS_TEAMS_TENANT_BASED_HANDLE_INFO + - MS_TEAMS_TENANT_BASED_HANDLE_INFO MicrosoftTeamsTenantBasedHandleRequestAttributes: description: Tenant-based handle attributes. properties: channel_id: description: Channel id. - example: fake-channel-id + example: "fake-channel-id" maxLength: 255 type: string name: description: Tenant-based handle name. - example: fake-handle-name + example: "fake-handle-name" maxLength: 255 type: string team_id: description: Team id. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" maxLength: 255 type: string tenant_id: description: Tenant id. - example: 00000000-0000-0000-0000-000000000001 + example: "00000000-0000-0000-0000-000000000001" maxLength: 255 type: string required: - - name - - channel_id - - team_id - - tenant_id + - name + - channel_id + - team_id + - tenant_id type: object MicrosoftTeamsTenantBasedHandleRequestData: description: Tenant-based handle data from a response. properties: attributes: - $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleRequestAttributes' + $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleRequestAttributes" type: - $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleType' + $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleType" required: - - type - - attributes + - type + - attributes type: object MicrosoftTeamsTenantBasedHandleResponse: description: Response of a tenant-based handle. properties: data: - $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleResponseData' + $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleResponseData" required: - - data + - data type: object MicrosoftTeamsTenantBasedHandleResponseData: description: Tenant-based handle data from a response. properties: attributes: - $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleAttributes' + $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleAttributes" id: description: The ID of the tenant-based handle. - example: 596da4af-0563-4097-90ff-07230c3f9db3 + example: "596da4af-0563-4097-90ff-07230c3f9db3" maxLength: 100 minLength: 1 type: string type: - $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleType' + $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleType" type: object MicrosoftTeamsTenantBasedHandleType: default: tenant-based-handle description: Specifies the tenant-based handle resource type. enum: - - tenant-based-handle + - tenant-based-handle example: tenant-based-handle type: string x-enum-varnames: - - TENANT_BASED_HANDLE + - TENANT_BASED_HANDLE MicrosoftTeamsTenantBasedHandlesResponse: description: Response with a list of tenant-based handles. properties: data: description: An array of tenant-based handles. - example: - - attributes: - channelId: 19:b41k24b14bn1nwffkernfkwrnfneubgkr@thread.tacv2 - channelName: General - name: general-handle - teamId: 00000000-0000-0000-0000-000000000000 - teamName: Example Team - tenantId: 00000000-0000-0000-0000-000000000001 - tenantName: Company, Inc. - id: 596da4af-0563-4097-90ff-07230c3f9db3 - type: ms-teams-tenant-based-handle-info - - attributes: - channelId: 19:b41k24b14bn1nwffkernfkwrnfneubgk1@thread.tacv2 - channelName: General2 - name: general-handle-2 - teamId: 00000000-0000-0000-0000-000000000002 - teamName: Example Team 2 - tenantId: 00000000-0000-0000-0000-000000000003 - tenantName: Company, Inc. - id: 596da4af-0563-4097-90ff-07230c3f9db4 - type: ms-teams-tenant-based-handle-info + example: [{"attributes": {"channelId": "19:b41k24b14bn1nwffkernfkwrnfneubgkr@thread.tacv2", "channelName": "General", "name": "general-handle", "teamId": "00000000-0000-0000-0000-000000000000", "teamName": "Example Team", "tenantId": "00000000-0000-0000-0000-000000000001", "tenantName": "Company, Inc."}, "id": "596da4af-0563-4097-90ff-07230c3f9db3", "type": "ms-teams-tenant-based-handle-info"}, {"attributes": {"channelId": "19:b41k24b14bn1nwffkernfkwrnfneubgk1@thread.tacv2", "channelName": "General2", "name": "general-handle-2", "teamId": "00000000-0000-0000-0000-000000000002", "teamName": "Example Team 2", "tenantId": "00000000-0000-0000-0000-000000000003", "tenantName": "Company, Inc."}, "id": "596da4af-0563-4097-90ff-07230c3f9db4", "type": "ms-teams-tenant-based-handle-info"}] items: - $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoResponseData' + $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoResponseData" type: array required: - - data + - data type: object MicrosoftTeamsUpdateTenantBasedHandleRequest: description: Update tenant-based handle request. properties: data: - $ref: '#/components/schemas/MicrosoftTeamsUpdateTenantBasedHandleRequestData' + $ref: "#/components/schemas/MicrosoftTeamsUpdateTenantBasedHandleRequestData" required: - - data + - data type: object MicrosoftTeamsUpdateTenantBasedHandleRequestData: description: Tenant-based handle data from a response. properties: attributes: - $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleAttributes' + $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleAttributes" type: - $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleType' + $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleType" required: - - type - - attributes + - type + - attributes type: object MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest: description: Update Workflows webhook handle request. properties: data: - $ref: '#/components/schemas/MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData' + $ref: "#/components/schemas/MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData" required: - - data + - data type: object MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData: description: Workflows Webhook handle data from a response. properties: attributes: - $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleAttributes' + $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleAttributes" type: - $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType' + $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType" required: - - type - - attributes + - type + - attributes type: object MicrosoftTeamsWorkflowsWebhookHandleAttributes: description: Workflows Webhook handle attributes. properties: name: description: Workflows Webhook handle name. - example: fake-handle-name + example: "fake-handle-name" maxLength: 255 type: string url: description: Workflows Webhook URL. - example: https://fake.url.com + example: "https://fake.url.com" maxLength: 255 type: string type: object @@ -40352,86 +38645,78 @@ components: properties: name: description: Workflows Webhook handle name. - example: fake-handle-name + example: "fake-handle-name" maxLength: 255 type: string url: description: Workflows Webhook URL. - example: https://fake.url.com + example: "https://fake.url.com" maxLength: 255 type: string required: - - name - - url + - name + - url type: object MicrosoftTeamsWorkflowsWebhookHandleRequestData: description: Workflows Webhook handle data from a response. properties: attributes: - $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleRequestAttributes' + $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleRequestAttributes" type: - $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType' + $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType" required: - - type - - attributes + - type + - attributes type: object MicrosoftTeamsWorkflowsWebhookHandleResponse: description: Response of a Workflows webhook handle. properties: data: - $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponseData' + $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponseData" required: - - data + - data type: object MicrosoftTeamsWorkflowsWebhookHandleResponseData: description: Workflows Webhook handle data from a response. properties: attributes: - $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookResponseAttributes' + $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookResponseAttributes" id: description: The ID of the Workflows webhook handle. - example: 596da4af-0563-4097-90ff-07230c3f9db3 + example: "596da4af-0563-4097-90ff-07230c3f9db3" maxLength: 100 minLength: 1 type: string type: - $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType' + $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType" type: object MicrosoftTeamsWorkflowsWebhookHandleType: default: workflows-webhook-handle description: Specifies the Workflows webhook handle resource type. enum: - - workflows-webhook-handle + - workflows-webhook-handle example: workflows-webhook-handle type: string x-enum-varnames: - - WORKFLOWS_WEBHOOK_HANDLE + - WORKFLOWS_WEBHOOK_HANDLE MicrosoftTeamsWorkflowsWebhookHandlesResponse: description: Response with a list of Workflows webhook handles. properties: data: description: An array of Workflows webhook handles. - example: - - attributes: - name: general-handle - id: 596da4af-0563-4097-90ff-07230c3f9db3 - type: workflows-webhook-handle - - attributes: - name: general-handle-2 - id: 596da4af-0563-4097-90ff-07230c3f9db4 - type: workflows-webhook-handle + example: [{"attributes": {"name": "general-handle"}, "id": "596da4af-0563-4097-90ff-07230c3f9db3", "type": "workflows-webhook-handle"}, {"attributes": {"name": "general-handle-2"}, "id": "596da4af-0563-4097-90ff-07230c3f9db4", "type": "workflows-webhook-handle"}] items: - $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponseData' + $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponseData" type: array required: - - data + - data type: object MicrosoftTeamsWorkflowsWebhookResponseAttributes: description: Workflows Webhook handle attributes. properties: name: description: Workflows Webhook handle name. - example: fake-handle-name + example: "fake-handle-name" maxLength: 255 type: string type: object @@ -40439,74 +38724,74 @@ components: description: Policy and policy type for a monitor configuration policy. properties: policy: - $ref: '#/components/schemas/MonitorConfigPolicyPolicyCreateRequest' + $ref: "#/components/schemas/MonitorConfigPolicyPolicyCreateRequest" policy_type: - $ref: '#/components/schemas/MonitorConfigPolicyType' + $ref: "#/components/schemas/MonitorConfigPolicyType" required: - - policy_type - - policy + - policy_type + - policy type: object MonitorConfigPolicyAttributeEditRequest: description: Policy and policy type for a monitor configuration policy. properties: policy: - $ref: '#/components/schemas/MonitorConfigPolicyPolicy' + $ref: "#/components/schemas/MonitorConfigPolicyPolicy" policy_type: - $ref: '#/components/schemas/MonitorConfigPolicyType' + $ref: "#/components/schemas/MonitorConfigPolicyType" required: - - policy_type - - policy + - policy_type + - policy type: object MonitorConfigPolicyAttributeResponse: description: Policy and policy type for a monitor configuration policy. properties: policy: - $ref: '#/components/schemas/MonitorConfigPolicyPolicy' + $ref: "#/components/schemas/MonitorConfigPolicyPolicy" policy_type: - $ref: '#/components/schemas/MonitorConfigPolicyType' + $ref: "#/components/schemas/MonitorConfigPolicyType" type: object MonitorConfigPolicyCreateData: description: A monitor configuration policy data. properties: attributes: - $ref: '#/components/schemas/MonitorConfigPolicyAttributeCreateRequest' + $ref: "#/components/schemas/MonitorConfigPolicyAttributeCreateRequest" type: - $ref: '#/components/schemas/MonitorConfigPolicyResourceType' + $ref: "#/components/schemas/MonitorConfigPolicyResourceType" required: - - type - - attributes + - type + - attributes type: object MonitorConfigPolicyCreateRequest: description: Request for creating a monitor configuration policy. properties: data: - $ref: '#/components/schemas/MonitorConfigPolicyCreateData' + $ref: "#/components/schemas/MonitorConfigPolicyCreateData" required: - - data + - data type: object MonitorConfigPolicyEditData: description: A monitor configuration policy data. properties: attributes: - $ref: '#/components/schemas/MonitorConfigPolicyAttributeEditRequest' + $ref: "#/components/schemas/MonitorConfigPolicyAttributeEditRequest" id: description: ID of this monitor configuration policy. - example: 00000000-0000-1234-0000-000000000000 + example: "00000000-0000-1234-0000-000000000000" type: string type: - $ref: '#/components/schemas/MonitorConfigPolicyResourceType' + $ref: "#/components/schemas/MonitorConfigPolicyResourceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object MonitorConfigPolicyEditRequest: description: Request for editing a monitor configuration policy. properties: data: - $ref: '#/components/schemas/MonitorConfigPolicyEditData' + $ref: "#/components/schemas/MonitorConfigPolicyEditData" required: - - data + - data type: object MonitorConfigPolicyListResponse: description: Response for retrieving all monitor configuration policies. @@ -40514,43 +38799,43 @@ components: data: description: An array of monitor configuration policies. items: - $ref: '#/components/schemas/MonitorConfigPolicyResponseData' + $ref: "#/components/schemas/MonitorConfigPolicyResponseData" type: array type: object MonitorConfigPolicyPolicy: description: Configuration for the policy. oneOf: - - $ref: '#/components/schemas/MonitorConfigPolicyTagPolicy' + - $ref: "#/components/schemas/MonitorConfigPolicyTagPolicy" MonitorConfigPolicyPolicyCreateRequest: description: Configuration for the policy. oneOf: - - $ref: '#/components/schemas/MonitorConfigPolicyTagPolicyCreateRequest' + - $ref: "#/components/schemas/MonitorConfigPolicyTagPolicyCreateRequest" MonitorConfigPolicyResourceType: default: monitor-config-policy description: Monitor configuration policy resource type. enum: - - monitor-config-policy - example: monitor-config-policy + - monitor-config-policy + example: "monitor-config-policy" type: string x-enum-varnames: - - MONITOR_CONFIG_POLICY + - MONITOR_CONFIG_POLICY MonitorConfigPolicyResponse: description: Response for retrieving a monitor configuration policy. properties: data: - $ref: '#/components/schemas/MonitorConfigPolicyResponseData' + $ref: "#/components/schemas/MonitorConfigPolicyResponseData" type: object MonitorConfigPolicyResponseData: description: A monitor configuration policy data. properties: attributes: - $ref: '#/components/schemas/MonitorConfigPolicyAttributeResponse' + $ref: "#/components/schemas/MonitorConfigPolicyAttributeResponse" id: description: ID of this monitor configuration policy. - example: 00000000-0000-1234-0000-000000000000 + example: "00000000-0000-1234-0000-000000000000" type: string type: - $ref: '#/components/schemas/MonitorConfigPolicyResourceType' + $ref: "#/components/schemas/MonitorConfigPolicyResourceType" type: object MonitorConfigPolicyTagPolicy: description: Tag attributes of a monitor configuration policy. @@ -40566,9 +38851,7 @@ components: type: boolean valid_tag_values: description: Valid values for the tag. - example: - - prod - - staging + example: ["prod", "staging"] items: maxLength: 255 type: string @@ -40588,46 +38871,44 @@ components: type: boolean valid_tag_values: description: Valid values for the tag. - example: - - prod - - staging + example: ["prod", "staging"] items: maxLength: 255 type: string type: array required: - - tag_key - - tag_key_required - - valid_tag_values + - tag_key + - tag_key_required + - valid_tag_values type: object MonitorConfigPolicyType: default: tag description: The monitor configuration policy type. enum: - - tag - example: tag + - tag + example: "tag" type: string x-enum-varnames: - - TAG + - TAG MonitorDowntimeMatchResourceType: default: downtime_match description: Monitor Downtime Match resource type. enum: - - downtime_match - example: downtime_match + - downtime_match + example: "downtime_match" type: string x-enum-varnames: - - DOWNTIME_MATCH + - DOWNTIME_MATCH MonitorDowntimeMatchResponse: description: Response for retrieving all downtime matches for a monitor. properties: data: description: An array of downtime matches. items: - $ref: '#/components/schemas/MonitorDowntimeMatchResponseData' + $ref: "#/components/schemas/MonitorDowntimeMatchResponseData" type: array meta: - $ref: '#/components/schemas/DowntimeMeta' + $ref: "#/components/schemas/DowntimeMeta" type: object MonitorDowntimeMatchResponseAttributes: description: Downtime match details. @@ -40640,16 +38921,14 @@ components: type: string groups: description: An array of groups associated with the downtime. - example: - - service:postgres - - team:frontend + example: ["service:postgres", "team:frontend"] items: description: An array of groups. - example: service:postgres + example: "service:postgres" type: string type: array scope: - $ref: '#/components/schemas/DowntimeScope' + $ref: "#/components/schemas/DowntimeScope" start: description: The start of the downtime. example: 2020-01-02 03:04:00+00:00 @@ -40660,135 +38939,120 @@ components: description: A downtime match. properties: attributes: - $ref: '#/components/schemas/MonitorDowntimeMatchResponseAttributes' + $ref: "#/components/schemas/MonitorDowntimeMatchResponseAttributes" id: description: The downtime ID. - example: 00000000-0000-1234-0000-000000000000 + example: "00000000-0000-1234-0000-000000000000" nullable: true type: string type: - $ref: '#/components/schemas/MonitorDowntimeMatchResourceType' + $ref: "#/components/schemas/MonitorDowntimeMatchResourceType" type: object MonitorNotificationRuleAttributes: additionalProperties: false description: Attributes of the monitor notification rule. properties: conditional_recipients: - $ref: '#/components/schemas/MonitorNotificationRuleConditionalRecipients' + $ref: "#/components/schemas/MonitorNotificationRuleConditionalRecipients" filter: - $ref: '#/components/schemas/MonitorNotificationRuleFilter' + $ref: "#/components/schemas/MonitorNotificationRuleFilter" name: - $ref: '#/components/schemas/MonitorNotificationRuleName' + $ref: "#/components/schemas/MonitorNotificationRuleName" recipients: - $ref: '#/components/schemas/MonitorNotificationRuleRecipients' - required: - - name + $ref: "#/components/schemas/MonitorNotificationRuleRecipients" + required: [name] type: object MonitorNotificationRuleCondition: - description: 'A conditional recipient rule composed of a `scope` (the matching - condition) and - - `recipients` (who to notify when it matches).' + description: |- + A conditional recipient rule composed of a `scope` (the matching condition) and + `recipients` (who to notify when it matches). properties: recipients: - $ref: '#/components/schemas/MonitorNotificationRuleRecipients' - description: A list of recipients to notify. Uses the same format as the - monitor `message` field. Must not start with an '@'. + $ref: "#/components/schemas/MonitorNotificationRuleRecipients" + description: A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'. scope: - $ref: '#/components/schemas/MonitorNotificationRuleConditionScope' - required: - - scope - - recipients + $ref: "#/components/schemas/MonitorNotificationRuleConditionScope" + required: [scope, recipients] type: object MonitorNotificationRuleConditionScope: - description: 'Defines the condition under which the recipients are notified. - Supported formats: - + description: |- + Defines the condition under which the recipients are notified. Supported formats: - Monitor status condition using `transition_type:`, for example `transition_type:is_alert`. - - - A single tag key:value pair, for example `env:prod`.' + - A single tag key:value pair, for example `env:prod`. example: transition_type:is_alert maxLength: 3000 minLength: 1 type: string MonitorNotificationRuleConditionalRecipients: - description: Use conditional recipients to define different recipients for different - situations. Cannot be used with `recipients`. + description: |- + Use conditional recipients to define different recipients for different situations. Cannot be used with `recipients`. properties: conditions: description: Conditions of the notification rule. items: - $ref: '#/components/schemas/MonitorNotificationRuleCondition' + $ref: "#/components/schemas/MonitorNotificationRuleCondition" maxItems: 10 minItems: 1 type: array fallback_recipients: - $ref: '#/components/schemas/MonitorNotificationRuleRecipients' - description: If none of the `conditions` applied, `fallback_recipients` - will get notified. - required: - - conditions + $ref: "#/components/schemas/MonitorNotificationRuleRecipients" + description: If none of the `conditions` applied, `fallback_recipients` will get notified. + required: [conditions] type: object MonitorNotificationRuleCreateRequest: description: Request for creating a monitor notification rule. properties: data: - $ref: '#/components/schemas/MonitorNotificationRuleCreateRequestData' - required: - - data + $ref: "#/components/schemas/MonitorNotificationRuleCreateRequestData" + required: [data] type: object MonitorNotificationRuleCreateRequestData: description: Object to create a monitor notification rule. properties: attributes: - $ref: '#/components/schemas/MonitorNotificationRuleAttributes' + $ref: "#/components/schemas/MonitorNotificationRuleAttributes" type: - $ref: '#/components/schemas/MonitorNotificationRuleResourceType' - required: - - attributes + $ref: "#/components/schemas/MonitorNotificationRuleResourceType" + required: [attributes] type: object MonitorNotificationRuleData: description: Monitor notification rule data. properties: attributes: - $ref: '#/components/schemas/MonitorNotificationRuleResponseAttributes' + $ref: "#/components/schemas/MonitorNotificationRuleResponseAttributes" id: - $ref: '#/components/schemas/MonitorNotificationRuleId' + $ref: "#/components/schemas/MonitorNotificationRuleId" relationships: - $ref: '#/components/schemas/MonitorNotificationRuleRelationships' + $ref: "#/components/schemas/MonitorNotificationRuleRelationships" type: - $ref: '#/components/schemas/MonitorNotificationRuleResourceType' + $ref: "#/components/schemas/MonitorNotificationRuleResourceType" type: object MonitorNotificationRuleFilter: description: Specifies the matching criteria for monitor notifications. oneOf: - - $ref: '#/components/schemas/MonitorNotificationRuleFilterTags' - - $ref: '#/components/schemas/MonitorNotificationRuleFilterScope' + - $ref: "#/components/schemas/MonitorNotificationRuleFilterTags" + - $ref: "#/components/schemas/MonitorNotificationRuleFilterScope" MonitorNotificationRuleFilterScope: additionalProperties: false - description: Filters monitor notifications using a scope expression over key:value - pairs with boolean logic (AND, OR, NOT). + description: Filters monitor notifications using a scope expression over key:value pairs with boolean logic (AND, OR, NOT). properties: scope: - description: A scope expression composed by key:value pairs (e.g. `service:foo`) - with boolean operators (AND, OR, NOT) and parentheses for grouping. + description: |- + A scope expression composed by key:value pairs (e.g. `service:foo`) with boolean operators (AND, OR, NOT) and parentheses for grouping. example: service:(foo OR bar) AND team:test NOT environment:staging maxLength: 3000 minLength: 1 type: string - required: - - scope + required: [scope] type: object MonitorNotificationRuleFilterTags: additionalProperties: false description: Filters monitor notifications by a list of tag key:value pairs. properties: tags: - description: A list of tag key:value pairs (e.g. `team:product`). All tags - must match (AND semantics). - example: - - team:product - - host:abc + description: |- + A list of tag key:value pairs (e.g. `team:product`). All tags must match (AND semantics). + example: [team:product, host:abc] items: maxLength: 255 type: string @@ -40796,8 +39060,7 @@ components: minItems: 1 type: array uniqueItems: true - required: - - tags + required: [tags] type: object MonitorNotificationRuleId: description: The ID of the monitor notification rule. @@ -40809,12 +39072,12 @@ components: data: description: A list of monitor notification rules. items: - $ref: '#/components/schemas/MonitorNotificationRuleData' + $ref: "#/components/schemas/MonitorNotificationRuleData" type: array included: description: Array of objects related to the monitor notification rules. items: - $ref: '#/components/schemas/MonitorNotificationRuleResponseIncludedItem' + $ref: "#/components/schemas/MonitorNotificationRuleResponseIncludedItem" type: array type: object MonitorNotificationRuleName: @@ -40824,11 +39087,9 @@ components: minLength: 1 type: string MonitorNotificationRuleRecipients: - description: A list of recipients to notify. Uses the same format as the monitor - `message` field. Must not start with an '@'. Cannot be used with `conditional_recipients`. - example: - - slack-test-channel - - jira-test + description: |- + A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'. Cannot be used with `conditional_recipients`. + example: [slack-test-channel, jira-test] items: description: individual recipient. maxLength: 255 @@ -40841,13 +39102,13 @@ components: description: All relationships associated with monitor notification rule. properties: created_by: - $ref: '#/components/schemas/MonitorNotificationRuleRelationshipsCreatedBy' + $ref: "#/components/schemas/MonitorNotificationRuleRelationshipsCreatedBy" type: object MonitorNotificationRuleRelationshipsCreatedBy: description: The user who created the monitor notification rule. properties: data: - $ref: '#/components/schemas/MonitorNotificationRuleRelationshipsCreatedByData' + $ref: "#/components/schemas/MonitorNotificationRuleRelationshipsCreatedByData" type: object MonitorNotificationRuleRelationshipsCreatedByData: description: Data for the user who created the monitor notification rule. @@ -40855,30 +39116,27 @@ components: properties: id: description: User ID of the monitor notification rule creator. - example: 00000000-0000-1234-0000-000000000000 + example: "00000000-0000-1234-0000-000000000000" type: string type: - $ref: '#/components/schemas/UsersType' + $ref: "#/components/schemas/UsersType" type: object MonitorNotificationRuleResourceType: default: monitor-notification-rule description: Monitor notification rule resource type. - enum: - - monitor-notification-rule + enum: [monitor-notification-rule] example: monitor-notification-rule type: string - x-enum-varnames: - - MONITOR_NOTIFICATION_RULE + x-enum-varnames: [MONITOR_NOTIFICATION_RULE] MonitorNotificationRuleResponse: description: A monitor notification rule. properties: data: - $ref: '#/components/schemas/MonitorNotificationRuleData' + $ref: "#/components/schemas/MonitorNotificationRuleData" included: - description: Array of objects related to the monitor notification rule that - the user requested. + description: Array of objects related to the monitor notification rule that the user requested. items: - $ref: '#/components/schemas/MonitorNotificationRuleResponseIncludedItem' + $ref: "#/components/schemas/MonitorNotificationRuleResponseIncludedItem" type: array type: object MonitorNotificationRuleResponseAttributes: @@ -40886,68 +39144,65 @@ components: description: Attributes of the monitor notification rule. properties: conditional_recipients: - $ref: '#/components/schemas/MonitorNotificationRuleConditionalRecipients' + $ref: "#/components/schemas/MonitorNotificationRuleConditionalRecipients" created: description: Creation time of the monitor notification rule. example: 2020-01-02 03:04:00+00:00 format: date-time type: string filter: - $ref: '#/components/schemas/MonitorNotificationRuleFilter' + $ref: "#/components/schemas/MonitorNotificationRuleFilter" modified: description: Time the monitor notification rule was last modified. example: 2020-01-02 03:04:00+00:00 format: date-time type: string name: - $ref: '#/components/schemas/MonitorNotificationRuleName' + $ref: "#/components/schemas/MonitorNotificationRuleName" recipients: - $ref: '#/components/schemas/MonitorNotificationRuleRecipients' + $ref: "#/components/schemas/MonitorNotificationRuleRecipients" type: object MonitorNotificationRuleResponseIncludedItem: description: An object related to a monitor notification rule. oneOf: - - $ref: '#/components/schemas/User' + - $ref: "#/components/schemas/User" MonitorNotificationRuleUpdateRequest: description: Request for updating a monitor notification rule. properties: data: - $ref: '#/components/schemas/MonitorNotificationRuleUpdateRequestData' - required: - - data + $ref: "#/components/schemas/MonitorNotificationRuleUpdateRequestData" + required: [data] type: object MonitorNotificationRuleUpdateRequestData: description: Object to update a monitor notification rule. properties: attributes: - $ref: '#/components/schemas/MonitorNotificationRuleAttributes' + $ref: "#/components/schemas/MonitorNotificationRuleAttributes" id: - $ref: '#/components/schemas/MonitorNotificationRuleId' + $ref: "#/components/schemas/MonitorNotificationRuleId" type: - $ref: '#/components/schemas/MonitorNotificationRuleResourceType' - required: - - id - - attributes + $ref: "#/components/schemas/MonitorNotificationRuleResourceType" + required: [id, attributes] type: object MonitorTrigger: - description: Trigger a workflow from a Monitor. For automatic triggering a handle - must be configured and the workflow must be published. + description: "Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published." properties: rateLimit: - $ref: '#/components/schemas/TriggerRateLimit' + $ref: "#/components/schemas/TriggerRateLimit" type: object MonitorTriggerWrapper: - description: Schema for a Monitor-based trigger. + description: "Schema for a Monitor-based trigger." properties: monitorTrigger: - $ref: '#/components/schemas/MonitorTrigger' + $ref: "#/components/schemas/MonitorTrigger" startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - monitorTrigger + - monitorTrigger type: object MonitorType: - description: Attributes from the monitor that triggered the event. + description: |- + Attributes from the monitor that triggered the event. nullable: true properties: created_at: @@ -40985,15 +39240,13 @@ components: type: string tags: description: A list of tags attached to the monitor. - example: - - environment:test + example: ["environment:test"] items: description: A tag. type: string type: array templated_name: - description: The templated name of the monitor before resolving any template - variables. + description: The templated name of the monitor before resolving any template variables. type: string type: description: The monitor type. @@ -41004,74 +39257,69 @@ components: description: A monitor user template object. properties: created: - $ref: '#/components/schemas/MonitorUserTemplateCreated' + $ref: "#/components/schemas/MonitorUserTemplateCreated" description: - $ref: '#/components/schemas/MonitorUserTemplateDescription' + $ref: "#/components/schemas/MonitorUserTemplateDescription" modified: - $ref: '#/components/schemas/MonitorUserTemplateModified' + $ref: "#/components/schemas/MonitorUserTemplateModified" monitor_definition: additionalProperties: {} - description: A valid monitor definition in the same format as the [V1 Monitor - API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor). - example: - message: You may need to add web hosts if this is consistently high. - name: Bytes received on host0 - query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100 - type: query alert + description: A valid monitor definition in the same format as the [V1 Monitor API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor). + example: {"message": "You may need to add web hosts if this is consistently high.", "name": "Bytes received on host0", "query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100", "type": "query alert"} type: object tags: - $ref: '#/components/schemas/MonitorUserTemplateTags' + $ref: "#/components/schemas/MonitorUserTemplateTags" template_variables: - $ref: '#/components/schemas/MonitorUserTemplateTemplateVariables' + $ref: "#/components/schemas/MonitorUserTemplateTemplateVariables" title: - $ref: '#/components/schemas/MonitorUserTemplateTitle' + $ref: "#/components/schemas/MonitorUserTemplateTitle" version: - $ref: '#/components/schemas/MonitorUserTemplateVersion' + $ref: "#/components/schemas/MonitorUserTemplateVersion" versions: description: All versions of the monitor user template. items: - $ref: '#/components/schemas/SimpleMonitorUserTemplate' + $ref: "#/components/schemas/SimpleMonitorUserTemplate" type: array type: object MonitorUserTemplateCreateData: description: Monitor user template data. properties: attributes: - $ref: '#/components/schemas/MonitorUserTemplateRequestAttributes' + $ref: "#/components/schemas/MonitorUserTemplateRequestAttributes" type: - $ref: '#/components/schemas/MonitorUserTemplateResourceType' + $ref: "#/components/schemas/MonitorUserTemplateResourceType" required: - - type - - attributes + - type + - attributes type: object MonitorUserTemplateCreateRequest: description: Request for creating a monitor user template. properties: data: - $ref: '#/components/schemas/MonitorUserTemplateCreateData' + $ref: "#/components/schemas/MonitorUserTemplateCreateData" required: - - data + - data type: object MonitorUserTemplateCreateResponse: description: Response for creating a monitor user template. properties: data: - $ref: '#/components/schemas/MonitorUserTemplateResponseData' + $ref: "#/components/schemas/MonitorUserTemplateResponseData" type: object MonitorUserTemplateCreated: description: The created timestamp of the template. - example: '2024-01-02T03:04:23.274966+00:00' + example: "2024-01-02T03:04:23.274966+00:00" format: date-time readOnly: true type: string MonitorUserTemplateDescription: description: A brief description of the monitor user template. - example: This is a template for monitoring user activity. + example: "This is a template for monitoring user activity." nullable: true type: string MonitorUserTemplateId: description: The unique identifier. - example: 00000000-0000-1234-0000-000000000000 + example: "00000000-0000-1234-0000-000000000000" type: string MonitorUserTemplateListResponse: description: Response for retrieving all monitor user templates. @@ -41079,12 +39327,12 @@ components: data: description: An array of monitor user templates. items: - $ref: '#/components/schemas/MonitorUserTemplateResponseData' + $ref: "#/components/schemas/MonitorUserTemplateResponseData" type: array type: object MonitorUserTemplateModified: description: The last modified timestamp. When the template version was created. - example: '2024-02-02T03:04:23.274966+00:00' + example: "2024-02-02T03:04:23.274966+00:00" format: date-time readOnly: true type: string @@ -41093,106 +39341,91 @@ components: description: Attributes for a monitor user template. properties: description: - $ref: '#/components/schemas/MonitorUserTemplateDescription' + $ref: "#/components/schemas/MonitorUserTemplateDescription" monitor_definition: additionalProperties: {} - description: A valid monitor definition in the same format as the [V1 Monitor - API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor). - example: - message: You may need to add web hosts if this is consistently high. - name: Bytes received on host0 - query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100 - type: query alert + description: A valid monitor definition in the same format as the [V1 Monitor API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor). + example: {"message": "You may need to add web hosts if this is consistently high.", "name": "Bytes received on host0", "query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100", "type": "query alert"} type: object tags: - $ref: '#/components/schemas/MonitorUserTemplateTags' + $ref: "#/components/schemas/MonitorUserTemplateTags" template_variables: - $ref: '#/components/schemas/MonitorUserTemplateTemplateVariables' + $ref: "#/components/schemas/MonitorUserTemplateTemplateVariables" title: - $ref: '#/components/schemas/MonitorUserTemplateTitle' + $ref: "#/components/schemas/MonitorUserTemplateTitle" required: - - title - - monitor_definition - - tags + - title + - monitor_definition + - tags type: object MonitorUserTemplateResourceType: default: monitor-user-template description: Monitor user template resource type. enum: - - monitor-user-template - example: monitor-user-template + - monitor-user-template + example: "monitor-user-template" type: string x-enum-varnames: - - MONITOR_USER_TEMPLATE + - MONITOR_USER_TEMPLATE MonitorUserTemplateResponse: description: Response for retrieving a monitor user template. properties: data: - $ref: '#/components/schemas/MonitorUserTemplateResponseDataWithVersions' + $ref: "#/components/schemas/MonitorUserTemplateResponseDataWithVersions" type: object MonitorUserTemplateResponseAttributes: additionalProperties: {} description: Attributes for a monitor user template. properties: created: - $ref: '#/components/schemas/MonitorUserTemplateCreated' + $ref: "#/components/schemas/MonitorUserTemplateCreated" description: - $ref: '#/components/schemas/MonitorUserTemplateDescription' + $ref: "#/components/schemas/MonitorUserTemplateDescription" modified: - $ref: '#/components/schemas/MonitorUserTemplateModified' + $ref: "#/components/schemas/MonitorUserTemplateModified" monitor_definition: additionalProperties: {} - description: A valid monitor definition in the same format as the [V1 Monitor - API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor). - example: - message: You may need to add web hosts if this is consistently high. - name: Bytes received on host0 - query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100 - type: query alert + description: A valid monitor definition in the same format as the [V1 Monitor API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor). + example: {"message": "You may need to add web hosts if this is consistently high.", "name": "Bytes received on host0", "query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100", "type": "query alert"} type: object tags: - $ref: '#/components/schemas/MonitorUserTemplateTags' + $ref: "#/components/schemas/MonitorUserTemplateTags" template_variables: - $ref: '#/components/schemas/MonitorUserTemplateTemplateVariables' + $ref: "#/components/schemas/MonitorUserTemplateTemplateVariables" title: - $ref: '#/components/schemas/MonitorUserTemplateTitle' + $ref: "#/components/schemas/MonitorUserTemplateTitle" version: - $ref: '#/components/schemas/MonitorUserTemplateVersion' + $ref: "#/components/schemas/MonitorUserTemplateVersion" type: object MonitorUserTemplateResponseData: description: Monitor user template list response data. properties: attributes: - $ref: '#/components/schemas/MonitorUserTemplateResponseAttributes' + $ref: "#/components/schemas/MonitorUserTemplateResponseAttributes" id: - $ref: '#/components/schemas/MonitorUserTemplateId' + $ref: "#/components/schemas/MonitorUserTemplateId" type: - $ref: '#/components/schemas/MonitorUserTemplateResourceType' + $ref: "#/components/schemas/MonitorUserTemplateResourceType" type: object MonitorUserTemplateResponseDataWithVersions: description: Monitor user template data. properties: attributes: - $ref: '#/components/schemas/MonitorUserTemplate' + $ref: "#/components/schemas/MonitorUserTemplate" id: - $ref: '#/components/schemas/MonitorUserTemplateId' + $ref: "#/components/schemas/MonitorUserTemplateId" type: - $ref: '#/components/schemas/MonitorUserTemplateResourceType' + $ref: "#/components/schemas/MonitorUserTemplateResourceType" type: object MonitorUserTemplateTags: description: The definition of `MonitorUserTemplateTags` object. - example: - - product:Our Custom App - - integration:Azure + example: ["product:Our Custom App", "integration:Azure"] items: - description: 'Tags associated with the monitor user template. Must be key - value. Only ''product'' and ''integration'' keys are - - allowed. The value is the name of the category to display the template under. - Integrations can be filtered out in the UI. - - (Review note: This modeling of ''categories'' is subject to change.)' - example: us-east1 + description: |- + Tags associated with the monitor user template. Must be key value. Only 'product' and 'integration' keys are + allowed. The value is the name of the category to display the template under. Integrations can be filtered out in the UI. + (Review note: This modeling of 'categories' is subject to change.) + example: "us-east1" minLength: 1 type: string uniqueItems: true @@ -41200,18 +39433,15 @@ components: MonitorUserTemplateTemplateVariables: description: The definition of `MonitorUserTemplateTemplateVariables` object. items: - $ref: '#/components/schemas/MonitorUserTemplateTemplateVariablesItems' + $ref: "#/components/schemas/MonitorUserTemplateTemplateVariablesItems" type: array MonitorUserTemplateTemplateVariablesItems: additionalProperties: false - description: List of objects representing template variables on the monitor - which can have selectable values. + description: List of objects representing template variables on the monitor which can have selectable values. properties: available_values: description: Available values for the variable. - example: - - value1 - - value2 + example: ["value1", "value2"] items: minLength: 1 type: string @@ -41219,8 +39449,7 @@ components: type: array defaults: description: Default values of the template variable. - example: - - defaultValue + example: ["defaultValue"] items: minLength: 0 type: string @@ -41228,41 +39457,41 @@ components: type: array name: description: The name of the template variable. - example: regionName + example: "regionName" type: string tag_key: - description: The tag key associated with the variable. This works the same - as dashboard template variables. - example: datacenter + description: |- + The tag key associated with the variable. This works the same as dashboard template variables. + example: "datacenter" type: string required: - - name + - name type: object MonitorUserTemplateTitle: description: The title of the monitor user template. - example: Postgres CPU Monitor + example: "Postgres CPU Monitor" type: string MonitorUserTemplateUpdateData: description: Monitor user template data. properties: attributes: - $ref: '#/components/schemas/MonitorUserTemplateRequestAttributes' + $ref: "#/components/schemas/MonitorUserTemplateRequestAttributes" id: - $ref: '#/components/schemas/MonitorUserTemplateId' + $ref: "#/components/schemas/MonitorUserTemplateId" type: - $ref: '#/components/schemas/MonitorUserTemplateResourceType' + $ref: "#/components/schemas/MonitorUserTemplateResourceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object MonitorUserTemplateUpdateRequest: description: Request for creating a new monitor user template version. properties: data: - $ref: '#/components/schemas/MonitorUserTemplateUpdateData' + $ref: "#/components/schemas/MonitorUserTemplateUpdateData" required: - - data + - data type: object MonitorUserTemplateVersion: description: The version of the monitor user template. @@ -41275,7 +39504,7 @@ components: description: Cost Attribution by Tag for a given organization. properties: month: - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.' + description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`." format: date-time type: string org_name: @@ -41285,47 +39514,42 @@ components: description: The organization public ID. type: string tag_config_source: - description: The source of the cost attribution tag configuration and the - selected tags in the format `::://////`. + description: The source of the cost attribution tag configuration and the selected tags in the format `::://////`. type: string tags: - $ref: '#/components/schemas/CostAttributionTagNames' + $ref: "#/components/schemas/CostAttributionTagNames" updated_at: - description: Shows the most recent hour in the current months for all organizations - for which all costs were calculated. + description: Shows the most recent hour in the current months for all organizations for which all costs were calculated. type: string values: - description: 'Fields in Cost Attribution by tag(s). Example: `infra_host_on_demand_cost`, - `infra_host_committed_cost`, `infra_host_total_cost`, `infra_host_percentage_in_org`, - `infra_host_percentage_in_account`.' + description: |- + Fields in Cost Attribution by tag(s). Example: `infra_host_on_demand_cost`, `infra_host_committed_cost`, `infra_host_total_cost`, `infra_host_percentage_in_org`, `infra_host_percentage_in_account`. type: object type: object MonthlyCostAttributionBody: description: Cost data. properties: attributes: - $ref: '#/components/schemas/MonthlyCostAttributionAttributes' + $ref: "#/components/schemas/MonthlyCostAttributionAttributes" id: description: Unique ID of the response. type: string type: - $ref: '#/components/schemas/CostAttributionType' + $ref: "#/components/schemas/CostAttributionType" type: object MonthlyCostAttributionMeta: description: The object containing document metadata. properties: aggregates: - $ref: '#/components/schemas/CostAttributionAggregates' + $ref: "#/components/schemas/CostAttributionAggregates" pagination: - $ref: '#/components/schemas/MonthlyCostAttributionPagination' + $ref: "#/components/schemas/MonthlyCostAttributionPagination" type: object MonthlyCostAttributionPagination: description: The metadata for the current pagination. properties: next_record_id: - description: The cursor to use to get the next results, if any. To make - the next request, use the same parameters with the addition of the `next_record_id`. + description: The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of the `next_record_id`. nullable: true type: string type: object @@ -41335,45 +39559,45 @@ components: data: description: Response containing cost attribution. items: - $ref: '#/components/schemas/MonthlyCostAttributionBody' + $ref: "#/components/schemas/MonthlyCostAttributionBody" type: array meta: - $ref: '#/components/schemas/MonthlyCostAttributionMeta' + $ref: "#/components/schemas/MonthlyCostAttributionMeta" type: object NotebookCreateData: description: Notebook creation data properties: type: - $ref: '#/components/schemas/NotebookResourceType' + $ref: "#/components/schemas/NotebookResourceType" required: - - type + - type type: object NotebookCreateRequest: description: Notebook creation request properties: data: - $ref: '#/components/schemas/NotebookCreateData' + $ref: "#/components/schemas/NotebookCreateData" required: - - data + - data type: object NotebookResourceType: description: Notebook resource type enum: - - notebook + - notebook example: notebook type: string x-enum-varnames: - - NOTEBOOK + - NOTEBOOK NotebookTriggerWrapper: - description: Schema for a Notebook-based trigger. + description: "Schema for a Notebook-based trigger." properties: notebookTrigger: - description: Trigger a workflow from a Notebook. + description: "Trigger a workflow from a Notebook." type: object startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - notebookTrigger + - notebookTrigger type: object NotificationChannel: description: A top-level wrapper for a user notification channel @@ -41381,15 +39605,14 @@ components: data: attributes: config: - address: foo@bar.com - formats: - - html - type: email + address: "foo@bar.com" + formats: ["html"] + type: "email" id: 27590dae-47be-4a7d-9abf-8f4e45124020 type: notification_channels properties: data: - $ref: '#/components/schemas/NotificationChannelData' + $ref: "#/components/schemas/NotificationChannelData" type: object NotificationChannelAttributes: description: Attributes for an on-call notification channel. @@ -41398,248 +39621,238 @@ components: description: Whether the notification channel is currently active. type: boolean config: - $ref: '#/components/schemas/NotificationChannelConfig' + $ref: "#/components/schemas/NotificationChannelConfig" description: Notification channel configuration type: object NotificationChannelConfig: - description: Defines the configuration for an On-Call notification channel + description: "Defines the configuration for an On-Call notification channel" oneOf: - - $ref: '#/components/schemas/NotificationChannelPhoneConfig' - - $ref: '#/components/schemas/NotificationChannelEmailConfig' - - $ref: '#/components/schemas/NotificationChannelPushConfig' + - $ref: "#/components/schemas/NotificationChannelPhoneConfig" + - $ref: "#/components/schemas/NotificationChannelEmailConfig" + - $ref: "#/components/schemas/NotificationChannelPushConfig" NotificationChannelData: description: Data for an on-call notification channel properties: attributes: - $ref: '#/components/schemas/NotificationChannelAttributes' + $ref: "#/components/schemas/NotificationChannelAttributes" id: description: Unique identifier for the channel type: string type: - $ref: '#/components/schemas/NotificationChannelType' + $ref: "#/components/schemas/NotificationChannelType" required: - - type + - type type: object NotificationChannelEmailConfig: - description: Email notification channel configuration + description: "Email notification channel configuration" properties: address: - description: The e-mail address to be notified - example: '' + description: "The e-mail address to be notified" + example: "" type: string formats: description: Preferred content formats for notifications. example: - - html + - html items: - $ref: '#/components/schemas/NotificationChannelEmailFormatType' + $ref: "#/components/schemas/NotificationChannelEmailFormatType" type: array type: - $ref: '#/components/schemas/NotificationChannelEmailConfigType' + $ref: "#/components/schemas/NotificationChannelEmailConfigType" required: - - type - - address - - formats + - type + - address + - formats type: object NotificationChannelEmailConfigType: default: email - description: Indicates that the notification channel is an e-mail address + description: "Indicates that the notification channel is an e-mail address" enum: - - email + - email example: email type: string x-enum-varnames: - - EMAIL + - EMAIL NotificationChannelEmailFormatType: default: html description: Specifies the format of the e-mail that is sent for On-Call notifications enum: - - html - - text + - html + - text example: html type: string x-enum-varnames: - - HTML - - TEXT + - HTML + - TEXT NotificationChannelPhoneConfig: - description: Phone notification channel configuration + description: "Phone notification channel configuration" properties: formatted_number: - description: The formatted international version of Number (e.g. +33 7 1 - 23 45 67). - example: '' + description: "The formatted international version of Number (e.g. +33 7 1 23 45 67)." + example: "" type: string number: - description: The E-164 formatted phone number (e.g. +3371234567) - example: '' + description: "The E-164 formatted phone number (e.g. +3371234567)" + example: "" type: string region: - description: The ISO 3166-1 alpha-2 two-letter country code. - example: '' + description: "The ISO 3166-1 alpha-2 two-letter country code." + example: "" type: string sms_subscribed_at: - description: If present, the date the user subscribed this number to SMS - messages + description: "If present, the date the user subscribed this number to SMS messages" format: date-time nullable: true type: string type: - $ref: '#/components/schemas/NotificationChannelPhoneConfigType' + $ref: "#/components/schemas/NotificationChannelPhoneConfigType" verified: - description: Indicates whether this phone has been verified by the user - in Datadog On-Call + description: "Indicates whether this phone has been verified by the user in Datadog On-Call" example: false type: boolean required: - - type - - number - - formatted_number - - region - - verified + - type + - number + - formatted_number + - region + - verified type: object NotificationChannelPhoneConfigType: default: phone - description: Indicates that the notification channel is a phone + description: "Indicates that the notification channel is a phone" enum: - - phone + - phone example: phone type: string x-enum-varnames: - - PHONE + - PHONE NotificationChannelPushConfig: - description: Push notification channel configuration + description: "Push notification channel configuration" properties: application_name: - description: The name of the application used to receive push notifications - example: '' + description: "The name of the application used to receive push notifications" + example: "" type: string device_name: - description: The name of the mobile device being used - example: '' + description: "The name of the mobile device being used" + example: "" type: string type: - $ref: '#/components/schemas/NotificationChannelPushConfigType' + $ref: "#/components/schemas/NotificationChannelPushConfigType" required: - - type - - device_name - - application_name + - type + - device_name + - application_name type: object NotificationChannelPushConfigType: default: push - description: Indicates that the notification channel is a mobile device for - push notifications + description: "Indicates that the notification channel is a mobile device for push notifications" enum: - - push + - push example: push type: string x-enum-varnames: - - PUSH + - PUSH NotificationChannelType: default: notification_channels - description: Indicates that the resource is of type 'notification_channels'. + description: "Indicates that the resource is of type 'notification_channels'." enum: - - notification_channels + - notification_channels example: notification_channels type: string x-enum-varnames: - - NOTIFICATION_CHANNELS + - NOTIFICATION_CHANNELS NotificationRule: - description: 'Notification rules allow full control over notifications generated - by the various Datadog security products. - - They allow users to define the conditions under which a notification should - be generated (based on rule severities, - + description: |- + Notification rules allow full control over notifications generated by the various Datadog security products. + They allow users to define the conditions under which a notification should be generated (based on rule severities, rule types, rule tags, and so on), and the targets to notify. - - A notification rule is composed of a rule ID, a rule type, and the rule attributes. - All fields are required.' + A notification rule is composed of a rule ID, a rule type, and the rule attributes. All fields are required. properties: attributes: - $ref: '#/components/schemas/NotificationRuleAttributes' + $ref: "#/components/schemas/NotificationRuleAttributes" id: - $ref: '#/components/schemas/ID' + $ref: "#/components/schemas/ID" type: - $ref: '#/components/schemas/NotificationRulesType' + $ref: "#/components/schemas/NotificationRulesType" required: - - attributes - - id - - type + - attributes + - id + - type type: object NotificationRuleAttributes: description: Attributes of the notification rule. properties: created_at: - $ref: '#/components/schemas/Date' + $ref: "#/components/schemas/Date" created_by: - $ref: '#/components/schemas/RuleUser' + $ref: "#/components/schemas/RuleUser" enabled: - $ref: '#/components/schemas/Enabled' + $ref: "#/components/schemas/Enabled" modified_at: - $ref: '#/components/schemas/Date' + $ref: "#/components/schemas/Date" modified_by: - $ref: '#/components/schemas/RuleUser' + $ref: "#/components/schemas/RuleUser" name: - $ref: '#/components/schemas/RuleName' + $ref: "#/components/schemas/RuleName" selectors: - $ref: '#/components/schemas/Selectors' + $ref: "#/components/schemas/Selectors" targets: - $ref: '#/components/schemas/Targets' + $ref: "#/components/schemas/Targets" time_aggregation: - $ref: '#/components/schemas/TimeAggregation' + $ref: "#/components/schemas/TimeAggregation" version: - $ref: '#/components/schemas/Version' - required: - - created_at - - created_by - - enabled - - modified_at - - modified_by - - name - - selectors - - targets - - version + $ref: "#/components/schemas/Version" + required: + - created_at + - created_by + - enabled + - modified_at + - modified_by + - name + - selectors + - targets + - version type: object NotificationRuleQuery: - description: The query is composed of one or several key:value pairs, which - can be used to filter security issues on tags and attributes. + description: The query is composed of one or several key:value pairs, which can be used to filter security issues on tags and attributes. example: (source:production_service OR env:prod) type: string NotificationRuleResponse: description: Response object which includes a notification rule. properties: data: - $ref: '#/components/schemas/NotificationRule' + $ref: "#/components/schemas/NotificationRule" type: object NotificationRulesType: description: The rule type associated to notification rules. enum: - - notification_rules + - notification_rules example: notification_rules type: string x-enum-varnames: - - NOTIFICATION_RULES + - NOTIFICATION_RULES NotionAPIKey: description: The definition of the `NotionAPIKey` object. properties: api_token: description: The `NotionAPIKey` `api_token`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/NotionAPIKeyType' + $ref: "#/components/schemas/NotionAPIKeyType" required: - - type - - api_token + - type + - api_token type: object NotionAPIKeyType: description: The definition of the `NotionAPIKey` object. enum: - - NotionAPIKey + - NotionAPIKey example: NotionAPIKey type: string x-enum-varnames: - - NOTIONAPIKEY + - NOTIONAPIKEY NotionAPIKeyUpdate: description: The definition of the `NotionAPIKey` object. properties: @@ -41647,55 +39860,55 @@ components: description: The `NotionAPIKeyUpdate` `api_token`. type: string type: - $ref: '#/components/schemas/NotionAPIKeyType' + $ref: "#/components/schemas/NotionAPIKeyType" required: - - type + - type type: object NotionCredentials: description: The definition of the `NotionCredentials` object. oneOf: - - $ref: '#/components/schemas/NotionAPIKey' + - $ref: "#/components/schemas/NotionAPIKey" NotionCredentialsUpdate: description: The definition of the `NotionCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/NotionAPIKeyUpdate' + - $ref: "#/components/schemas/NotionAPIKeyUpdate" NotionIntegration: description: The definition of the `NotionIntegration` object. properties: credentials: - $ref: '#/components/schemas/NotionCredentials' + $ref: "#/components/schemas/NotionCredentials" type: - $ref: '#/components/schemas/NotionIntegrationType' + $ref: "#/components/schemas/NotionIntegrationType" required: - - type - - credentials + - type + - credentials type: object NotionIntegrationType: description: The definition of the `NotionIntegrationType` object. enum: - - Notion + - Notion example: Notion type: string x-enum-varnames: - - NOTION + - NOTION NotionIntegrationUpdate: description: The definition of the `NotionIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/NotionCredentialsUpdate' + $ref: "#/components/schemas/NotionCredentialsUpdate" type: - $ref: '#/components/schemas/NotionIntegrationType' + $ref: "#/components/schemas/NotionIntegrationType" required: - - type + - type type: object NullableRelationshipToUser: description: Relationship to user. nullable: true properties: data: - $ref: '#/components/schemas/NullableRelationshipToUserData' + $ref: "#/components/schemas/NullableRelationshipToUserData" required: - - data + - data type: object NullableRelationshipToUserData: description: Relationship to user object. @@ -41703,22 +39916,22 @@ components: properties: id: description: A unique identifier that represents the user. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string type: - $ref: '#/components/schemas/UsersType' + $ref: "#/components/schemas/UsersType" required: - - id - - type + - id + - type type: object NullableUserRelationship: description: Relationship to user. nullable: true properties: data: - $ref: '#/components/schemas/NullableUserRelationshipData' + $ref: "#/components/schemas/NullableUserRelationshipData" required: - - data + - data type: object NullableUserRelationshipData: description: Relationship to user object. @@ -41726,70 +39939,66 @@ components: properties: id: description: A unique identifier that represents the user. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string type: - $ref: '#/components/schemas/UserResourceType' + $ref: "#/components/schemas/UserResourceType" required: - - id - - type + - id + - type type: object ObservabilityPipeline: description: Top-level schema representing a pipeline. properties: data: - $ref: '#/components/schemas/ObservabilityPipelineData' + $ref: "#/components/schemas/ObservabilityPipelineData" required: - - data + - data type: object ObservabilityPipelineAddEnvVarsProcessor: - description: 'The `add_env_vars` processor adds environment variable values - to log events. + description: |- + The `add_env_vars` processor adds environment variable values to log events. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean id: - description: The unique identifier for this component. Used to reference - this processor in the pipeline. + description: The unique identifier for this component. Used to reference this processor in the pipeline. example: add-env-vars-processor type: string include: - description: A Datadog search query used to determine which logs this processor - targets. + description: A Datadog search query used to determine which logs this processor targets. example: service:my-service type: string type: - $ref: '#/components/schemas/ObservabilityPipelineAddEnvVarsProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineAddEnvVarsProcessorType" variables: description: A list of environment variable mappings to apply to log fields. items: - $ref: '#/components/schemas/ObservabilityPipelineAddEnvVarsProcessorVariable' + $ref: "#/components/schemas/ObservabilityPipelineAddEnvVarsProcessorVariable" type: array required: - - id - - type - - include - - variables - - enabled + - id + - type + - include + - variables + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineAddEnvVarsProcessorType: default: add_env_vars description: The processor type. The value should always be `add_env_vars`. enum: - - add_env_vars + - add_env_vars example: add_env_vars type: string x-enum-varnames: - - ADD_ENV_VARS + - ADD_ENV_VARS ObservabilityPipelineAddEnvVarsProcessorVariable: description: Defines a mapping between an environment variable and a log field. properties: @@ -41802,148 +40011,133 @@ components: example: AWS_REGION type: string required: - - field - - name + - field + - name type: object ObservabilityPipelineAddFieldsProcessor: - description: 'The `add_fields` processor adds static key-value fields to logs. - + description: |- + The `add_fields` processor adds static key-value fields to logs. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean fields: - description: A list of static fields (key-value pairs) that is added to - each log event processed by this component. + description: A list of static fields (key-value pairs) that is added to each log event processed by this component. items: - $ref: '#/components/schemas/ObservabilityPipelineFieldValue' + $ref: "#/components/schemas/ObservabilityPipelineFieldValue" type: array id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). - example: add-fields-processor + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). + example: "add-fields-processor" type: string include: - description: A Datadog search query used to determine which logs this processor - targets. - example: service:my-service + description: A Datadog search query used to determine which logs this processor targets. + example: "service:my-service" type: string type: - $ref: '#/components/schemas/ObservabilityPipelineAddFieldsProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineAddFieldsProcessorType" required: - - id - - type - - include - - fields - - enabled + - id + - type + - include + - fields + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineAddFieldsProcessorType: default: add_fields description: The processor type. The value should always be `add_fields`. enum: - - add_fields + - add_fields example: add_fields type: string x-enum-varnames: - - ADD_FIELDS + - ADD_FIELDS ObservabilityPipelineAddHostnameProcessor: - description: 'The `add_hostname` processor adds the hostname to log events. - + description: |- + The `add_hostname` processor adds the hostname to log events. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). example: add-hostname-processor type: string include: - description: A Datadog search query used to determine which logs this processor - targets. - example: service:my-service + description: A Datadog search query used to determine which logs this processor targets. + example: "service:my-service" type: string type: - $ref: '#/components/schemas/ObservabilityPipelineAddHostnameProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineAddHostnameProcessorType" required: - - id - - type - - include - - enabled + - id + - type + - include + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineAddHostnameProcessorType: default: add_hostname description: The processor type. The value should always be `add_hostname`. enum: - - add_hostname + - add_hostname example: add_hostname type: string x-enum-varnames: - - ADD_HOSTNAME + - ADD_HOSTNAME ObservabilityPipelineAmazonDataFirehoseSource: - description: 'The `amazon_data_firehose` source ingests logs from AWS Data Firehose. - + description: |- + The `amazon_data_firehose` source ingests logs from AWS Data Firehose. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: address_key: - description: Name of the environment variable or secret that holds the Firehose - delivery stream address. + description: Name of the environment variable or secret that holds the Firehose delivery stream address. example: FIREHOSE_ADDRESS type: string auth: - $ref: '#/components/schemas/ObservabilityPipelineAwsAuth' + $ref: "#/components/schemas/ObservabilityPipelineAwsAuth" id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). example: amazon-firehose-source type: string tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineAmazonDataFirehoseSourceType' + $ref: "#/components/schemas/ObservabilityPipelineAmazonDataFirehoseSourceType" required: - - id - - type + - id + - type type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineAmazonDataFirehoseSourceType: default: amazon_data_firehose description: The source type. The value should always be `amazon_data_firehose`. - enum: - - amazon_data_firehose + enum: [amazon_data_firehose] example: amazon_data_firehose type: string - x-enum-varnames: - - AMAZON_DATA_FIREHOSE + x-enum-varnames: [AMAZON_DATA_FIREHOSE] ObservabilityPipelineAmazonOpenSearchDestination: - description: 'The `amazon_opensearch` destination writes logs to Amazon OpenSearch. + description: |- + The `amazon_opensearch` destination writes logs to Amazon OpenSearch. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: auth: - $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationAuth' + $ref: "#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationAuth" buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" bulk_index: description: The index to write logs to. example: logs-index @@ -41953,28 +40147,24 @@ components: example: elasticsearch-destination type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array type: - $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationType" required: - - id - - type - - inputs - - auth + - id + - type + - inputs + - auth type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineAmazonOpenSearchDestinationAuth: - description: 'Authentication settings for the Amazon OpenSearch destination. - - The `strategy` field determines whether basic or AWS-based authentication - is used.' + description: |- + Authentication settings for the Amazon OpenSearch destination. + The `strategy` field determines whether basic or AWS-based authentication is used. properties: assume_role: description: The ARN of the role to assume (used with `aws` strategy). @@ -41989,53 +40179,48 @@ components: description: Session name for the assumed role (used with `aws` strategy). type: string strategy: - $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationAuthStrategy' + $ref: "#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationAuthStrategy" required: - - strategy + - strategy type: object ObservabilityPipelineAmazonOpenSearchDestinationAuthStrategy: description: The authentication strategy to use. - enum: - - basic - - aws + enum: [basic, aws] example: aws type: string x-enum-varnames: - - BASIC - - AWS + - BASIC + - AWS ObservabilityPipelineAmazonOpenSearchDestinationType: default: amazon_opensearch description: The destination type. The value should always be `amazon_opensearch`. enum: - - amazon_opensearch + - amazon_opensearch example: amazon_opensearch type: string x-enum-varnames: - - AMAZON_OPENSEARCH + - AMAZON_OPENSEARCH ObservabilityPipelineAmazonS3Destination: - description: 'The `amazon_s3` destination sends your logs in Datadog-rehydratable - format to an Amazon S3 bucket for archiving. + description: |- + The `amazon_s3` destination sends your logs in Datadog-rehydratable format to an Amazon S3 bucket for archiving. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: auth: - $ref: '#/components/schemas/ObservabilityPipelineAwsAuth' + $ref: "#/components/schemas/ObservabilityPipelineAwsAuth" bucket: description: S3 bucket name. - example: error-logs + example: "error-logs" type: string buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" id: description: Unique identifier for the destination component. example: amazon-s3-destination type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - datadog-agent-source + description: A list of component IDs whose output is used as the `input` for this component. + example: ["datadog-agent-source"] items: type: string type: array @@ -42044,57 +40229,56 @@ components: type: string region: description: AWS region of the S3 bucket. - example: us-east-1 + example: "us-east-1" type: string storage_class: - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3DestinationStorageClass' + $ref: "#/components/schemas/ObservabilityPipelineAmazonS3DestinationStorageClass" tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3DestinationType' + $ref: "#/components/schemas/ObservabilityPipelineAmazonS3DestinationType" required: - - id - - type - - inputs - - bucket - - region - - storage_class + - id + - type + - inputs + - bucket + - region + - storage_class type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineAmazonS3DestinationStorageClass: description: S3 storage class. enum: - - STANDARD - - REDUCED_REDUNDANCY - - INTELLIGENT_TIERING - - STANDARD_IA - - EXPRESS_ONEZONE - - ONEZONE_IA - - GLACIER - - GLACIER_IR - - DEEP_ARCHIVE + - STANDARD + - REDUCED_REDUNDANCY + - INTELLIGENT_TIERING + - STANDARD_IA + - EXPRESS_ONEZONE + - ONEZONE_IA + - GLACIER + - GLACIER_IR + - DEEP_ARCHIVE example: STANDARD type: string x-enum-varnames: - - STANDARD - - REDUCED_REDUNDANCY - - INTELLIGENT_TIERING - - STANDARD_IA - - EXPRESS_ONEZONE - - ONEZONE_IA - - GLACIER - - GLACIER_IR - - DEEP_ARCHIVE + - STANDARD + - REDUCED_REDUNDANCY + - INTELLIGENT_TIERING + - STANDARD_IA + - EXPRESS_ONEZONE + - ONEZONE_IA + - GLACIER + - GLACIER_IR + - DEEP_ARCHIVE ObservabilityPipelineAmazonS3DestinationType: default: amazon_s3 description: The destination type. Always `amazon_s3`. enum: - - amazon_s3 + - amazon_s3 example: amazon_s3 type: string x-enum-varnames: - - AMAZON_S3 + - AMAZON_S3 ObservabilityPipelineAmazonS3GenericBatchSettings: description: Event batching settings properties: @@ -42112,100 +40296,97 @@ components: ObservabilityPipelineAmazonS3GenericCompression: description: Compression algorithm applied to encoded logs. oneOf: - - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionZstd' - - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionGzip' - - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionSnappy' + - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionZstd" + - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionGzip" + - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionSnappy" ObservabilityPipelineAmazonS3GenericCompressionGzip: description: Gzip compression. properties: algorithm: - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionGzipType' + $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionGzipType" level: description: Gzip compression level. example: 6 format: int64 type: integer required: - - algorithm - - level + - algorithm + - level type: object ObservabilityPipelineAmazonS3GenericCompressionGzipType: default: gzip description: The compression type. Always `gzip`. enum: - - gzip + - gzip example: gzip type: string x-enum-varnames: - - GZIP + - GZIP ObservabilityPipelineAmazonS3GenericCompressionSnappy: description: Snappy compression. properties: algorithm: - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionSnappyType' + $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionSnappyType" required: - - algorithm + - algorithm type: object ObservabilityPipelineAmazonS3GenericCompressionSnappyType: default: snappy description: The compression type. Always `snappy`. enum: - - snappy + - snappy example: snappy type: string x-enum-varnames: - - SNAPPY + - SNAPPY ObservabilityPipelineAmazonS3GenericCompressionZstd: description: Zstd compression. properties: algorithm: - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionZstdType' + $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionZstdType" level: description: Zstd compression level. example: 3 format: int64 type: integer required: - - algorithm - - level + - algorithm + - level type: object ObservabilityPipelineAmazonS3GenericCompressionZstdType: default: zstd description: The compression type. Always `zstd`. enum: - - zstd + - zstd example: zstd type: string x-enum-varnames: - - ZSTD + - ZSTD ObservabilityPipelineAmazonS3GenericDestination: - description: 'The `amazon_s3_generic` destination sends your logs to an Amazon - S3 bucket. - + description: |- + The `amazon_s3_generic` destination sends your logs to an Amazon S3 bucket. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: auth: - $ref: '#/components/schemas/ObservabilityPipelineAwsAuth' + $ref: "#/components/schemas/ObservabilityPipelineAwsAuth" batch_settings: - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericBatchSettings' + $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericBatchSettings" bucket: description: S3 bucket name. - example: my-bucket + example: "my-bucket" type: string compression: - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompression' + $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericCompression" encoding: - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncoding' + $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericEncoding" id: description: Unique identifier for the destination component. example: generic-s3-destination type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array @@ -42214,86 +40395,82 @@ components: type: string region: description: AWS region of the S3 bucket. - example: us-east-1 + example: "us-east-1" type: string storage_class: - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3DestinationStorageClass' + $ref: "#/components/schemas/ObservabilityPipelineAmazonS3DestinationStorageClass" type: - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericDestinationType" required: - - id - - type - - inputs - - bucket - - region - - storage_class - - encoding - - compression + - id + - type + - inputs + - bucket + - region + - storage_class + - encoding + - compression type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineAmazonS3GenericDestinationType: default: amazon_s3_generic description: The destination type. Always `amazon_s3_generic`. enum: - - amazon_s3_generic + - amazon_s3_generic example: amazon_s3_generic type: string x-enum-varnames: - - GENERIC_ARCHIVES_S3 + - GENERIC_ARCHIVES_S3 ObservabilityPipelineAmazonS3GenericEncoding: description: Encoding format for the destination. oneOf: - - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingJson' - - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingParquet' + - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingJson" + - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingParquet" ObservabilityPipelineAmazonS3GenericEncodingJson: description: JSON encoding. properties: type: - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingJsonType' + $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingJsonType" required: - - type + - type type: object ObservabilityPipelineAmazonS3GenericEncodingJsonType: default: json description: The encoding type. Always `json`. enum: - - json + - json example: json type: string x-enum-varnames: - - JSON + - JSON ObservabilityPipelineAmazonS3GenericEncodingParquet: description: Parquet encoding. properties: type: - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingParquetType' + $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingParquetType" required: - - type + - type type: object ObservabilityPipelineAmazonS3GenericEncodingParquetType: default: parquet description: The encoding type. Always `parquet`. enum: - - parquet + - parquet example: parquet type: string x-enum-varnames: - - PARQUET + - PARQUET ObservabilityPipelineAmazonS3Source: - description: 'The `amazon_s3` source ingests logs from an Amazon S3 bucket. - + description: |- + The `amazon_s3` source ingests logs from an Amazon S3 bucket. It supports AWS authentication and TLS encryption. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: auth: - $ref: '#/components/schemas/ObservabilityPipelineAwsAuth' + $ref: "#/components/schemas/ObservabilityPipelineAwsAuth" id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). example: aws-s3-source type: string region: @@ -42301,92 +40478,86 @@ components: example: us-east-1 type: string tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3SourceType' + $ref: "#/components/schemas/ObservabilityPipelineAmazonS3SourceType" url_key: - description: Name of the environment variable or secret that holds the S3 - bucket URL. + description: Name of the environment variable or secret that holds the S3 bucket URL. example: S3_BUCKET_URL type: string required: - - id - - type - - region + - id + - type + - region type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineAmazonS3SourceType: default: amazon_s3 description: The source type. Always `amazon_s3`. enum: - - amazon_s3 + - amazon_s3 example: amazon_s3 type: string x-enum-varnames: - - AMAZON_S3 + - AMAZON_S3 ObservabilityPipelineAmazonSecurityLakeDestination: - description: 'The `amazon_security_lake` destination sends your logs to Amazon - Security Lake. + description: |- + The `amazon_security_lake` destination sends your logs to Amazon Security Lake. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: auth: - $ref: '#/components/schemas/ObservabilityPipelineAwsAuth' + $ref: "#/components/schemas/ObservabilityPipelineAwsAuth" bucket: description: Name of the Amazon S3 bucket in Security Lake (3-63 characters). - example: security-lake-bucket + example: "security-lake-bucket" type: string buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" custom_source_name: description: Custom source name for the logs in Security Lake. - example: my-custom-source + example: "my-custom-source" type: string id: description: Unique identifier for the destination component. example: amazon-security-lake-destination type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array region: description: AWS region of the S3 bucket. - example: us-east-1 + example: "us-east-1" type: string tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineAmazonSecurityLakeDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineAmazonSecurityLakeDestinationType" required: - - id - - type - - inputs - - bucket - - region - - custom_source_name + - id + - type + - inputs + - bucket + - region + - custom_source_name type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineAmazonSecurityLakeDestinationType: default: amazon_security_lake description: The destination type. Always `amazon_security_lake`. enum: - - amazon_security_lake + - amazon_security_lake example: amazon_security_lake type: string x-enum-varnames: - - AMAZON_SECURITY_LAKE + - AMAZON_SECURITY_LAKE ObservabilityPipelineAwsAuth: - description: "AWS authentication credentials used for accessing AWS services - such as S3.\nIf omitted, the system\u2019s default credentials are used (for - example, the IAM role and environment variables)." + description: |- + AWS authentication credentials used for accessing AWS services such as S3. + If omitted, the system’s default credentials are used (for example, the IAM role and environment variables). properties: assume_role: description: The Amazon Resource Name (ARN) of the role to assume. @@ -42395,52 +40566,49 @@ components: description: A unique identifier for cross-account role assumption. type: string session_name: - description: A session identifier used for logging and tracing the assumed - role session. + description: A session identifier used for logging and tracing the assumed role session. type: string type: object ObservabilityPipelineBufferOptions: description: Configuration for buffer settings on destination components. oneOf: - - $ref: '#/components/schemas/ObservabilityPipelineDiskBufferOptions' - - $ref: '#/components/schemas/ObservabilityPipelineMemoryBufferOptions' - - $ref: '#/components/schemas/ObservabilityPipelineMemoryBufferSizeOptions' + - $ref: "#/components/schemas/ObservabilityPipelineDiskBufferOptions" + - $ref: "#/components/schemas/ObservabilityPipelineMemoryBufferOptions" + - $ref: "#/components/schemas/ObservabilityPipelineMemoryBufferSizeOptions" ObservabilityPipelineBufferOptionsDiskType: default: disk description: The type of the buffer that will be configured, a disk buffer. enum: - - disk + - disk type: string x-enum-varnames: - - DISK + - DISK ObservabilityPipelineBufferOptionsMemoryType: default: memory description: The type of the buffer that will be configured, a memory buffer. enum: - - memory + - memory type: string x-enum-varnames: - - MEMORY + - MEMORY ObservabilityPipelineBufferOptionsWhenFull: default: block - description: Behavior when the buffer is full (block and stop accepting new - events, or drop new events) + description: Behavior when the buffer is full (block and stop accepting new events, or drop new events) enum: - - block - - drop_newest + - block + - drop_newest type: string x-enum-varnames: - - BLOCK - - DROP_NEWEST + - BLOCK + - DROP_NEWEST ObservabilityPipelineCloudPremDestination: - description: 'The `cloud_prem` destination sends logs to Datadog CloudPrem. - + description: |- + The `cloud_prem` destination sends logs to Datadog CloudPrem. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: endpoint_url_key: - description: Name of the environment variable or secret that holds the CloudPrem - endpoint URL. + description: Name of the environment variable or secret that holds the CloudPrem endpoint URL. example: CLOUDPREM_ENDPOINT_URL type: string id: @@ -42448,275 +40616,208 @@ components: example: cloud-prem-destination type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array type: - $ref: '#/components/schemas/ObservabilityPipelineCloudPremDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineCloudPremDestinationType" required: - - id - - type - - inputs + - id + - type + - inputs type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineCloudPremDestinationType: default: cloud_prem description: The destination type. The value should always be `cloud_prem`. enum: - - cloud_prem + - cloud_prem example: cloud_prem type: string x-enum-varnames: - - CLOUD_PREM + - CLOUD_PREM ObservabilityPipelineComponentDisplayName: description: The display name for a component. - example: my component + example: "my component" type: string ObservabilityPipelineConfig: - description: Specifies the pipeline's configuration, including its sources, - processors, and destinations. + description: Specifies the pipeline's configuration, including its sources, processors, and destinations. properties: destinations: description: A list of destination components where processed logs are sent. - example: - - id: datadog-logs-destination - inputs: - - my-processor-group - type: datadog_logs + example: [{"id": "datadog-logs-destination", "inputs": ["my-processor-group"], "type": "datadog_logs"}] items: - $ref: '#/components/schemas/ObservabilityPipelineConfigDestinationItem' + $ref: "#/components/schemas/ObservabilityPipelineConfigDestinationItem" type: array pipeline_type: - $ref: '#/components/schemas/ObservabilityPipelineConfigPipelineType' + $ref: "#/components/schemas/ObservabilityPipelineConfigPipelineType" processor_groups: description: A list of processor groups that transform or enrich log data. - example: - - enabled: true - id: my-processor-group - include: service:my-service - inputs: - - datadog-agent-source - processors: - - enabled: true - id: filter-processor - include: status:error - type: filter - - enabled: true - field: message - id: json-processor - include: '*' - type: parse_json - items: - $ref: '#/components/schemas/ObservabilityPipelineConfigProcessorGroup' + example: [{"enabled": true, "id": "my-processor-group", "include": "service:my-service", "inputs": ["datadog-agent-source"], "processors": [{"enabled": true, "id": "filter-processor", "include": "status:error", "type": "filter"}, {"enabled": true, "field": "message", "id": "json-processor", "include": "*", "type": "parse_json"}]}] + items: + $ref: "#/components/schemas/ObservabilityPipelineConfigProcessorGroup" type: array processors: deprecated: true - description: 'A list of processor groups that transform or enrich log data. + description: |- + A list of processor groups that transform or enrich log data. - - **Deprecated:** This field is deprecated, you should now use the processor_groups - field.' + **Deprecated:** This field is deprecated, you should now use the processor_groups field. example: [] items: - $ref: '#/components/schemas/ObservabilityPipelineConfigProcessorGroup' + $ref: "#/components/schemas/ObservabilityPipelineConfigProcessorGroup" type: array sources: description: A list of configured data sources for the pipeline. - example: - - id: datadog-agent-source - type: datadog_agent + example: [{"id": "datadog-agent-source", "type": "datadog_agent"}] items: - $ref: '#/components/schemas/ObservabilityPipelineConfigSourceItem' + $ref: "#/components/schemas/ObservabilityPipelineConfigSourceItem" type: array use_legacy_search_syntax: - description: 'Set to `true` to continue using the legacy search syntax while - migrating filter queries. After migrating all queries to the new syntax, - set to `false`. - + description: |- + Set to `true` to continue using the legacy search syntax while migrating filter queries. After migrating all queries to the new syntax, set to `false`. The legacy syntax is deprecated and will eventually be removed. - Requires Observability Pipelines Worker 2.11 or later. - - See [Upgrade Your Filter Queries to the New Search Syntax](https://docs.datadoghq.com/observability_pipelines/guide/upgrade_your_filter_queries_to_the_new_search_syntax/) - for more information.' + See [Upgrade Your Filter Queries to the New Search Syntax](https://docs.datadoghq.com/observability_pipelines/guide/upgrade_your_filter_queries_to_the_new_search_syntax/) for more information. type: boolean required: - - sources - - destinations + - sources + - destinations type: object ObservabilityPipelineConfigDestinationItem: - description: A destination for the pipeline. + description: "A destination for the pipeline." oneOf: - - $ref: '#/components/schemas/ObservabilityPipelineHttpClientDestination' - - $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestination' - - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3Destination' - - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericDestination' - - $ref: '#/components/schemas/ObservabilityPipelineAmazonSecurityLakeDestination' - - $ref: '#/components/schemas/AzureStorageDestination' - - $ref: '#/components/schemas/ObservabilityPipelineCloudPremDestination' - - $ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestination' - - $ref: '#/components/schemas/ObservabilityPipelineDatadogLogsDestination' - - $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestination' - - $ref: '#/components/schemas/ObservabilityPipelineGoogleChronicleDestination' - - $ref: '#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestination' - - $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubDestination' - - $ref: '#/components/schemas/ObservabilityPipelineKafkaDestination' - - $ref: '#/components/schemas/MicrosoftSentinelDestination' - - $ref: '#/components/schemas/ObservabilityPipelineNewRelicDestination' - - $ref: '#/components/schemas/ObservabilityPipelineOpenSearchDestination' - - $ref: '#/components/schemas/ObservabilityPipelineRsyslogDestination' - - $ref: '#/components/schemas/ObservabilityPipelineSentinelOneDestination' - - $ref: '#/components/schemas/ObservabilityPipelineSocketDestination' - - $ref: '#/components/schemas/ObservabilityPipelineSplunkHecDestination' - - $ref: '#/components/schemas/ObservabilityPipelineSumoLogicDestination' - - $ref: '#/components/schemas/ObservabilityPipelineSyslogNgDestination' - - $ref: '#/components/schemas/ObservabilityPipelineDatadogMetricsDestination' + - $ref: "#/components/schemas/ObservabilityPipelineHttpClientDestination" + - $ref: "#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestination" + - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3Destination" + - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericDestination" + - $ref: "#/components/schemas/ObservabilityPipelineAmazonSecurityLakeDestination" + - $ref: "#/components/schemas/AzureStorageDestination" + - $ref: "#/components/schemas/ObservabilityPipelineCloudPremDestination" + - $ref: "#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestination" + - $ref: "#/components/schemas/ObservabilityPipelineDatadogLogsDestination" + - $ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestination" + - $ref: "#/components/schemas/ObservabilityPipelineGoogleChronicleDestination" + - $ref: "#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestination" + - $ref: "#/components/schemas/ObservabilityPipelineGooglePubSubDestination" + - $ref: "#/components/schemas/ObservabilityPipelineKafkaDestination" + - $ref: "#/components/schemas/MicrosoftSentinelDestination" + - $ref: "#/components/schemas/ObservabilityPipelineNewRelicDestination" + - $ref: "#/components/schemas/ObservabilityPipelineOpenSearchDestination" + - $ref: "#/components/schemas/ObservabilityPipelineRsyslogDestination" + - $ref: "#/components/schemas/ObservabilityPipelineSentinelOneDestination" + - $ref: "#/components/schemas/ObservabilityPipelineSocketDestination" + - $ref: "#/components/schemas/ObservabilityPipelineSplunkHecDestination" + - $ref: "#/components/schemas/ObservabilityPipelineSumoLogicDestination" + - $ref: "#/components/schemas/ObservabilityPipelineSyslogNgDestination" + - $ref: "#/components/schemas/ObservabilityPipelineDatadogMetricsDestination" ObservabilityPipelineConfigPipelineType: default: logs description: The type of data being ingested. Defaults to `logs` if not specified. - enum: - - logs - - metrics + enum: [logs, metrics] example: logs type: string x-enum-varnames: - - LOGS - - METRICS + - LOGS + - METRICS ObservabilityPipelineConfigProcessorGroup: - description: A group of processors. - example: - enabled: true - id: my-processor-group - include: service:my-service - inputs: - - datadog-agent-source - processors: - - enabled: true - fields: - - name: env - value: prod - id: add-fields-processor - include: '*' - type: add_fields - - enabled: true - id: filter-processor - include: status:error - type: filter + description: "A group of processors." + example: {"enabled": true, "id": "my-processor-group", "include": "service:my-service", "inputs": ["datadog-agent-source"], "processors": [{"enabled": true, "fields": [{"name": "env", "value": "prod"}], "id": "add-fields-processor", "include": "*", "type": "add_fields"}, {"enabled": true, "id": "filter-processor", "include": "status:error", "type": "filter"}]} properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Whether this processor group is enabled. example: true type: boolean id: description: The unique identifier for the processor group. - example: grouped-processors + example: "grouped-processors" type: string include: - description: Conditional expression for when this processor group should - execute. - example: service:my-service + description: Conditional expression for when this processor group should execute. + example: "service:my-service" type: string inputs: - description: A list of IDs for components whose output is used as the input - for this processor group. - example: - - datadog-agent-source + description: A list of IDs for components whose output is used as the input for this processor group. + example: ["datadog-agent-source"] items: type: string type: array processors: - description: Processors applied sequentially within this group. Events flow - through each processor in order. - example: - - enabled: true - fields: - - name: env - value: prod - id: add-fields-processor - include: '*' - type: add_fields - - enabled: true - id: filter-processor - include: status:error - type: filter + description: Processors applied sequentially within this group. Events flow through each processor in order. + example: [{"enabled": true, "fields": [{"name": "env", "value": "prod"}], "id": "add-fields-processor", "include": "*", "type": "add_fields"}, {"enabled": true, "id": "filter-processor", "include": "status:error", "type": "filter"}] items: - $ref: '#/components/schemas/ObservabilityPipelineConfigProcessorItem' + $ref: "#/components/schemas/ObservabilityPipelineConfigProcessorItem" type: array required: - - id - - include - - inputs - - processors - - enabled + - id + - include + - inputs + - processors + - enabled type: object ObservabilityPipelineConfigProcessorItem: - description: A processor for the pipeline. + description: "A processor for the pipeline." oneOf: - - $ref: '#/components/schemas/ObservabilityPipelineFilterProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineAddEnvVarsProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineAddFieldsProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineAddHostnameProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineCustomProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineDedupeProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineGenerateMetricsProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineOcsfMapperProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineParseJSONProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineParseXMLProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineReduceProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineRemoveFieldsProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineRenameFieldsProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineSampleProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineSplitArrayProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineThrottleProcessor' - - $ref: '#/components/schemas/ObservabilityPipelineMetricTagsProcessor' + - $ref: "#/components/schemas/ObservabilityPipelineFilterProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineAddEnvVarsProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineAddFieldsProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineAddHostnameProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineCustomProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineDatadogTagsProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineDedupeProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineGenerateMetricsProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineOcsfMapperProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineParseGrokProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineParseJSONProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineParseXMLProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineQuotaProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineReduceProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineRemoveFieldsProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineRenameFieldsProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineSampleProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineSplitArrayProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineThrottleProcessor" + - $ref: "#/components/schemas/ObservabilityPipelineMetricTagsProcessor" ObservabilityPipelineConfigSourceItem: - description: A data source for the pipeline. + description: "A data source for the pipeline." oneOf: - - $ref: '#/components/schemas/ObservabilityPipelineDatadogAgentSource' - - $ref: '#/components/schemas/ObservabilityPipelineAmazonDataFirehoseSource' - - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3Source' - - $ref: '#/components/schemas/ObservabilityPipelineFluentBitSource' - - $ref: '#/components/schemas/ObservabilityPipelineFluentdSource' - - $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubSource' - - $ref: '#/components/schemas/ObservabilityPipelineHttpClientSource' - - $ref: '#/components/schemas/ObservabilityPipelineHttpServerSource' - - $ref: '#/components/schemas/ObservabilityPipelineKafkaSource' - - $ref: '#/components/schemas/ObservabilityPipelineLogstashSource' - - $ref: '#/components/schemas/ObservabilityPipelineRsyslogSource' - - $ref: '#/components/schemas/ObservabilityPipelineSocketSource' - - $ref: '#/components/schemas/ObservabilityPipelineSplunkHecSource' - - $ref: '#/components/schemas/ObservabilityPipelineSplunkTcpSource' - - $ref: '#/components/schemas/ObservabilityPipelineSumoLogicSource' - - $ref: '#/components/schemas/ObservabilityPipelineSyslogNgSource' - - $ref: '#/components/schemas/ObservabilityPipelineOpentelemetrySource' + - $ref: "#/components/schemas/ObservabilityPipelineDatadogAgentSource" + - $ref: "#/components/schemas/ObservabilityPipelineAmazonDataFirehoseSource" + - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3Source" + - $ref: "#/components/schemas/ObservabilityPipelineFluentBitSource" + - $ref: "#/components/schemas/ObservabilityPipelineFluentdSource" + - $ref: "#/components/schemas/ObservabilityPipelineGooglePubSubSource" + - $ref: "#/components/schemas/ObservabilityPipelineHttpClientSource" + - $ref: "#/components/schemas/ObservabilityPipelineHttpServerSource" + - $ref: "#/components/schemas/ObservabilityPipelineKafkaSource" + - $ref: "#/components/schemas/ObservabilityPipelineLogstashSource" + - $ref: "#/components/schemas/ObservabilityPipelineRsyslogSource" + - $ref: "#/components/schemas/ObservabilityPipelineSocketSource" + - $ref: "#/components/schemas/ObservabilityPipelineSplunkHecSource" + - $ref: "#/components/schemas/ObservabilityPipelineSplunkTcpSource" + - $ref: "#/components/schemas/ObservabilityPipelineSumoLogicSource" + - $ref: "#/components/schemas/ObservabilityPipelineSyslogNgSource" + - $ref: "#/components/schemas/ObservabilityPipelineOpentelemetrySource" ObservabilityPipelineCrowdStrikeNextGenSiemDestination: - description: 'The `crowdstrike_next_gen_siem` destination forwards logs to CrowdStrike - Next Gen SIEM. - + description: |- + The `crowdstrike_next_gen_siem` destination forwards logs to CrowdStrike Next Gen SIEM. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" compression: - $ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompression' + $ref: "#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompression" encoding: - $ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationEncoding' + $ref: "#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationEncoding" endpoint_url_key: - description: Name of the environment variable or secret that holds the CrowdStrike - endpoint URL. + description: Name of the environment variable or secret that holds the CrowdStrike endpoint URL. example: CROWDSTRIKE_ENDPOINT_URL type: string id: @@ -42724,82 +40825,76 @@ components: example: crowdstrike-ngsiem-destination type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" token_key: - description: Name of the environment variable or secret that holds the CrowdStrike - API token. + description: Name of the environment variable or secret that holds the CrowdStrike API token. example: CROWDSTRIKE_TOKEN type: string type: - $ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationType" required: - - id - - type - - inputs - - encoding + - id + - type + - inputs + - encoding type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompression: description: Compression configuration for log events. properties: algorithm: - $ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompressionAlgorithm' + $ref: "#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompressionAlgorithm" level: description: Compression level. example: 6 format: int64 type: integer required: - - algorithm + - algorithm type: object ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompressionAlgorithm: description: Compression algorithm for log events. enum: - - gzip - - zlib + - gzip + - zlib example: gzip type: string x-enum-varnames: - - GZIP - - ZLIB + - GZIP + - ZLIB ObservabilityPipelineCrowdStrikeNextGenSiemDestinationEncoding: description: Encoding format for log events. enum: - - json - - raw_message + - json + - raw_message example: json type: string x-enum-varnames: - - JSON - - RAW_MESSAGE + - JSON + - RAW_MESSAGE ObservabilityPipelineCrowdStrikeNextGenSiemDestinationType: default: crowdstrike_next_gen_siem description: The destination type. The value should always be `crowdstrike_next_gen_siem`. enum: - - crowdstrike_next_gen_siem + - crowdstrike_next_gen_siem example: crowdstrike_next_gen_siem type: string x-enum-varnames: - - CROWDSTRIKE_NEXT_GEN_SIEM + - CROWDSTRIKE_NEXT_GEN_SIEM ObservabilityPipelineCustomProcessor: - description: 'The `custom_processor` processor transforms events using [Vector - Remap Language (VRL)](https://vector.dev/docs/reference/vrl/) scripts with - advanced filtering capabilities. - + description: |- + The `custom_processor` processor transforms events using [Vector Remap Language (VRL)](https://vector.dev/docs/reference/vrl/) scripts with advanced filtering capabilities. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true @@ -42809,32 +40904,28 @@ components: example: remap-vrl-processor type: string include: - default: '*' - description: A Datadog search query used to determine which logs this processor - targets. This field should always be set to `*` for the custom_processor - processor. - example: '*' + default: "*" + description: A Datadog search query used to determine which logs this processor targets. This field should always be set to `*` for the custom_processor processor. + example: "*" type: string remaps: description: Array of VRL remap rules. items: - $ref: '#/components/schemas/ObservabilityPipelineCustomProcessorRemap' + $ref: "#/components/schemas/ObservabilityPipelineCustomProcessorRemap" minItems: 1 type: array type: - $ref: '#/components/schemas/ObservabilityPipelineCustomProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineCustomProcessorType" required: - - id - - type - - include - - remaps - - enabled + - id + - type + - include + - remaps + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineCustomProcessorRemap: - description: Defines a single VRL remap rule with its own filtering and transformation - logic. + description: Defines a single VRL remap rule with its own filtering and transformation logic. properties: drop_on_error: description: Whether to drop events that caused errors during processing. @@ -42845,158 +40936,134 @@ components: example: true type: boolean include: - description: A Datadog search query used to filter events for this specific - remap rule. - example: service:web + description: A Datadog search query used to filter events for this specific remap rule. + example: "service:web" type: string name: description: A descriptive name for this remap rule. - example: Parse JSON from message field + example: "Parse JSON from message field" type: string source: description: The VRL script source code that defines the processing logic. - example: . = parse_json!(.message) + example: ". = parse_json!(.message)" type: string required: - - include - - name - - source - - drop_on_error + - include + - name + - source + - drop_on_error type: object ObservabilityPipelineCustomProcessorType: default: custom_processor description: The processor type. The value should always be `custom_processor`. enum: - - custom_processor + - custom_processor example: custom_processor type: string x-enum-varnames: - - CUSTOM_PROCESSOR + - CUSTOM_PROCESSOR ObservabilityPipelineData: - description: "Contains the pipeline\u2019s ID, type, and configuration attributes." + description: Contains the pipeline’s ID, type, and configuration attributes. properties: attributes: - $ref: '#/components/schemas/ObservabilityPipelineDataAttributes' + $ref: "#/components/schemas/ObservabilityPipelineDataAttributes" id: description: Unique identifier for the pipeline. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 type: string type: default: pipelines - description: The resource type identifier. For pipeline resources, this - should always be set to `pipelines`. + description: The resource type identifier. For pipeline resources, this should always be set to `pipelines`. example: pipelines type: string required: - - id - - type - - attributes + - id + - type + - attributes type: object ObservabilityPipelineDataAttributes: - description: "Defines the pipeline\u2019s name and its components (sources, - processors, and destinations)." + description: Defines the pipeline’s name and its components (sources, processors, and destinations). properties: config: - $ref: '#/components/schemas/ObservabilityPipelineConfig' + $ref: "#/components/schemas/ObservabilityPipelineConfig" name: description: Name of the pipeline. example: Main Observability Pipeline type: string required: - - name - - config + - name + - config type: object ObservabilityPipelineDatadogAgentSource: - description: 'The `datadog_agent` source collects logs/metrics from the Datadog - Agent. + description: |- + The `datadog_agent` source collects logs/metrics from the Datadog Agent. - - **Supported pipeline types:** logs, metrics' + **Supported pipeline types:** logs, metrics properties: - address_key: - description: Name of the environment variable or secret that holds the listen - address for the Datadog Agent source. - example: DATADOG_AGENT_ADDRESS - type: string id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). - example: datadog-agent-source + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). + example: "datadog-agent-source" type: string tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineDatadogAgentSourceType' + $ref: "#/components/schemas/ObservabilityPipelineDatadogAgentSourceType" required: - - id - - type + - id + - type type: object - x-pipeline-types: - - logs - - metrics + x-pipeline-types: [logs, metrics] ObservabilityPipelineDatadogAgentSourceType: default: datadog_agent description: The source type. The value should always be `datadog_agent`. enum: - - datadog_agent + - datadog_agent example: datadog_agent type: string x-enum-varnames: - - DATADOG_AGENT + - DATADOG_AGENT ObservabilityPipelineDatadogLogsDestination: - description: 'The `datadog_logs` destination forwards logs to Datadog Log Management. - + description: |- + The `datadog_logs` destination forwards logs to Datadog Log Management. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" id: description: The unique identifier for this component. - example: datadog-logs-destination + example: "datadog-logs-destination" type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array routes: - description: A list of routing rules that forward matching logs to Datadog - using dedicated API keys. - example: - - api_key_key: API_KEY_IDENTIFIER - include: service:api - route_id: datadog-logs-route-us1 - site: us1 + description: A list of routing rules that forward matching logs to Datadog using dedicated API keys. + example: [{"api_key_key": "API_KEY_IDENTIFIER", "include": "service:api", "route_id": "datadog-logs-route-us1", "site": "us1"}] items: - $ref: '#/components/schemas/ObservabilityPipelineDatadogLogsDestinationRoute' + $ref: "#/components/schemas/ObservabilityPipelineDatadogLogsDestinationRoute" maxItems: 100 type: array type: - $ref: '#/components/schemas/ObservabilityPipelineDatadogLogsDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineDatadogLogsDestinationType" required: - - id - - type - - inputs + - id + - type + - inputs type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineDatadogLogsDestinationRoute: - description: Defines how the `datadog_logs` destination routes matching logs - to a Datadog site using a specific API key. + description: Defines how the `datadog_logs` destination routes matching logs to a Datadog site using a specific API key. properties: api_key_key: - description: Name of the environment variable or secret that stores the - Datadog API key used by this route. + description: Name of the environment variable or secret that stores the Datadog API key used by this route. example: API_KEY_IDENTIFIER type: string include: - description: A Datadog search query that determines which logs are forwarded - using this route. + description: A Datadog search query that determines which logs are forwarded using this route. example: service:api type: string route_id: @@ -43012,157 +41079,144 @@ components: default: datadog_logs description: The destination type. The value should always be `datadog_logs`. enum: - - datadog_logs + - datadog_logs example: datadog_logs type: string x-enum-varnames: - - DATADOG_LOGS + - DATADOG_LOGS ObservabilityPipelineDatadogMetricsDestination: - description: 'The `datadog_metrics` destination forwards metrics to Datadog. + description: |- + The `datadog_metrics` destination forwards metrics to Datadog. - - **Supported pipeline types:** metrics' + **Supported pipeline types:** metrics properties: id: description: The unique identifier for this component. example: datadog-metrics-destination type: string inputs: - description: A list of component IDs whose output is used as the input for - this component. - example: - - metric-tags-processor + description: A list of component IDs whose output is used as the input for this component. + example: ["metric-tags-processor"] items: type: string type: array type: - $ref: '#/components/schemas/ObservabilityPipelineDatadogMetricsDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineDatadogMetricsDestinationType" required: - - id - - type - - inputs + - id + - type + - inputs type: object - x-pipeline-types: - - metrics + x-pipeline-types: [metrics] ObservabilityPipelineDatadogMetricsDestinationType: default: datadog_metrics description: The destination type. The value should always be `datadog_metrics`. enum: - - datadog_metrics + - datadog_metrics example: datadog_metrics type: string x-enum-varnames: - - DATADOG_METRICS + - DATADOG_METRICS ObservabilityPipelineDatadogTagsProcessor: - description: 'The `datadog_tags` processor includes or excludes specific Datadog - tags in your logs. + description: |- + The `datadog_tags` processor includes or excludes specific Datadog tags in your logs. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: action: - $ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessorAction' + $ref: "#/components/schemas/ObservabilityPipelineDatadogTagsProcessorAction" display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). - example: datadog-tags-processor + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). + example: "datadog-tags-processor" type: string include: - description: A Datadog search query used to determine which logs this processor - targets. - example: service:my-service + description: A Datadog search query used to determine which logs this processor targets. + example: "service:my-service" type: string keys: description: A list of tag keys. - example: - - env - - service - - version + example: ["env", "service", "version"] items: type: string type: array mode: - $ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessorMode' + $ref: "#/components/schemas/ObservabilityPipelineDatadogTagsProcessorMode" type: - $ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineDatadogTagsProcessorType" required: - - id - - type - - include - - mode - - action - - keys - - enabled + - id + - type + - include + - mode + - action + - keys + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineDatadogTagsProcessorAction: description: The action to take on tags with matching keys. enum: - - include - - exclude + - include + - exclude example: include type: string x-enum-varnames: - - INCLUDE - - EXCLUDE + - INCLUDE + - EXCLUDE ObservabilityPipelineDatadogTagsProcessorMode: description: The processing mode. enum: - - filter + - filter example: filter type: string x-enum-varnames: - - FILTER + - FILTER ObservabilityPipelineDatadogTagsProcessorType: default: datadog_tags description: The processor type. The value should always be `datadog_tags`. enum: - - datadog_tags + - datadog_tags example: datadog_tags type: string x-enum-varnames: - - DATADOG_TAGS + - DATADOG_TAGS ObservabilityPipelineDecoding: description: The decoding format used to interpret incoming logs. enum: - - bytes - - gelf - - json - - syslog + - bytes + - gelf + - json + - syslog example: json type: string x-enum-varnames: - - DECODE_BYTES - - DECODE_GELF - - DECODE_JSON - - DECODE_SYSLOG + - DECODE_BYTES + - DECODE_GELF + - DECODE_JSON + - DECODE_SYSLOG ObservabilityPipelineDedupeProcessor: - description: 'The `dedupe` processor removes duplicate fields in log events. - + description: |- + The `dedupe` processor removes duplicate fields in log events. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: cache: - $ref: '#/components/schemas/ObservabilityPipelineDedupeProcessorCache' + $ref: "#/components/schemas/ObservabilityPipelineDedupeProcessorCache" display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean fields: description: A list of log field paths to check for duplicates. - example: - - log.message - - log.error + example: ["log.message", "log.error"] items: type: string type: array @@ -43171,24 +41225,22 @@ components: example: dedupe-processor type: string include: - description: A Datadog search query used to determine which logs this processor - targets. + description: A Datadog search query used to determine which logs this processor targets. example: service:my-service type: string mode: - $ref: '#/components/schemas/ObservabilityPipelineDedupeProcessorMode' + $ref: "#/components/schemas/ObservabilityPipelineDedupeProcessorMode" type: - $ref: '#/components/schemas/ObservabilityPipelineDedupeProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineDedupeProcessorType" required: - - id - - type - - include - - fields - - mode - - enabled + - id + - type + - include + - fields + - mode + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineDedupeProcessorCache: description: Configuration for the cache used to detect duplicates. properties: @@ -43200,27 +41252,27 @@ components: minimum: 1 type: integer required: - - num_events + - num_events type: object ObservabilityPipelineDedupeProcessorMode: description: The deduplication mode to apply to the fields. enum: - - match - - ignore + - match + - ignore example: match type: string x-enum-varnames: - - MATCH - - IGNORE + - MATCH + - IGNORE ObservabilityPipelineDedupeProcessorType: default: dedupe description: The processor type. The value should always be `dedupe`. enum: - - dedupe + - dedupe example: dedupe type: string x-enum-varnames: - - DEDUPE + - DEDUPE ObservabilityPipelineDiskBufferOptions: description: Options for configuring a disk buffer. properties: @@ -43230,127 +41282,111 @@ components: format: int64 type: integer type: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsDiskType' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptionsDiskType" when_full: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsWhenFull' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptionsWhenFull" required: - - max_size + - max_size type: object ObservabilityPipelineElasticsearchDestination: - description: 'The `elasticsearch` destination writes logs to an Elasticsearch - cluster. - + description: |- + The `elasticsearch` destination writes logs to an Elasticsearch cluster. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: api_version: - $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationApiVersion' + $ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationApiVersion" auth: - $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationAuth' + $ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationAuth" buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" bulk_index: description: The index to write logs to in Elasticsearch. example: logs-index type: string data_stream: - $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationDataStream' + $ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationDataStream" endpoint_url_key: - description: Name of the environment variable or secret that holds the Elasticsearch - endpoint URL. + description: Name of the environment variable or secret that holds the Elasticsearch endpoint URL. example: ELASTICSEARCH_ENDPOINT_URL type: string id: description: The unique identifier for this component. - example: elasticsearch-destination + example: "elasticsearch-destination" type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array type: - $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationType" required: - - id - - type - - inputs + - id + - type + - inputs type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineElasticsearchDestinationApiVersion: description: The Elasticsearch API version to use. Set to `auto` to auto-detect. - enum: - - auto - - v6 - - v7 - - v8 + enum: [auto, v6, v7, v8] example: auto type: string x-enum-varnames: - - AUTO - - V6 - - V7 - - V8 + - AUTO + - V6 + - V7 + - V8 ObservabilityPipelineElasticsearchDestinationAuth: - description: 'Authentication settings for the Elasticsearch destination. - - When `strategy` is `basic`, use `username_key` and `password_key` to reference - credentials stored in environment variables or secrets.' + description: |- + Authentication settings for the Elasticsearch destination. + When `strategy` is `basic`, use `username_key` and `password_key` to reference credentials stored in environment variables or secrets. properties: password_key: - description: Name of the environment variable or secret that holds the Elasticsearch - password (used when `strategy` is `basic`). + description: Name of the environment variable or secret that holds the Elasticsearch password (used when `strategy` is `basic`). example: ELASTICSEARCH_PASSWORD type: string strategy: - $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationAuthStrategy' + $ref: "#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationAuthStrategy" username_key: - description: Name of the environment variable or secret that holds the Elasticsearch - username (used when `strategy` is `basic`). + description: Name of the environment variable or secret that holds the Elasticsearch username (used when `strategy` is `basic`). example: ELASTICSEARCH_USERNAME type: string required: - - strategy + - strategy type: object ObservabilityPipelineElasticsearchDestinationDataStream: - description: Configuration options for writing to Elasticsearch Data Streams - instead of a fixed index. + description: Configuration options for writing to Elasticsearch Data Streams instead of a fixed index. properties: dataset: - description: The data stream dataset for your logs. This groups logs by - their source or application. + description: The data stream dataset for your logs. This groups logs by their source or application. type: string dtype: - description: The data stream type for your logs. This determines how logs - are categorized within the data stream. + description: The data stream type for your logs. This determines how logs are categorized within the data stream. type: string namespace: - description: The data stream namespace for your logs. This separates logs - into different environments or domains. + description: The data stream namespace for your logs. This separates logs into different environments or domains. type: string type: object ObservabilityPipelineElasticsearchDestinationType: default: elasticsearch description: The destination type. The value should always be `elasticsearch`. enum: - - elasticsearch + - elasticsearch example: elasticsearch type: string x-enum-varnames: - - ELASTICSEARCH + - ELASTICSEARCH ObservabilityPipelineEnrichmentTableFile: description: Defines a static enrichment table loaded from a CSV file. properties: encoding: - $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFileEncoding' + $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFileEncoding" key: description: Key fields used to look up enrichment values. items: - $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFileKeyItems' + $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFileKeyItems" type: array path: description: Path to the CSV file. @@ -43359,67 +41395,64 @@ components: schema: description: Schema defining column names and their types. items: - $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFileSchemaItems' + $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFileSchemaItems" type: array required: - - encoding - - key - - path - - schema + - encoding + - key + - path + - schema type: object ObservabilityPipelineEnrichmentTableFileEncoding: description: File encoding format. properties: delimiter: description: The `encoding` `delimiter`. - example: ',' + example: "," type: string includes_headers: description: The `encoding` `includes_headers`. example: true type: boolean type: - $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFileEncodingType' + $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFileEncodingType" required: - - type - - delimiter - - includes_headers + - type + - delimiter + - includes_headers type: object ObservabilityPipelineEnrichmentTableFileEncodingType: description: Specifies the encoding format (e.g., CSV) used for enrichment tables. - enum: - - csv + enum: [csv] example: csv type: string x-enum-varnames: - - CSV + - CSV ObservabilityPipelineEnrichmentTableFileKeyItems: - description: Defines how to map log fields to enrichment table columns during - lookups. + description: Defines how to map log fields to enrichment table columns during lookups. properties: column: description: The `items` `column`. example: user_id type: string comparison: - $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFileKeyItemsComparison' + $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFileKeyItemsComparison" field: description: The `items` `field`. example: log.user.id type: string required: - - column - - comparison - - field + - column + - comparison + - field type: object ObservabilityPipelineEnrichmentTableFileKeyItemsComparison: description: Defines how to compare key fields for enrichment table lookups. - enum: - - equals + enum: [equals] example: equals type: string x-enum-varnames: - - EQUALS + - EQUALS ObservabilityPipelineEnrichmentTableFileSchemaItems: description: Describes a single column and its type in an enrichment table schema. properties: @@ -43428,29 +41461,23 @@ components: example: region type: string type: - $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFileSchemaItemsType' + $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFileSchemaItemsType" required: - - column - - type + - column + - type type: object ObservabilityPipelineEnrichmentTableFileSchemaItemsType: description: Declares allowed data types for enrichment table columns. - enum: - - string - - boolean - - integer - - float - - date - - timestamp + enum: [string, boolean, integer, float, date, timestamp] example: string type: string x-enum-varnames: - - STRING - - BOOLEAN - - INTEGER - - FLOAT - - DATE - - TIMESTAMP + - STRING + - BOOLEAN + - INTEGER + - FLOAT + - DATE + - TIMESTAMP ObservabilityPipelineEnrichmentTableGeoIp: description: Uses a GeoIP database to enrich logs based on an IP field. properties: @@ -43467,80 +41494,73 @@ components: example: /etc/geoip/GeoLite2-City.mmdb type: string required: - - key_field - - locale - - path + - key_field + - locale + - path type: object ObservabilityPipelineEnrichmentTableProcessor: - description: 'The `enrichment_table` processor enriches logs using a static - CSV file, GeoIP database, or reference table. Exactly one of `file`, `geoip`, - or `reference_table` must be configured. - + description: |- + The `enrichment_table` processor enriches logs using a static CSV file, GeoIP database, or reference table. Exactly one of `file`, `geoip`, or `reference_table` must be configured. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean file: - $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFile' + $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFile" geoip: - $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableGeoIp' + $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableGeoIp" id: description: The unique identifier for this processor. example: enrichment-table-processor type: string include: - description: A Datadog search query used to determine which logs this processor - targets. + description: A Datadog search query used to determine which logs this processor targets. example: source:my-source type: string reference_table: - $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableReferenceTable' + $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableReferenceTable" target: description: Path where enrichment results should be stored in the log. example: enriched.geoip type: string type: - $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableProcessorType" required: - - id - - type - - include - - target - - enabled + - id + - type + - include + - target + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineEnrichmentTableProcessorType: default: enrichment_table description: The processor type. The value should always be `enrichment_table`. enum: - - enrichment_table + - enrichment_table example: enrichment_table type: string x-enum-varnames: - - ENRICHMENT_TABLE + - ENRICHMENT_TABLE ObservabilityPipelineEnrichmentTableReferenceTable: description: Uses a Datadog reference table to enrich logs. properties: app_key_key: - description: Name of the environment variable or secret that holds the Datadog - application key used to access the reference table. + description: Name of the environment variable or secret that holds the Datadog application key used to access the reference table. example: DD_APP_KEY type: string columns: - description: List of column names to include from the reference table. If - not provided, all columns are included. + description: List of column names to include from the reference table. If not provided, all columns are included. items: type: string type: array key_field: - description: Path to the field in the log event to match against the reference - table. + description: Path to the field in the log event to match against the reference table. example: log.user.id type: string table_id: @@ -43548,213 +41568,188 @@ components: example: 550e8400-e29b-41d4-a716-446655440000 type: string required: - - key_field - - table_id + - key_field + - table_id type: object ObservabilityPipelineFieldValue: description: Represents a static key-value pair used in various processors. properties: name: description: The field name. - example: field_name + example: "field_name" type: string value: description: The field value. - example: field_value + example: "field_value" type: string required: - - name - - value + - name + - value type: object ObservabilityPipelineFilterProcessor: - description: 'The `filter` processor allows conditional processing of logs/metrics - based on a Datadog search query. Logs/metrics that match the `include` query - are passed through; others are discarded. + description: |- + The `filter` processor allows conditional processing of logs/metrics based on a Datadog search query. Logs/metrics that match the `include` query are passed through; others are discarded. - - **Supported pipeline types:** logs, metrics' + **Supported pipeline types:** logs, metrics properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). - example: filter-processor + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). + example: "filter-processor" type: string include: - description: A Datadog search query used to determine which logs/metrics - should pass through the filter. Logs/metrics that match this query continue - to downstream components; others are dropped. - example: service:my-service + description: A Datadog search query used to determine which logs/metrics should pass through the filter. Logs/metrics that match this query continue to downstream components; others are dropped. + example: "service:my-service" type: string type: - $ref: '#/components/schemas/ObservabilityPipelineFilterProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineFilterProcessorType" required: - - id - - type - - include - - enabled + - id + - type + - include + - enabled type: object - x-pipeline-types: - - logs - - metrics + x-pipeline-types: [logs, metrics] ObservabilityPipelineFilterProcessorType: default: filter description: The processor type. The value should always be `filter`. enum: - - filter + - filter example: filter type: string x-enum-varnames: - - FILTER + - FILTER ObservabilityPipelineFluentBitSource: - description: 'The `fluent_bit` source ingests logs from Fluent Bit. + description: |- + The `fluent_bit` source ingests logs from Fluent Bit. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: address_key: - description: Name of the environment variable or secret that holds the listen - address for the Fluent Bit receiver. + description: Name of the environment variable or secret that holds the listen address for the Fluent Bit receiver. example: FLUENT_ADDRESS type: string id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). - example: fluent-source + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). + example: "fluent-source" type: string tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineFluentBitSourceType' + $ref: "#/components/schemas/ObservabilityPipelineFluentBitSourceType" required: - - id - - type + - id + - type type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineFluentBitSourceType: default: fluent_bit description: The source type. The value should always be `fluent_bit`. enum: - - fluent_bit + - fluent_bit example: fluent_bit type: string x-enum-varnames: - - FLUENT_BIT + - FLUENT_BIT ObservabilityPipelineFluentdSource: - description: 'The `fluentd` source ingests logs from a Fluentd-compatible service. - + description: |- + The `fluentd` source ingests logs from a Fluentd-compatible service. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: address_key: - description: Name of the environment variable or secret that holds the listen - address for the Fluent receiver. + description: Name of the environment variable or secret that holds the listen address for the Fluent receiver. example: FLUENT_ADDRESS type: string id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). - example: fluent-source + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). + example: "fluent-source" type: string tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineFluentdSourceType' + $ref: "#/components/schemas/ObservabilityPipelineFluentdSourceType" required: - - id - - type + - id + - type type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineFluentdSourceType: default: fluentd description: The source type. The value should always be `fluentd. enum: - - fluentd + - fluentd example: fluentd type: string x-enum-varnames: - - FLUENTD + - FLUENTD ObservabilityPipelineGcpAuth: - description: Google Cloud credentials used to authenticate with Google Cloud - Storage. + description: |- + Google Cloud credentials used to authenticate with Google Cloud Storage. properties: credentials_file: description: Path to the Google Cloud service account key file. example: /var/secrets/gcp-credentials.json type: string required: - - credentials_file + - credentials_file type: object ObservabilityPipelineGenerateMetricsProcessor: - description: 'The `generate_datadog_metrics` processor creates custom metrics - from logs and sends them to Datadog. - - Metrics can be counters, gauges, or distributions and optionally grouped by - log fields. - + description: |- + The `generate_datadog_metrics` processor creates custom metrics from logs and sends them to Datadog. + Metrics can be counters, gauges, or distributions and optionally grouped by log fields. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean id: - description: The unique identifier for this component. Used to reference - this component in other parts of the pipeline. + description: The unique identifier for this component. Used to reference this component in other parts of the pipeline. example: generate-metrics-processor type: string include: - description: A Datadog search query used to determine which logs this processor - targets. - example: service:my-service + description: A Datadog search query used to determine which logs this processor targets. + example: "service:my-service" type: string metrics: description: Configuration for generating individual metrics. items: - $ref: '#/components/schemas/ObservabilityPipelineGeneratedMetric' + $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetric" type: array type: - $ref: '#/components/schemas/ObservabilityPipelineGenerateMetricsProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineGenerateMetricsProcessorType" required: - - id - - type - - enabled + - id + - type + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineGenerateMetricsProcessorType: default: generate_datadog_metrics description: The processor type. Always `generate_datadog_metrics`. enum: - - generate_datadog_metrics + - generate_datadog_metrics example: generate_datadog_metrics type: string x-enum-varnames: - - GENERATE_DATADOG_METRICS + - GENERATE_DATADOG_METRICS ObservabilityPipelineGeneratedMetric: - description: 'Defines a log-based custom metric, including its name, type, filter, - value computation strategy, - - and optional grouping fields.' + description: |- + Defines a log-based custom metric, including its name, type, filter, value computation strategy, + and optional grouping fields. properties: group_by: description: Optional fields used to group the metric series. - example: - - service - - env + example: ["service", "env"] items: type: string type: array @@ -43763,90 +41758,86 @@ components: example: service:billing type: string metric_type: - $ref: '#/components/schemas/ObservabilityPipelineGeneratedMetricMetricType' + $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetricMetricType" name: description: Name of the custom metric to be created. example: logs.processed type: string value: - $ref: '#/components/schemas/ObservabilityPipelineMetricValue' + $ref: "#/components/schemas/ObservabilityPipelineMetricValue" required: - - name - - include - - metric_type - - value + - name + - include + - metric_type + - value type: object ObservabilityPipelineGeneratedMetricIncrementByField: - description: Strategy that increments a generated metric based on the value - of a log field. + description: Strategy that increments a generated metric based on the value of a log field. properties: field: - description: Name of the log field containing the numeric value to increment - the metric by. - example: errors + description: Name of the log field containing the numeric value to increment the metric by. + example: "errors" type: string strategy: - $ref: '#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByFieldStrategy' + $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByFieldStrategy" required: - - strategy - - field + - strategy + - field type: object ObservabilityPipelineGeneratedMetricIncrementByFieldStrategy: description: Uses a numeric field in the log event as the metric increment. enum: - - increment_by_field + - increment_by_field example: increment_by_field type: string x-enum-varnames: - - INCREMENT_BY_FIELD + - INCREMENT_BY_FIELD ObservabilityPipelineGeneratedMetricIncrementByOne: - description: Strategy that increments a generated metric by one for each matching - event. + description: Strategy that increments a generated metric by one for each matching event. properties: strategy: - $ref: '#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByOneStrategy' + $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByOneStrategy" required: - - strategy + - strategy type: object ObservabilityPipelineGeneratedMetricIncrementByOneStrategy: description: Increments the metric by 1 for each matching event. enum: - - increment_by_one + - increment_by_one example: increment_by_one type: string x-enum-varnames: - - INCREMENT_BY_ONE + - INCREMENT_BY_ONE ObservabilityPipelineGeneratedMetricMetricType: description: Type of metric to create. enum: - - count - - gauge - - distribution + - count + - gauge + - distribution example: count type: string x-enum-varnames: - - COUNT - - GAUGE - - DISTRIBUTION + - COUNT + - GAUGE + - DISTRIBUTION ObservabilityPipelineGoogleChronicleDestination: - description: 'The `google_chronicle` destination sends logs to Google Chronicle. - + description: |- + The `google_chronicle` destination sends logs to Google Chronicle. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: auth: - $ref: '#/components/schemas/ObservabilityPipelineGcpAuth' + $ref: "#/components/schemas/ObservabilityPipelineGcpAuth" buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" customer_id: description: The Google Chronicle customer ID. example: abcdefg123456789 type: string encoding: - $ref: '#/components/schemas/ObservabilityPipelineGoogleChronicleDestinationEncoding' + $ref: "#/components/schemas/ObservabilityPipelineGoogleChronicleDestinationEncoding" endpoint_url_key: - description: Name of the environment variable or secret that holds the Google - Chronicle endpoint URL. + description: Name of the environment variable or secret that holds the Google Chronicle endpoint URL. example: CHRONICLE_ENDPOINT_URL type: string id: @@ -43854,10 +41845,8 @@ components: example: google-chronicle-destination type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - parse-json-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["parse-json-processor"] items: type: string type: array @@ -43866,62 +41855,57 @@ components: example: nginx_logs type: string type: - $ref: '#/components/schemas/ObservabilityPipelineGoogleChronicleDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineGoogleChronicleDestinationType" required: - - id - - type - - inputs - - customer_id + - id + - type + - inputs + - customer_id type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineGoogleChronicleDestinationEncoding: description: The encoding format for the logs sent to Chronicle. enum: - - json - - raw_message + - json + - raw_message example: json type: string x-enum-varnames: - - JSON - - RAW_MESSAGE + - JSON + - RAW_MESSAGE ObservabilityPipelineGoogleChronicleDestinationType: default: google_chronicle description: The destination type. The value should always be `google_chronicle`. enum: - - google_chronicle + - google_chronicle example: google_chronicle type: string x-enum-varnames: - - GOOGLE_CHRONICLE + - GOOGLE_CHRONICLE ObservabilityPipelineGoogleCloudStorageDestination: - description: 'The `google_cloud_storage` destination stores logs in a Google - Cloud Storage (GCS) bucket. - + description: |- + The `google_cloud_storage` destination stores logs in a Google Cloud Storage (GCS) bucket. It requires a bucket name, Google Cloud authentication, and metadata fields. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: acl: - $ref: '#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationAcl' + $ref: "#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationAcl" auth: - $ref: '#/components/schemas/ObservabilityPipelineGcpAuth' + $ref: "#/components/schemas/ObservabilityPipelineGcpAuth" bucket: description: Name of the GCS bucket. - example: error-logs + example: "error-logs" type: string buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" id: description: Unique identifier for the destination component. example: gcs-destination type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - datadog-agent-source + description: A list of component IDs whose output is used as the `input` for this component. + example: ["datadog-agent-source"] items: type: string type: array @@ -43929,81 +41913,77 @@ components: description: Optional prefix for object keys within the GCS bucket. type: string metadata: - description: Custom metadata to attach to each object uploaded to the GCS - bucket. + description: Custom metadata to attach to each object uploaded to the GCS bucket. items: - $ref: '#/components/schemas/ObservabilityPipelineMetadataEntry' + $ref: "#/components/schemas/ObservabilityPipelineMetadataEntry" type: array storage_class: - $ref: '#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationStorageClass' + $ref: "#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationStorageClass" type: - $ref: '#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationType" required: - - id - - type - - inputs - - bucket - - storage_class + - id + - type + - inputs + - bucket + - storage_class type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineGoogleCloudStorageDestinationAcl: description: Access control list setting for objects written to the bucket. enum: - - private - - project-private - - public-read - - authenticated-read - - bucket-owner-read - - bucket-owner-full-control + - private + - project-private + - public-read + - authenticated-read + - bucket-owner-read + - bucket-owner-full-control example: private type: string x-enum-varnames: - - PRIVATE - - PROJECTNOT_PRIVATE - - PUBLICNOT_READ - - AUTHENTICATEDNOT_READ - - BUCKETNOT_OWNERNOT_READ - - BUCKETNOT_OWNERNOT_FULLNOT_CONTROL + - PRIVATE + - PROJECTNOT_PRIVATE + - PUBLICNOT_READ + - AUTHENTICATEDNOT_READ + - BUCKETNOT_OWNERNOT_READ + - BUCKETNOT_OWNERNOT_FULLNOT_CONTROL ObservabilityPipelineGoogleCloudStorageDestinationStorageClass: description: Storage class used for objects stored in GCS. enum: - - STANDARD - - NEARLINE - - COLDLINE - - ARCHIVE + - STANDARD + - NEARLINE + - COLDLINE + - ARCHIVE example: STANDARD type: string x-enum-varnames: - - STANDARD - - NEARLINE - - COLDLINE - - ARCHIVE + - STANDARD + - NEARLINE + - COLDLINE + - ARCHIVE ObservabilityPipelineGoogleCloudStorageDestinationType: default: google_cloud_storage description: The destination type. Always `google_cloud_storage`. enum: - - google_cloud_storage + - google_cloud_storage example: google_cloud_storage type: string x-enum-varnames: - - GOOGLE_CLOUD_STORAGE + - GOOGLE_CLOUD_STORAGE ObservabilityPipelineGooglePubSubDestination: - description: 'The `google_pubsub` destination publishes logs to a Google Cloud - Pub/Sub topic. - + description: |- + The `google_pubsub` destination publishes logs to a Google Cloud Pub/Sub topic. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: auth: - $ref: '#/components/schemas/ObservabilityPipelineGcpAuth' + $ref: "#/components/schemas/ObservabilityPipelineGcpAuth" buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" encoding: - $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubDestinationEncoding' + $ref: "#/components/schemas/ObservabilityPipelineGooglePubSubDestinationEncoding" endpoint_url_key: - description: Name of the environment variable or secret that holds the Google - Cloud Pub/Sub endpoint URL. + description: Name of the environment variable or secret that holds the Google Cloud Pub/Sub endpoint URL. example: GCP_PUBSUB_ENDPOINT_URL type: string id: @@ -44011,10 +41991,8 @@ components: example: google-pubsub-destination type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array @@ -44023,57 +42001,53 @@ components: example: my-gcp-project type: string tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" topic: description: The Pub/Sub topic name to publish logs to. example: logs-subscription type: string type: - $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineGooglePubSubDestinationType" required: - - id - - type - - inputs - - encoding - - project - - topic + - id + - type + - inputs + - encoding + - project + - topic type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineGooglePubSubDestinationEncoding: description: Encoding format for log events. enum: - - json - - raw_message + - json + - raw_message example: json type: string x-enum-varnames: - - JSON - - RAW_MESSAGE + - JSON + - RAW_MESSAGE ObservabilityPipelineGooglePubSubDestinationType: default: google_pubsub description: The destination type. The value should always be `google_pubsub`. enum: - - google_pubsub + - google_pubsub example: google_pubsub type: string x-enum-varnames: - - GOOGLE_PUBSUB + - GOOGLE_PUBSUB ObservabilityPipelineGooglePubSubSource: - description: 'The `google_pubsub` source ingests logs from a Google Cloud Pub/Sub - subscription. - + description: |- + The `google_pubsub` source ingests logs from a Google Cloud Pub/Sub subscription. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: auth: - $ref: '#/components/schemas/ObservabilityPipelineGcpAuth' + $ref: "#/components/schemas/ObservabilityPipelineGcpAuth" decoding: - $ref: '#/components/schemas/ObservabilityPipelineDecoding' + $ref: "#/components/schemas/ObservabilityPipelineDecoding" id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). example: google-pubsub-source type: string project: @@ -44085,164 +42059,140 @@ components: example: logs-subscription type: string tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubSourceType' + $ref: "#/components/schemas/ObservabilityPipelineGooglePubSubSourceType" required: - - id - - type - - decoding - - project - - subscription + - id + - type + - decoding + - project + - subscription type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineGooglePubSubSourceType: default: google_pubsub description: The source type. The value should always be `google_pubsub`. - enum: - - google_pubsub + enum: [google_pubsub] example: google_pubsub type: string - x-enum-varnames: - - GOOGLE_PUBSUB + x-enum-varnames: [GOOGLE_PUBSUB] ObservabilityPipelineHttpClientDestination: - description: 'The `http_client` destination sends data to an HTTP endpoint. + description: |- + The `http_client` destination sends data to an HTTP endpoint. - - **Supported pipeline types:** logs, metrics' + **Supported pipeline types:** logs, metrics properties: auth_strategy: - $ref: '#/components/schemas/ObservabilityPipelineHttpClientDestinationAuthStrategy' + $ref: "#/components/schemas/ObservabilityPipelineHttpClientDestinationAuthStrategy" compression: - $ref: '#/components/schemas/ObservabilityPipelineHttpClientDestinationCompression' + $ref: "#/components/schemas/ObservabilityPipelineHttpClientDestinationCompression" custom_key: - description: Name of the environment variable or secret that holds a custom - header value (used with custom auth strategies). + description: Name of the environment variable or secret that holds a custom header value (used with custom auth strategies). example: HTTP_AUTH_CUSTOM_HEADER type: string encoding: - $ref: '#/components/schemas/ObservabilityPipelineHttpClientDestinationEncoding' + $ref: "#/components/schemas/ObservabilityPipelineHttpClientDestinationEncoding" id: description: The unique identifier for this component. example: http-client-destination type: string inputs: - description: A list of component IDs whose output is used as the input for - this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the input for this component. + example: ["filter-processor"] items: type: string type: array password_key: - description: Name of the environment variable or secret that holds the password - (used when `auth_strategy` is `basic`). + description: Name of the environment variable or secret that holds the password (used when `auth_strategy` is `basic`). example: HTTP_AUTH_PASSWORD type: string tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" token_key: - description: Name of the environment variable or secret that holds the bearer - token (used when `auth_strategy` is `bearer`). + description: Name of the environment variable or secret that holds the bearer token (used when `auth_strategy` is `bearer`). example: HTTP_AUTH_TOKEN type: string type: - $ref: '#/components/schemas/ObservabilityPipelineHttpClientDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineHttpClientDestinationType" uri_key: - description: Name of the environment variable or secret that holds the HTTP - endpoint URI. + description: Name of the environment variable or secret that holds the HTTP endpoint URI. example: HTTP_DESTINATION_URI type: string username_key: - description: Name of the environment variable or secret that holds the username - (used when `auth_strategy` is `basic`). + description: Name of the environment variable or secret that holds the username (used when `auth_strategy` is `basic`). example: HTTP_AUTH_USERNAME type: string required: - - id - - type - - inputs - - encoding + - id + - type + - inputs + - encoding type: object - x-pipeline-types: - - logs - - metrics + x-pipeline-types: [logs, metrics] ObservabilityPipelineHttpClientDestinationAuthStrategy: description: HTTP authentication strategy. - enum: - - none - - basic - - bearer + enum: [none, basic, bearer] example: basic type: string x-enum-varnames: - - NONE - - BASIC - - BEARER + - NONE + - BASIC + - BEARER ObservabilityPipelineHttpClientDestinationCompression: description: Compression configuration for HTTP requests. properties: algorithm: - $ref: '#/components/schemas/ObservabilityPipelineHttpClientDestinationCompressionAlgorithm' + $ref: "#/components/schemas/ObservabilityPipelineHttpClientDestinationCompressionAlgorithm" required: - - algorithm + - algorithm type: object ObservabilityPipelineHttpClientDestinationCompressionAlgorithm: description: Compression algorithm. - enum: - - gzip + enum: [gzip] example: gzip type: string x-enum-varnames: - - GZIP + - GZIP ObservabilityPipelineHttpClientDestinationEncoding: description: Encoding format for log events. - enum: - - json + enum: [json] example: json type: string x-enum-varnames: - - JSON + - JSON ObservabilityPipelineHttpClientDestinationType: default: http_client description: The destination type. The value should always be `http_client`. - enum: - - http_client + enum: [http_client] example: http_client type: string x-enum-varnames: - - HTTP_CLIENT + - HTTP_CLIENT ObservabilityPipelineHttpClientSource: - description: 'The `http_client` source scrapes logs from HTTP endpoints at regular - intervals. + description: |- + The `http_client` source scrapes logs from HTTP endpoints at regular intervals. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: auth_strategy: - $ref: '#/components/schemas/ObservabilityPipelineHttpClientSourceAuthStrategy' + $ref: "#/components/schemas/ObservabilityPipelineHttpClientSourceAuthStrategy" custom_key: - description: Name of the environment variable or secret that holds a custom - header value (used with custom auth strategies). + description: Name of the environment variable or secret that holds a custom header value (used with custom auth strategies). example: HTTP_AUTH_CUSTOM_HEADER type: string decoding: - $ref: '#/components/schemas/ObservabilityPipelineDecoding' + $ref: "#/components/schemas/ObservabilityPipelineDecoding" endpoint_url_key: - description: Name of the environment variable or secret that holds the HTTP - endpoint URL to scrape. + description: Name of the environment variable or secret that holds the HTTP endpoint URL to scrape. example: HTTP_ENDPOINT_URL type: string id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). example: http-client-source type: string password_key: - description: Name of the environment variable or secret that holds the password - (used when `auth_strategy` is `basic`). + description: Name of the environment variable or secret that holds the password (used when `auth_strategy` is `basic`). example: HTTP_AUTH_PASSWORD type: string scrape_interval_secs: @@ -44256,130 +42206,113 @@ components: format: int64 type: integer tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" token_key: - description: Name of the environment variable or secret that holds the bearer - token (used when `auth_strategy` is `bearer`). + description: Name of the environment variable or secret that holds the bearer token (used when `auth_strategy` is `bearer`). example: HTTP_AUTH_TOKEN type: string type: - $ref: '#/components/schemas/ObservabilityPipelineHttpClientSourceType' + $ref: "#/components/schemas/ObservabilityPipelineHttpClientSourceType" username_key: - description: Name of the environment variable or secret that holds the username - (used when `auth_strategy` is `basic`). + description: Name of the environment variable or secret that holds the username (used when `auth_strategy` is `basic`). example: HTTP_AUTH_USERNAME type: string required: - - id - - type - - decoding + - id + - type + - decoding type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineHttpClientSourceAuthStrategy: description: Optional authentication strategy for HTTP requests. - enum: - - none - - basic - - bearer - - custom + enum: [none, basic, bearer, custom] example: basic type: string x-enum-varnames: - - NONE - - BASIC - - BEARER - - CUSTOM + - NONE + - BASIC + - BEARER + - CUSTOM ObservabilityPipelineHttpClientSourceType: default: http_client description: The source type. The value should always be `http_client`. - enum: - - http_client + enum: [http_client] example: http_client type: string - x-enum-varnames: - - HTTP_CLIENT + x-enum-varnames: [HTTP_CLIENT] ObservabilityPipelineHttpServerSource: - description: 'The `http_server` source collects logs over HTTP POST from external - services. + description: |- + The `http_server` source collects logs over HTTP POST from external services. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: address_key: - description: Name of the environment variable or secret that holds the listen - address for the HTTP server. + description: Name of the environment variable or secret that holds the listen address for the HTTP server. example: HTTP_SERVER_ADDRESS type: string auth_strategy: - $ref: '#/components/schemas/ObservabilityPipelineHttpServerSourceAuthStrategy' + $ref: "#/components/schemas/ObservabilityPipelineHttpServerSourceAuthStrategy" custom_key: - description: Name of the environment variable or secret that holds a custom - header value (used with custom auth strategies). + description: Name of the environment variable or secret that holds a custom header value (used with custom auth strategies). example: HTTP_AUTH_CUSTOM_HEADER type: string decoding: - $ref: '#/components/schemas/ObservabilityPipelineDecoding' + $ref: "#/components/schemas/ObservabilityPipelineDecoding" id: description: Unique ID for the HTTP server source. - example: http-server-source + example: "http-server-source" type: string password_key: - description: Name of the environment variable or secret that holds the password - (used when `auth_strategy` is `plain`). + description: Name of the environment variable or secret that holds the password (used when `auth_strategy` is `plain`). example: HTTP_AUTH_PASSWORD type: string tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineHttpServerSourceType' + $ref: "#/components/schemas/ObservabilityPipelineHttpServerSourceType" username_key: - description: Name of the environment variable or secret that holds the username - (used when `auth_strategy` is `plain`). + description: Name of the environment variable or secret that holds the username (used when `auth_strategy` is `plain`). example: HTTP_AUTH_USERNAME type: string required: - - id - - type - - auth_strategy - - decoding + - id + - type + - auth_strategy + - decoding type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineHttpServerSourceAuthStrategy: description: HTTP authentication method. enum: - - none - - plain + - none + - plain example: plain type: string x-enum-varnames: - - NONE - - PLAIN + - NONE + - PLAIN ObservabilityPipelineHttpServerSourceType: default: http_server description: The source type. The value should always be `http_server`. - enum: - - http_server + enum: [http_server] example: http_server type: string x-enum-varnames: - - HTTP_SERVER + - HTTP_SERVER ObservabilityPipelineKafkaDestination: - description: 'The `kafka` destination sends logs to Apache Kafka topics. + description: |- + The `kafka` destination sends logs to Apache Kafka topics. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: bootstrap_servers_key: - description: Name of the environment variable or secret that holds the Kafka - bootstrap servers list. + description: Name of the environment variable or secret that holds the Kafka bootstrap servers list. example: KAFKA_BOOTSTRAP_SERVERS type: string compression: - $ref: '#/components/schemas/ObservabilityPipelineKafkaDestinationCompression' + $ref: "#/components/schemas/ObservabilityPipelineKafkaDestinationCompression" encoding: - $ref: '#/components/schemas/ObservabilityPipelineKafkaDestinationEncoding' + $ref: "#/components/schemas/ObservabilityPipelineKafkaDestinationEncoding" headers_key: description: The field name to use for Kafka message headers. example: headers @@ -44389,10 +42322,8 @@ components: example: kafka-destination type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array @@ -44401,10 +42332,9 @@ components: example: message_id type: string librdkafka_options: - description: Optional list of advanced Kafka producer configuration options, - defined as key-value pairs. + description: Optional list of advanced Kafka producer configuration options, defined as key-value pairs. items: - $ref: '#/components/schemas/ObservabilityPipelineKafkaLibrdkafkaOption' + $ref: "#/components/schemas/ObservabilityPipelineKafkaLibrdkafkaOption" type: array message_timeout_ms: description: Maximum time in milliseconds to wait for message delivery confirmation. @@ -44425,7 +42355,7 @@ components: minimum: 1 type: integer sasl: - $ref: '#/components/schemas/ObservabilityPipelineKafkaSasl' + $ref: "#/components/schemas/ObservabilityPipelineKafkaSasl" socket_timeout_ms: description: Socket timeout in milliseconds for network requests. example: 60000 @@ -44434,197 +42364,179 @@ components: minimum: 10 type: integer tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" topic: description: The Kafka topic name to publish logs to. example: logs-topic type: string type: - $ref: '#/components/schemas/ObservabilityPipelineKafkaDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineKafkaDestinationType" required: - - id - - type - - inputs - - topic - - encoding + - id + - type + - inputs + - topic + - encoding type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineKafkaDestinationCompression: description: Compression codec for Kafka messages. enum: - - none - - gzip - - snappy - - lz4 - - zstd + - none + - gzip + - snappy + - lz4 + - zstd example: gzip type: string x-enum-varnames: - - NONE - - GZIP - - SNAPPY - - LZ4 - - ZSTD + - NONE + - GZIP + - SNAPPY + - LZ4 + - ZSTD ObservabilityPipelineKafkaDestinationEncoding: description: Encoding format for log events. enum: - - json - - raw_message + - json + - raw_message example: json type: string x-enum-varnames: - - JSON - - RAW_MESSAGE + - JSON + - RAW_MESSAGE ObservabilityPipelineKafkaDestinationType: default: kafka description: The destination type. The value should always be `kafka`. enum: - - kafka + - kafka example: kafka type: string x-enum-varnames: - - KAFKA + - KAFKA ObservabilityPipelineKafkaLibrdkafkaOption: - description: Represents a key-value pair used to configure low-level `librdkafka` - client options for Kafka source and destination, such as timeouts, buffer - sizes, and security settings. + description: Represents a key-value pair used to configure low-level `librdkafka` client options for Kafka source and destination, such as timeouts, buffer sizes, and security settings. properties: name: description: The name of the `librdkafka` configuration option to set. - example: fetch.message.max.bytes + example: "fetch.message.max.bytes" type: string value: - description: The value assigned to the specified `librdkafka` configuration - option. - example: '1048576' + description: The value assigned to the specified `librdkafka` configuration option. + example: "1048576" type: string required: - - name - - value + - name + - value type: object ObservabilityPipelineKafkaSasl: description: Specifies the SASL mechanism for authenticating with a Kafka cluster. properties: mechanism: - $ref: '#/components/schemas/ObservabilityPipelineKafkaSaslMechanism' + $ref: "#/components/schemas/ObservabilityPipelineKafkaSaslMechanism" password_key: - description: Name of the environment variable or secret that holds the SASL - password. + description: Name of the environment variable or secret that holds the SASL password. example: KAFKA_SASL_PASSWORD type: string username_key: - description: Name of the environment variable or secret that holds the SASL - username. + description: Name of the environment variable or secret that holds the SASL username. example: KAFKA_SASL_USERNAME type: string type: object ObservabilityPipelineKafkaSaslMechanism: description: SASL mechanism used for Kafka authentication. enum: - - PLAIN - - SCRAM-SHA-256 - - SCRAM-SHA-512 + - PLAIN + - SCRAM-SHA-256 + - SCRAM-SHA-512 type: string x-enum-varnames: - - PLAIN - - SCRAMNOT_SHANOT_256 - - SCRAMNOT_SHANOT_512 + - PLAIN + - SCRAMNOT_SHANOT_256 + - SCRAMNOT_SHANOT_512 ObservabilityPipelineKafkaSource: - description: 'The `kafka` source ingests data from Apache Kafka topics. + description: |- + The `kafka` source ingests data from Apache Kafka topics. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: bootstrap_servers_key: - description: Name of the environment variable or secret that holds the Kafka - bootstrap servers list. + description: Name of the environment variable or secret that holds the Kafka bootstrap servers list. example: KAFKA_BOOTSTRAP_SERVERS type: string group_id: description: Consumer group ID used by the Kafka client. - example: consumer-group-0 + example: "consumer-group-0" type: string id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). - example: kafka-source + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). + example: "kafka-source" type: string librdkafka_options: - description: Optional list of advanced Kafka client configuration options, - defined as key-value pairs. + description: Optional list of advanced Kafka client configuration options, defined as key-value pairs. items: - $ref: '#/components/schemas/ObservabilityPipelineKafkaLibrdkafkaOption' + $ref: "#/components/schemas/ObservabilityPipelineKafkaLibrdkafkaOption" type: array sasl: - $ref: '#/components/schemas/ObservabilityPipelineKafkaSasl' + $ref: "#/components/schemas/ObservabilityPipelineKafkaSasl" tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" topics: - description: A list of Kafka topic names to subscribe to. The source ingests - messages from each topic specified. - example: - - topic1 - - topic2 + description: A list of Kafka topic names to subscribe to. The source ingests messages from each topic specified. + example: ["topic1", "topic2"] items: type: string type: array type: - $ref: '#/components/schemas/ObservabilityPipelineKafkaSourceType' + $ref: "#/components/schemas/ObservabilityPipelineKafkaSourceType" required: - - id - - type - - group_id - - topics + - id + - type + - group_id + - topics type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineKafkaSourceType: default: kafka description: The source type. The value should always be `kafka`. enum: - - kafka + - kafka example: kafka type: string x-enum-varnames: - - KAFKA + - KAFKA ObservabilityPipelineLogstashSource: - description: 'The `logstash` source ingests logs from a Logstash forwarder. + description: |- + The `logstash` source ingests logs from a Logstash forwarder. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: address_key: - description: Name of the environment variable or secret that holds the listen - address for the Logstash receiver. + description: Name of the environment variable or secret that holds the listen address for the Logstash receiver. example: LOGSTASH_ADDRESS type: string id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). example: logstash-source type: string tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineLogstashSourceType' + $ref: "#/components/schemas/ObservabilityPipelineLogstashSourceType" required: - - id - - type + - id + - type type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineLogstashSourceType: default: logstash description: The source type. The value should always be `logstash`. enum: - - logstash + - logstash example: logstash type: string x-enum-varnames: - - LOGSTASH + - LOGSTASH ObservabilityPipelineMemoryBufferOptions: description: Options for configuring a memory buffer by byte size. properties: @@ -44634,11 +42546,11 @@ components: format: int64 type: integer type: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsMemoryType' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptionsMemoryType" when_full: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsWhenFull' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptionsWhenFull" required: - - max_size + - max_size type: object ObservabilityPipelineMemoryBufferSizeOptions: description: Options for configuring a memory buffer by queue length. @@ -44649,11 +42561,11 @@ components: format: int64 type: integer type: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsMemoryType' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptionsMemoryType" when_full: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsWhenFull' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptionsWhenFull" required: - - max_events + - max_events type: object ObservabilityPipelineMetadataEntry: description: A custom metadata entry. @@ -44667,293 +42579,264 @@ components: example: production type: string required: - - name - - value + - name + - value type: object ObservabilityPipelineMetricTagsProcessor: - description: 'The `metric_tags` processor filters metrics based on their tags - using Datadog tag key patterns. - + description: |- + The `metric_tags` processor filters metrics based on their tags using Datadog tag key patterns. - **Supported pipeline types:** metrics' + **Supported pipeline types:** metrics properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). example: metric-tags-processor type: string include: - description: A Datadog search query that determines which metrics the processor - targets. - example: '*' + description: A Datadog search query that determines which metrics the processor targets. + example: "*" type: string rules: description: A list of rules for filtering metric tags. items: - $ref: '#/components/schemas/ObservabilityPipelineMetricTagsProcessorRule' + $ref: "#/components/schemas/ObservabilityPipelineMetricTagsProcessorRule" maxItems: 100 minItems: 1 type: array type: - $ref: '#/components/schemas/ObservabilityPipelineMetricTagsProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineMetricTagsProcessorType" required: - - id - - type - - include - - rules - - enabled + - id + - type + - include + - rules + - enabled type: object - x-pipeline-types: - - metrics + x-pipeline-types: [metrics] ObservabilityPipelineMetricTagsProcessorRule: description: Defines a rule for filtering metric tags based on key patterns. properties: action: - $ref: '#/components/schemas/ObservabilityPipelineMetricTagsProcessorRuleAction' + $ref: "#/components/schemas/ObservabilityPipelineMetricTagsProcessorRuleAction" include: - description: A Datadog search query used to determine which metrics this - rule targets. - example: '*' + description: A Datadog search query used to determine which metrics this rule targets. + example: "*" type: string keys: description: A list of tag keys to include or exclude. - example: - - env - - service - - version + example: ["env", "service", "version"] items: type: string type: array mode: - $ref: '#/components/schemas/ObservabilityPipelineMetricTagsProcessorRuleMode' + $ref: "#/components/schemas/ObservabilityPipelineMetricTagsProcessorRuleMode" required: - - include - - mode - - action - - keys + - include + - mode + - action + - keys type: object ObservabilityPipelineMetricTagsProcessorRuleAction: description: The action to take on tags with matching keys. - enum: - - include - - exclude + enum: [include, exclude] example: include type: string x-enum-varnames: - - INCLUDE - - EXCLUDE + - INCLUDE + - EXCLUDE ObservabilityPipelineMetricTagsProcessorRuleMode: description: The processing mode for tag filtering. - enum: - - filter + enum: [filter] example: filter type: string x-enum-varnames: - - FILTER + - FILTER ObservabilityPipelineMetricTagsProcessorType: default: metric_tags description: The processor type. The value should always be `metric_tags`. - enum: - - metric_tags + enum: [metric_tags] example: metric_tags type: string x-enum-varnames: - - METRIC_TAGS + - METRIC_TAGS ObservabilityPipelineMetricValue: description: Specifies how the value of the generated metric is computed. oneOf: - - $ref: '#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByOne' - - $ref: '#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByField' + - $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByOne" + - $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByField" ObservabilityPipelineNewRelicDestination: - description: 'The `new_relic` destination sends logs to the New Relic platform. + description: |- + The `new_relic` destination sends logs to the New Relic platform. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: account_id_key: - description: Name of the environment variable or secret that holds the New - Relic account ID. + description: Name of the environment variable or secret that holds the New Relic account ID. example: NEW_RELIC_ACCOUNT_ID type: string buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" id: description: The unique identifier for this component. example: new-relic-destination type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - parse-json-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["parse-json-processor"] items: type: string type: array license_key_key: - description: Name of the environment variable or secret that holds the New - Relic license key. + description: Name of the environment variable or secret that holds the New Relic license key. example: NEW_RELIC_LICENSE_KEY type: string region: - $ref: '#/components/schemas/ObservabilityPipelineNewRelicDestinationRegion' + $ref: "#/components/schemas/ObservabilityPipelineNewRelicDestinationRegion" type: - $ref: '#/components/schemas/ObservabilityPipelineNewRelicDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineNewRelicDestinationType" required: - - id - - type - - inputs - - region + - id + - type + - inputs + - region type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineNewRelicDestinationRegion: description: The New Relic region. enum: - - us - - eu + - us + - eu example: us type: string x-enum-varnames: - - US - - EU + - US + - EU ObservabilityPipelineNewRelicDestinationType: default: new_relic description: The destination type. The value should always be `new_relic`. enum: - - new_relic + - new_relic example: new_relic type: string x-enum-varnames: - - NEW_RELIC + - NEW_RELIC ObservabilityPipelineOcsfMapperProcessor: - description: 'The `ocsf_mapper` processor transforms logs into the OCSF schema - using a predefined mapping configuration. + description: |- + The `ocsf_mapper` processor transforms logs into the OCSF schema using a predefined mapping configuration. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean id: - description: The unique identifier for this component. Used to reference - this component in other parts of the pipeline. + description: The unique identifier for this component. Used to reference this component in other parts of the pipeline. example: ocsf-mapper-processor type: string include: - description: A Datadog search query used to determine which logs this processor - targets. + description: A Datadog search query used to determine which logs this processor targets. example: service:my-service type: string mappings: description: A list of mapping rules to convert events to the OCSF format. items: - $ref: '#/components/schemas/ObservabilityPipelineOcsfMapperProcessorMapping' + $ref: "#/components/schemas/ObservabilityPipelineOcsfMapperProcessorMapping" type: array type: - $ref: '#/components/schemas/ObservabilityPipelineOcsfMapperProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineOcsfMapperProcessorType" required: - - id - - type - - include - - mappings - - enabled + - id + - type + - include + - mappings + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineOcsfMapperProcessorMapping: - description: Defines how specific events are transformed to OCSF using a mapping - configuration. + description: Defines how specific events are transformed to OCSF using a mapping configuration. properties: include: - description: A Datadog search query used to select the logs that this mapping - should apply to. + description: A Datadog search query used to select the logs that this mapping should apply to. example: service:my-service type: string mapping: - $ref: '#/components/schemas/ObservabilityPipelineOcsfMapperProcessorMappingMapping' + $ref: "#/components/schemas/ObservabilityPipelineOcsfMapperProcessorMappingMapping" required: - - include - - mapping + - include + - mapping type: object ObservabilityPipelineOcsfMapperProcessorMappingMapping: - description: Defines a single mapping rule for transforming logs into the OCSF - schema. + description: Defines a single mapping rule for transforming logs into the OCSF schema. example: CloudTrail Account Change oneOf: - - $ref: '#/components/schemas/ObservabilityPipelineOcsfMappingLibrary' - - $ref: '#/components/schemas/ObservabilityPipelineOcsfMappingCustom' + - $ref: "#/components/schemas/ObservabilityPipelineOcsfMappingLibrary" + - $ref: "#/components/schemas/ObservabilityPipelineOcsfMappingCustom" ObservabilityPipelineOcsfMapperProcessorType: default: ocsf_mapper description: The processor type. The value should always be `ocsf_mapper`. enum: - - ocsf_mapper + - ocsf_mapper example: ocsf_mapper type: string x-enum-varnames: - - OCSF_MAPPER + - OCSF_MAPPER ObservabilityPipelineOcsfMappingCustom: description: Custom OCSF mapping configuration for transforming logs. properties: mapping: - description: A list of field mapping rules for transforming log fields to - OCSF schema fields. + description: A list of field mapping rules for transforming log fields to OCSF schema fields. items: - $ref: '#/components/schemas/ObservabilityPipelineOcsfMappingCustomFieldMapping' + $ref: "#/components/schemas/ObservabilityPipelineOcsfMappingCustomFieldMapping" type: array metadata: - $ref: '#/components/schemas/ObservabilityPipelineOcsfMappingCustomMetadata' + $ref: "#/components/schemas/ObservabilityPipelineOcsfMappingCustomMetadata" version: description: The version of the custom mapping configuration. example: 1 format: int64 type: integer required: - - mapping - - metadata - - version + - mapping + - metadata + - version type: object ObservabilityPipelineOcsfMappingCustomFieldMapping: - description: Defines a single field mapping rule for transforming a source field - to an OCSF destination field. + description: Defines a single field mapping rule for transforming a source field to an OCSF destination field. properties: default: - description: The default value to use if the source field is missing or - empty. - example: '' + description: The default value to use if the source field is missing or empty. + example: "" dest: description: The destination OCSF field path. example: device.type type: string lookup: - $ref: '#/components/schemas/ObservabilityPipelineOcsfMappingCustomLookup' + $ref: "#/components/schemas/ObservabilityPipelineOcsfMappingCustomLookup" source: description: The source field path from the log event. example: host.type sources: description: Multiple source field paths for combined mapping. example: - - field1 - - field2 + - field1 + - field2 value: description: A static value to use for the destination field. example: static_value required: - - dest + - dest type: object ObservabilityPipelineOcsfMappingCustomLookup: - description: Lookup table configuration for mapping source values to destination - values. + description: Lookup table configuration for mapping source values to destination values. properties: default: description: The default value to use if no lookup match is found. @@ -44961,7 +42844,7 @@ components: table: description: A list of lookup table entries for value transformation. items: - $ref: '#/components/schemas/ObservabilityPipelineOcsfMappingCustomLookupTableEntry' + $ref: "#/components/schemas/ObservabilityPipelineOcsfMappingCustomLookupTableEntry" type: array type: object ObservabilityPipelineOcsfMappingCustomLookupTableEntry: @@ -44980,11 +42863,11 @@ components: type: string matches: description: A regex pattern to match in the source value. - example: ^Desktop.* + example: "^Desktop.*" type: string not_matches: description: A regex pattern that must not match the source value. - example: ^Mobile.* + example: "^Mobile.*" type: string value: description: The value to use when a match is found. @@ -45000,338 +42883,301 @@ components: profiles: description: A list of OCSF profiles to apply. example: - - container + - container items: type: string type: array version: description: The OCSF schema version. - example: 1.3.0 + example: "1.3.0" type: string required: - - class - - version + - class + - version type: object ObservabilityPipelineOcsfMappingLibrary: description: Predefined library mappings for common log formats. enum: - - CloudTrail Account Change - - GCP Cloud Audit CreateBucket - - GCP Cloud Audit CreateSink - - GCP Cloud Audit SetIamPolicy - - GCP Cloud Audit UpdateSink - - Github Audit Log API Activity - - Google Workspace Admin Audit addPrivilege - - Microsoft 365 Defender Incident - - Microsoft 365 Defender UserLoggedIn - - Okta System Log Authentication - - Palo Alto Networks Firewall Traffic + - CloudTrail Account Change + - GCP Cloud Audit CreateBucket + - GCP Cloud Audit CreateSink + - GCP Cloud Audit SetIamPolicy + - GCP Cloud Audit UpdateSink + - Github Audit Log API Activity + - Google Workspace Admin Audit addPrivilege + - Microsoft 365 Defender Incident + - Microsoft 365 Defender UserLoggedIn + - Okta System Log Authentication + - Palo Alto Networks Firewall Traffic example: CloudTrail Account Change type: string x-enum-varnames: - - CLOUDTRAIL_ACCOUNT_CHANGE - - GCP_CLOUD_AUDIT_CREATEBUCKET - - GCP_CLOUD_AUDIT_CREATESINK - - GCP_CLOUD_AUDIT_SETIAMPOLICY - - GCP_CLOUD_AUDIT_UPDATESINK - - GITHUB_AUDIT_LOG_API_ACTIVITY - - GOOGLE_WORKSPACE_ADMIN_AUDIT_ADDPRIVILEGE - - MICROSOFT_365_DEFENDER_INCIDENT - - MICROSOFT_365_DEFENDER_USERLOGGEDIN - - OKTA_SYSTEM_LOG_AUTHENTICATION - - PALO_ALTO_NETWORKS_FIREWALL_TRAFFIC + - CLOUDTRAIL_ACCOUNT_CHANGE + - GCP_CLOUD_AUDIT_CREATEBUCKET + - GCP_CLOUD_AUDIT_CREATESINK + - GCP_CLOUD_AUDIT_SETIAMPOLICY + - GCP_CLOUD_AUDIT_UPDATESINK + - GITHUB_AUDIT_LOG_API_ACTIVITY + - GOOGLE_WORKSPACE_ADMIN_AUDIT_ADDPRIVILEGE + - MICROSOFT_365_DEFENDER_INCIDENT + - MICROSOFT_365_DEFENDER_USERLOGGEDIN + - OKTA_SYSTEM_LOG_AUTHENTICATION + - PALO_ALTO_NETWORKS_FIREWALL_TRAFFIC ObservabilityPipelineOpenSearchDestination: - description: 'The `opensearch` destination writes logs to an OpenSearch cluster. - + description: |- + The `opensearch` destination writes logs to an OpenSearch cluster. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: auth: - $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationAuth' + $ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationAuth" buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" bulk_index: description: The index to write logs to. example: logs-index type: string data_stream: - $ref: '#/components/schemas/ObservabilityPipelineOpenSearchDestinationDataStream' + $ref: "#/components/schemas/ObservabilityPipelineOpenSearchDestinationDataStream" endpoint_url_key: - description: Name of the environment variable or secret that holds the OpenSearch - endpoint URL. + description: Name of the environment variable or secret that holds the OpenSearch endpoint URL. example: OPENSEARCH_ENDPOINT_URL type: string id: description: The unique identifier for this component. - example: opensearch-destination + example: "opensearch-destination" type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array type: - $ref: '#/components/schemas/ObservabilityPipelineOpenSearchDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineOpenSearchDestinationType" required: - - id - - type - - inputs + - id + - type + - inputs type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineOpenSearchDestinationDataStream: - description: Configuration options for writing to OpenSearch Data Streams instead - of a fixed index. + description: Configuration options for writing to OpenSearch Data Streams instead of a fixed index. properties: dataset: - description: The data stream dataset for your logs. This groups logs by - their source or application. + description: The data stream dataset for your logs. This groups logs by their source or application. type: string dtype: - description: The data stream type for your logs. This determines how logs - are categorized within the data stream. + description: The data stream type for your logs. This determines how logs are categorized within the data stream. type: string namespace: - description: The data stream namespace for your logs. This separates logs - into different environments or domains. + description: The data stream namespace for your logs. This separates logs into different environments or domains. type: string type: object ObservabilityPipelineOpenSearchDestinationType: default: opensearch description: The destination type. The value should always be `opensearch`. enum: - - opensearch + - opensearch example: opensearch type: string x-enum-varnames: - - OPENSEARCH + - OPENSEARCH ObservabilityPipelineOpentelemetrySource: - description: 'The `opentelemetry` source receives telemetry data using the OpenTelemetry - Protocol (OTLP) over gRPC and HTTP. - + description: |- + The `opentelemetry` source receives telemetry data using the OpenTelemetry Protocol (OTLP) over gRPC and HTTP. - **Supported pipeline types:** logs, metrics' + **Supported pipeline types:** logs, metrics properties: grpc_address_key: - description: Environment variable name containing the gRPC server address - for receiving OTLP data. Must be a valid environment variable name (alphanumeric - characters and underscores only). + description: Environment variable name containing the gRPC server address for receiving OTLP data. Must be a valid environment variable name (alphanumeric characters and underscores only). example: OTEL_GRPC_ADDRESS type: string http_address_key: - description: Environment variable name containing the HTTP server address - for receiving OTLP data. Must be a valid environment variable name (alphanumeric - characters and underscores only). + description: Environment variable name containing the HTTP server address for receiving OTLP data. Must be a valid environment variable name (alphanumeric characters and underscores only). example: OTEL_HTTP_ADDRESS type: string id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). example: opentelemetry-source type: string tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineOpentelemetrySourceType' + $ref: "#/components/schemas/ObservabilityPipelineOpentelemetrySourceType" required: - - id - - type + - id + - type type: object - x-pipeline-types: - - logs - - metrics + x-pipeline-types: [logs, metrics] ObservabilityPipelineOpentelemetrySourceType: default: opentelemetry description: The source type. The value should always be `opentelemetry`. - enum: - - opentelemetry + enum: [opentelemetry] example: opentelemetry type: string x-enum-varnames: - - OPENTELEMETRY + - OPENTELEMETRY ObservabilityPipelineParseGrokProcessor: - description: 'The `parse_grok` processor extracts structured fields from unstructured - log messages using Grok patterns. - + description: |- + The `parse_grok` processor extracts structured fields from unstructured log messages using Grok patterns. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: disable_library_rules: default: false - description: If set to `true`, disables the default Grok rules provided - by Datadog. + description: If set to `true`, disables the default Grok rules provided by Datadog. example: true type: boolean display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean id: description: A unique identifier for this processor. - example: parse-grok-processor + example: "parse-grok-processor" type: string include: - description: A Datadog search query used to determine which logs this processor - targets. - example: service:my-service + description: A Datadog search query used to determine which logs this processor targets. + example: "service:my-service" type: string rules: - description: The list of Grok parsing rules. If multiple matching rules - are provided, they are evaluated in order. The first successful match - is applied. + description: The list of Grok parsing rules. If multiple matching rules are provided, they are evaluated in order. The first successful match is applied. items: - $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessorRule' + $ref: "#/components/schemas/ObservabilityPipelineParseGrokProcessorRule" type: array type: - $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineParseGrokProcessorType" required: - - id - - type - - include - - rules - - enabled + - id + - type + - include + - rules + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineParseGrokProcessorRule: - description: 'A Grok parsing rule used in the `parse_grok` processor. Each rule - defines how to extract structured fields - - from a specific log field using Grok patterns.' + description: |- + A Grok parsing rule used in the `parse_grok` processor. Each rule defines how to extract structured fields + from a specific log field using Grok patterns. properties: match_rules: - description: 'A list of Grok parsing rules that define how to extract fields - from the source field. - - Each rule must contain a name and a valid Grok pattern.' + description: |- + A list of Grok parsing rules that define how to extract fields from the source field. + Each rule must contain a name and a valid Grok pattern. example: - - name: MyParsingRule - rule: '%{word:user} connected on %{date("MM/dd/yyyy"):date}' + - name: "MyParsingRule" + rule: '%{word:user} connected on %{date("MM/dd/yyyy"):date}' items: - $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessorRuleMatchRule' + $ref: "#/components/schemas/ObservabilityPipelineParseGrokProcessorRuleMatchRule" type: array source: - description: The name of the field in the log event to apply the Grok rules - to. - example: message + description: The name of the field in the log event to apply the Grok rules to. + example: "message" type: string support_rules: - description: A list of Grok helper rules that can be referenced by the parsing - rules. + description: |- + A list of Grok helper rules that can be referenced by the parsing rules. example: - - name: user - rule: '%{word:user.name}' + - name: "user" + rule: "%{word:user.name}" items: - $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessorRuleSupportRule' + $ref: "#/components/schemas/ObservabilityPipelineParseGrokProcessorRuleSupportRule" type: array required: - - source - - match_rules + - source + - match_rules type: object ObservabilityPipelineParseGrokProcessorRuleMatchRule: - description: 'Defines a Grok parsing rule, which extracts structured fields - from log content using named Grok patterns. - - Each rule must have a unique name and a valid Datadog Grok pattern that will - be applied to the source field.' + description: |- + Defines a Grok parsing rule, which extracts structured fields from log content using named Grok patterns. + Each rule must have a unique name and a valid Datadog Grok pattern that will be applied to the source field. properties: name: description: The name of the rule. - example: MyParsingRule + example: "MyParsingRule" type: string rule: description: The definition of the Grok rule. example: '%{word:user} connected on %{date("MM/dd/yyyy"):date}' type: string required: - - name - - rule + - name + - rule type: object ObservabilityPipelineParseGrokProcessorRuleSupportRule: description: The Grok helper rule referenced in the parsing rules. properties: name: description: The name of the Grok helper rule. - example: user + example: "user" type: string rule: description: The definition of the Grok helper rule. - example: ' %{word:user.name}' + example: " %{word:user.name}" type: string required: - - name - - rule + - name + - rule type: object ObservabilityPipelineParseGrokProcessorType: default: parse_grok description: The processor type. The value should always be `parse_grok`. - enum: - - parse_grok + enum: [parse_grok] example: parse_grok type: string x-enum-varnames: - - PARSE_GROK + - PARSE_GROK ObservabilityPipelineParseJSONProcessor: - description: 'The `parse_json` processor extracts JSON from a specified field - and flattens it into the event. This is useful when logs contain embedded - JSON as a string. - + description: |- + The `parse_json` processor extracts JSON from a specified field and flattens it into the event. This is useful when logs contain embedded JSON as a string. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean field: description: The name of the log field that contains a JSON string. - example: message + example: "message" type: string id: - description: A unique identifier for this component. Used to reference this - component in other parts of the pipeline (e.g., as input to downstream - components). - example: parse-json-processor + description: A unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components). + example: "parse-json-processor" type: string include: - description: A Datadog search query used to determine which logs this processor - targets. - example: service:my-service + description: A Datadog search query used to determine which logs this processor targets. + example: "service:my-service" type: string type: - $ref: '#/components/schemas/ObservabilityPipelineParseJSONProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineParseJSONProcessorType" required: - - id - - type - - include - - field - - enabled + - id + - type + - include + - field + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineParseJSONProcessorType: default: parse_json description: The processor type. The value should always be `parse_json`. enum: - - parse_json + - parse_json example: parse_json type: string x-enum-varnames: - - PARSE_JSON + - PARSE_JSON ObservabilityPipelineParseXMLProcessor: - description: 'The `parse_xml` processor parses XML from a specified field and - extracts it into the event. - + description: |- + The `parse_xml` processor parses XML from a specified field and extracts it into the event. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: always_use_text_key: description: Whether to always use a text key for element content. @@ -45340,25 +43186,22 @@ components: description: The prefix to use for XML attributes in the parsed output. type: string display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean field: description: The name of the log field that contains an XML string. - example: message + example: "message" type: string id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). example: parse-xml-processor type: string include: - description: A Datadog search query used to determine which logs this processor - targets. - example: service:my-service + description: A Datadog search query used to determine which logs this processor targets. + example: "service:my-service" type: string include_attr: description: Whether to include XML attributes in the parsed output. @@ -45373,45 +43216,39 @@ components: description: Whether to parse numeric values from strings. type: boolean text_key: - description: The key name to use for text content within XML elements. Must - be at least 1 character if specified. + description: The key name to use for text content within XML elements. Must be at least 1 character if specified. minLength: 1 type: string type: - $ref: '#/components/schemas/ObservabilityPipelineParseXMLProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineParseXMLProcessorType" required: - - id - - type - - include - - field - - enabled + - id + - type + - include + - field + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineParseXMLProcessorType: default: parse_xml description: The processor type. The value should always be `parse_xml`. enum: - - parse_xml + - parse_xml example: parse_xml type: string x-enum-varnames: - - PARSE_XML + - PARSE_XML ObservabilityPipelineQuotaProcessor: - description: 'The `quota` processor measures logging traffic for logs that match - a specified filter. When the configured daily quota is met, the processor - can drop or alert. - + description: |- + The `quota` processor measures logging traffic for logs that match a specified filter. When the configured daily quota is met, the processor can drop or alert. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" drop_events: - description: 'If set to `true`, logs that match the quota filter and are - sent after the quota is exceeded are dropped. Logs that do not match the - filter continue through the pipeline. **Note**: You can set either `drop_events` - or `overflow_action`, but not both.' + description: |- + If set to `true`, logs that match the quota filter and are sent after the quota is exceeded are dropped. Logs that do not match the filter continue through the pipeline. **Note**: You can set either `drop_events` or `overflow_action`, but not both. example: false type: boolean enabled: @@ -45419,145 +43256,125 @@ components: example: true type: boolean id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). - example: quota-processor + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). + example: "quota-processor" type: string ignore_when_missing_partitions: - description: If `true`, the processor skips quota checks when partition - fields are missing from the logs. + description: If `true`, the processor skips quota checks when partition fields are missing from the logs. type: boolean include: - description: A Datadog search query used to determine which logs this processor - targets. - example: service:my-service + description: A Datadog search query used to determine which logs this processor targets. + example: "service:my-service" type: string limit: - $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorLimit' + $ref: "#/components/schemas/ObservabilityPipelineQuotaProcessorLimit" name: description: Name of the quota. example: MyQuota type: string overflow_action: - $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorOverflowAction' + $ref: "#/components/schemas/ObservabilityPipelineQuotaProcessorOverflowAction" overrides: - description: A list of alternate quota rules that apply to specific sets - of events, identified by matching field values. Each override can define - a custom limit. + description: A list of alternate quota rules that apply to specific sets of events, identified by matching field values. Each override can define a custom limit. items: - $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorOverride' + $ref: "#/components/schemas/ObservabilityPipelineQuotaProcessorOverride" type: array partition_fields: - description: A list of fields used to segment log traffic for quota enforcement. - Quotas are tracked independently by unique combinations of these field - values. + description: A list of fields used to segment log traffic for quota enforcement. Quotas are tracked independently by unique combinations of these field values. items: type: string type: array too_many_buckets_action: - $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorOverflowAction' + $ref: "#/components/schemas/ObservabilityPipelineQuotaProcessorOverflowAction" type: - $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineQuotaProcessorType" required: - - id - - type - - include - - name - - limit - - enabled + - id + - type + - include + - name + - limit + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineQuotaProcessorLimit: - description: The maximum amount of data or number of events allowed before the - quota is enforced. Can be specified in bytes or events. + description: The maximum amount of data or number of events allowed before the quota is enforced. Can be specified in bytes or events. properties: enforce: - $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorLimitEnforceType' + $ref: "#/components/schemas/ObservabilityPipelineQuotaProcessorLimitEnforceType" limit: description: The limit for quota enforcement. example: 1000 format: int64 type: integer required: - - enforce - - limit + - enforce + - limit type: object ObservabilityPipelineQuotaProcessorLimitEnforceType: - description: Unit for quota enforcement in bytes for data size or events for - count. + description: Unit for quota enforcement in bytes for data size or events for count. enum: - - bytes - - events + - bytes + - events example: bytes type: string x-enum-varnames: - - BYTES - - EVENTS + - BYTES + - EVENTS ObservabilityPipelineQuotaProcessorOverflowAction: - description: 'The action to take when the quota or bucket limit is exceeded. - Options: - + description: |- + The action to take when the quota or bucket limit is exceeded. Options: - `drop`: Drop the event. - - `no_action`: Let the event pass through. - - - `overflow_routing`: Route to an overflow destination.' + - `overflow_routing`: Route to an overflow destination. enum: - - drop - - no_action - - overflow_routing + - drop + - no_action + - overflow_routing example: drop type: string x-enum-varnames: - - DROP - - NO_ACTION - - OVERFLOW_ROUTING + - DROP + - NO_ACTION + - OVERFLOW_ROUTING ObservabilityPipelineQuotaProcessorOverride: - description: Defines a custom quota limit that applies to specific log events - based on matching field values. + description: Defines a custom quota limit that applies to specific log events based on matching field values. properties: fields: - description: A list of field matchers used to apply a specific override. - If an event matches all listed key-value pairs, the corresponding override - limit is enforced. + description: A list of field matchers used to apply a specific override. If an event matches all listed key-value pairs, the corresponding override limit is enforced. items: - $ref: '#/components/schemas/ObservabilityPipelineFieldValue' + $ref: "#/components/schemas/ObservabilityPipelineFieldValue" type: array limit: - $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorLimit' + $ref: "#/components/schemas/ObservabilityPipelineQuotaProcessorLimit" required: - - fields - - limit + - fields + - limit type: object ObservabilityPipelineQuotaProcessorType: default: quota description: The processor type. The value should always be `quota`. enum: - - quota + - quota example: quota type: string x-enum-varnames: - - QUOTA + - QUOTA ObservabilityPipelineReduceProcessor: - description: 'The `reduce` processor aggregates and merges logs based on matching - keys and merge strategies. + description: |- + The `reduce` processor aggregates and merges logs based on matching keys and merge strategies. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean group_by: description: A list of fields used to group log events for merging. - example: - - log.user.id - - log.device.id + example: ["log.user.id", "log.device.id"] items: type: string type: array @@ -45566,28 +43383,25 @@ components: example: reduce-processor type: string include: - description: A Datadog search query used to determine which logs this processor - targets. + description: A Datadog search query used to determine which logs this processor targets. example: env:prod type: string merge_strategies: - description: List of merge strategies defining how values from grouped events - should be combined. + description: List of merge strategies defining how values from grouped events should be combined. items: - $ref: '#/components/schemas/ObservabilityPipelineReduceProcessorMergeStrategy' + $ref: "#/components/schemas/ObservabilityPipelineReduceProcessorMergeStrategy" type: array type: - $ref: '#/components/schemas/ObservabilityPipelineReduceProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineReduceProcessorType" required: - - id - - type - - include - - group_by - - merge_strategies - - enabled + - id + - type + - include + - group_by + - merge_strategies + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineReduceProcessorMergeStrategy: description: Defines how a specific field should be merged across grouped events. properties: @@ -45596,195 +43410,178 @@ components: example: log.user.roles type: string strategy: - $ref: '#/components/schemas/ObservabilityPipelineReduceProcessorMergeStrategyStrategy' + $ref: "#/components/schemas/ObservabilityPipelineReduceProcessorMergeStrategyStrategy" required: - - path - - strategy + - path + - strategy type: object ObservabilityPipelineReduceProcessorMergeStrategyStrategy: description: The merge strategy to apply. enum: - - discard - - retain - - sum - - max - - min - - array - - concat - - concat_newline - - concat_raw - - shortest_array - - longest_array - - flat_unique + - discard + - retain + - sum + - max + - min + - array + - concat + - concat_newline + - concat_raw + - shortest_array + - longest_array + - flat_unique example: flat_unique type: string x-enum-varnames: - - DISCARD - - RETAIN - - SUM - - MAX - - MIN - - ARRAY - - CONCAT - - CONCAT_NEWLINE - - CONCAT_RAW - - SHORTEST_ARRAY - - LONGEST_ARRAY - - FLAT_UNIQUE + - DISCARD + - RETAIN + - SUM + - MAX + - MIN + - ARRAY + - CONCAT + - CONCAT_NEWLINE + - CONCAT_RAW + - SHORTEST_ARRAY + - LONGEST_ARRAY + - FLAT_UNIQUE ObservabilityPipelineReduceProcessorType: default: reduce description: The processor type. The value should always be `reduce`. enum: - - reduce + - reduce example: reduce type: string x-enum-varnames: - - REDUCE + - REDUCE ObservabilityPipelineRemoveFieldsProcessor: - description: 'The `remove_fields` processor deletes specified fields from logs. + description: |- + The `remove_fields` processor deletes specified fields from logs. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean fields: description: A list of field names to be removed from each log event. - example: - - field1 - - field2 + example: ["field1", "field2"] items: type: string type: array id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). - example: remove-fields-processor + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). + example: "remove-fields-processor" type: string include: - description: A Datadog search query used to determine which logs this processor - targets. - example: service:my-service + description: A Datadog search query used to determine which logs this processor targets. + example: "service:my-service" type: string type: - $ref: '#/components/schemas/ObservabilityPipelineRemoveFieldsProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineRemoveFieldsProcessorType" required: - - id - - type - - include - - fields - - enabled + - id + - type + - include + - fields + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineRemoveFieldsProcessorType: default: remove_fields description: The processor type. The value should always be `remove_fields`. enum: - - remove_fields + - remove_fields example: remove_fields type: string x-enum-varnames: - - REMOVE_FIELDS + - REMOVE_FIELDS ObservabilityPipelineRenameFieldsProcessor: - description: 'The `rename_fields` processor changes field names. - + description: |- + The `rename_fields` processor changes field names. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean fields: - description: A list of rename rules specifying which fields to rename in - the event, what to rename them to, and whether to preserve the original - fields. + description: A list of rename rules specifying which fields to rename in the event, what to rename them to, and whether to preserve the original fields. items: - $ref: '#/components/schemas/ObservabilityPipelineRenameFieldsProcessorField' + $ref: "#/components/schemas/ObservabilityPipelineRenameFieldsProcessorField" type: array id: - description: A unique identifier for this component. Used to reference this - component in other parts of the pipeline (e.g., as input to downstream - components). - example: rename-fields-processor + description: A unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components). + example: "rename-fields-processor" type: string include: - description: A Datadog search query used to determine which logs this processor - targets. - example: service:my-service + description: A Datadog search query used to determine which logs this processor targets. + example: "service:my-service" type: string type: - $ref: '#/components/schemas/ObservabilityPipelineRenameFieldsProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineRenameFieldsProcessorType" required: - - id - - type - - include - - fields - - enabled + - id + - type + - include + - fields + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineRenameFieldsProcessorField: description: Defines how to rename a field in log events. properties: destination: description: The field name to assign the renamed value to. - example: destination_field + example: "destination_field" type: string preserve_source: - description: Indicates whether the original field, that is received from - the source, should be kept (`true`) or removed (`false`) after renaming. + description: Indicates whether the original field, that is received from the source, should be kept (`true`) or removed (`false`) after renaming. example: false type: boolean source: description: The original field name in the log event that should be renamed. - example: source_field + example: "source_field" type: string required: - - source - - destination - - preserve_source + - source + - destination + - preserve_source type: object ObservabilityPipelineRenameFieldsProcessorType: default: rename_fields description: The processor type. The value should always be `rename_fields`. enum: - - rename_fields + - rename_fields example: rename_fields type: string x-enum-varnames: - - RENAME_FIELDS + - RENAME_FIELDS ObservabilityPipelineRsyslogDestination: - description: 'The `rsyslog` destination forwards logs to an external `rsyslog` - server over TCP or UDP using the syslog protocol. - + description: |- + The `rsyslog` destination forwards logs to an external `rsyslog` server over TCP or UDP using the syslog protocol. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" endpoint_url_key: - description: Name of the environment variable or secret that holds the syslog - server endpoint URL. + description: Name of the environment variable or secret that holds the syslog server endpoint URL. example: SYSLOG_ENDPOINT_URL type: string id: description: The unique identifier for this component. - example: rsyslog-destination + example: "rsyslog-destination" type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array @@ -45795,98 +43592,83 @@ components: minimum: 0 type: integer tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineRsyslogDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineRsyslogDestinationType" required: - - id - - type - - inputs + - id + - type + - inputs type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineRsyslogDestinationType: default: rsyslog description: The destination type. The value should always be `rsyslog`. - enum: - - rsyslog + enum: [rsyslog] example: rsyslog type: string x-enum-varnames: - - RSYSLOG + - RSYSLOG ObservabilityPipelineRsyslogSource: - description: 'The `rsyslog` source listens for logs over TCP or UDP from an - `rsyslog` server using the syslog protocol. + description: |- + The `rsyslog` source listens for logs over TCP or UDP from an `rsyslog` server using the syslog protocol. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: address_key: - description: Name of the environment variable or secret that holds the listen - address for the syslog receiver. + description: Name of the environment variable or secret that holds the listen address for the syslog receiver. example: SYSLOG_ADDRESS type: string id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). - example: rsyslog-source + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). + example: "rsyslog-source" type: string mode: - $ref: '#/components/schemas/ObservabilityPipelineSyslogSourceMode' + $ref: "#/components/schemas/ObservabilityPipelineSyslogSourceMode" tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineRsyslogSourceType' + $ref: "#/components/schemas/ObservabilityPipelineRsyslogSourceType" required: - - id - - type - - mode + - id + - type + - mode type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineRsyslogSourceType: default: rsyslog description: The source type. The value should always be `rsyslog`. - enum: - - rsyslog + enum: [rsyslog] example: rsyslog type: string x-enum-varnames: - - RSYSLOG + - RSYSLOG ObservabilityPipelineSampleProcessor: - description: 'The `sample` processor allows probabilistic sampling of logs at - a fixed rate. + description: |- + The `sample` processor allows probabilistic sampling of logs at a fixed rate. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean group_by: - description: Optional list of fields to group events by. Each group is sampled - independently. - example: - - service - - host + description: Optional list of fields to group events by. Each group is sampled independently. + example: ["service", "host"] items: type: string minItems: 1 type: array id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). - example: sample-processor + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). + example: "sample-processor" type: string include: - description: A Datadog search query used to determine which logs this processor - targets. - example: service:my-service + description: A Datadog search query used to determine which logs this processor targets. + example: "service:my-service" type: string percentage: description: The percentage of logs to sample. @@ -45894,1143 +43676,984 @@ components: format: double type: number type: - $ref: '#/components/schemas/ObservabilityPipelineSampleProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineSampleProcessorType" required: - - id - - type - - include - - percentage - - enabled + - id + - type + - include + - percentage + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineSampleProcessorType: default: sample description: The processor type. The value should always be `sample`. - enum: - - sample + enum: [sample] example: sample type: string x-enum-varnames: - - SAMPLE + - SAMPLE ObservabilityPipelineSensitiveDataScannerProcessor: - description: 'The `sensitive_data_scanner` processor detects and optionally - redacts sensitive data in log events. + description: |- + The `sensitive_data_scanner` processor detects and optionally redacts sensitive data in log events. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). - example: sensitive-scanner + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). + example: "sensitive-scanner" type: string include: - description: A Datadog search query used to determine which logs this processor - targets. - example: source:prod + description: A Datadog search query used to determine which logs this processor targets. + example: "source:prod" type: string rules: - description: A list of rules for identifying and acting on sensitive data - patterns. + description: A list of rules for identifying and acting on sensitive data patterns. items: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorRule' + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorRule" type: array type: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorType" required: - - id - - type - - include - - rules - - enabled + - id + - type + - include + - rules + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineSensitiveDataScannerProcessorAction: description: Defines what action to take when sensitive data is matched. oneOf: - - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionRedact' - - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionHash' - - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedact' + - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionRedact" + - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionHash" + - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedact" ObservabilityPipelineSensitiveDataScannerProcessorActionHash: description: Configuration for hashing matched sensitive values. properties: action: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionHashAction' + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionHashAction" options: - description: The `ObservabilityPipelineSensitiveDataScannerProcessorActionHash` - `options`. + description: The `ObservabilityPipelineSensitiveDataScannerProcessorActionHash` `options`. type: object - required: - - action + required: [action] type: object ObservabilityPipelineSensitiveDataScannerProcessorActionHashAction: - description: Action type that replaces the matched sensitive data with a hashed - representation, preserving structure while securing content. - enum: - - hash + description: Action type that replaces the matched sensitive data with a hashed representation, preserving structure while securing content. + enum: [hash] example: hash type: string x-enum-varnames: - - HASH + - HASH ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedact: description: Configuration for partially redacting matched sensitive data. properties: action: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactAction' + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactAction" options: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions' - required: - - action - - options + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions" + required: [action, options] type: object ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactAction: - description: Action type that redacts part of the sensitive data while preserving - a configurable number of characters, typically used for masking purposes (e.g., - show last 4 digits of a credit card). - enum: - - partial_redact + description: Action type that redacts part of the sensitive data while preserving a configurable number of characters, typically used for masking purposes (e.g., show last 4 digits of a credit card). + enum: [partial_redact] example: partial_redact type: string x-enum-varnames: - - PARTIAL_REDACT + - PARTIAL_REDACT ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions: - description: Controls how partial redaction is applied, including character - count and direction. + description: Controls how partial redaction is applied, including character count and direction. properties: characters: - description: The `ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions` - `characters`. + description: The `ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions` `characters`. example: 4 format: int64 type: integer direction: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptionsDirection' - required: - - characters - - direction + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptionsDirection" + required: [characters, direction] type: object ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptionsDirection: - description: Indicates whether to redact characters from the first or last part - of the matched value. - enum: - - first - - last + description: Indicates whether to redact characters from the first or last part of the matched value. + enum: [first, last] example: last type: string x-enum-varnames: - - FIRST - - LAST + - FIRST + - LAST ObservabilityPipelineSensitiveDataScannerProcessorActionRedact: description: Configuration for completely redacting matched sensitive data. properties: action: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionRedactAction' + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionRedactAction" options: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions' - required: - - action - - options + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions" + required: [action, options] type: object ObservabilityPipelineSensitiveDataScannerProcessorActionRedactAction: - description: Action type that completely replaces the matched sensitive data - with a fixed replacement string to remove all visibility. - enum: - - redact + description: Action type that completely replaces the matched sensitive data with a fixed replacement string to remove all visibility. + enum: [redact] example: redact type: string x-enum-varnames: - - REDACT + - REDACT ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions: description: Configuration for fully redacting sensitive data. properties: replace: - description: The `ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions` - `replace`. - example: '***' + description: The `ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions` `replace`. + example: "***" type: string - required: - - replace + required: [replace] type: object ObservabilityPipelineSensitiveDataScannerProcessorCustomPattern: - description: Defines a custom regex-based pattern for identifying sensitive - data in logs. + description: Defines a custom regex-based pattern for identifying sensitive data in logs. properties: options: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions' + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions" type: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternType' - required: - - type - - options + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternType" + required: [type, options] type: object ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions: description: Options for defining a custom regex pattern. properties: description: - description: Human-readable description providing context about a sensitive - data scanner rule - example: "Custom regex for internal API\u202Fkeys" + description: Human-readable description providing context about a sensitive data scanner rule + example: Custom regex for internal API keys type: string rule: - description: A regular expression used to detect sensitive values. Must - be a valid regex. - example: \b\d{16}\b + description: A regular expression used to detect sensitive values. Must be a valid regex. + example: "\\b\\d{16}\\b" type: string - required: - - rule + required: [rule] type: object ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternType: description: Indicates a custom regular expression is used for matching. - enum: - - custom + enum: [custom] example: custom type: string x-enum-varnames: - - CUSTOM + - CUSTOM ObservabilityPipelineSensitiveDataScannerProcessorKeywordOptions: - description: Configuration for keywords used to reinforce sensitive data pattern - detection. + description: Configuration for keywords used to reinforce sensitive data pattern detection. properties: keywords: description: A list of keywords to match near the sensitive pattern. - example: - - ssn - - card - - account + example: ["ssn", "card", "account"] items: type: string type: array proximity: - description: Maximum number of tokens between a keyword and a sensitive - value match. + description: Maximum number of tokens between a keyword and a sensitive value match. example: 5 format: int64 type: integer - required: - - keywords - - proximity + required: [keywords, proximity] type: object ObservabilityPipelineSensitiveDataScannerProcessorLibraryPattern: - description: "Specifies a pattern from Datadog\u2019s sensitive data detection - library to match known sensitive data types." + description: Specifies a pattern from Datadog’s sensitive data detection library to match known sensitive data types. properties: options: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions' + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions" type: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternType' - required: - - type - - options + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternType" + required: [type, options] type: object ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions: - description: Options for selecting a predefined library pattern and enabling - keyword support. + description: Options for selecting a predefined library pattern and enabling keyword support. properties: description: - description: Human-readable description providing context about a sensitive - data scanner rule + description: Human-readable description providing context about a sensitive data scanner rule example: Credit card pattern type: string id: - description: Identifier for a predefined pattern from the sensitive data - scanner pattern library. + description: Identifier for a predefined pattern from the sensitive data scanner pattern library. example: credit_card type: string use_recommended_keywords: description: Whether to augment the pattern with recommended keywords (optional). type: boolean - required: - - id + required: [id] type: object ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternType: description: Indicates that a predefined library pattern is used. - enum: - - library + enum: [library] example: library type: string x-enum-varnames: - - LIBRARY + - LIBRARY ObservabilityPipelineSensitiveDataScannerProcessorPattern: - description: Pattern detection configuration for identifying sensitive data - using either a custom regex or a library reference. + description: Pattern detection configuration for identifying sensitive data using either a custom regex or a library reference. oneOf: - - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorCustomPattern' - - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorLibraryPattern' + - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorCustomPattern" + - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorLibraryPattern" ObservabilityPipelineSensitiveDataScannerProcessorRule: - description: Defines a rule for detecting sensitive data, including matching - pattern, scope, and the action to take. + description: Defines a rule for detecting sensitive data, including matching pattern, scope, and the action to take. properties: keyword_options: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorKeywordOptions' + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorKeywordOptions" name: description: A name identifying the rule. - example: Redact Credit Card Numbers + example: "Redact Credit Card Numbers" type: string on_match: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorAction' + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorAction" pattern: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorPattern' + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorPattern" scope: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScope' + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScope" tags: description: Tags assigned to this rule for filtering and classification. - example: - - pii - - ccn + example: ["pii", "ccn"] items: type: string type: array required: - - name - - tags - - pattern - - scope - - on_match + - name + - tags + - pattern + - scope + - on_match type: object ObservabilityPipelineSensitiveDataScannerProcessorScope: - description: Determines which parts of the log the pattern-matching rule should - be applied to. + description: Determines which parts of the log the pattern-matching rule should be applied to. oneOf: - - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeInclude' - - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeExclude' - - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeAll' + - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeInclude" + - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeExclude" + - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeAll" ObservabilityPipelineSensitiveDataScannerProcessorScopeAll: description: Applies scanning across all available fields. properties: target: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeAllTarget' - required: - - target + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeAllTarget" + required: [target] type: object ObservabilityPipelineSensitiveDataScannerProcessorScopeAllTarget: description: Applies the rule to all fields. - enum: - - all + enum: [all] example: all type: string x-enum-varnames: - - ALL + - ALL ObservabilityPipelineSensitiveDataScannerProcessorScopeExclude: description: Excludes specific fields from sensitive data scanning. properties: options: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions' + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions" target: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeExcludeTarget' - required: - - target - - options + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeExcludeTarget" + required: [target, options] type: object ObservabilityPipelineSensitiveDataScannerProcessorScopeExcludeTarget: description: Excludes specific fields from processing. - enum: - - exclude + enum: [exclude] example: exclude type: string x-enum-varnames: - - EXCLUDE + - EXCLUDE ObservabilityPipelineSensitiveDataScannerProcessorScopeInclude: description: Includes only specific fields for sensitive data scanning. properties: options: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions' + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions" target: - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeIncludeTarget' - required: - - target - - options + $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeIncludeTarget" + required: [target, options] type: object ObservabilityPipelineSensitiveDataScannerProcessorScopeIncludeTarget: description: Applies the rule only to included fields. - enum: - - include + enum: [include] example: include type: string x-enum-varnames: - - INCLUDE + - INCLUDE ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions: description: Fields to which the scope rule applies. properties: fields: - description: The `ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions` - `fields`. + description: The `ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions` `fields`. example: - - '' + - "" items: type: string type: array - required: - - fields + required: [fields] type: object ObservabilityPipelineSensitiveDataScannerProcessorType: default: sensitive_data_scanner description: The processor type. The value should always be `sensitive_data_scanner`. - enum: - - sensitive_data_scanner + enum: [sensitive_data_scanner] example: sensitive_data_scanner type: string x-enum-varnames: - - SENSITIVE_DATA_SCANNER + - SENSITIVE_DATA_SCANNER ObservabilityPipelineSentinelOneDestination: - description: 'The `sentinel_one` destination sends logs to SentinelOne. - + description: |- + The `sentinel_one` destination sends logs to SentinelOne. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" id: description: The unique identifier for this component. example: sentinelone-destination type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array region: - $ref: '#/components/schemas/ObservabilityPipelineSentinelOneDestinationRegion' + $ref: "#/components/schemas/ObservabilityPipelineSentinelOneDestinationRegion" token_key: - description: Name of the environment variable or secret that holds the SentinelOne - API token. + description: Name of the environment variable or secret that holds the SentinelOne API token. example: SENTINELONE_TOKEN type: string type: - $ref: '#/components/schemas/ObservabilityPipelineSentinelOneDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineSentinelOneDestinationType" required: - - id - - type - - inputs - - region + - id + - type + - inputs + - region type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineSentinelOneDestinationRegion: description: The SentinelOne region to send logs to. enum: - - us - - eu - - ca - - data_set_us + - us + - eu + - ca + - data_set_us example: us type: string x-enum-varnames: - - US - - EU - - CA - - DATA_SET_US + - US + - EU + - CA + - DATA_SET_US ObservabilityPipelineSentinelOneDestinationType: default: sentinel_one description: The destination type. The value should always be `sentinel_one`. enum: - - sentinel_one + - sentinel_one example: sentinel_one type: string x-enum-varnames: - - SENTINEL_ONE + - SENTINEL_ONE ObservabilityPipelineSocketDestination: - description: 'The `socket` destination sends logs over TCP or UDP to a remote - server. - + description: |- + The `socket` destination sends logs over TCP or UDP to a remote server. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: address_key: - description: Name of the environment variable or secret that holds the socket - address (host:port). + description: Name of the environment variable or secret that holds the socket address (host:port). example: SOCKET_ADDRESS type: string buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" encoding: - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationEncoding' + $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationEncoding" framing: - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFraming' + $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationFraming" id: description: The unique identifier for this component. example: socket-destination type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array mode: - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationMode' + $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationMode" tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" description: TLS configuration. Relevant only when `mode` is `tcp`. type: - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationType" required: - - id - - type - - inputs - - encoding - - framing - - mode + - id + - type + - inputs + - encoding + - framing + - mode type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineSocketDestinationEncoding: description: Encoding format for log events. - enum: - - json - - raw_message + enum: [json, raw_message] example: json type: string x-enum-varnames: - - JSON - - RAW_MESSAGE + - JSON + - RAW_MESSAGE ObservabilityPipelineSocketDestinationFraming: description: Framing method configuration. oneOf: - - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimited' - - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytes' - - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimited' + - $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimited" + - $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytes" + - $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimited" ObservabilityPipelineSocketDestinationFramingBytes: description: Event data is not delimited at all. properties: method: - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytesMethod' - required: - - method + $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytesMethod" + required: [method] type: object ObservabilityPipelineSocketDestinationFramingBytesMethod: - description: The definition of `ObservabilityPipelineSocketDestinationFramingBytesMethod` - object. - enum: - - bytes + description: The definition of `ObservabilityPipelineSocketDestinationFramingBytesMethod` object. + enum: [bytes] example: bytes type: string x-enum-varnames: - - BYTES + - BYTES ObservabilityPipelineSocketDestinationFramingCharacterDelimited: description: Each log event is separated using the specified delimiter character. properties: delimiter: description: A single ASCII character used as a delimiter. - example: '|' + example: "|" maxLength: 1 minLength: 1 type: string method: - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod' - required: - - method - - delimiter + $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod" + required: [method, delimiter] type: object ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod: - description: The definition of `ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod` - object. - enum: - - character_delimited + description: The definition of `ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod` object. + enum: [character_delimited] example: character_delimited type: string x-enum-varnames: - - CHARACTER_DELIMITED + - CHARACTER_DELIMITED ObservabilityPipelineSocketDestinationFramingNewlineDelimited: description: Each log event is delimited by a newline character. properties: method: - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod' - required: - - method + $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod" + required: [method] type: object ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod: - description: The definition of `ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod` - object. - enum: - - newline_delimited + description: The definition of `ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod` object. + enum: [newline_delimited] example: newline_delimited type: string x-enum-varnames: - - NEWLINE_DELIMITED + - NEWLINE_DELIMITED ObservabilityPipelineSocketDestinationMode: description: Protocol used to send logs. - enum: - - tcp - - udp + enum: [tcp, udp] example: tcp type: string x-enum-varnames: - - TCP - - UDP + - TCP + - UDP ObservabilityPipelineSocketDestinationType: default: socket description: The destination type. The value should always be `socket`. - enum: - - socket + enum: [socket] example: socket type: string x-enum-varnames: - - SOCKET + - SOCKET ObservabilityPipelineSocketSource: - description: 'The `socket` source ingests logs over TCP or UDP. - + description: |- + The `socket` source ingests logs over TCP or UDP. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: address_key: - description: Name of the environment variable or secret that holds the listen - address for the socket. + description: Name of the environment variable or secret that holds the listen address for the socket. example: SOCKET_ADDRESS type: string framing: - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFraming' + $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFraming" id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). example: socket-source type: string mode: - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceMode' + $ref: "#/components/schemas/ObservabilityPipelineSocketSourceMode" tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" description: TLS configuration. Relevant only when `mode` is `tcp`. type: - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceType' + $ref: "#/components/schemas/ObservabilityPipelineSocketSourceType" required: - - id - - type - - mode - - framing + - id + - type + - mode + - framing type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineSocketSourceFraming: description: Framing method configuration for the socket source. oneOf: - - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimited' - - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingBytes' - - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimited' - - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCounting' - - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelf' + - $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimited" + - $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingBytes" + - $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimited" + - $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCounting" + - $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelf" ObservabilityPipelineSocketSourceFramingBytes: - description: Byte frames are passed through as-is according to the underlying - I/O boundaries (for example, split between messages or stream segments). + description: Byte frames are passed through as-is according to the underlying I/O boundaries (for example, split between messages or stream segments). properties: method: - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingBytesMethod' - required: - - method + $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingBytesMethod" + required: [method] type: object ObservabilityPipelineSocketSourceFramingBytesMethod: - description: Byte frames are passed through as-is according to the underlying - I/O boundaries (for example, split between messages or stream segments). - enum: - - bytes + description: Byte frames are passed through as-is according to the underlying I/O boundaries (for example, split between messages or stream segments). + enum: [bytes] example: bytes type: string x-enum-varnames: - - BYTES + - BYTES ObservabilityPipelineSocketSourceFramingCharacterDelimited: description: Byte frames which are delimited by a chosen character. properties: delimiter: description: A single ASCII character used to delimit events. - example: '|' + example: "|" maxLength: 1 minLength: 1 type: string method: - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod' - required: - - method - - delimiter + $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod" + required: [method, delimiter] type: object ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod: description: Byte frames which are delimited by a chosen character. - enum: - - character_delimited + enum: [character_delimited] example: character_delimited type: string x-enum-varnames: - - CHARACTER_DELIMITED + - CHARACTER_DELIMITED ObservabilityPipelineSocketSourceFramingChunkedGelf: description: Byte frames which are chunked GELF messages. properties: method: - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelfMethod' - required: - - method + $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelfMethod" + required: [method] type: object ObservabilityPipelineSocketSourceFramingChunkedGelfMethod: description: Byte frames which are chunked GELF messages. - enum: - - chunked_gelf + enum: [chunked_gelf] example: chunked_gelf type: string x-enum-varnames: - - CHUNKED_GELF + - CHUNKED_GELF ObservabilityPipelineSocketSourceFramingNewlineDelimited: description: Byte frames which are delimited by a newline character. properties: method: - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod' - required: - - method + $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod" + required: [method] type: object ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod: description: Byte frames which are delimited by a newline character. - enum: - - newline_delimited + enum: [newline_delimited] example: newline_delimited type: string x-enum-varnames: - - NEWLINE_DELIMITED + - NEWLINE_DELIMITED ObservabilityPipelineSocketSourceFramingOctetCounting: description: Byte frames according to the octet counting format as per RFC6587. properties: method: - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCountingMethod' - required: - - method + $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCountingMethod" + required: [method] type: object ObservabilityPipelineSocketSourceFramingOctetCountingMethod: description: Byte frames according to the octet counting format as per RFC6587. - enum: - - octet_counting + enum: [octet_counting] example: octet_counting type: string x-enum-varnames: - - OCTET_COUNTING + - OCTET_COUNTING ObservabilityPipelineSocketSourceMode: description: Protocol used to receive logs. - enum: - - tcp - - udp + enum: [tcp, udp] example: tcp type: string x-enum-varnames: - - TCP - - UDP + - TCP + - UDP ObservabilityPipelineSocketSourceType: default: socket description: The source type. The value should always be `socket`. - enum: - - socket + enum: [socket] example: socket type: string x-enum-varnames: - - SOCKET + - SOCKET ObservabilityPipelineSpec: - description: Input schema representing an observability pipeline configuration. - Used in create and validate requests. + description: Input schema representing an observability pipeline configuration. Used in create and validate requests. properties: data: - $ref: '#/components/schemas/ObservabilityPipelineSpecData' + $ref: "#/components/schemas/ObservabilityPipelineSpecData" required: - - data + - data type: object ObservabilityPipelineSpecData: description: Contains the the pipeline configuration. properties: attributes: - $ref: '#/components/schemas/ObservabilityPipelineDataAttributes' + $ref: "#/components/schemas/ObservabilityPipelineDataAttributes" type: default: pipelines - description: The resource type identifier. For pipeline resources, this - should always be set to `pipelines`. + description: The resource type identifier. For pipeline resources, this should always be set to `pipelines`. example: pipelines type: string required: - - type - - attributes + - type + - attributes type: object ObservabilityPipelineSplitArrayProcessor: - description: 'The `split_array` processor splits array fields into separate - events based on configured rules. + description: |- + The `split_array` processor splits array fields into separate events based on configured rules. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: arrays: description: A list of array split configurations. items: - $ref: '#/components/schemas/ObservabilityPipelineSplitArrayProcessorArrayConfig' + $ref: "#/components/schemas/ObservabilityPipelineSplitArrayProcessorArrayConfig" maxItems: 15 minItems: 1 type: array display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). example: split-array-processor type: string include: - description: A Datadog search query used to determine which logs this processor - targets. For split_array, this should typically be `*`. - example: '*' + description: A Datadog search query used to determine which logs this processor targets. For split_array, this should typically be `*`. + example: "*" type: string type: - $ref: '#/components/schemas/ObservabilityPipelineSplitArrayProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineSplitArrayProcessorType" required: - - id - - type - - include - - arrays - - enabled + - id + - type + - include + - arrays + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineSplitArrayProcessorArrayConfig: description: Configuration for a single array split operation. properties: field: description: The path to the array field to split. - example: tags + example: "tags" type: string include: - description: A Datadog search query used to determine which logs this array - split operation targets. - example: '*' + description: A Datadog search query used to determine which logs this array split operation targets. + example: "*" type: string required: - - include - - field + - include + - field type: object ObservabilityPipelineSplitArrayProcessorType: default: split_array description: The processor type. The value should always be `split_array`. enum: - - split_array + - split_array example: split_array type: string x-enum-varnames: - - SPLIT_ARRAY + - SPLIT_ARRAY ObservabilityPipelineSplunkHecDestination: - description: 'The `splunk_hec` destination forwards logs to Splunk using the - HTTP Event Collector (HEC). - + description: |- + The `splunk_hec` destination forwards logs to Splunk using the HTTP Event Collector (HEC). - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: auto_extract_timestamp: - description: 'If `true`, Splunk tries to extract timestamps from incoming - log events. - - If `false`, Splunk assigns the time the event was received.' + description: |- + If `true`, Splunk tries to extract timestamps from incoming log events. + If `false`, Splunk assigns the time the event was received. example: true type: boolean buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" encoding: - $ref: '#/components/schemas/ObservabilityPipelineSplunkHecDestinationEncoding' + $ref: "#/components/schemas/ObservabilityPipelineSplunkHecDestinationEncoding" endpoint_url_key: - description: Name of the environment variable or secret that holds the Splunk - HEC endpoint URL. + description: Name of the environment variable or secret that holds the Splunk HEC endpoint URL. example: SPLUNK_HEC_ENDPOINT_URL type: string id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). example: splunk-hec-destination type: string index: description: Optional name of the Splunk index where logs are written. - example: main + example: "main" type: string indexed_fields: - description: List of log field names to send as indexed fields to Splunk - HEC. Available only when `encoding` is `json`. - example: - - service - - host + description: List of log field names to send as indexed fields to Splunk HEC. Available only when `encoding` is `json`. + example: ["service", "host"] items: type: string type: array inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array sourcetype: description: The Splunk sourcetype to assign to log events. - example: custom_sourcetype + example: "custom_sourcetype" type: string token_key: - description: Name of the environment variable or secret that holds the Splunk - HEC token. + description: Name of the environment variable or secret that holds the Splunk HEC token. example: SPLUNK_HEC_TOKEN type: string type: - $ref: '#/components/schemas/ObservabilityPipelineSplunkHecDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineSplunkHecDestinationType" required: - - id - - type - - inputs + - id + - type + - inputs type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineSplunkHecDestinationEncoding: description: Encoding format for log events. enum: - - json - - raw_message + - json + - raw_message example: json type: string x-enum-varnames: - - JSON - - RAW_MESSAGE + - JSON + - RAW_MESSAGE ObservabilityPipelineSplunkHecDestinationType: default: splunk_hec description: The destination type. Always `splunk_hec`. enum: - - splunk_hec + - splunk_hec example: splunk_hec type: string x-enum-varnames: - - SPLUNK_HEC + - SPLUNK_HEC ObservabilityPipelineSplunkHecSource: - description: 'The `splunk_hec` source implements the Splunk HTTP Event Collector - (HEC) API. + description: |- + The `splunk_hec` source implements the Splunk HTTP Event Collector (HEC) API. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: address_key: - description: Name of the environment variable or secret that holds the listen - address for the HEC API. + description: Name of the environment variable or secret that holds the listen address for the HEC API. example: SPLUNK_HEC_ADDRESS type: string id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). example: splunk-hec-source type: string tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineSplunkHecSourceType' + $ref: "#/components/schemas/ObservabilityPipelineSplunkHecSourceType" required: - - id - - type + - id + - type type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineSplunkHecSourceType: default: splunk_hec description: The source type. Always `splunk_hec`. enum: - - splunk_hec + - splunk_hec example: splunk_hec type: string x-enum-varnames: - - SPLUNK_HEC + - SPLUNK_HEC ObservabilityPipelineSplunkTcpSource: - description: 'The `splunk_tcp` source receives logs from a Splunk Universal - Forwarder over TCP. - + description: |- + The `splunk_tcp` source receives logs from a Splunk Universal Forwarder over TCP. TLS is supported for secure transmission. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: address_key: - description: Name of the environment variable or secret that holds the listen - address for the Splunk TCP receiver. + description: Name of the environment variable or secret that holds the listen address for the Splunk TCP receiver. example: SPLUNK_TCP_ADDRESS type: string id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). example: splunk-tcp-source type: string tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineSplunkTcpSourceType' + $ref: "#/components/schemas/ObservabilityPipelineSplunkTcpSourceType" required: - - id - - type + - id + - type type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineSplunkTcpSourceType: default: splunk_tcp description: The source type. Always `splunk_tcp`. enum: - - splunk_tcp + - splunk_tcp example: splunk_tcp type: string x-enum-varnames: - - SPLUNK_TCP + - SPLUNK_TCP ObservabilityPipelineSumoLogicDestination: - description: 'The `sumo_logic` destination forwards logs to Sumo Logic. - + description: |- + The `sumo_logic` destination forwards logs to Sumo Logic. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" encoding: - $ref: '#/components/schemas/ObservabilityPipelineSumoLogicDestinationEncoding' + $ref: "#/components/schemas/ObservabilityPipelineSumoLogicDestinationEncoding" endpoint_url_key: - description: Name of the environment variable or secret that holds the Sumo - Logic HTTP endpoint URL. + description: Name of the environment variable or secret that holds the Sumo Logic HTTP endpoint URL. example: SUMO_LOGIC_ENDPOINT_URL type: string header_custom_fields: - description: A list of custom headers to include in the request to Sumo - Logic. + description: A list of custom headers to include in the request to Sumo Logic. items: - $ref: '#/components/schemas/ObservabilityPipelineSumoLogicDestinationHeaderCustomFieldsItem' + $ref: "#/components/schemas/ObservabilityPipelineSumoLogicDestinationHeaderCustomFieldsItem" type: array header_host_name: description: Optional override for the host name header. - example: host-123 + example: "host-123" type: string header_source_category: description: Optional override for the source category header. - example: source-category + example: "source-category" type: string header_source_name: description: Optional override for the source name header. - example: source-name + example: "source-name" type: string id: description: The unique identifier for this component. - example: sumo-logic-destination + example: "sumo-logic-destination" type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array type: - $ref: '#/components/schemas/ObservabilityPipelineSumoLogicDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineSumoLogicDestinationType" required: - - id - - type - - inputs + - id + - type + - inputs type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineSumoLogicDestinationEncoding: description: The output encoding format. - enum: - - json - - raw_message - - logfmt + enum: [json, raw_message, logfmt] example: json type: string x-enum-varnames: - - JSON - - RAW_MESSAGE - - LOGFMT + - JSON + - RAW_MESSAGE + - LOGFMT ObservabilityPipelineSumoLogicDestinationHeaderCustomFieldsItem: description: Single key-value pair used as a custom log header for Sumo Logic. properties: name: description: The header field name. - example: X-Sumo-Category + example: "X-Sumo-Category" type: string value: description: The header field value. - example: my-app-logs + example: "my-app-logs" type: string required: - - name - - value + - name + - value type: object ObservabilityPipelineSumoLogicDestinationType: default: sumo_logic description: The destination type. The value should always be `sumo_logic`. enum: - - sumo_logic + - sumo_logic example: sumo_logic type: string x-enum-varnames: - - SUMO_LOGIC + - SUMO_LOGIC ObservabilityPipelineSumoLogicSource: - description: 'The `sumo_logic` source receives logs from Sumo Logic collectors. + description: |- + The `sumo_logic` source receives logs from Sumo Logic collectors. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: address_key: - description: Name of the environment variable or secret that holds the listen - address for the Sumo Logic receiver. + description: Name of the environment variable or secret that holds the listen address for the Sumo Logic receiver. example: SUMO_LOGIC_ADDRESS type: string id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). - example: sumo-logic-source + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). + example: "sumo-logic-source" type: string type: - $ref: '#/components/schemas/ObservabilityPipelineSumoLogicSourceType' + $ref: "#/components/schemas/ObservabilityPipelineSumoLogicSourceType" required: - - id - - type + - id + - type type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineSumoLogicSourceType: default: sumo_logic description: The source type. The value should always be `sumo_logic`. enum: - - sumo_logic + - sumo_logic example: sumo_logic type: string x-enum-varnames: - - SUMO_LOGIC + - SUMO_LOGIC ObservabilityPipelineSyslogNgDestination: - description: 'The `syslog_ng` destination forwards logs to an external `syslog-ng` - server over TCP or UDP using the syslog protocol. - + description: |- + The `syslog_ng` destination forwards logs to an external `syslog-ng` server over TCP or UDP using the syslog protocol. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: buffer: - $ref: '#/components/schemas/ObservabilityPipelineBufferOptions' + $ref: "#/components/schemas/ObservabilityPipelineBufferOptions" endpoint_url_key: - description: Name of the environment variable or secret that holds the syslog-ng - server endpoint URL. + description: Name of the environment variable or secret that holds the syslog-ng server endpoint URL. example: SYSLOG_ENDPOINT_URL type: string id: description: The unique identifier for this component. - example: syslog-ng-destination + example: "syslog-ng-destination" type: string inputs: - description: A list of component IDs whose output is used as the `input` - for this component. - example: - - filter-processor + description: A list of component IDs whose output is used as the `input` for this component. + example: ["filter-processor"] items: type: string type: array @@ -47041,93 +44664,80 @@ components: minimum: 0 type: integer tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineSyslogNgDestinationType' + $ref: "#/components/schemas/ObservabilityPipelineSyslogNgDestinationType" required: - - id - - type - - inputs + - id + - type + - inputs type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineSyslogNgDestinationType: default: syslog_ng description: The destination type. The value should always be `syslog_ng`. - enum: - - syslog_ng + enum: [syslog_ng] example: syslog_ng type: string x-enum-varnames: - - SYSLOG_NG + - SYSLOG_NG ObservabilityPipelineSyslogNgSource: - description: 'The `syslog_ng` source listens for logs over TCP or UDP from a - `syslog-ng` server using the syslog protocol. + description: |- + The `syslog_ng` source listens for logs over TCP or UDP from a `syslog-ng` server using the syslog protocol. - - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: address_key: - description: Name of the environment variable or secret that holds the listen - address for the syslog-ng receiver. + description: Name of the environment variable or secret that holds the listen address for the syslog-ng receiver. example: SYSLOG_ADDRESS type: string id: - description: The unique identifier for this component. Used in other parts - of the pipeline to reference this component (for example, as the `input` - to downstream components). - example: syslog-ng-source + description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). + example: "syslog-ng-source" type: string mode: - $ref: '#/components/schemas/ObservabilityPipelineSyslogSourceMode' + $ref: "#/components/schemas/ObservabilityPipelineSyslogSourceMode" tls: - $ref: '#/components/schemas/ObservabilityPipelineTls' + $ref: "#/components/schemas/ObservabilityPipelineTls" type: - $ref: '#/components/schemas/ObservabilityPipelineSyslogNgSourceType' + $ref: "#/components/schemas/ObservabilityPipelineSyslogNgSourceType" required: - - id - - type - - mode + - id + - type + - mode type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineSyslogNgSourceType: default: syslog_ng description: The source type. The value should always be `syslog_ng`. - enum: - - syslog_ng + enum: [syslog_ng] example: syslog_ng type: string x-enum-varnames: - - SYSLOG_NG + - SYSLOG_NG ObservabilityPipelineSyslogSourceMode: description: Protocol used by the syslog source to receive messages. - enum: - - tcp - - udp + enum: [tcp, udp] example: tcp type: string x-enum-varnames: - - TCP - - UDP + - TCP + - UDP ObservabilityPipelineThrottleProcessor: - description: 'The `throttle` processor limits the number of events that pass - through over a given time window. - + description: |- + The `throttle` processor limits the number of events that pass through over a given time window. - **Supported pipeline types:** logs' + **Supported pipeline types:** logs properties: display_name: - $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName' + $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName" enabled: description: Indicates whether the processor is enabled. example: true type: boolean group_by: - description: Optional list of fields used to group events before the threshold - has been reached. - example: - - log.user.id + description: Optional list of fields used to group events before the threshold has been reached. + example: ["log.user.id"] items: type: string type: array @@ -47136,93 +44746,85 @@ components: example: throttle-processor type: string include: - description: A Datadog search query used to determine which logs this processor - targets. + description: A Datadog search query used to determine which logs this processor targets. example: env:prod type: string threshold: - description: the number of events allowed in a given time window. Events - sent after the threshold has been reached, are dropped. + description: the number of events allowed in a given time window. Events sent after the threshold has been reached, are dropped. example: 1000 format: int64 type: integer type: - $ref: '#/components/schemas/ObservabilityPipelineThrottleProcessorType' + $ref: "#/components/schemas/ObservabilityPipelineThrottleProcessorType" window: description: The time window in seconds over which the threshold applies. example: 60.0 format: double type: number required: - - id - - type - - include - - threshold - - window - - enabled + - id + - type + - include + - threshold + - window + - enabled type: object - x-pipeline-types: - - logs + x-pipeline-types: [logs] ObservabilityPipelineThrottleProcessorType: default: throttle description: The processor type. The value should always be `throttle`. enum: - - throttle + - throttle example: throttle type: string x-enum-varnames: - - THROTTLE + - THROTTLE ObservabilityPipelineTls: - description: Configuration for enabling TLS encryption between the pipeline - component and external services. + description: Configuration for enabling TLS encryption between the pipeline component and external services. properties: ca_file: - description: "Path to the Certificate Authority (CA) file used to validate - the server\u2019s TLS certificate." + description: Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate. type: string crt_file: - description: Path to the TLS client certificate file used to authenticate - the pipeline component with upstream or downstream services. - example: /path/to/cert.crt + description: Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services. + example: "/path/to/cert.crt" type: string key_file: - description: Path to the private key file associated with the TLS client - certificate. Used for mutual TLS authentication. + description: Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication. type: string key_pass_key: - description: Name of the environment variable or secret that holds the passphrase - for the private key file. + description: Name of the environment variable or secret that holds the passphrase for the private key file. example: TLS_KEY_PASSPHRASE type: string required: - - crt_file + - crt_file type: object OktaAPIToken: description: The definition of the `OktaAPIToken` object. properties: api_token: description: The `OktaAPIToken` `api_token`. - example: '' + example: "" type: string domain: description: The `OktaAPIToken` `domain`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/OktaAPITokenType' + $ref: "#/components/schemas/OktaAPITokenType" required: - - type - - domain - - api_token + - type + - domain + - api_token type: object OktaAPITokenType: description: The definition of the `OktaAPIToken` object. enum: - - OktaAPIToken + - OktaAPIToken example: OktaAPIToken type: string x-enum-varnames: - - OKTAAPITOKEN + - OKTAAPITOKEN OktaAPITokenUpdate: description: The definition of the `OktaAPIToken` object. properties: @@ -47233,24 +44835,24 @@ components: description: The `OktaAPITokenUpdate` `domain`. type: string type: - $ref: '#/components/schemas/OktaAPITokenType' + $ref: "#/components/schemas/OktaAPITokenType" required: - - type + - type type: object OktaAccount: description: Schema for an Okta account. properties: attributes: - $ref: '#/components/schemas/OktaAccountAttributes' + $ref: "#/components/schemas/OktaAccountAttributes" id: description: The ID of the Okta account, a UUID hash of the account name. - example: f749daaf-682e-4208-a38d-c9b43162c609 + example: "f749daaf-682e-4208-a38d-c9b43162c609" type: string type: - $ref: '#/components/schemas/OktaAccountType' + $ref: "#/components/schemas/OktaAccountType" required: - - attributes - - type + - attributes + - type type: object OktaAccountAttributes: description: Attributes object for an Okta account. @@ -47261,7 +44863,7 @@ components: writeOnly: true auth_method: description: The authorization method for an Okta account. - example: oauth + example: "oauth" type: string client_id: description: The Client ID of an Okta app integration. @@ -47272,63 +44874,63 @@ components: writeOnly: true domain: description: The domain of the Okta account. - example: https://example.okta.com/ + example: "https://example.okta.com/" type: string name: description: The name of the Okta account. - example: Okta-Prod + example: "Okta-Prod" type: string required: - - auth_method - - domain - - name + - auth_method + - domain + - name type: object OktaAccountRequest: description: Request object for an Okta account. properties: data: - $ref: '#/components/schemas/OktaAccount' + $ref: "#/components/schemas/OktaAccount" required: - - data + - data type: object OktaAccountResponse: description: Response object for an Okta account. properties: data: - $ref: '#/components/schemas/OktaAccount' + $ref: "#/components/schemas/OktaAccount" type: object OktaAccountResponseData: description: Data object of an Okta account properties: attributes: - $ref: '#/components/schemas/OktaAccountAttributes' + $ref: "#/components/schemas/OktaAccountAttributes" id: description: The ID of the Okta account, a UUID hash of the account name. - example: f749daaf-682e-4208-a38d-c9b43162c609 + example: "f749daaf-682e-4208-a38d-c9b43162c609" type: string type: - $ref: '#/components/schemas/OktaAccountType' + $ref: "#/components/schemas/OktaAccountType" required: - - attributes - - id - - type + - attributes + - id + - type type: object OktaAccountType: default: okta-accounts description: Account type for an Okta account. enum: - - okta-accounts + - okta-accounts example: okta-accounts type: string x-enum-varnames: - - OKTA_ACCOUNTS + - OKTA_ACCOUNTS OktaAccountUpdateRequest: description: Payload schema when updating an Okta account. properties: data: - $ref: '#/components/schemas/OktaAccountUpdateRequestData' + $ref: "#/components/schemas/OktaAccountUpdateRequestData" required: - - data + - data type: object OktaAccountUpdateRequestAttributes: description: Attributes object for updating an Okta account. @@ -47339,7 +44941,7 @@ components: writeOnly: true auth_method: description: The authorization method for an Okta account. - example: oauth + example: "oauth" type: string client_id: description: The Client ID of an Okta app integration. @@ -47350,19 +44952,19 @@ components: writeOnly: true domain: description: The domain associated with an Okta account. - example: https://dev-test.okta.com/ + example: "https://dev-test.okta.com/" type: string required: - - auth_method - - domain + - auth_method + - domain type: object OktaAccountUpdateRequestData: description: Data object for updating an Okta account. properties: attributes: - $ref: '#/components/schemas/OktaAccountUpdateRequestAttributes' + $ref: "#/components/schemas/OktaAccountUpdateRequestAttributes" type: - $ref: '#/components/schemas/OktaAccountType' + $ref: "#/components/schemas/OktaAccountType" type: object OktaAccountsResponse: description: The expected response schema when getting Okta accounts. @@ -47370,56 +44972,56 @@ components: data: description: List of Okta accounts. items: - $ref: '#/components/schemas/OktaAccountResponseData' + $ref: "#/components/schemas/OktaAccountResponseData" type: array type: object OktaCredentials: description: The definition of the `OktaCredentials` object. oneOf: - - $ref: '#/components/schemas/OktaAPIToken' + - $ref: "#/components/schemas/OktaAPIToken" OktaCredentialsUpdate: description: The definition of the `OktaCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/OktaAPITokenUpdate' + - $ref: "#/components/schemas/OktaAPITokenUpdate" OktaIntegration: description: The definition of the `OktaIntegration` object. properties: credentials: - $ref: '#/components/schemas/OktaCredentials' + $ref: "#/components/schemas/OktaCredentials" type: - $ref: '#/components/schemas/OktaIntegrationType' + $ref: "#/components/schemas/OktaIntegrationType" required: - - type - - credentials + - type + - credentials type: object OktaIntegrationType: description: The definition of the `OktaIntegrationType` object. enum: - - Okta + - Okta example: Okta type: string x-enum-varnames: - - OKTA + - OKTA OktaIntegrationUpdate: description: The definition of the `OktaIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/OktaCredentialsUpdate' + $ref: "#/components/schemas/OktaCredentialsUpdate" type: - $ref: '#/components/schemas/OktaIntegrationType' + $ref: "#/components/schemas/OktaIntegrationType" required: - - type + - type type: object OnCallNotificationRule: description: A top-level wrapper for a notification rule example: data: attributes: - category: high_urgency + "category": "high_urgency" channel_settings: - method: sms - type: phone - delay_minutes: 1 + method: "sms" + type: "phone" + "delay_minutes": 1 id: 27590dae-47be-4a7d-9abf-8f4e45124020 relationships: channel: @@ -47429,46 +45031,45 @@ components: type: notification_rules properties: data: - $ref: '#/components/schemas/OnCallNotificationRuleData' + $ref: "#/components/schemas/OnCallNotificationRuleData" included: items: - $ref: '#/components/schemas/OnCallNotificationRulesIncluded' + $ref: "#/components/schemas/OnCallNotificationRulesIncluded" type: array required: - - data + - data type: object OnCallNotificationRuleAttributes: description: Attributes for an on-call notification rule. properties: category: - $ref: '#/components/schemas/OnCallNotificationRuleCategory' + $ref: "#/components/schemas/OnCallNotificationRuleCategory" channel_settings: - $ref: '#/components/schemas/OnCallNotificationRuleChannelSettings' + $ref: "#/components/schemas/OnCallNotificationRuleChannelSettings" description: Configuration for the associated channel, if necessary nullable: true delay_minutes: - description: The number of minutes that will elapse before this rule is - evaluated. 0 indicates immediate evaluation + description: The number of minutes that will elapse before this rule is evaluated. 0 indicates immediate evaluation format: int64 type: integer type: object OnCallNotificationRuleCategory: default: high_urgency - description: Specifies the category a notification rule will apply to + description: "Specifies the category a notification rule will apply to" enum: - - high_urgency - - low_urgency + - high_urgency + - low_urgency type: string x-enum-varnames: - - HIGH_URGENCY - - LOW_URGENCY + - HIGH_URGENCY + - LOW_URGENCY OnCallNotificationRuleChannelRelationship: description: Relationship object for creating a notification rule properties: data: - $ref: '#/components/schemas/OnCallNotificationRuleChannelRelationshipData' + $ref: "#/components/schemas/OnCallNotificationRuleChannelRelationshipData" required: - - data + - data type: object OnCallNotificationRuleChannelRelationshipData: description: Channel relationship data for creating a notification rule @@ -47477,123 +45078,116 @@ components: description: ID of the notification channel type: string type: - $ref: '#/components/schemas/NotificationChannelType' + $ref: "#/components/schemas/NotificationChannelType" type: object OnCallNotificationRuleChannelSettings: - description: Defines the configuration for a channel associated with a notification - rule + description: "Defines the configuration for a channel associated with a notification rule" oneOf: - - $ref: '#/components/schemas/OnCallPhoneNotificationRuleSettings' + - $ref: "#/components/schemas/OnCallPhoneNotificationRuleSettings" OnCallNotificationRuleData: description: Data for an on-call notification rule properties: attributes: - $ref: '#/components/schemas/OnCallNotificationRuleAttributes' + $ref: "#/components/schemas/OnCallNotificationRuleAttributes" id: description: Unique identifier for the rule type: string relationships: - $ref: '#/components/schemas/OnCallNotificationRuleRelationships' + $ref: "#/components/schemas/OnCallNotificationRuleRelationships" type: - $ref: '#/components/schemas/OnCallNotificationRuleType' + $ref: "#/components/schemas/OnCallNotificationRuleType" required: - - type + - type type: object OnCallNotificationRuleRelationships: description: Relationship object for creating a notification rule properties: channel: - $ref: '#/components/schemas/OnCallNotificationRuleChannelRelationship' + $ref: "#/components/schemas/OnCallNotificationRuleChannelRelationship" type: object OnCallNotificationRuleRequestAttributes: description: Attributes for creating or modifying an on-call notification rule. properties: category: - $ref: '#/components/schemas/OnCallNotificationRuleCategory' + $ref: "#/components/schemas/OnCallNotificationRuleCategory" channel_settings: - $ref: '#/components/schemas/OnCallNotificationRuleChannelSettings' + $ref: "#/components/schemas/OnCallNotificationRuleChannelSettings" description: Configuration for the associated channel, if necessary nullable: true delay_minutes: - description: The number of minutes that will elapse before this rule is - evaluated. 0 indicates immediate evaluation + description: The number of minutes that will elapse before this rule is evaluated. 0 indicates immediate evaluation format: int64 type: integer type: object OnCallNotificationRuleType: default: notification_rules - description: Indicates that the resource is of type 'notification_rules'. + description: "Indicates that the resource is of type 'notification_rules'." enum: - - notification_rules + - notification_rules example: notification_rules type: string x-enum-varnames: - - NOTIFICATION_RULES + - NOTIFICATION_RULES OnCallNotificationRulesIncluded: - description: Represents additional included resources for a on-call notification - rules + description: Represents additional included resources for a on-call notification rules oneOf: - - $ref: '#/components/schemas/NotificationChannelData' + - $ref: "#/components/schemas/NotificationChannelData" OnCallPageTargetType: description: The kind of target, `team_id` | `team_handle` | `user_id`. enum: - - team_id - - team_handle - - user_id + - team_id + - team_handle + - user_id example: team_id type: string x-enum-varnames: - - TEAM_ID - - TEAM_HANDLE - - USER_ID + - TEAM_ID + - TEAM_HANDLE + - USER_ID OnCallPhoneNotificationRuleMethod: - description: Specifies the method in which a phone is used in a notification - rule + description: "Specifies the method in which a phone is used in a notification rule" enum: - - sms - - voice + - sms + - voice example: sms type: string x-enum-varnames: - - SMS - - VOICE + - SMS + - VOICE OnCallPhoneNotificationRuleSettings: - description: Configuration for using a phone notification channel in a notification - rule + description: "Configuration for using a phone notification channel in a notification rule" properties: method: - $ref: '#/components/schemas/OnCallPhoneNotificationRuleMethod' + $ref: "#/components/schemas/OnCallPhoneNotificationRuleMethod" type: - $ref: '#/components/schemas/NotificationChannelPhoneConfigType' + $ref: "#/components/schemas/NotificationChannelPhoneConfigType" required: - - type - - method + - type + - method type: object OnCallTrigger: - description: Trigger a workflow from an On-Call Page or On-Call Handover. For - automatic triggering a handle must be configured and the workflow must be - published. + description: "Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published." properties: rateLimit: - $ref: '#/components/schemas/TriggerRateLimit' + $ref: "#/components/schemas/TriggerRateLimit" type: object OnCallTriggerWrapper: - description: Schema for an On-Call-based trigger. + description: "Schema for an On-Call-based trigger." properties: onCallTrigger: - $ref: '#/components/schemas/OnCallTrigger' + $ref: "#/components/schemas/OnCallTrigger" startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - onCallTrigger + - onCallTrigger type: object OnDemandConcurrencyCap: description: On-demand concurrency cap. properties: attributes: - $ref: '#/components/schemas/OnDemandConcurrencyCapAttributes' + $ref: "#/components/schemas/OnDemandConcurrencyCapAttributes" type: - $ref: '#/components/schemas/OnDemandConcurrencyCapType' + $ref: "#/components/schemas/OnDemandConcurrencyCapType" type: object OnDemandConcurrencyCapAttributes: description: On-demand concurrency cap attributes. @@ -47607,36 +45201,36 @@ components: description: On-demand concurrency cap response. properties: data: - $ref: '#/components/schemas/OnDemandConcurrencyCap' + $ref: "#/components/schemas/OnDemandConcurrencyCap" type: object OnDemandConcurrencyCapType: description: On-demand concurrency cap type. enum: - - on_demand_concurrency_cap + - on_demand_concurrency_cap type: string x-enum-varnames: - - ON_DEMAND_CONCURRENCY_CAP + - ON_DEMAND_CONCURRENCY_CAP OpenAIAPIKey: description: The definition of the `OpenAIAPIKey` object. properties: api_token: description: The `OpenAIAPIKey` `api_token`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/OpenAIAPIKeyType' + $ref: "#/components/schemas/OpenAIAPIKeyType" required: - - type - - api_token + - type + - api_token type: object OpenAIAPIKeyType: description: The definition of the `OpenAIAPIKey` object. enum: - - OpenAIAPIKey + - OpenAIAPIKey example: OpenAIAPIKey type: string x-enum-varnames: - - OPENAIAPIKEY + - OPENAIAPIKEY OpenAIAPIKeyUpdate: description: The definition of the `OpenAIAPIKey` object. properties: @@ -47644,46 +45238,46 @@ components: description: The `OpenAIAPIKeyUpdate` `api_token`. type: string type: - $ref: '#/components/schemas/OpenAIAPIKeyType' + $ref: "#/components/schemas/OpenAIAPIKeyType" required: - - type + - type type: object OpenAICredentials: description: The definition of the `OpenAICredentials` object. oneOf: - - $ref: '#/components/schemas/OpenAIAPIKey' + - $ref: "#/components/schemas/OpenAIAPIKey" OpenAICredentialsUpdate: description: The definition of the `OpenAICredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/OpenAIAPIKeyUpdate' + - $ref: "#/components/schemas/OpenAIAPIKeyUpdate" OpenAIIntegration: description: The definition of the `OpenAIIntegration` object. properties: credentials: - $ref: '#/components/schemas/OpenAICredentials' + $ref: "#/components/schemas/OpenAICredentials" type: - $ref: '#/components/schemas/OpenAIIntegrationType' + $ref: "#/components/schemas/OpenAIIntegrationType" required: - - type - - credentials + - type + - credentials type: object OpenAIIntegrationType: description: The definition of the `OpenAIIntegrationType` object. enum: - - OpenAI + - OpenAI example: OpenAI type: string x-enum-varnames: - - OPENAI + - OPENAI OpenAIIntegrationUpdate: description: The definition of the `OpenAIIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/OpenAICredentialsUpdate' + $ref: "#/components/schemas/OpenAICredentialsUpdate" type: - $ref: '#/components/schemas/OpenAIIntegrationType' + $ref: "#/components/schemas/OpenAIIntegrationType" required: - - type + - type type: object OpenAPIEndpoint: description: Endpoint info extracted from an `OpenAPI` specification. @@ -47708,220 +45302,199 @@ components: properties: custom_url: description: The custom URL for a custom region. - example: https://example.com + example: "https://example.com" type: string name: description: The name for the Opsgenie service. - example: fake-opsgenie-service-name + example: "fake-opsgenie-service-name" maxLength: 100 type: string opsgenie_api_key: description: The Opsgenie API key for your Opsgenie service. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string region: - $ref: '#/components/schemas/OpsgenieServiceRegionType' + $ref: "#/components/schemas/OpsgenieServiceRegionType" required: - - name - - opsgenie_api_key - - region + - name + - opsgenie_api_key + - region type: object OpsgenieServiceCreateData: description: Opsgenie service data for a create request. properties: attributes: - $ref: '#/components/schemas/OpsgenieServiceCreateAttributes' + $ref: "#/components/schemas/OpsgenieServiceCreateAttributes" type: - $ref: '#/components/schemas/OpsgenieServiceType' + $ref: "#/components/schemas/OpsgenieServiceType" required: - - type - - attributes + - type + - attributes type: object OpsgenieServiceCreateRequest: description: Create request for an Opsgenie service. properties: data: - $ref: '#/components/schemas/OpsgenieServiceCreateData' + $ref: "#/components/schemas/OpsgenieServiceCreateData" required: - - data + - data type: object OpsgenieServiceRegionType: description: The region for the Opsgenie service. enum: - - us - - eu - - custom - example: us + - us + - eu + - custom + example: "us" type: string x-enum-varnames: - - US - - EU - - CUSTOM + - US + - EU + - CUSTOM OpsgenieServiceResponse: description: Response of an Opsgenie service. properties: data: - $ref: '#/components/schemas/OpsgenieServiceResponseData' + $ref: "#/components/schemas/OpsgenieServiceResponseData" required: - - data + - data type: object OpsgenieServiceResponseAttributes: description: The attributes from an Opsgenie service response. properties: custom_url: description: The custom URL for a custom region. - example: null + example: nullable: true type: string name: description: The name for the Opsgenie service. - example: fake-opsgenie-service-name + example: "fake-opsgenie-service-name" maxLength: 100 type: string region: - $ref: '#/components/schemas/OpsgenieServiceRegionType' + $ref: "#/components/schemas/OpsgenieServiceRegionType" type: object OpsgenieServiceResponseData: description: Opsgenie service data from a response. properties: attributes: - $ref: '#/components/schemas/OpsgenieServiceResponseAttributes' + $ref: "#/components/schemas/OpsgenieServiceResponseAttributes" id: description: The ID of the Opsgenie service. - example: 596da4af-0563-4097-90ff-07230c3f9db3 + example: "596da4af-0563-4097-90ff-07230c3f9db3" maxLength: 100 minLength: 1 type: string type: - $ref: '#/components/schemas/OpsgenieServiceType' + $ref: "#/components/schemas/OpsgenieServiceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object OpsgenieServiceType: default: opsgenie-service description: Opsgenie service resource type. enum: - - opsgenie-service + - opsgenie-service example: opsgenie-service type: string x-enum-varnames: - - OPSGENIE_SERVICE + - OPSGENIE_SERVICE OpsgenieServiceUpdateAttributes: description: The Opsgenie service attributes for an update request. properties: custom_url: description: The custom URL for a custom region. - example: https://example.com + example: "https://example.com" nullable: true type: string name: description: The name for the Opsgenie service. - example: fake-opsgenie-service-name + example: "fake-opsgenie-service-name" maxLength: 100 type: string opsgenie_api_key: description: The Opsgenie API key for your Opsgenie service. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string region: - $ref: '#/components/schemas/OpsgenieServiceRegionType' + $ref: "#/components/schemas/OpsgenieServiceRegionType" type: object OpsgenieServiceUpdateData: description: Opsgenie service for an update request. properties: attributes: - $ref: '#/components/schemas/OpsgenieServiceUpdateAttributes' + $ref: "#/components/schemas/OpsgenieServiceUpdateAttributes" id: description: The ID of the Opsgenie service. - example: 596da4af-0563-4097-90ff-07230c3f9db3 + example: "596da4af-0563-4097-90ff-07230c3f9db3" maxLength: 100 minLength: 1 type: string type: - $ref: '#/components/schemas/OpsgenieServiceType' + $ref: "#/components/schemas/OpsgenieServiceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object OpsgenieServiceUpdateRequest: description: Update request for an Opsgenie service. properties: data: - $ref: '#/components/schemas/OpsgenieServiceUpdateData' + $ref: "#/components/schemas/OpsgenieServiceUpdateData" required: - - data + - data type: object OpsgenieServicesResponse: description: Response with a list of Opsgenie services. properties: data: description: An array of Opsgenie services. - example: - - attributes: - custom_url: null - name: fake-opsgenie-service-name - region: us - id: 596da4af-0563-4097-90ff-07230c3f9db3 - type: opsgenie-service - - attributes: - custom_url: null - name: fake-opsgenie-service-name-2 - region: eu - id: 0d2937f1-b561-44fa-914a-99910f848014 - type: opsgenie-service + example: [{"attributes": {"custom_url": null, "name": "fake-opsgenie-service-name", "region": "us"}, "id": "596da4af-0563-4097-90ff-07230c3f9db3", "type": "opsgenie-service"}, {"attributes": {"custom_url": null, "name": "fake-opsgenie-service-name-2", "region": "eu"}, "id": "0d2937f1-b561-44fa-914a-99910f848014", "type": "opsgenie-service"}] items: - $ref: '#/components/schemas/OpsgenieServiceResponseData' + $ref: "#/components/schemas/OpsgenieServiceResponseData" type: array required: - - data + - data type: object OrderDirection: description: The sort direction for results. enum: - - asc - - desc + - asc + - desc example: asc type: string x-enum-varnames: - - ASC - - DESC + - ASC + - DESC OrgConfigGetResponse: description: A response with a single Org Config. properties: - data: - $ref: '#/components/schemas/OrgConfigRead' - required: - - data + data: {$ref: "#/components/schemas/OrgConfigRead"} + required: [data] type: object OrgConfigListResponse: description: A response with multiple Org Configs. properties: data: description: An array of Org Configs. - items: - $ref: '#/components/schemas/OrgConfigRead' + items: {$ref: "#/components/schemas/OrgConfigRead"} type: array - required: - - data + required: [data] type: object OrgConfigRead: description: A single Org Config. properties: - attributes: - $ref: '#/components/schemas/OrgConfigReadAttributes' + attributes: {$ref: "#/components/schemas/OrgConfigReadAttributes"} id: description: A unique identifier for an Org Config. example: abcd1234 type: string - type: - $ref: '#/components/schemas/OrgConfigType' - required: - - id - - type - - attributes + type: {$ref: "#/components/schemas/OrgConfigType"} + required: [id, type, attributes] type: object OrgConfigReadAttributes: description: Readable attributes of an Org Config. @@ -47945,130 +45518,103 @@ components: description: The type of an Org Config value. example: bool type: string - required: - - name - - description - - value_type - - value + required: [name, description, value_type, value] type: object OrgConfigType: description: Data type of an Org Config. - enum: - - org_configs + enum: [org_configs] example: org_configs type: string x-enum-varnames: - - ORG_CONFIGS + - ORG_CONFIGS OrgConfigWrite: description: An Org Config write operation. properties: - attributes: - $ref: '#/components/schemas/OrgConfigWriteAttributes' - type: - $ref: '#/components/schemas/OrgConfigType' - required: - - type - - attributes + attributes: {$ref: "#/components/schemas/OrgConfigWriteAttributes"} + type: {$ref: "#/components/schemas/OrgConfigType"} + required: [type, attributes] type: object OrgConfigWriteAttributes: description: Writable attributes of an Org Config. properties: value: description: The value of an Org Config. - required: - - value + required: [value] type: object OrgConfigWriteRequest: description: A request to update an Org Config. properties: - data: - $ref: '#/components/schemas/OrgConfigWrite' - required: - - data + data: {$ref: "#/components/schemas/OrgConfigWrite"} + required: [data] type: object OrgConnection: description: An org connection. properties: attributes: - $ref: '#/components/schemas/OrgConnectionAttributes' + $ref: "#/components/schemas/OrgConnectionAttributes" id: description: The unique identifier of the org connection. - example: f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a + example: "f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a" format: uuid type: string relationships: - $ref: '#/components/schemas/OrgConnectionRelationships' + $ref: "#/components/schemas/OrgConnectionRelationships" type: - $ref: '#/components/schemas/OrgConnectionType' - required: - - id - - type - - attributes - - relationships + $ref: "#/components/schemas/OrgConnectionType" + required: [id, type, attributes, relationships] type: object OrgConnectionAttributes: description: Org connection attributes. properties: connection_types: description: List of connection types. - example: - - logs - - metrics + example: ["logs", "metrics"] items: - $ref: '#/components/schemas/OrgConnectionTypeEnum' + $ref: "#/components/schemas/OrgConnectionTypeEnum" type: array created_at: description: Timestamp when the connection was created. - example: '2023-01-01T12:00:00Z' + example: "2023-01-01T12:00:00Z" format: date-time type: string - required: - - connection_types - - created_at + required: [connection_types, created_at] type: object OrgConnectionCreate: description: Org connection creation data. properties: attributes: - $ref: '#/components/schemas/OrgConnectionCreateAttributes' + $ref: "#/components/schemas/OrgConnectionCreateAttributes" relationships: - $ref: '#/components/schemas/OrgConnectionCreateRelationships' + $ref: "#/components/schemas/OrgConnectionCreateRelationships" type: - $ref: '#/components/schemas/OrgConnectionType' - required: - - type - - attributes - - relationships + $ref: "#/components/schemas/OrgConnectionType" + required: [type, attributes, relationships] type: object OrgConnectionCreateAttributes: description: Attributes for creating an org connection. properties: connection_types: description: List of connection types to establish. - example: - - logs + example: ["logs"] items: - $ref: '#/components/schemas/OrgConnectionTypeEnum' + $ref: "#/components/schemas/OrgConnectionTypeEnum" minItems: 1 type: array - required: - - connection_types + required: [connection_types] type: object OrgConnectionCreateRelationships: description: Relationships for org connection creation. properties: sink_org: - $ref: '#/components/schemas/OrgConnectionOrgRelationship' - required: - - sink_org + $ref: "#/components/schemas/OrgConnectionOrgRelationship" + required: [sink_org] type: object OrgConnectionCreateRequest: description: Request to create an org connection. properties: data: - $ref: '#/components/schemas/OrgConnectionCreate' - required: - - data + $ref: "#/components/schemas/OrgConnectionCreate" + required: [data] type: object OrgConnectionListResponse: description: Response containing a list of org connections. @@ -48076,18 +45622,17 @@ components: data: description: List of org connections. items: - $ref: '#/components/schemas/OrgConnection' + $ref: "#/components/schemas/OrgConnection" type: array meta: - $ref: '#/components/schemas/OrgConnectionListResponseMeta' - required: - - data + $ref: "#/components/schemas/OrgConnectionListResponseMeta" + required: [data] type: object OrgConnectionListResponseMeta: description: Pagination metadata. properties: page: - $ref: '#/components/schemas/OrgConnectionListResponseMetaPage' + $ref: "#/components/schemas/OrgConnectionListResponseMetaPage" type: object OrgConnectionListResponseMetaPage: description: Page information. @@ -48107,146 +45652,135 @@ components: description: Org relationship. properties: data: - $ref: '#/components/schemas/OrgConnectionOrgRelationshipData' + $ref: "#/components/schemas/OrgConnectionOrgRelationshipData" type: object OrgConnectionOrgRelationshipData: description: The definition of `OrgConnectionOrgRelationshipData` object. properties: id: description: Org UUID. - example: f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a + example: "f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a" type: string name: description: Org name. - example: Example Org + example: "Example Org" type: string type: - $ref: '#/components/schemas/OrgConnectionOrgRelationshipDataType' + $ref: "#/components/schemas/OrgConnectionOrgRelationshipDataType" type: object OrgConnectionOrgRelationshipDataType: description: The type of the organization relationship. - enum: - - orgs - example: orgs + enum: [orgs] + example: "orgs" type: string x-enum-varnames: - - ORGS + - ORGS OrgConnectionRelationships: description: Related organizations and user. properties: created_by: - $ref: '#/components/schemas/OrgConnectionUserRelationship' + $ref: "#/components/schemas/OrgConnectionUserRelationship" sink_org: - $ref: '#/components/schemas/OrgConnectionOrgRelationship' + $ref: "#/components/schemas/OrgConnectionOrgRelationship" source_org: - $ref: '#/components/schemas/OrgConnectionOrgRelationship' + $ref: "#/components/schemas/OrgConnectionOrgRelationship" type: object OrgConnectionResponse: description: Response containing a single org connection. properties: data: - $ref: '#/components/schemas/OrgConnection' - required: - - data + $ref: "#/components/schemas/OrgConnection" + required: [data] type: object OrgConnectionType: description: Org connection type. - enum: - - org_connection - example: org_connection + enum: [org_connection] + example: "org_connection" type: string x-enum-varnames: - - ORG_CONNECTION + - ORG_CONNECTION OrgConnectionTypeEnum: description: Available connection types between organizations. enum: - - logs - - metrics - example: logs + - logs + - metrics + example: "logs" type: string x-enum-varnames: - - LOGS - - METRICS + - LOGS + - METRICS OrgConnectionUpdate: description: Org connection update data. properties: attributes: - $ref: '#/components/schemas/OrgConnectionUpdateAttributes' + $ref: "#/components/schemas/OrgConnectionUpdateAttributes" id: description: The unique identifier of the org connection. - example: f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a + example: "f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a" format: uuid type: string type: - $ref: '#/components/schemas/OrgConnectionType' - required: - - type - - id - - attributes + $ref: "#/components/schemas/OrgConnectionType" + required: [type, id, attributes] type: object OrgConnectionUpdateAttributes: description: Attributes for updating an org connection. properties: connection_types: description: Updated list of connection types. - example: - - logs - - metrics + example: ["logs", "metrics"] items: - $ref: '#/components/schemas/OrgConnectionTypeEnum' + $ref: "#/components/schemas/OrgConnectionTypeEnum" minItems: 1 type: array - required: - - connection_types + required: [connection_types] type: object OrgConnectionUpdateRequest: description: Request to update an org connection. properties: data: - $ref: '#/components/schemas/OrgConnectionUpdate' - required: - - data + $ref: "#/components/schemas/OrgConnectionUpdate" + required: [data] type: object OrgConnectionUserRelationship: description: User relationship. properties: data: - $ref: '#/components/schemas/OrgConnectionUserRelationshipData' + $ref: "#/components/schemas/OrgConnectionUserRelationshipData" type: object OrgConnectionUserRelationshipData: description: The data for a user relationship. properties: id: description: User UUID. - example: usr123abc456 + example: "usr123abc456" type: string name: description: User name. - example: John Doe + example: "John Doe" type: string type: - $ref: '#/components/schemas/OrgConnectionUserRelationshipDataType' + $ref: "#/components/schemas/OrgConnectionUserRelationshipDataType" type: object OrgConnectionUserRelationshipDataType: description: The type of the user relationship. - enum: - - users - example: users + enum: [users] + example: "users" type: string x-enum-varnames: - - USERS + - USERS Organization: description: Organization object. properties: attributes: - $ref: '#/components/schemas/OrganizationAttributes' + $ref: "#/components/schemas/OrganizationAttributes" id: description: ID of the organization. type: string type: - $ref: '#/components/schemas/OrganizationsType' + $ref: "#/components/schemas/OrganizationsType" required: - - type + - type type: object OrganizationAttributes: description: Attributes of the organization. @@ -48282,90 +45816,89 @@ components: default: orgs description: Organizations resource type. enum: - - orgs + - orgs example: orgs type: string x-enum-varnames: - - ORGS + - ORGS OutboundEdge: description: The definition of `OutboundEdge` object. properties: branchName: description: The `OutboundEdge` `branchName`. - example: '' + example: "" type: string nextStepName: description: The `OutboundEdge` `nextStepName`. - example: '' + example: "" type: string required: - - nextStepName - - branchName + - nextStepName + - branchName type: object OutcomeType: default: outcome description: The JSON:API type for an outcome. enum: - - outcome + - outcome example: outcome type: string x-enum-varnames: - - OUTCOME + - OUTCOME OutcomesBatchAttributes: description: The JSON:API attributes for a batched set of scorecard outcomes. properties: results: description: Set of scorecard outcomes to update. items: - $ref: '#/components/schemas/OutcomesBatchRequestItem' + $ref: "#/components/schemas/OutcomesBatchRequestItem" type: array type: object OutcomesBatchRequest: description: Scorecard outcomes batch request. properties: data: - $ref: '#/components/schemas/OutcomesBatchRequestData' + $ref: "#/components/schemas/OutcomesBatchRequestData" type: object OutcomesBatchRequestData: description: Scorecard outcomes batch request data. properties: attributes: - $ref: '#/components/schemas/OutcomesBatchAttributes' + $ref: "#/components/schemas/OutcomesBatchAttributes" type: - $ref: '#/components/schemas/OutcomesBatchType' + $ref: "#/components/schemas/OutcomesBatchType" type: object OutcomesBatchRequestItem: - description: Scorecard outcome for a specific rule, for a given service within - a batched update. + description: Scorecard outcome for a specific rule, for a given service within a batched update. properties: remarks: - description: Any remarks regarding the scorecard rule's evaluation, and - supports HTML hyperlinks. + description: >- + Any remarks regarding the scorecard rule's evaluation, and supports HTML hyperlinks. example: 'See: Services' type: string rule_id: - $ref: '#/components/schemas/RuleId' + $ref: "#/components/schemas/RuleId" service_name: description: The unique name for a service in the catalog. example: my-service type: string state: - $ref: '#/components/schemas/State' + $ref: "#/components/schemas/State" required: - - rule_id - - service_name - - state + - rule_id + - service_name + - state type: object OutcomesBatchResponse: description: Scorecard outcomes batch response. properties: data: - $ref: '#/components/schemas/OutcomesBatchResponseData' + $ref: "#/components/schemas/OutcomesBatchResponseData" meta: - $ref: '#/components/schemas/OutcomesBatchResponseMeta' + $ref: "#/components/schemas/OutcomesBatchResponseMeta" required: - - data - - meta + - data + - meta type: object OutcomesBatchResponseAttributes: description: The JSON:API attributes for an outcome. @@ -48379,8 +45912,8 @@ components: format: date-time type: string remarks: - description: Any remarks regarding the scorecard rule's evaluation, and - supports HTML hyperlinks. + description: >- + Any remarks regarding the scorecard rule's evaluation, and supports HTML hyperlinks. example: 'See: Services' type: string service_name: @@ -48388,78 +45921,74 @@ components: example: my-service type: string state: - $ref: '#/components/schemas/State' + $ref: "#/components/schemas/State" type: object OutcomesBatchResponseData: description: List of rule outcomes which were affected during the bulk operation. items: - $ref: '#/components/schemas/OutcomesResponseDataItem' + $ref: "#/components/schemas/OutcomesResponseDataItem" type: array OutcomesBatchResponseMeta: description: Metadata pertaining to the bulk operation. properties: total_received: - description: Total number of scorecard results received during the bulk - operation. + description: Total number of scorecard results received during the bulk operation. format: int64 type: integer total_updated: - description: Total number of scorecard results modified during the bulk - operation. + description: Total number of scorecard results modified during the bulk operation. format: int64 type: integer type: object OutcomesBatchType: default: batched-outcome description: The JSON:API type for scorecard outcomes. - enum: - - batched-outcome + enum: [batched-outcome] example: batched-outcome type: string - x-enum-varnames: - - BATCHED_OUTCOME + x-enum-varnames: [BATCHED_OUTCOME] OutcomesResponse: description: Scorecard outcomes - the result of a rule for a service. properties: data: - $ref: '#/components/schemas/OutcomesResponseData' + $ref: "#/components/schemas/OutcomesResponseData" included: - $ref: '#/components/schemas/OutcomesResponseIncluded' + $ref: "#/components/schemas/OutcomesResponseIncluded" links: - $ref: '#/components/schemas/OutcomesResponseLinks' + $ref: "#/components/schemas/OutcomesResponseLinks" type: object OutcomesResponseData: description: List of rule outcomes. items: - $ref: '#/components/schemas/OutcomesResponseDataItem' + $ref: "#/components/schemas/OutcomesResponseDataItem" type: array OutcomesResponseDataItem: description: A single rule outcome. properties: attributes: - $ref: '#/components/schemas/OutcomesBatchResponseAttributes' + $ref: "#/components/schemas/OutcomesBatchResponseAttributes" id: description: The unique ID for a rule outcome. type: string relationships: - $ref: '#/components/schemas/RuleOutcomeRelationships' + $ref: "#/components/schemas/RuleOutcomeRelationships" type: - $ref: '#/components/schemas/OutcomeType' + $ref: "#/components/schemas/OutcomeType" type: object OutcomesResponseIncluded: description: Array of rule details. items: - $ref: '#/components/schemas/OutcomesResponseIncludedItem' + $ref: "#/components/schemas/OutcomesResponseIncludedItem" type: array OutcomesResponseIncludedItem: description: Attributes of the included rule. properties: attributes: - $ref: '#/components/schemas/OutcomesResponseIncludedRuleAttributes' + $ref: "#/components/schemas/OutcomesResponseIncludedRuleAttributes" id: - $ref: '#/components/schemas/RuleId' + $ref: "#/components/schemas/RuleId" type: - $ref: '#/components/schemas/RuleType' + $ref: "#/components/schemas/RuleType" type: object OutcomesResponseIncludedRuleAttributes: description: Details of a rule. @@ -48477,17 +46006,18 @@ components: description: Links attributes. properties: next: - description: Link for the next set of results. - example: /api/v2/scorecard/outcomes?include=rule&page%5Blimit%5D=100&page%5Boffset%5D=100 + description: |- + Link for the next set of results. + example: "/api/v2/scorecard/outcomes?include=rule&page%5Blimit%5D=100&page%5Boffset%5D=100" type: string type: object OutputSchema: - description: A list of output parameters for the workflow. + description: "A list of output parameters for the workflow." properties: parameters: description: The `OutputSchema` `parameters`. items: - $ref: '#/components/schemas/OutputSchemaParameters' + $ref: "#/components/schemas/OutputSchemaParameters" type: array type: object OutputSchemaParameters: @@ -48503,49 +46033,49 @@ components: type: string name: description: The `OutputSchemaParameters` `name`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/OutputSchemaParametersType' + $ref: "#/components/schemas/OutputSchemaParametersType" value: description: The `OutputSchemaParameters` `value`. required: - - name - - type + - name + - type type: object OutputSchemaParametersType: description: The definition of `OutputSchemaParametersType` object. enum: - - STRING - - NUMBER - - BOOLEAN - - OBJECT - - ARRAY_STRING - - ARRAY_NUMBER - - ARRAY_BOOLEAN - - ARRAY_OBJECT + - STRING + - NUMBER + - BOOLEAN + - OBJECT + - ARRAY_STRING + - ARRAY_NUMBER + - ARRAY_BOOLEAN + - ARRAY_OBJECT example: STRING type: string x-enum-varnames: - - STRING - - NUMBER - - BOOLEAN - - OBJECT - - ARRAY_STRING - - ARRAY_NUMBER - - ARRAY_BOOLEAN - - ARRAY_OBJECT + - STRING + - NUMBER + - BOOLEAN + - OBJECT + - ARRAY_STRING + - ARRAY_NUMBER + - ARRAY_BOOLEAN + - ARRAY_OBJECT PageUrgency: default: high description: On-Call Page urgency level. enum: - - low - - high + - low + - high example: high type: string x-enum-varnames: - - LOW - - HIGH + - LOW + - HIGH Pagination: description: Pagination object. properties: @@ -48562,7 +46092,7 @@ components: description: Response metadata. properties: page: - $ref: '#/components/schemas/PaginationMetaPage' + $ref: "#/components/schemas/PaginationMetaPage" readOnly: true type: object PaginationMetaPage: @@ -48578,8 +46108,7 @@ components: type: offset_limit properties: first_offset: - description: Integer representing the offset to fetch the first page of - results. + description: Integer representing the offset to fetch the first page of results. example: 0 format: int64 type: integer @@ -48590,27 +46119,24 @@ components: nullable: true type: integer limit: - description: Integer representing the number of elements to be returned - in the results. + description: Integer representing the number of elements to be returned in the results. example: 100 format: int64 type: integer next_offset: - description: Integer representing the index of the first element in the - next page of results. Equal to page size added to the current offset. + description: >- + Integer representing the index of the first element in the next page of results. Equal to page size added to the current offset. example: 100 format: int64 nullable: true type: integer offset: - description: Integer representing the index of the first element in the - results. + description: Integer representing the index of the first element in the results. example: 0 format: int64 type: integer prev_offset: - description: Integer representing the index of the first element in the - previous page of results. + description: Integer representing the index of the first element in the previous page of results. example: 100 format: int64 nullable: true @@ -48622,41 +46148,41 @@ components: nullable: true type: integer type: - $ref: '#/components/schemas/PaginationMetaPageType' + $ref: "#/components/schemas/PaginationMetaPageType" type: object PaginationMetaPageType: default: offset_limit enum: - - offset_limit + - offset_limit example: offset_limit type: string x-enum-varnames: - - OFFSET_LIMIT + - OFFSET_LIMIT Parameter: description: The definition of `Parameter` object. properties: name: description: The `Parameter` `name`. - example: '' + example: "" type: string value: description: The `Parameter` `value`. required: - - name - - value + - name + - value type: object PartialAPIKey: description: Partial Datadog API key. properties: attributes: - $ref: '#/components/schemas/PartialAPIKeyAttributes' + $ref: "#/components/schemas/PartialAPIKeyAttributes" id: description: ID of the API key. type: string relationships: - $ref: '#/components/schemas/APIKeyRelationships' + $ref: "#/components/schemas/APIKeyRelationships" type: - $ref: '#/components/schemas/APIKeysType' + $ref: "#/components/schemas/APIKeysType" type: object PartialAPIKeyAttributes: description: Attributes of a partial API key. @@ -48666,31 +46192,31 @@ components: type: string created_at: description: Creation date of the API key. - example: '2020-11-23T10:00:00.000Z' + example: "2020-11-23T10:00:00.000Z" readOnly: true type: string date_last_used: description: Date the API Key was last used. - example: '2020-11-27T10:00:00.000Z' + example: "2020-11-27T10:00:00.000Z" format: date-time nullable: true readOnly: true type: string last4: description: The last four characters of the API key. - example: abcd + example: "abcd" maxLength: 4 minLength: 4 readOnly: true type: string modified_at: description: Date the API key was last modified. - example: '2020-11-23T10:00:00.000Z' + example: "2020-11-23T10:00:00.000Z" readOnly: true type: string name: description: Name of the API key. - example: API Key for submitting metrics + example: "API Key for submitting metrics" type: string remote_config_read_enabled: description: The remote config read enabled status. @@ -48700,46 +46226,43 @@ components: description: Partial Datadog application key. properties: attributes: - $ref: '#/components/schemas/PartialApplicationKeyAttributes' + $ref: "#/components/schemas/PartialApplicationKeyAttributes" id: description: ID of the application key. type: string relationships: - $ref: '#/components/schemas/ApplicationKeyRelationships' + $ref: "#/components/schemas/ApplicationKeyRelationships" type: - $ref: '#/components/schemas/ApplicationKeysType' + $ref: "#/components/schemas/ApplicationKeysType" type: object PartialApplicationKeyAttributes: description: Attributes of a partial application key. properties: created_at: description: Creation date of the application key. - example: '2020-11-23T10:00:00.000Z' + example: "2020-11-23T10:00:00.000Z" readOnly: true type: string last4: description: The last four characters of the application key. - example: abcd + example: "abcd" maxLength: 4 minLength: 4 readOnly: true type: string last_used_at: description: Last usage timestamp of the application key. - example: '2020-12-20T10:00:00.000Z' + example: "2020-12-20T10:00:00.000Z" nullable: true readOnly: true type: string name: description: Name of the application key. - example: Application Key for managing dashboards + example: "Application Key for managing dashboards" type: string scopes: description: Array of scopes to grant the application key. - example: - - dashboards_read - - dashboards_write - - dashboards_public_share + example: ["dashboards_read", "dashboards_write", "dashboards_public_share"] items: description: Name of scope. type: string @@ -48750,38 +46273,38 @@ components: description: Response for retrieving a partial application key. properties: data: - $ref: '#/components/schemas/PartialApplicationKey' + $ref: "#/components/schemas/PartialApplicationKey" included: description: Array of objects related to the application key. items: - $ref: '#/components/schemas/ApplicationKeyResponseIncludedItem' + $ref: "#/components/schemas/ApplicationKeyResponseIncludedItem" type: array type: object PatchAttachmentRequest: description: Request to update an attachment. properties: data: - $ref: '#/components/schemas/PatchAttachmentRequestData' + $ref: "#/components/schemas/PatchAttachmentRequestData" type: object PatchAttachmentRequestData: description: Attachment data for an update request. properties: attributes: - $ref: '#/components/schemas/PatchAttachmentRequestDataAttributes' + $ref: "#/components/schemas/PatchAttachmentRequestDataAttributes" id: description: The unique identifier of the attachment. - example: 00000000-abcd-0002-0000-000000000000 + example: "00000000-abcd-0002-0000-000000000000" type: string type: - $ref: '#/components/schemas/IncidentAttachmentType' + $ref: "#/components/schemas/IncidentAttachmentType" required: - - type + - type type: object PatchAttachmentRequestDataAttributes: description: The attributes for updating an attachment. properties: attachment: - $ref: '#/components/schemas/PatchAttachmentRequestDataAttributesAttachment' + $ref: "#/components/schemas/PatchAttachmentRequestDataAttributesAttachment" type: object PatchAttachmentRequestDataAttributesAttachment: description: The updated attachment object. @@ -48805,23 +46328,23 @@ components: type: components properties: data: - $ref: '#/components/schemas/PatchComponentRequestData' + $ref: "#/components/schemas/PatchComponentRequestData" type: object PatchComponentRequestData: properties: attributes: - $ref: '#/components/schemas/PatchComponentRequestDataAttributes' + $ref: "#/components/schemas/PatchComponentRequestDataAttributes" id: description: The ID of the component. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string type: - $ref: '#/components/schemas/StatusPagesComponentGroupType' + $ref: "#/components/schemas/StatusPagesComponentGroupType" required: - - attributes - - id - - type + - attributes + - id + - type type: object PatchComponentRequestDataAttributes: description: The supported attributes for updating a component. @@ -48831,8 +46354,7 @@ components: example: Web App type: string position: - description: The position of the component. If the component belongs to - a group, the position is relative to the other components in the group. + description: The position of the component. If the component belongs to a group, the position is relative to the other components in the group. example: 1 format: int64 type: integer @@ -48842,32 +46364,31 @@ components: data: attributes: components_affected: - - id: 1234abcd-12ab-34cd-56ef-123456abcdef - status: operational - description: We've deployed a fix and latency has returned to normal. - This issue has been resolved. + - id: 1234abcd-12ab-34cd-56ef-123456abcdef + status: operational + description: We've deployed a fix and latency has returned to normal. This issue has been resolved. status: resolved id: 1234abcd-12ab-34cd-56ef-123456abcdef type: degradations properties: data: - $ref: '#/components/schemas/PatchDegradationRequestData' + $ref: "#/components/schemas/PatchDegradationRequestData" type: object PatchDegradationRequestData: properties: attributes: - $ref: '#/components/schemas/PatchDegradationRequestDataAttributes' + $ref: "#/components/schemas/PatchDegradationRequestDataAttributes" id: description: The ID of the degradation. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string type: - $ref: '#/components/schemas/PatchDegradationRequestDataType' + $ref: "#/components/schemas/PatchDegradationRequestDataType" required: - - attributes - - id - - type + - attributes + - id + - type type: object PatchDegradationRequestDataAttributes: description: The supported attributes for updating a degradation. @@ -48875,18 +46396,17 @@ components: components_affected: description: The components affected by the degradation. example: - - id: 1234abcd-12ab-34cd-56ef-123456abcdef - status: operational + - id: 1234abcd-12ab-34cd-56ef-123456abcdef + status: operational items: - $ref: '#/components/schemas/PatchDegradationRequestDataAttributesComponentsAffectedItems' + $ref: "#/components/schemas/PatchDegradationRequestDataAttributesComponentsAffectedItems" type: array description: description: The description of the degradation. - example: We've deployed a fix and latency has returned to normal. This issue - has been resolved. + example: We've deployed a fix and latency has returned to normal. This issue has been resolved. type: string status: - $ref: '#/components/schemas/PatchDegradationRequestDataAttributesStatus' + $ref: "#/components/schemas/PatchDegradationRequestDataAttributesStatus" example: resolved title: description: The title of the degradation. @@ -48897,80 +46417,78 @@ components: properties: id: description: The ID of the component. Must be a component of type `component`. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string name: readOnly: true type: string status: - $ref: '#/components/schemas/StatusPagesComponentDataAttributesStatus' + $ref: "#/components/schemas/StatusPagesComponentDataAttributesStatus" required: - - id - - status + - id + - status type: object PatchDegradationRequestDataAttributesStatus: description: The status of the degradation. enum: - - investigating - - identified - - monitoring - - resolved + - investigating + - identified + - monitoring + - resolved type: string x-enum-varnames: - - INVESTIGATING - - IDENTIFIED - - MONITORING - - RESOLVED + - INVESTIGATING + - IDENTIFIED + - MONITORING + - RESOLVED PatchDegradationRequestDataType: default: degradations description: Degradations resource type. enum: - - degradations + - degradations example: degradations type: string x-enum-varnames: - - DEGRADATIONS + - DEGRADATIONS PatchIncidentNotificationTemplateRequest: description: Update request for a notification template. properties: data: - $ref: '#/components/schemas/IncidentNotificationTemplateUpdateData' + $ref: "#/components/schemas/IncidentNotificationTemplateUpdateData" required: - - data + - data type: object PatchMaintenanceRequest: example: data: attributes: - completed_date: '2026-02-18T20:01:13.332360075Z' - in_progress_description: We are currently performing maintenance on the - API to improve performance for 40 minutes. - scheduled_description: We will be performing maintenance on the API to - improve performance for 40 minutes. - start_date: '2026-02-18T19:21:13.332360075Z' + completed_date: "2026-02-18T20:01:13.332360075Z" + in_progress_description: We are currently performing maintenance on the API to improve performance for 40 minutes. + scheduled_description: We will be performing maintenance on the API to improve performance for 40 minutes. + start_date: "2026-02-18T19:21:13.332360075Z" title: API Maintenance id: 1234abcd-12ab-34cd-56ef-123456abcdef type: maintenances properties: data: - $ref: '#/components/schemas/PatchMaintenanceRequestData' + $ref: "#/components/schemas/PatchMaintenanceRequestData" type: object PatchMaintenanceRequestData: properties: attributes: - $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributes' + $ref: "#/components/schemas/PatchMaintenanceRequestDataAttributes" id: description: The ID of the maintenance. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string type: - $ref: '#/components/schemas/PatchMaintenanceRequestDataType' + $ref: "#/components/schemas/PatchMaintenanceRequestDataType" required: - - attributes - - type - - id + - attributes + - type + - id type: object PatchMaintenanceRequestDataAttributes: description: The supported attributes for updating a maintenance. @@ -48985,7 +46503,7 @@ components: components_affected: description: The components affected by the maintenance. items: - $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItems' + $ref: "#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItems" type: array in_progress_description: description: The description shown while the maintenance is in progress. @@ -48998,7 +46516,7 @@ components: format: date-time type: string status: - $ref: '#/components/schemas/MaintenanceDataAttributesStatus' + $ref: "#/components/schemas/MaintenanceDataAttributesStatus" description: The status of the maintenance. title: description: The title of the maintenance. @@ -49008,7 +46526,7 @@ components: properties: id: description: The ID of the component. Must be a component of type `component`. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string name: @@ -49016,67 +46534,67 @@ components: readOnly: true type: string status: - $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus' + $ref: "#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus" required: - - id - - status + - id + - status type: object PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus: description: The status of the component. enum: - - operational - - maintenance + - operational + - maintenance example: operational type: string x-enum-varnames: - - OPERATIONAL - - MAINTENANCE + - OPERATIONAL + - MAINTENANCE PatchMaintenanceRequestDataType: default: maintenances description: Maintenances resource type. enum: - - maintenances + - maintenances example: maintenances type: string x-enum-varnames: - - MAINTENANCES + - MAINTENANCES PatchNotificationRuleParameters: description: Body of the notification rule patch request. properties: data: - $ref: '#/components/schemas/PatchNotificationRuleParametersData' + $ref: "#/components/schemas/PatchNotificationRuleParametersData" type: object PatchNotificationRuleParametersData: - description: 'Data of the notification rule patch request: the rule ID, the - rule type, and the rule attributes. All fields are required.' + description: |- + Data of the notification rule patch request: the rule ID, the rule type, and the rule attributes. All fields are required. properties: attributes: - $ref: '#/components/schemas/PatchNotificationRuleParametersDataAttributes' + $ref: "#/components/schemas/PatchNotificationRuleParametersDataAttributes" id: - $ref: '#/components/schemas/ID' + $ref: "#/components/schemas/ID" type: - $ref: '#/components/schemas/NotificationRulesType' + $ref: "#/components/schemas/NotificationRulesType" required: - - attributes - - id - - type + - attributes + - id + - type type: object PatchNotificationRuleParametersDataAttributes: - description: Attributes of the notification rule patch request. It is required - to update the version of the rule when patching it. + description: |- + Attributes of the notification rule patch request. It is required to update the version of the rule when patching it. properties: enabled: - $ref: '#/components/schemas/Enabled' + $ref: "#/components/schemas/Enabled" name: - $ref: '#/components/schemas/RuleName' + $ref: "#/components/schemas/RuleName" selectors: - $ref: '#/components/schemas/Selectors' + $ref: "#/components/schemas/Selectors" targets: - $ref: '#/components/schemas/Targets' + $ref: "#/components/schemas/Targets" time_aggregation: - $ref: '#/components/schemas/TimeAggregation' + $ref: "#/components/schemas/TimeAggregation" version: - $ref: '#/components/schemas/Version' + $ref: "#/components/schemas/Version" type: object PatchStatusPageRequest: example: @@ -49095,23 +46613,23 @@ components: type: status_pages properties: data: - $ref: '#/components/schemas/PatchStatusPageRequestData' + $ref: "#/components/schemas/PatchStatusPageRequestData" type: object PatchStatusPageRequestData: properties: attributes: - $ref: '#/components/schemas/PatchStatusPageRequestDataAttributes' + $ref: "#/components/schemas/PatchStatusPageRequestDataAttributes" id: description: The ID of the status page. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string type: - $ref: '#/components/schemas/StatusPageDataType' + $ref: "#/components/schemas/StatusPageDataType" required: - - attributes - - id - - type + - attributes + - id + - type type: object PatchStatusPageRequestDataAttributes: description: The supported attributes for updating a status page. @@ -49121,13 +46639,11 @@ components: example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAIKMMMM type: string domain_prefix: - description: The subdomain of the status page's url taking the form `https://{domain_prefix}.statuspage.datadoghq.com`. - Globally unique across Datadog Status Pages. + description: The subdomain of the status page's url taking the form `https://{domain_prefix}.statuspage.datadoghq.com`. Globally unique across Datadog Status Pages. example: status-page-us1 type: string email_header_image: - description: The base64-encoded image data displayed in email notifications - sent to status page subscribers. + description: The base64-encoded image data displayed in email notifications sent to status page subscribers. example: data:image/png;base64,pQSLAw0KGgoAAAANSUhEUgAAAQ4AASJKFF type: string enabled: @@ -49147,10 +46663,10 @@ components: example: true type: boolean type: - $ref: '#/components/schemas/CreateStatusPageRequestDataAttributesType' + $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesType" example: public visualization_type: - $ref: '#/components/schemas/CreateStatusPageRequestDataAttributesVisualizationType' + $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesVisualizationType" example: bars_and_uptime_percentage type: object PatchTableRequest: @@ -49168,65 +46684,61 @@ components: sync_enabled: true schema: fields: - - name: id - type: INT32 - - name: name - type: STRING + - name: id + type: INT32 + - name: name + type: STRING primary_keys: - - id + - id tags: - - test_tag + - test_tag type: reference_table properties: data: - $ref: '#/components/schemas/PatchTableRequestData' + $ref: "#/components/schemas/PatchTableRequestData" type: object PatchTableRequestData: additionalProperties: false description: The data object containing the partial table definition updates. properties: attributes: - $ref: '#/components/schemas/PatchTableRequestDataAttributes' + $ref: "#/components/schemas/PatchTableRequestDataAttributes" type: - $ref: '#/components/schemas/PatchTableRequestDataType' + $ref: "#/components/schemas/PatchTableRequestDataType" required: - - type + - type type: object PatchTableRequestDataAttributes: - description: Attributes that define the updates to the reference table's configuration - and properties. + description: Attributes that define the updates to the reference table's configuration and properties. properties: description: - description: Optional text describing the purpose or contents of this reference - table. - example: example description + description: Optional text describing the purpose or contents of this reference table. + example: "example description" type: string file_metadata: - $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadata' + $ref: "#/components/schemas/PatchTableRequestDataAttributesFileMetadata" schema: - $ref: '#/components/schemas/PatchTableRequestDataAttributesSchema' + $ref: "#/components/schemas/PatchTableRequestDataAttributesSchema" tags: description: Tags for organizing and filtering reference tables. example: - - tag_1 - - tag_2 + - "tag_1" + - "tag_2" items: type: string type: array type: object PatchTableRequestDataAttributesFileMetadata: - description: Metadata specifying where and how to access the reference table's - data file. + description: Metadata specifying where and how to access the reference table's data file. oneOf: - - $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataCloudStorage' - - $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataLocalFile' + - $ref: "#/components/schemas/PatchTableRequestDataAttributesFileMetadataCloudStorage" + - $ref: "#/components/schemas/PatchTableRequestDataAttributesFileMetadataLocalFile" PatchTableRequestDataAttributesFileMetadataCloudStorage: additionalProperties: false - description: Cloud storage file metadata for patch requests. Allows partial - updates of access_details and sync_enabled. + description: Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled. properties: access_details: - $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails' + $ref: "#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails" sync_enabled: description: Whether this table is synced automatically. example: false @@ -49239,149 +46751,141 @@ components: properties: upload_id: description: The upload ID. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string required: - - upload_id + - upload_id title: LocalFileMetadataV2 type: object PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails: - description: Cloud storage access configuration for the reference table data - file. + description: Cloud storage access configuration for the reference table data file. properties: aws_detail: - $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail' + $ref: "#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail" azure_detail: - $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail' + $ref: "#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail" gcp_detail: - $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail' + $ref: "#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail" type: object PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail: description: Amazon Web Services S3 storage access configuration. properties: aws_account_id: description: AWS account ID where the S3 bucket is located. - example: '123456789000' + example: "123456789000" type: string aws_bucket_name: description: S3 bucket containing the CSV file. - example: example-data-bucket + example: "example-data-bucket" type: string file_path: description: The relative file path from the S3 bucket root to the CSV file. - example: reference-tables/users.csv + example: "reference-tables/users.csv" type: string type: object x-oneOf-parent: - - AwsDetail + - AwsDetail PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail: description: Azure Blob Storage access configuration. properties: azure_client_id: - description: Azure service principal (application) client ID with permissions - to read from the container. - example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb + description: Azure service principal (application) client ID with permissions to read from the container. + example: "aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb" type: string azure_container_name: description: Azure Blob Storage container containing the CSV file. - example: reference-data + example: "reference-data" type: string azure_storage_account_name: description: Azure storage account where the container is located. - example: examplestorageaccount + example: "examplestorageaccount" type: string azure_tenant_id: description: Azure Active Directory tenant ID. - example: cccccccc-4444-5555-6666-dddddddddddd + example: "cccccccc-4444-5555-6666-dddddddddddd" type: string file_path: - description: The relative file path from the Azure container root to the - CSV file. - example: tables/users.csv + description: The relative file path from the Azure container root to the CSV file. + example: "tables/users.csv" type: string type: object x-oneOf-parent: - - AzureDetail + - AzureDetail PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail: description: Google Cloud Platform storage access configuration. properties: file_path: - description: The relative file path from the GCS bucket root to the CSV - file. - example: data/reference_tables/users.csv + description: The relative file path from the GCS bucket root to the CSV file. + example: "data/reference_tables/users.csv" type: string gcp_bucket_name: description: GCP bucket containing the CSV file. - example: example-data-bucket + example: "example-data-bucket" type: string gcp_project_id: description: GCP project ID where the bucket is located. - example: example-gcp-project-12345 + example: "example-gcp-project-12345" type: string gcp_service_account_email: description: Service account email with read permissions for the GCS bucket. - example: example-service@example-gcp-project-12345.iam.gserviceaccount.com + example: "example-service@example-gcp-project-12345.iam.gserviceaccount.com" type: string type: object x-oneOf-parent: - - GcpDetail + - GcpDetail PatchTableRequestDataAttributesSchema: - description: Schema defining the updates to the structure and columns of the - reference table. Schema fields cannot be deleted or renamed. + description: Schema defining the updates to the structure and columns of the reference table. Schema fields cannot be deleted or renamed. properties: fields: description: The schema fields. items: - $ref: '#/components/schemas/PatchTableRequestDataAttributesSchemaFieldsItems' + $ref: "#/components/schemas/PatchTableRequestDataAttributesSchemaFieldsItems" type: array primary_keys: - description: List of field names that serve as primary keys for the table. - Only one primary key is supported, and it is used as an ID to retrieve - rows. Primary keys cannot be changed after table creation. + description: List of field names that serve as primary keys for the table. Only one primary key is supported, and it is used as an ID to retrieve rows. Primary keys cannot be changed after table creation. example: - - field_1 + - "field_1" items: type: string type: array required: - - fields - - primary_keys + - fields + - primary_keys type: object PatchTableRequestDataAttributesSchemaFieldsItems: - description: A single field (column) in the reference table schema to be updated. - Schema fields cannot be deleted or renamed. + description: A single field (column) in the reference table schema to be updated. Schema fields cannot be deleted or renamed. properties: name: description: The field name. - example: field_1 + example: "field_1" type: string type: - $ref: '#/components/schemas/ReferenceTableSchemaFieldType' + $ref: "#/components/schemas/ReferenceTableSchemaFieldType" required: - - name - - type + - name + - type type: object PatchTableRequestDataType: default: reference_table description: Reference table resource type. enum: - - reference_table + - reference_table example: reference_table type: string x-enum-varnames: - - REFERENCE_TABLE + - REFERENCE_TABLE Permission: description: Permission object. properties: attributes: - $ref: '#/components/schemas/PermissionAttributes' + $ref: "#/components/schemas/PermissionAttributes" id: description: ID of the permission. type: string type: - $ref: '#/components/schemas/PermissionsType' + $ref: "#/components/schemas/PermissionsType" required: - - type + - type type: object PermissionAttributes: description: Attributes of a permission. @@ -49420,44 +46924,44 @@ components: data: description: Array of permissions. items: - $ref: '#/components/schemas/Permission' + $ref: "#/components/schemas/Permission" type: array type: object PermissionsType: default: permissions description: Permissions resource type. enum: - - permissions + - permissions example: permissions type: string x-enum-varnames: - - PERMISSIONS + - PERMISSIONS Playlist: properties: data: - $ref: '#/components/schemas/PlaylistData' + $ref: "#/components/schemas/PlaylistData" required: - - data + - data type: object PlaylistArray: properties: data: items: - $ref: '#/components/schemas/PlaylistData' + $ref: "#/components/schemas/PlaylistData" type: array required: - - data + - data type: object PlaylistData: properties: attributes: - $ref: '#/components/schemas/PlaylistDataAttributes' + $ref: "#/components/schemas/PlaylistDataAttributes" id: type: string type: - $ref: '#/components/schemas/PlaylistDataType' + $ref: "#/components/schemas/PlaylistDataType" required: - - type + - type type: object PlaylistDataAttributes: properties: @@ -49465,7 +46969,7 @@ components: format: date-time type: string created_by: - $ref: '#/components/schemas/PlaylistDataAttributesCreatedBy' + $ref: "#/components/schemas/PlaylistDataAttributesCreatedBy" description: type: string name: @@ -49478,7 +46982,7 @@ components: format: date-time type: string required: - - name + - name type: object PlaylistDataAttributesCreatedBy: properties: @@ -49496,45 +47000,45 @@ components: example: 00000000-0000-0000-0000-000000000001 type: string required: - - handle - - id - - uuid + - handle + - id + - uuid type: object PlaylistDataType: default: rum_replay_playlist description: Rum replay playlist resource type. enum: - - rum_replay_playlist + - rum_replay_playlist example: rum_replay_playlist type: string x-enum-varnames: - - RUM_REPLAY_PLAYLIST + - RUM_REPLAY_PLAYLIST PlaylistsSession: properties: data: - $ref: '#/components/schemas/PlaylistsSessionData' + $ref: "#/components/schemas/PlaylistsSessionData" required: - - data + - data type: object PlaylistsSessionArray: properties: data: items: - $ref: '#/components/schemas/PlaylistsSessionData' + $ref: "#/components/schemas/PlaylistsSessionData" type: array required: - - data + - data type: object PlaylistsSessionData: properties: attributes: - $ref: '#/components/schemas/PlaylistsSessionDataAttributes' + $ref: "#/components/schemas/PlaylistsSessionDataAttributes" id: type: string type: - $ref: '#/components/schemas/ViewershipHistorySessionDataType' + $ref: "#/components/schemas/ViewershipHistorySessionDataType" required: - - type + - type type: object PlaylistsSessionDataAttributes: properties: @@ -49547,9 +47051,9 @@ components: PostmortemAttachmentRequest: properties: data: - $ref: '#/components/schemas/PostmortemAttachmentRequestData' + $ref: "#/components/schemas/PostmortemAttachmentRequestData" required: - - data + - data type: object PostmortemAttachmentRequestAttributes: description: Postmortem attachment attributes @@ -49557,17 +47061,17 @@ components: cells: description: The cells of the postmortem items: - $ref: '#/components/schemas/PostmortemCell' + $ref: "#/components/schemas/PostmortemCell" type: array content: description: The content of the postmortem - example: '# Incident Report - IR-123 - - [...]' + example: |- + # Incident Report - IR-123 + [...] type: string postmortem_template_id: description: The ID of the postmortem template - example: 93645509-874e-45c4-adfa-623bfeaead89-123 + example: "93645509-874e-45c4-adfa-623bfeaead89-123" type: string title: description: The title of the postmortem @@ -49578,159 +47082,158 @@ components: description: Postmortem attachment data properties: attributes: - $ref: '#/components/schemas/PostmortemAttachmentRequestAttributes' + $ref: "#/components/schemas/PostmortemAttachmentRequestAttributes" type: - $ref: '#/components/schemas/IncidentAttachmentType' + $ref: "#/components/schemas/IncidentAttachmentType" required: - - type - - attributes + - type + - attributes type: object PostmortemCell: description: A cell in the postmortem properties: attributes: - $ref: '#/components/schemas/PostmortemCellAttributes' + $ref: "#/components/schemas/PostmortemCellAttributes" id: description: The unique identifier of the cell - example: cell-1 + example: "cell-1" type: string type: - $ref: '#/components/schemas/PostmortemCellType' + $ref: "#/components/schemas/PostmortemCellType" type: object PostmortemCellAttributes: description: Attributes of a postmortem cell properties: definition: - $ref: '#/components/schemas/PostmortemCellDefinition' + $ref: "#/components/schemas/PostmortemCellDefinition" type: object PostmortemCellDefinition: description: Definition of a postmortem cell properties: content: description: The content of the cell in markdown format - example: '## Incident Summary - - This incident was caused by...' + example: |- + ## Incident Summary + This incident was caused by... type: string type: object PostmortemCellType: description: The postmortem cell resource type. enum: - - markdown + - markdown example: markdown type: string x-enum-varnames: - - MARKDOWN + - MARKDOWN PostmortemTemplateAttributesRequest: properties: name: description: The name of the template - example: Standard Postmortem Template + example: "Standard Postmortem Template" type: string required: - - name + - name type: object PostmortemTemplateAttributesResponse: properties: createdAt: description: When the template was created - example: '2026-01-13T17:15:53.208340Z' + example: "2026-01-13T17:15:53.208340Z" format: date-time type: string modifiedAt: description: When the template was last modified - example: '2026-01-13T17:15:53.208340Z' + example: "2026-01-13T17:15:53.208340Z" format: date-time type: string name: description: The name of the template - example: Standard Postmortem Template + example: "Standard Postmortem Template" type: string required: - - name - - createdAt - - modifiedAt + - name + - createdAt + - modifiedAt type: object PostmortemTemplateDataRequest: properties: attributes: - $ref: '#/components/schemas/PostmortemTemplateAttributesRequest' + $ref: "#/components/schemas/PostmortemTemplateAttributesRequest" type: - $ref: '#/components/schemas/PostmortemTemplateType' + $ref: "#/components/schemas/PostmortemTemplateType" required: - - type - - attributes + - type + - attributes type: object PostmortemTemplateDataResponse: properties: attributes: - $ref: '#/components/schemas/PostmortemTemplateAttributesResponse' + $ref: "#/components/schemas/PostmortemTemplateAttributesResponse" id: description: The ID of the template - example: template-456 + example: "template-456" type: string type: - $ref: '#/components/schemas/PostmortemTemplateType' + $ref: "#/components/schemas/PostmortemTemplateType" required: - - id - - type - - attributes + - id + - type + - attributes type: object PostmortemTemplateRequest: properties: data: - $ref: '#/components/schemas/PostmortemTemplateDataRequest' + $ref: "#/components/schemas/PostmortemTemplateDataRequest" required: - - data + - data type: object PostmortemTemplateResponse: properties: data: - $ref: '#/components/schemas/PostmortemTemplateDataResponse' + $ref: "#/components/schemas/PostmortemTemplateDataResponse" required: - - data + - data type: object PostmortemTemplateType: description: Postmortem template resource type enum: - - postmortem_template + - postmortem_template example: postmortem_template type: string x-enum-varnames: - - POSTMORTEM_TEMPLATE + - POSTMORTEM_TEMPLATE PostmortemTemplatesResponse: properties: data: items: - $ref: '#/components/schemas/PostmortemTemplateDataResponse' + $ref: "#/components/schemas/PostmortemTemplateDataResponse" type: array required: - - data + - data type: object Powerpack: - description: Powerpacks are templated groups of dashboard widgets you can save - from an existing dashboard and turn into reusable packs in the widget tray. + description: |- + Powerpacks are templated groups of dashboard widgets you can save from an existing dashboard and turn into reusable packs in the widget tray. properties: data: - $ref: '#/components/schemas/PowerpackData' + $ref: "#/components/schemas/PowerpackData" type: object PowerpackAttributes: description: Powerpack attribute object. properties: description: description: Description of this powerpack. - example: Powerpack for ABC + example: "Powerpack for ABC" type: string group_widget: - $ref: '#/components/schemas/PowerpackGroupWidget' + $ref: "#/components/schemas/PowerpackGroupWidget" name: description: Name of the powerpack. - example: Sample Powerpack + example: "Sample Powerpack" type: string tags: description: List of tags to identify this powerpack. - example: - - tag:foo1 + example: ["tag:foo1"] items: maxLength: 80 type: string @@ -49738,43 +47241,40 @@ components: type: array template_variables: description: List of template variables for this powerpack. - example: - - defaults: - - '*' - name: test + example: [{"defaults": ["*"], "name": "test"}] items: - $ref: '#/components/schemas/PowerpackTemplateVariable' + $ref: "#/components/schemas/PowerpackTemplateVariable" type: array required: - - group_widget - - name + - group_widget + - name type: object PowerpackData: description: Powerpack data object. properties: attributes: - $ref: '#/components/schemas/PowerpackAttributes' + $ref: "#/components/schemas/PowerpackAttributes" id: description: ID of the powerpack. type: string relationships: - $ref: '#/components/schemas/PowerpackRelationships' + $ref: "#/components/schemas/PowerpackRelationships" type: description: Type of widget, must be powerpack. - example: powerpack + example: "powerpack" type: string type: object PowerpackGroupWidget: description: Powerpack group widget definition object. properties: definition: - $ref: '#/components/schemas/PowerpackGroupWidgetDefinition' + $ref: "#/components/schemas/PowerpackGroupWidgetDefinition" layout: - $ref: '#/components/schemas/PowerpackGroupWidgetLayout' + $ref: "#/components/schemas/PowerpackGroupWidgetLayout" live_span: - $ref: '#/components/schemas/WidgetLiveSpan' + $ref: "#/components/schemas/WidgetLiveSpan" required: - - definition + - definition type: object PowerpackGroupWidgetDefinition: description: Powerpack group widget object. @@ -49784,8 +47284,7 @@ components: example: ordered type: string show_title: - description: Boolean indicating whether powerpack group title should be - visible or not. + description: Boolean indicating whether powerpack group title should be visible or not. example: true type: boolean title: @@ -49798,22 +47297,14 @@ components: type: string widgets: description: Widgets inside the powerpack. - example: - - definition: - content: example - type: note - layout: - height: 5 - width: 10 - x: 0 - y: 0 + example: [{"definition": {"content": "example", "type": "note"}, "layout": {"height": 5, "width": 10, "x": 0, "y": 0}}] items: - $ref: '#/components/schemas/PowerpackInnerWidgets' + $ref: "#/components/schemas/PowerpackInnerWidgets" type: array required: - - widgets - - layout_type - - type + - widgets + - layout_type + - type type: object PowerpackGroupWidgetLayout: description: Powerpack group widget layout. @@ -49831,24 +47322,22 @@ components: minimum: 0 type: integer x: - description: The position of the widget on the x (horizontal) axis. Should - be a non-negative integer. + description: The position of the widget on the x (horizontal) axis. Should be a non-negative integer. example: 0 format: int64 minimum: 0 type: integer y: - description: The position of the widget on the y (vertical) axis. Should - be a non-negative integer. + description: The position of the widget on the y (vertical) axis. Should be a non-negative integer. example: 0 format: int64 minimum: 0 type: integer required: - - x - - y - - width - - height + - x + - y + - width + - height type: object PowerpackInnerWidgetLayout: description: Powerpack inner widget layout. @@ -49866,24 +47355,22 @@ components: minimum: 0 type: integer x: - description: The position of the widget on the x (horizontal) axis. Should - be a non-negative integer. + description: The position of the widget on the x (horizontal) axis. Should be a non-negative integer. example: 0 format: int64 minimum: 0 type: integer y: - description: The position of the widget on the y (vertical) axis. Should - be a non-negative integer. + description: The position of the widget on the y (vertical) axis. Should be a non-negative integer. example: 0 format: int64 minimum: 0 type: integer required: - - x - - y - - width - - height + - x + - y + - width + - height type: object PowerpackInnerWidgets: description: Powerpack group widget definition of individual widgets. @@ -49891,31 +47378,28 @@ components: definition: additionalProperties: {} description: Information about widget. - example: - definition: - content: example - type: note + example: {"definition": {"content": "example", "type": "note"}} type: object layout: - $ref: '#/components/schemas/PowerpackInnerWidgetLayout' + $ref: "#/components/schemas/PowerpackInnerWidgetLayout" required: - - definition + - definition type: object PowerpackRelationships: description: Powerpack relationship object. properties: author: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" type: object PowerpackResponse: description: Response object which includes a single powerpack configuration. properties: data: - $ref: '#/components/schemas/PowerpackData' + $ref: "#/components/schemas/PowerpackData" included: description: Array of objects related to the users. items: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" type: array readOnly: true type: object @@ -49927,12 +47411,12 @@ components: type: string last: description: Link to first page. - example: https://app.datadoghq.com/api/v2/powerpacks?page[offset]=0&page[limit]=25 + example: "https://app.datadoghq.com/api/v2/powerpacks?page[offset]=0&page[limit]=25" nullable: true type: string next: description: Link for the next set of results. - example: https://app.datadoghq.com/api/v2/powerpacks?page[offset]=25&page[limit]=25 + example: "https://app.datadoghq.com/api/v2/powerpacks?page[offset]=25&page[limit]=25" type: string prev: description: Link for the previous set of results. @@ -49940,27 +47424,22 @@ components: type: string self: description: Link to current page. - example: https://app.datadoghq.com/api/v2/powerpacks + example: "https://app.datadoghq.com/api/v2/powerpacks" type: string type: object PowerpackTemplateVariable: description: Powerpack template variables. properties: available_values: - description: The list of values that the template variable drop-down is - limited to. - example: - - my-host - - host1 - - host2 + description: The list of values that the template variable drop-down is limited to. + example: ["my-host", "host1", "host2"] items: description: Template variable value. type: string nullable: true type: array defaults: - description: One or many template variable default values within the saved - view, which are unioned together using `OR` if more than one is specified. + description: One or many template variable default values within the saved view, which are unioned together using `OR` if more than one is specified. items: description: One or many default values of the template variable. minLength: 1 @@ -49971,19 +47450,18 @@ components: example: datacenter type: string prefix: - description: The tag prefix associated with the variable. Only tags with - this prefix appear in the variable drop-down. + description: The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. example: host nullable: true type: string required: - - name + - name type: object PowerpacksResponseMeta: description: Powerpack response metadata. properties: pagination: - $ref: '#/components/schemas/PowerpacksResponseMetaPagination' + $ref: "#/components/schemas/PowerpacksResponseMetaPagination" type: object PowerpacksResponseMetaPagination: description: Powerpack response pagination metadata. @@ -50024,30 +47502,29 @@ components: PreviewEntityResponseData: properties: attributes: - $ref: '#/components/schemas/EntityResponseDataAttributes' + $ref: "#/components/schemas/EntityResponseDataAttributes" id: type: string relationships: - $ref: '#/components/schemas/EntityResponseDataRelationships' + $ref: "#/components/schemas/EntityResponseDataRelationships" type: - $ref: '#/components/schemas/EntityResponseDataType' + $ref: "#/components/schemas/EntityResponseDataType" required: - - type + - type type: object ProcessSummariesMeta: description: Response metadata object. properties: page: - $ref: '#/components/schemas/ProcessSummariesMetaPage' + $ref: "#/components/schemas/ProcessSummariesMetaPage" type: object ProcessSummariesMetaPage: description: Paging attributes. properties: after: - description: 'The cursor used to get the next results, if any. To make the - next request, use the same - - parameters with the addition of the `page[cursor]`.' + description: |- + The cursor used to get the next results, if any. To make the next request, use the same + parameters with the addition of the `page[cursor]`. example: 911abf1204838d9cdfcb9a96d0b6a1bd03e1b514074f1ce1737c4cbd type: string size: @@ -50063,21 +47540,21 @@ components: data: description: Array of process summary objects. items: - $ref: '#/components/schemas/ProcessSummary' + $ref: "#/components/schemas/ProcessSummary" type: array meta: - $ref: '#/components/schemas/ProcessSummariesMeta' + $ref: "#/components/schemas/ProcessSummariesMeta" type: object ProcessSummary: description: Process summary object. properties: attributes: - $ref: '#/components/schemas/ProcessSummaryAttributes' + $ref: "#/components/schemas/ProcessSummaryAttributes" id: description: Process ID. type: string type: - $ref: '#/components/schemas/ProcessSummaryType' + $ref: "#/components/schemas/ProcessSummaryType" type: object ProcessSummaryAttributes: description: Attributes for a process summary. @@ -50116,23 +47593,22 @@ components: default: process description: Type of process summary. enum: - - process + - process example: process type: string x-enum-varnames: - - PROCESS + - PROCESS ProductAnalyticsAnalyticsQuery: - description: The analytics query definition containing a base query, compute - rule, and optional grouping. + description: The analytics query definition containing a base query, compute rule, and optional grouping. properties: audience_filters: - $ref: '#/components/schemas/ProductAnalyticsAudienceFilters' + $ref: "#/components/schemas/ProductAnalyticsAudienceFilters" compute: - $ref: '#/components/schemas/ProductAnalyticsCompute' + $ref: "#/components/schemas/ProductAnalyticsCompute" group_by: description: Group-by rules for segmenting results. items: - $ref: '#/components/schemas/ProductAnalyticsGroupBy' + $ref: "#/components/schemas/ProductAnalyticsGroupBy" type: array indexes: description: Restrict the query to specific indexes. Max 1 entry. @@ -50141,10 +47617,10 @@ components: maxItems: 1 type: array query: - $ref: '#/components/schemas/ProductAnalyticsBaseQuery' + $ref: "#/components/schemas/ProductAnalyticsBaseQuery" required: - - query - - compute + - query + - compute type: object ProductAnalyticsAnalyticsRequest: description: Request for computing analytics results (scalar or timeseries). @@ -50158,27 +47634,27 @@ components: query: data_source: product_analytics search: - query: '@type:view' + query: "@type:view" to: 1771836848262 type: formula_analytics_extended_request properties: data: - $ref: '#/components/schemas/ProductAnalyticsAnalyticsRequestData' + $ref: "#/components/schemas/ProductAnalyticsAnalyticsRequestData" required: - - data + - data type: object ProductAnalyticsAnalyticsRequestAttributes: description: Attributes for an analytics request. properties: enforced_execution_type: - $ref: '#/components/schemas/ProductAnalyticsExecutionType' + $ref: "#/components/schemas/ProductAnalyticsExecutionType" from: description: Start time in epoch milliseconds. Must be less than `to`. example: 1771232048460 format: int64 type: integer query: - $ref: '#/components/schemas/ProductAnalyticsAnalyticsQuery' + $ref: "#/components/schemas/ProductAnalyticsAnalyticsQuery" request_id: description: Optional request ID for multi-step query continuation. type: string @@ -50188,41 +47664,41 @@ components: format: int64 type: integer required: - - from - - to - - query + - from + - to + - query type: object ProductAnalyticsAnalyticsRequestData: description: Data object for an analytics request. properties: attributes: - $ref: '#/components/schemas/ProductAnalyticsAnalyticsRequestAttributes' + $ref: "#/components/schemas/ProductAnalyticsAnalyticsRequestAttributes" type: - $ref: '#/components/schemas/ProductAnalyticsAnalyticsRequestType' + $ref: "#/components/schemas/ProductAnalyticsAnalyticsRequestType" required: - - type - - attributes + - type + - attributes type: object ProductAnalyticsAnalyticsRequestType: description: The resource type for analytics requests. enum: - - formula_analytics_extended_request + - formula_analytics_extended_request example: formula_analytics_extended_request type: string x-enum-varnames: - - FORMULA_ANALYTICS_EXTENDED_REQUEST + - FORMULA_ANALYTICS_EXTENDED_REQUEST ProductAnalyticsAudienceAccountSubquery: description: An account-based audience query. properties: name: description: Name of this query, referenced in the formula. - example: '' + example: "" type: string query: description: Search query for filtering accounts. type: string required: - - name + - name type: object ProductAnalyticsAudienceFilters: description: Audience filter definitions for targeting specific user segments. @@ -50230,21 +47706,21 @@ components: accounts: description: Account audience queries. items: - $ref: '#/components/schemas/ProductAnalyticsAudienceAccountSubquery' + $ref: "#/components/schemas/ProductAnalyticsAudienceAccountSubquery" type: array formula: description: Boolean formula combining audience queries by name. - example: u + example: "u" type: string segments: description: Segment audience queries. items: - $ref: '#/components/schemas/ProductAnalyticsAudienceSegmentSubquery' + $ref: "#/components/schemas/ProductAnalyticsAudienceSegmentSubquery" type: array users: description: User audience queries. items: - $ref: '#/components/schemas/ProductAnalyticsAudienceUserSubquery' + $ref: "#/components/schemas/ProductAnalyticsAudienceUserSubquery" type: array type: object ProductAnalyticsAudienceSegmentSubquery: @@ -50252,16 +47728,16 @@ components: properties: name: description: Name of this query, referenced in the formula. - example: '' + example: "" type: string segment_id: description: UUID of the segment to filter by. - example: '' + example: "" format: uuid type: string required: - - name - - segment_id + - name + - segment_id type: object ProductAnalyticsAudienceUserSubquery: description: A user-based audience query. @@ -50272,26 +47748,24 @@ components: type: string query: description: Search query for filtering users. - example: '*' + example: "*" type: string required: - - name + - name type: object ProductAnalyticsBaseQuery: - description: 'A query definition discriminated by the `data_source` field. - + description: |- + A query definition discriminated by the `data_source` field. Use `product_analytics` for standard event queries, or - - `product_analytics_occurrence` for occurrence-filtered queries.' + `product_analytics_occurrence` for occurrence-filtered queries. oneOf: - - $ref: '#/components/schemas/ProductAnalyticsEventQuery' - - $ref: '#/components/schemas/ProductAnalyticsOccurrenceQuery' + - $ref: "#/components/schemas/ProductAnalyticsEventQuery" + - $ref: "#/components/schemas/ProductAnalyticsOccurrenceQuery" ProductAnalyticsCompute: description: A compute rule for aggregating data. properties: aggregation: - description: The aggregation function (count, cardinality, avg, sum, min, - max, etc.). + description: The aggregation function (count, cardinality, avg, sum, min, max, etc.). example: count type: string interval: @@ -50301,57 +47775,57 @@ components: type: integer metric: description: The metric to aggregate on. Required for non-count aggregations. - example: '@session.time_spent' + example: "@session.time_spent" type: string required: - - aggregation + - aggregation type: object ProductAnalyticsEventQuery: description: A standard Product Analytics event query. properties: data_source: - $ref: '#/components/schemas/ProductAnalyticsEventQueryDataSource' + $ref: "#/components/schemas/ProductAnalyticsEventQueryDataSource" search: - $ref: '#/components/schemas/ProductAnalyticsEventSearch' + $ref: "#/components/schemas/ProductAnalyticsEventSearch" required: - - data_source - - search + - data_source + - search type: object ProductAnalyticsEventQueryDataSource: description: The data source identifier. enum: - - product_analytics + - product_analytics example: product_analytics type: string x-enum-varnames: - - PRODUCT_ANALYTICS + - PRODUCT_ANALYTICS ProductAnalyticsEventSearch: description: Search parameters for an event query. properties: query: description: The search query using Datadog search syntax. - example: '@type:view' + example: "@type:view" type: string type: object ProductAnalyticsExecutionType: description: Override the query execution strategy. enum: - - simple - - background - - trino-multistep - - materialized-view + - simple + - background + - trino-multistep + - materialized-view type: string x-enum-varnames: - - SIMPLE - - BACKGROUND - - TRINO_MULTISTEP - - MATERIALIZED_VIEW + - SIMPLE + - BACKGROUND + - TRINO_MULTISTEP + - MATERIALIZED_VIEW ProductAnalyticsGroupBy: description: A group-by rule for segmenting results by facet values. properties: facet: description: The facet to group by. - example: '@view.name' + example: "@view.name" type: string limit: description: Maximum number of groups to return. @@ -50363,12 +47837,12 @@ components: description: Exclude results with missing facet values. type: boolean sort: - $ref: '#/components/schemas/ProductAnalyticsGroupBySort' + $ref: "#/components/schemas/ProductAnalyticsGroupBySort" source: description: The source for audience-filter-based group-by. type: string required: - - facet + - facet type: object ProductAnalyticsGroupBySort: description: Sort configuration for group-by results. @@ -50381,7 +47855,7 @@ components: description: The metric to sort by. type: string order: - $ref: '#/components/schemas/QuerySortOrder' + $ref: "#/components/schemas/QuerySortOrder" type: object ProductAnalyticsInterval: description: An interval definition in a timeseries response. @@ -50410,43 +47884,43 @@ components: type: object operator: description: Comparison operator (=, >=, <=, >, <). - example: '>=' + example: ">=" type: string value: description: The occurrence count threshold as a string. - example: '1' + example: "1" type: string required: - - operator - - value + - operator + - value type: object ProductAnalyticsOccurrenceQuery: description: A Product Analytics occurrence-filtered query. properties: data_source: - $ref: '#/components/schemas/ProductAnalyticsOccurrenceQueryDataSource' + $ref: "#/components/schemas/ProductAnalyticsOccurrenceQueryDataSource" search: - $ref: '#/components/schemas/ProductAnalyticsOccurrenceSearch' + $ref: "#/components/schemas/ProductAnalyticsOccurrenceSearch" required: - - data_source - - search + - data_source + - search type: object ProductAnalyticsOccurrenceQueryDataSource: description: The data source identifier for occurrence queries. enum: - - product_analytics_occurrence + - product_analytics_occurrence example: product_analytics_occurrence type: string x-enum-varnames: - - PRODUCT_ANALYTICS_OCCURRENCE + - PRODUCT_ANALYTICS_OCCURRENCE ProductAnalyticsOccurrenceSearch: description: Search parameters for an occurrence query. properties: occurrences: - $ref: '#/components/schemas/ProductAnalyticsOccurrenceFilter' + $ref: "#/components/schemas/ProductAnalyticsOccurrenceFilter" query: description: The search query using Datadog search syntax. - example: '@type:action' + example: "@type:action" type: string type: object ProductAnalyticsResponseMeta: @@ -50455,28 +47929,28 @@ components: request_id: type: string status: - $ref: '#/components/schemas/ProductAnalyticsResponseMetaStatus' + $ref: "#/components/schemas/ProductAnalyticsResponseMetaStatus" type: object ProductAnalyticsResponseMetaStatus: enum: - - done - - running - - timeout + - done + - running + - timeout type: string x-enum-varnames: - - DONE - - RUNNING - - TIMEOUT + - DONE + - RUNNING + - TIMEOUT ProductAnalyticsScalarColumn: description: A column in a scalar response. properties: meta: - $ref: '#/components/schemas/ProductAnalyticsScalarColumnMeta' + $ref: "#/components/schemas/ProductAnalyticsScalarColumnMeta" name: description: Column name (facet name for group-by, or "query"). type: string type: - $ref: '#/components/schemas/ProductAnalyticsScalarColumnType' + $ref: "#/components/schemas/ProductAnalyticsScalarColumnType" values: description: Column values. items: {} @@ -50486,50 +47960,50 @@ components: properties: unit: items: - $ref: '#/components/schemas/ProductAnalyticsUnit' + $ref: "#/components/schemas/ProductAnalyticsUnit" nullable: true type: array type: object ProductAnalyticsScalarColumnType: description: Column type. enum: - - number - - group + - number + - group type: string x-enum-varnames: - - NUMBER - - GROUP + - NUMBER + - GROUP ProductAnalyticsScalarResponse: description: Response for a scalar analytics query. properties: data: - $ref: '#/components/schemas/ProductAnalyticsScalarResponseData' + $ref: "#/components/schemas/ProductAnalyticsScalarResponseData" meta: - $ref: '#/components/schemas/ProductAnalyticsResponseMeta' + $ref: "#/components/schemas/ProductAnalyticsResponseMeta" type: object ProductAnalyticsScalarResponseAttributes: properties: columns: items: - $ref: '#/components/schemas/ProductAnalyticsScalarColumn' + $ref: "#/components/schemas/ProductAnalyticsScalarColumn" type: array type: object ProductAnalyticsScalarResponseData: description: Data object for a scalar response. properties: attributes: - $ref: '#/components/schemas/ProductAnalyticsScalarResponseAttributes' + $ref: "#/components/schemas/ProductAnalyticsScalarResponseAttributes" id: type: string type: - $ref: '#/components/schemas/ProductAnalyticsScalarResponseType' + $ref: "#/components/schemas/ProductAnalyticsScalarResponseType" type: object ProductAnalyticsScalarResponseType: enum: - - scalar_response + - scalar_response type: string x-enum-varnames: - - SCALAR_RESPONSE + - SCALAR_RESPONSE ProductAnalyticsSerie: description: A series in a timeseries response. properties: @@ -50542,7 +48016,7 @@ components: type: integer unit: items: - $ref: '#/components/schemas/ProductAnalyticsUnit' + $ref: "#/components/schemas/ProductAnalyticsUnit" type: array type: object ProductAnalyticsServerSideEventError: @@ -50550,15 +48024,15 @@ components: properties: detail: description: Error message. - example: Malformed payload + example: "Malformed payload" type: string status: description: Error code. - example: '400' + example: "400" type: string title: description: Error title. - example: Bad Request + example: "Bad Request" type: string type: object ProductAnalyticsServerSideEventErrors: @@ -50567,109 +48041,107 @@ components: errors: description: Structured errors. items: - $ref: '#/components/schemas/ProductAnalyticsServerSideEventError' + $ref: "#/components/schemas/ProductAnalyticsServerSideEventError" type: array type: object ProductAnalyticsServerSideEventItem: description: A Product Analytics server-side event. properties: account: - $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemAccount' + $ref: "#/components/schemas/ProductAnalyticsServerSideEventItemAccount" application: - $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemApplication' + $ref: "#/components/schemas/ProductAnalyticsServerSideEventItemApplication" event: - $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemEvent' + $ref: "#/components/schemas/ProductAnalyticsServerSideEventItemEvent" session: - $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemSession' + $ref: "#/components/schemas/ProductAnalyticsServerSideEventItemSession" type: - $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemType' + $ref: "#/components/schemas/ProductAnalyticsServerSideEventItemType" usr: - $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemUsr' + $ref: "#/components/schemas/ProductAnalyticsServerSideEventItemUsr" required: - - application - - event - - type + - application + - event + - type type: object ProductAnalyticsServerSideEventItemAccount: description: The account linked to your event. properties: id: description: The account ID used in Datadog. - example: account-67890 + example: "account-67890" type: string required: - - id + - id type: object ProductAnalyticsServerSideEventItemApplication: description: The application in which you want to send your events. properties: id: - description: 'The application ID of your application. It can be found in - your - - [application management page](https://app.datadoghq.com/rum/list).' - example: 123abcde-123a-123b-1234-123456789abc + description: |- + The application ID of your application. It can be found in your + [application management page](https://app.datadoghq.com/rum/list). + example: "123abcde-123a-123b-1234-123456789abc" type: string required: - - id + - id type: object ProductAnalyticsServerSideEventItemEvent: description: Fields used for the event. properties: name: - description: The name of your event, which is used for search in the same - way as view or action names. - example: payment.processed + description: |- + The name of your event, which is used for search in the same way as view or action names. + example: "payment.processed" type: string required: - - name + - name type: object ProductAnalyticsServerSideEventItemSession: description: The session linked to your event. properties: id: description: The session ID captured by the SDK. - example: session-abcdef + example: "session-abcdef" type: string required: - - id + - id type: object ProductAnalyticsServerSideEventItemType: - description: The type of Product Analytics event. Must be `server` for server-side - events. + description: The type of Product Analytics event. Must be `server` for server-side events. enum: - - server + - server example: server type: string x-enum-varnames: - - SERVER + - SERVER ProductAnalyticsServerSideEventItemUsr: description: The user linked to your event. properties: id: description: The user ID used in Datadog. - example: user-12345 + example: "user-12345" type: string required: - - id + - id type: object ProductAnalyticsTimeseriesResponse: description: Response for a timeseries analytics query. properties: data: - $ref: '#/components/schemas/ProductAnalyticsTimeseriesResponseData' + $ref: "#/components/schemas/ProductAnalyticsTimeseriesResponseData" meta: - $ref: '#/components/schemas/ProductAnalyticsResponseMeta' + $ref: "#/components/schemas/ProductAnalyticsResponseMeta" type: object ProductAnalyticsTimeseriesResponseAttributes: properties: intervals: items: - $ref: '#/components/schemas/ProductAnalyticsInterval' + $ref: "#/components/schemas/ProductAnalyticsInterval" type: array series: items: - $ref: '#/components/schemas/ProductAnalyticsSerie' + $ref: "#/components/schemas/ProductAnalyticsSerie" type: array times: description: Timestamps for each data point (epoch milliseconds). @@ -50690,18 +48162,18 @@ components: ProductAnalyticsTimeseriesResponseData: properties: attributes: - $ref: '#/components/schemas/ProductAnalyticsTimeseriesResponseAttributes' + $ref: "#/components/schemas/ProductAnalyticsTimeseriesResponseAttributes" id: type: string type: - $ref: '#/components/schemas/ProductAnalyticsTimeseriesResponseType' + $ref: "#/components/schemas/ProductAnalyticsTimeseriesResponseType" type: object ProductAnalyticsTimeseriesResponseType: enum: - - timeseries_response + - timeseries_response type: string x-enum-varnames: - - TIMESERIES_RESPONSE + - TIMESERIES_RESPONSE ProductAnalyticsUnit: description: A unit definition for metric values. properties: @@ -50726,25 +48198,25 @@ components: description: A Project properties: attributes: - $ref: '#/components/schemas/ProjectAttributes' + $ref: "#/components/schemas/ProjectAttributes" id: description: The Project's identifier example: aeadc05e-98a8-11ec-ac2c-da7ad0900001 type: string relationships: - $ref: '#/components/schemas/ProjectRelationships' + $ref: "#/components/schemas/ProjectRelationships" type: - $ref: '#/components/schemas/ProjectResourceType' + $ref: "#/components/schemas/ProjectResourceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object ProjectAttributes: description: Project attributes properties: columns_config: - $ref: '#/components/schemas/ProjectColumnsConfig' + $ref: "#/components/schemas/ProjectColumnsConfig" enabled_custom_case_types: description: List of enabled custom case type IDs items: @@ -50756,26 +48228,26 @@ components: type: string name: description: Project's name - example: Security Investigation + example: "Security Investigation" type: string restricted: description: Whether the project is restricted type: boolean settings: - $ref: '#/components/schemas/ProjectSettings' + $ref: "#/components/schemas/ProjectSettings" type: object ProjectColumnsConfig: description: Project columns configuration properties: columns: items: - $ref: '#/components/schemas/ProjectColumnsConfigColumnsItems' + $ref: "#/components/schemas/ProjectColumnsConfigColumnsItems" type: array type: object ProjectColumnsConfigColumnsItems: properties: sort: - $ref: '#/components/schemas/ProjectColumnsConfigColumnsItemsSort' + $ref: "#/components/schemas/ProjectColumnsConfigColumnsItemsSort" sort_field: type: string type: @@ -50793,12 +48265,12 @@ components: description: Project create properties: attributes: - $ref: '#/components/schemas/ProjectCreateAttributes' + $ref: "#/components/schemas/ProjectCreateAttributes" type: - $ref: '#/components/schemas/ProjectResourceType' + $ref: "#/components/schemas/ProjectResourceType" required: - - attributes - - type + - attributes + - type type: object ProjectCreateAttributes: description: Project creation attributes @@ -50810,26 +48282,26 @@ components: type: array key: description: Project's key. Cannot be "CASE" - example: SEC + example: "SEC" type: string name: description: Project name - example: Security Investigation + example: "Security Investigation" type: string team_uuid: description: Team UUID to associate with the project type: string required: - - name - - key + - name + - key type: object ProjectCreateRequest: description: Project create request properties: data: - $ref: '#/components/schemas/ProjectCreate' + $ref: "#/components/schemas/ProjectCreate" required: - - data + - data type: object ProjectNotificationSettings: description: Project notification settings @@ -50861,81 +48333,81 @@ components: description: Relationship to project properties: data: - $ref: '#/components/schemas/ProjectRelationshipData' + $ref: "#/components/schemas/ProjectRelationshipData" required: - - data + - data type: object ProjectRelationshipData: description: Relationship to project object properties: id: description: A unique identifier that represents the project - example: e555e290-ed65-49bd-ae18-8acbfcf18db7 + example: "e555e290-ed65-49bd-ae18-8acbfcf18db7" type: string type: - $ref: '#/components/schemas/ProjectResourceType' + $ref: "#/components/schemas/ProjectResourceType" required: - - id - - type + - id + - type type: object ProjectRelationships: description: Project relationships properties: member_team: - $ref: '#/components/schemas/RelationshipToTeamLinks' + $ref: "#/components/schemas/RelationshipToTeamLinks" member_user: - $ref: '#/components/schemas/UsersRelationship' + $ref: "#/components/schemas/UsersRelationship" type: object ProjectResourceType: default: project description: Project resource type enum: - - project + - project example: project type: string x-enum-varnames: - - PROJECT + - PROJECT ProjectResponse: description: Project response properties: data: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" type: object ProjectSettings: description: Project settings properties: auto_close_inactive_cases: - $ref: '#/components/schemas/AutoCloseInactiveCases' + $ref: "#/components/schemas/AutoCloseInactiveCases" auto_transition_assigned_cases: - $ref: '#/components/schemas/AutoTransitionAssignedCases' + $ref: "#/components/schemas/AutoTransitionAssignedCases" integration_incident: - $ref: '#/components/schemas/IntegrationIncident' + $ref: "#/components/schemas/IntegrationIncident" integration_jira: - $ref: '#/components/schemas/IntegrationJira' + $ref: "#/components/schemas/IntegrationJira" integration_monitor: - $ref: '#/components/schemas/IntegrationMonitor' + $ref: "#/components/schemas/IntegrationMonitor" integration_on_call: - $ref: '#/components/schemas/IntegrationOnCall' + $ref: "#/components/schemas/IntegrationOnCall" integration_service_now: - $ref: '#/components/schemas/IntegrationServiceNow' + $ref: "#/components/schemas/IntegrationServiceNow" notification: - $ref: '#/components/schemas/ProjectNotificationSettings' + $ref: "#/components/schemas/ProjectNotificationSettings" type: object ProjectUpdate: description: Project update properties: attributes: - $ref: '#/components/schemas/ProjectUpdateAttributes' + $ref: "#/components/schemas/ProjectUpdateAttributes" type: - $ref: '#/components/schemas/ProjectResourceType' + $ref: "#/components/schemas/ProjectResourceType" required: - - type + - type type: object ProjectUpdateAttributes: description: Project update attributes properties: columns_config: - $ref: '#/components/schemas/ProjectColumnsConfig' + $ref: "#/components/schemas/ProjectColumnsConfig" enabled_custom_case_types: description: List of enabled custom case type IDs items: @@ -50945,7 +48417,7 @@ components: description: Project name type: string settings: - $ref: '#/components/schemas/ProjectSettings' + $ref: "#/components/schemas/ProjectSettings" team_uuid: description: Team UUID to associate with the project type: string @@ -50954,20 +48426,20 @@ components: description: Project update request properties: data: - $ref: '#/components/schemas/ProjectUpdate' + $ref: "#/components/schemas/ProjectUpdate" required: - - data + - data type: object ProjectedCost: description: Projected Cost data. properties: attributes: - $ref: '#/components/schemas/ProjectedCostAttributes' + $ref: "#/components/schemas/ProjectedCostAttributes" id: description: Unique ID of the response. type: string type: - $ref: '#/components/schemas/ProjectedCostType' + $ref: "#/components/schemas/ProjectedCostType" type: object ProjectedCostAttributes: description: Projected Cost attributes data. @@ -50981,7 +48453,7 @@ components: charges: description: List of charges data reported for the requested month. items: - $ref: '#/components/schemas/ChargebackBreakdown' + $ref: "#/components/schemas/ChargebackBreakdown" type: array date: description: The month requested. @@ -50998,8 +48470,7 @@ components: description: The organization public ID. type: string region: - description: The region of the Datadog instance that the organization belongs - to. + description: The region of the Datadog instance that the organization belongs to. type: string type: object ProjectedCostResponse: @@ -51008,74 +48479,70 @@ components: data: description: Response containing Projected Cost. items: - $ref: '#/components/schemas/ProjectedCost' + $ref: "#/components/schemas/ProjectedCost" type: array type: object ProjectedCostType: default: projected_cost description: Type of cost data. enum: - - projected_cost + - projected_cost example: projected_cost type: string x-enum-varnames: - - PROJECt_COST + - PROJECt_COST ProjectsResponse: description: Response with projects properties: data: description: Projects response data items: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" type: array type: object PublishAppResponse: description: The response object after an app is successfully published. properties: data: - $ref: '#/components/schemas/Deployment' + $ref: "#/components/schemas/Deployment" type: object PutAppsDatastoreItemResponseArray: - description: Response after successfully inserting multiple items into a datastore, - containing the identifiers of the created items. + description: Response after successfully inserting multiple items into a datastore, containing the identifiers of the created items. properties: data: - description: An array of data objects containing the identifiers of the - successfully inserted items. + description: An array of data objects containing the identifiers of the successfully inserted items. items: - $ref: '#/components/schemas/PutAppsDatastoreItemResponseData' + $ref: "#/components/schemas/PutAppsDatastoreItemResponseData" maxItems: 100 type: array required: - - data + - data type: object PutAppsDatastoreItemResponseData: - description: Data containing the identifier of a single item that was successfully - inserted into the datastore. + description: Data containing the identifier of a single item that was successfully inserted into the datastore. properties: id: description: The unique identifier assigned to the inserted item. type: string type: - $ref: '#/components/schemas/DatastoreItemsDataType' + $ref: "#/components/schemas/DatastoreItemsDataType" required: - - type + - type type: object PutIncidentNotificationRuleRequest: description: Put request for a notification rule. properties: data: - $ref: '#/components/schemas/IncidentNotificationRuleUpdateData' + $ref: "#/components/schemas/IncidentNotificationRuleUpdateData" required: - - data + - data type: object Query: - description: A data query used by an app. This can take the form of an external - action, a data transformation, or a state variable. + description: A data query used by an app. This can take the form of an external action, a data transformation, or a state variable. oneOf: - - $ref: '#/components/schemas/ActionQuery' - - $ref: '#/components/schemas/DataTransform' - - $ref: '#/components/schemas/StateVariable' + - $ref: "#/components/schemas/ActionQuery" + - $ref: "#/components/schemas/DataTransform" + - $ref: "#/components/schemas/StateVariable" QueryAccountRequest: example: data: @@ -51083,14 +48550,14 @@ components: limit: 20 query: plan_type:enterprise AND user_count:>100 AND subscription_status:active select_columns: - - account_id - - account_name - - user_count - - plan_type - - subscription_status - - created_at - - mrr - - industry + - account_id + - account_name + - user_count + - plan_type + - subscription_status + - created_at + - mrr + - industry sort: field: user_count order: DESC @@ -51099,18 +48566,18 @@ components: type: query_account_request properties: data: - $ref: '#/components/schemas/QueryAccountRequestData' + $ref: "#/components/schemas/QueryAccountRequestData" type: object QueryAccountRequestData: properties: attributes: - $ref: '#/components/schemas/QueryAccountRequestDataAttributes' + $ref: "#/components/schemas/QueryAccountRequestDataAttributes" id: type: string type: - $ref: '#/components/schemas/QueryAccountRequestDataType' + $ref: "#/components/schemas/QueryAccountRequestDataType" required: - - type + - type type: object QueryAccountRequestDataAttributes: properties: @@ -51124,7 +48591,7 @@ components: type: string type: array sort: - $ref: '#/components/schemas/QueryAccountRequestDataAttributesSort' + $ref: "#/components/schemas/QueryAccountRequestDataAttributesSort" wildcard_search_term: type: string type: object @@ -51139,17 +48606,17 @@ components: default: query_account_request description: Query account request resource type. enum: - - query_account_request + - query_account_request example: query_account_request type: string x-enum-varnames: - - QUERY_ACCOUNT_REQUEST + - QUERY_ACCOUNT_REQUEST QueryEventFilteredUsersRequest: example: data: attributes: event_query: - query: '@type:view AND @view.loading_time:>3000 AND @application.name:ecommerce-platform' + query: "@type:view AND @view.loading_time:>3000 AND @application.name:ecommerce-platform" time_frame: end: 1761309676 start: 1760100076 @@ -51157,35 +48624,35 @@ components: limit: 25 query: user_org_id:5001 AND first_country_code:US AND first_browser_name:Chrome select_columns: - - user_id - - user_email - - first_country_code - - first_browser_name - - events_count - - session_count - - error_count - - avg_loading_time + - user_id + - user_email + - first_country_code + - first_browser_name + - events_count + - session_count + - error_count + - avg_loading_time id: query_event_filtered_users_request type: query_event_filtered_users_request properties: data: - $ref: '#/components/schemas/QueryEventFilteredUsersRequestData' + $ref: "#/components/schemas/QueryEventFilteredUsersRequestData" type: object QueryEventFilteredUsersRequestData: properties: attributes: - $ref: '#/components/schemas/QueryEventFilteredUsersRequestDataAttributes' + $ref: "#/components/schemas/QueryEventFilteredUsersRequestDataAttributes" id: type: string type: - $ref: '#/components/schemas/QueryEventFilteredUsersRequestDataType' + $ref: "#/components/schemas/QueryEventFilteredUsersRequestDataType" required: - - type + - type type: object QueryEventFilteredUsersRequestDataAttributes: properties: event_query: - $ref: '#/components/schemas/QueryEventFilteredUsersRequestDataAttributesEventQuery' + $ref: "#/components/schemas/QueryEventFilteredUsersRequestDataAttributesEventQuery" include_row_count: type: boolean limit: @@ -51203,7 +48670,7 @@ components: query: type: string time_frame: - $ref: '#/components/schemas/QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame' + $ref: "#/components/schemas/QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame" type: object QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame: properties: @@ -51218,79 +48685,78 @@ components: default: query_event_filtered_users_request description: Query event filtered users request resource type. enum: - - query_event_filtered_users_request + - query_event_filtered_users_request example: query_event_filtered_users_request type: string x-enum-varnames: - - QUERY_EVENT_FILTERED_USERS_REQUEST + - QUERY_EVENT_FILTERED_USERS_REQUEST QueryFormula: description: A formula for calculation based on one or more queries. properties: formula: - description: Formula string, referencing one or more queries with their - name property. - example: a+b + description: Formula string, referencing one or more queries with their name property. + example: "a+b" type: string limit: - $ref: '#/components/schemas/FormulaLimit' + $ref: "#/components/schemas/FormulaLimit" required: - - formula + - formula type: object QueryResponse: example: data: attributes: hits: - - first_browser_name: Chrome - first_city: San Francisco - first_country_code: US - first_device_type: Desktop - last_seen: '2025-08-14T06:45:12.142Z' - session_count: 47 - user_created: '2024-12-15T08:42:33.287Z' - user_email: john.smith@techcorp.com - user_id: '150847' - user_name: John Smith - user_org_id: '5001' - - first_browser_name: Chrome - first_city: Austin - first_country_code: US - first_device_type: Desktop - last_seen: '2025-08-14T05:22:08.951Z' - session_count: 89 - user_created: '2024-11-28T14:17:45.634Z' - user_email: john.williams@techcorp.com - user_id: '150848' - user_name: John Williams - user_org_id: '5001' - - first_browser_name: Chrome - first_city: Seattle - first_country_code: US - first_device_type: Desktop - last_seen: '2025-08-14T04:18:34.726Z' - session_count: 23 - user_created: '2025-01-03T16:33:21.445Z' - user_email: john.jones@techcorp.com - user_id: '150849' - user_name: John Jones - user_org_id: '5001' + - first_browser_name: Chrome + first_city: San Francisco + first_country_code: US + first_device_type: Desktop + last_seen: "2025-08-14T06:45:12.142Z" + session_count: 47 + user_created: "2024-12-15T08:42:33.287Z" + user_email: john.smith@techcorp.com + user_id: "150847" + user_name: John Smith + user_org_id: "5001" + - first_browser_name: Chrome + first_city: Austin + first_country_code: US + first_device_type: Desktop + last_seen: "2025-08-14T05:22:08.951Z" + session_count: 89 + user_created: "2024-11-28T14:17:45.634Z" + user_email: john.williams@techcorp.com + user_id: "150848" + user_name: John Williams + user_org_id: "5001" + - first_browser_name: Chrome + first_city: Seattle + first_country_code: US + first_device_type: Desktop + last_seen: "2025-08-14T04:18:34.726Z" + session_count: 23 + user_created: "2025-01-03T16:33:21.445Z" + user_email: john.jones@techcorp.com + user_id: "150849" + user_name: John Jones + user_org_id: "5001" total: 147 id: query_response type: query_response properties: data: - $ref: '#/components/schemas/QueryResponseData' + $ref: "#/components/schemas/QueryResponseData" type: object QueryResponseData: properties: attributes: - $ref: '#/components/schemas/QueryResponseDataAttributes' + $ref: "#/components/schemas/QueryResponseDataAttributes" id: type: string type: - $ref: '#/components/schemas/QueryResponseDataType' + $ref: "#/components/schemas/QueryResponseDataType" required: - - type + - type type: object QueryResponseDataAttributes: properties: @@ -51306,21 +48772,21 @@ components: default: query_response description: Query response resource type. enum: - - query_response + - query_response example: query_response type: string x-enum-varnames: - - QUERY_RESPONSE + - QUERY_RESPONSE QuerySortOrder: default: desc description: Direction of sort. enum: - - asc - - desc + - asc + - desc type: string x-enum-varnames: - - ASC - - DESC + - ASC + - DESC QueryUsersRequest: example: data: @@ -51328,14 +48794,14 @@ components: limit: 25 query: user_email:*@techcorp.com AND first_country_code:US AND first_browser_name:Chrome select_columns: - - user_id - - user_email - - user_name - - user_org_id - - first_country_code - - first_browser_name - - first_device_type - - last_seen + - user_id + - user_email + - user_name + - user_org_id + - first_country_code + - first_browser_name + - first_device_type + - last_seen sort: field: first_seen order: DESC @@ -51344,18 +48810,18 @@ components: type: query_users_request properties: data: - $ref: '#/components/schemas/QueryUsersRequestData' + $ref: "#/components/schemas/QueryUsersRequestData" type: object QueryUsersRequestData: properties: attributes: - $ref: '#/components/schemas/QueryUsersRequestDataAttributes' + $ref: "#/components/schemas/QueryUsersRequestDataAttributes" id: type: string type: - $ref: '#/components/schemas/QueryUsersRequestDataType' + $ref: "#/components/schemas/QueryUsersRequestDataType" required: - - type + - type type: object QueryUsersRequestDataAttributes: properties: @@ -51369,7 +48835,7 @@ components: type: string type: array sort: - $ref: '#/components/schemas/QueryUsersRequestDataAttributesSort' + $ref: "#/components/schemas/QueryUsersRequestDataAttributesSort" wildcard_search_term: type: string type: object @@ -51384,17 +48850,17 @@ components: default: query_users_request description: Query users request resource type. enum: - - query_users_request + - query_users_request example: query_users_request type: string x-enum-varnames: - - QUERY_USERS_REQUEST + - QUERY_USERS_REQUEST RUMAggregateBucketValue: description: A bucket value, can be either a timeseries or a single value. oneOf: - - $ref: '#/components/schemas/RUMAggregateBucketValueSingleString' - - $ref: '#/components/schemas/RUMAggregateBucketValueSingleNumber' - - $ref: '#/components/schemas/RUMAggregateBucketValueTimeseries' + - $ref: "#/components/schemas/RUMAggregateBucketValueSingleString" + - $ref: "#/components/schemas/RUMAggregateBucketValueSingleNumber" + - $ref: "#/components/schemas/RUMAggregateBucketValueTimeseries" RUMAggregateBucketValueSingleNumber: description: A single number value. format: double @@ -51405,7 +48871,7 @@ components: RUMAggregateBucketValueTimeseries: description: A timeseries array. items: - $ref: '#/components/schemas/RUMAggregateBucketValueTimeseriesPoint' + $ref: "#/components/schemas/RUMAggregateBucketValueTimeseriesPoint" type: array x-generate-alias-as-model: true RUMAggregateBucketValueTimeseriesPoint: @@ -51413,7 +48879,7 @@ components: properties: time: description: The time value for this point. - example: '2020-06-08T11:55:00.123Z' + example: "2020-06-08T11:55:00.123Z" format: date-time type: string value: @@ -51423,118 +48889,86 @@ components: type: number type: object RUMAggregateRequest: - description: The object sent with the request to retrieve aggregation buckets - of RUM events from your organization. + description: The object sent with the request to retrieve aggregation buckets of RUM events from your organization. properties: compute: - description: The list of metrics or timeseries to compute for the retrieved - buckets. + description: The list of metrics or timeseries to compute for the retrieved buckets. items: - $ref: '#/components/schemas/RUMCompute' + $ref: "#/components/schemas/RUMCompute" type: array filter: - $ref: '#/components/schemas/RUMQueryFilter' + $ref: "#/components/schemas/RUMQueryFilter" group_by: description: The rules for the group by. items: - $ref: '#/components/schemas/RUMGroupBy' + $ref: "#/components/schemas/RUMGroupBy" type: array options: - $ref: '#/components/schemas/RUMQueryOptions' + $ref: "#/components/schemas/RUMQueryOptions" page: - $ref: '#/components/schemas/RUMQueryPageOptions' + $ref: "#/components/schemas/RUMQueryPageOptions" type: object RUMAggregateSort: description: A sort rule. - example: - aggregation: count - order: asc + example: {"aggregation": "count", "order": "asc"} properties: aggregation: - $ref: '#/components/schemas/RUMAggregationFunction' + $ref: "#/components/schemas/RUMAggregationFunction" metric: description: The metric to sort by (only used for `type=measure`). - example: '@duration' + example: "@duration" type: string order: - $ref: '#/components/schemas/RUMSortOrder' + $ref: "#/components/schemas/RUMSortOrder" type: - $ref: '#/components/schemas/RUMAggregateSortType' + $ref: "#/components/schemas/RUMAggregateSortType" type: object RUMAggregateSortType: - default: alphabetical + default: "alphabetical" description: The type of sorting algorithm. - enum: - - alphabetical - - measure + enum: ["alphabetical", "measure"] type: string - x-enum-varnames: - - ALPHABETICAL - - MEASURE + x-enum-varnames: ["ALPHABETICAL", "MEASURE"] RUMAggregationBucketsResponse: description: The query results. properties: buckets: description: The list of matching buckets, one item per bucket. items: - $ref: '#/components/schemas/RUMBucketResponse' + $ref: "#/components/schemas/RUMBucketResponse" type: array type: object RUMAggregationFunction: description: An aggregation function. - enum: - - count - - cardinality - - pc75 - - pc90 - - pc95 - - pc98 - - pc99 - - sum - - min - - max - - avg - - median - example: pc90 - type: string - x-enum-varnames: - - COUNT - - CARDINALITY - - PERCENTILE_75 - - PERCENTILE_90 - - PERCENTILE_95 - - PERCENTILE_98 - - PERCENTILE_99 - - SUM - - MIN - - MAX - - AVG - - MEDIAN + enum: ["count", "cardinality", "pc75", "pc90", "pc95", "pc98", "pc99", "sum", "min", "max", "avg", "median"] + example: "pc90" + type: string + x-enum-varnames: ["COUNT", "CARDINALITY", "PERCENTILE_75", "PERCENTILE_90", "PERCENTILE_95", "PERCENTILE_98", "PERCENTILE_99", "SUM", "MIN", "MAX", "AVG", "MEDIAN"] RUMAnalyticsAggregateResponse: description: The response object for the RUM events aggregate API endpoint. properties: data: - $ref: '#/components/schemas/RUMAggregationBucketsResponse' + $ref: "#/components/schemas/RUMAggregationBucketsResponse" links: - $ref: '#/components/schemas/RUMResponseLinks' + $ref: "#/components/schemas/RUMResponseLinks" meta: - $ref: '#/components/schemas/RUMResponseMetadata' + $ref: "#/components/schemas/RUMResponseMetadata" type: object RUMApplication: description: RUM application. properties: attributes: - $ref: '#/components/schemas/RUMApplicationAttributes' + $ref: "#/components/schemas/RUMApplicationAttributes" id: description: RUM application ID. example: abcd1234-0000-0000-abcd-1234abcd5678 type: string type: - $ref: '#/components/schemas/RUMApplicationType' + $ref: "#/components/schemas/RUMApplicationType" required: - - attributes - - id - - type + - attributes + - id + - type type: object RUMApplicationAttributes: description: RUM application attributes. @@ -51580,11 +49014,9 @@ components: maximum: 2147483647 type: integer product_scales: - $ref: '#/components/schemas/RUMProductScales' + $ref: "#/components/schemas/RUMProductScales" type: - description: Type of the RUM application. Supported values are `browser`, - `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, - `kotlin-multiplatform`. + description: "Type of the RUM application. Supported values are `browser`, `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, `kotlin-multiplatform`." example: browser type: string updated_at: @@ -51597,26 +49029,26 @@ components: example: jane.doe type: string required: - - application_id - - client_token - - created_at - - created_by_handle - - name - - org_id - - type - - updated_at - - updated_by_handle + - application_id + - client_token + - created_at + - created_by_handle + - name + - org_id + - type + - updated_at + - updated_by_handle type: object RUMApplicationCreate: description: RUM application creation. properties: attributes: - $ref: '#/components/schemas/RUMApplicationCreateAttributes' + $ref: "#/components/schemas/RUMApplicationCreateAttributes" type: - $ref: '#/components/schemas/RUMApplicationCreateType' + $ref: "#/components/schemas/RUMApplicationCreateType" required: - - attributes - - type + - attributes + - type type: object RUMApplicationCreateAttributes: description: RUM application creation attributes. @@ -51626,49 +49058,47 @@ components: example: my_new_rum_application type: string product_analytics_retention_state: - $ref: '#/components/schemas/RUMProductAnalyticsRetentionState' + $ref: "#/components/schemas/RUMProductAnalyticsRetentionState" rum_event_processing_state: - $ref: '#/components/schemas/RUMEventProcessingState' + $ref: "#/components/schemas/RUMEventProcessingState" type: - description: Type of the RUM application. Supported values are `browser`, - `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, - `kotlin-multiplatform`. + description: "Type of the RUM application. Supported values are `browser`, `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, `kotlin-multiplatform`." example: browser type: string required: - - name + - name type: object RUMApplicationCreateRequest: description: RUM application creation request attributes. properties: data: - $ref: '#/components/schemas/RUMApplicationCreate' + $ref: "#/components/schemas/RUMApplicationCreate" required: - - data + - data type: object RUMApplicationCreateType: default: rum_application_create description: RUM application creation type. enum: - - rum_application_create + - rum_application_create example: rum_application_create type: string x-enum-varnames: - - RUM_APPLICATION_CREATE + - RUM_APPLICATION_CREATE RUMApplicationList: description: RUM application list. properties: attributes: - $ref: '#/components/schemas/RUMApplicationListAttributes' + $ref: "#/components/schemas/RUMApplicationListAttributes" id: description: RUM application ID. example: abcd1234-0000-0000-abcd-1234abcd5678 type: string type: - $ref: '#/components/schemas/RUMApplicationListType' + $ref: "#/components/schemas/RUMApplicationListType" required: - - attributes - - type + - attributes + - type type: object RUMApplicationListAttributes: description: RUM application list attributes. @@ -51704,11 +49134,9 @@ components: maximum: 2147483647 type: integer product_scales: - $ref: '#/components/schemas/RUMProductScales' + $ref: "#/components/schemas/RUMProductScales" type: - description: Type of the RUM application. Supported values are `browser`, - `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, - `kotlin-multiplatform`. + description: Type of the RUM application. Supported values are `browser`, `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, `kotlin-multiplatform`. example: browser type: string updated_at: @@ -51721,53 +49149,53 @@ components: example: jane.doe type: string required: - - application_id - - created_at - - created_by_handle - - name - - org_id - - type - - updated_at - - updated_by_handle + - application_id + - created_at + - created_by_handle + - name + - org_id + - type + - updated_at + - updated_by_handle type: object RUMApplicationListType: default: rum_application description: RUM application list type. enum: - - rum_application + - rum_application example: rum_application type: string x-enum-varnames: - - RUM_APPLICATION + - RUM_APPLICATION RUMApplicationResponse: description: RUM application response. properties: data: - $ref: '#/components/schemas/RUMApplication' + $ref: "#/components/schemas/RUMApplication" type: object RUMApplicationType: default: rum_application description: RUM application response type. enum: - - rum_application + - rum_application example: rum_application type: string x-enum-varnames: - - RUM_APPLICATION + - RUM_APPLICATION RUMApplicationUpdate: description: RUM application update. properties: attributes: - $ref: '#/components/schemas/RUMApplicationUpdateAttributes' + $ref: "#/components/schemas/RUMApplicationUpdateAttributes" id: description: RUM application ID. example: abcd1234-0000-0000-abcd-1234abcd5678 type: string type: - $ref: '#/components/schemas/RUMApplicationUpdateType' + $ref: "#/components/schemas/RUMApplicationUpdateType" required: - - id - - type + - id + - type type: object RUMApplicationUpdateAttributes: description: RUM application update attributes. @@ -51777,13 +49205,11 @@ components: example: updated_name_for_my_existing_rum_application type: string product_analytics_retention_state: - $ref: '#/components/schemas/RUMProductAnalyticsRetentionState' + $ref: "#/components/schemas/RUMProductAnalyticsRetentionState" rum_event_processing_state: - $ref: '#/components/schemas/RUMEventProcessingState' + $ref: "#/components/schemas/RUMEventProcessingState" type: - description: Type of the RUM application. Supported values are `browser`, - `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, - `kotlin-multiplatform`. + description: "Type of the RUM application. Supported values are `browser`, `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, `kotlin-multiplatform`." example: browser type: string type: object @@ -51791,26 +49217,26 @@ components: description: RUM application update request. properties: data: - $ref: '#/components/schemas/RUMApplicationUpdate' + $ref: "#/components/schemas/RUMApplicationUpdate" required: - - data + - data type: object RUMApplicationUpdateType: default: rum_application_update description: RUM application update type. enum: - - rum_application_update + - rum_application_update example: rum_application_update type: string x-enum-varnames: - - RUM_APPLICATION_UPDATE + - RUM_APPLICATION_UPDATE RUMApplicationsResponse: description: RUM applications response. properties: data: description: RUM applications array response. items: - $ref: '#/components/schemas/RUMApplicationList' + $ref: "#/components/schemas/RUMApplicationList" type: array type: object RUMBucketResponse: @@ -51821,90 +49247,77 @@ components: description: The values for each group-by. type: string description: The key-value pairs for each group-by. - example: - '@session.type': user - '@type': view + example: {"@session.type": "user", "@type": "view"} type: object computes: additionalProperties: - $ref: '#/components/schemas/RUMAggregateBucketValue' - description: A map of the metric name to value for regular compute, or a - list of values for a timeseries. + $ref: "#/components/schemas/RUMAggregateBucketValue" + description: A map of the metric name to value for regular compute, or a list of values for a timeseries. type: object type: object RUMCompute: description: A compute rule to compute metrics or timeseries. properties: aggregation: - $ref: '#/components/schemas/RUMAggregationFunction' + $ref: "#/components/schemas/RUMAggregationFunction" interval: - description: 'The time buckets'' size (only used for type=timeseries) - - Defaults to a resolution of 150 points.' - example: 5m + description: |- + The time buckets' size (only used for type=timeseries) + Defaults to a resolution of 150 points. + example: "5m" type: string metric: description: The metric to use. - example: '@duration' + example: "@duration" type: string type: - $ref: '#/components/schemas/RUMComputeType' + $ref: "#/components/schemas/RUMComputeType" required: - - aggregation + - aggregation type: object RUMComputeType: - default: total + default: "total" description: The type of compute. - enum: - - timeseries - - total + enum: ["timeseries", "total"] type: string - x-enum-varnames: - - TIMESERIES - - TOTAL + x-enum-varnames: ["TIMESERIES", "TOTAL"] RUMEvent: - description: Object description of a RUM event after being processed and stored - by Datadog. + description: Object description of a RUM event after being processed and stored by Datadog. properties: attributes: - $ref: '#/components/schemas/RUMEventAttributes' + $ref: "#/components/schemas/RUMEventAttributes" id: description: Unique ID of the event. - example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA" type: string type: - $ref: '#/components/schemas/RUMEventType' + $ref: "#/components/schemas/RUMEventType" type: object RUMEventAttributes: - description: JSON object containing all event attributes and their associated - values. + description: JSON object containing all event attributes and their associated values. properties: attributes: additionalProperties: {} description: JSON object of attributes from RUM events. - example: - customAttribute: 123 - duration: 2345 + example: {"customAttribute": 123, "duration": 2345} type: object service: - description: 'The name of the application or service generating RUM events. - + description: |- + The name of the application or service generating RUM events. It is used to switch from RUM to APM, so make sure you define the same - - value when you use both products.' - example: web-app + value when you use both products. + example: "web-app" type: string tags: description: Array of tags associated with your event. - example: - - team:A + example: ["team:A"] items: description: Tag associated with your event. type: string type: array timestamp: description: Timestamp of your event. - example: '2019-01-02T09:42:36.320Z' + example: "2019-01-02T09:42:36.320Z" format: date-time type: string type: object @@ -51917,74 +49330,73 @@ components: format: int64 type: integer state: - $ref: '#/components/schemas/RUMEventProcessingState' + $ref: "#/components/schemas/RUMEventProcessingState" type: object RUMEventProcessingState: description: Configures which RUM events are processed and stored for the application. enum: - - ALL - - ERROR_FOCUSED_MODE - - NONE + - ALL + - ERROR_FOCUSED_MODE + - NONE example: ALL type: string x-enum-descriptions: - - Process and store all RUM events (sessions, views, actions, resources, errors) - - Process and store only error events and related critical events - - "Disable RUM event processing\u2014no events are stored" + - Process and store all RUM events (sessions, views, actions, resources, errors) + - Process and store only error events and related critical events + - Disable RUM event processing—no events are stored x-enum-varnames: - - ALL - - ERROR_FOCUSED_MODE - - NONE + - ALL + - ERROR_FOCUSED_MODE + - NONE RUMEventType: default: rum description: Type of the event. enum: - - rum - example: rum + - rum + example: "rum" type: string x-enum-varnames: - - RUM + - RUM RUMEventsResponse: - description: Response object with all events matching the request and pagination - information. + description: Response object with all events matching the request and pagination information. properties: data: description: Array of events matching the request. items: - $ref: '#/components/schemas/RUMEvent' + $ref: "#/components/schemas/RUMEvent" type: array links: - $ref: '#/components/schemas/RUMResponseLinks' + $ref: "#/components/schemas/RUMResponseLinks" meta: - $ref: '#/components/schemas/RUMResponseMetadata' + $ref: "#/components/schemas/RUMResponseMetadata" type: object RUMGroupBy: description: A group-by rule. properties: facet: description: The name of the facet to use (required). - example: '@view.time_spent' + example: "@view.time_spent" type: string histogram: - $ref: '#/components/schemas/RUMGroupByHistogram' + $ref: "#/components/schemas/RUMGroupByHistogram" limit: default: 10 description: The maximum buckets to return for this group-by. format: int64 type: integer missing: - $ref: '#/components/schemas/RUMGroupByMissing' + $ref: "#/components/schemas/RUMGroupByMissing" sort: - $ref: '#/components/schemas/RUMAggregateSort' + $ref: "#/components/schemas/RUMAggregateSort" total: - $ref: '#/components/schemas/RUMGroupByTotal' + $ref: "#/components/schemas/RUMGroupByTotal" required: - - facet + - facet type: object RUMGroupByHistogram: - description: 'Used to perform a histogram computation (only for measure facets). - - Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.' + description: |- + Used to perform a histogram computation (only for measure facets). + Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval. properties: interval: description: The bin size of the histogram buckets. @@ -51992,30 +49404,29 @@ components: format: double type: number max: - description: 'The maximum value for the measure used in the histogram - - (values greater than this one are filtered out).' + description: |- + The maximum value for the measure used in the histogram + (values greater than this one are filtered out). example: 100 format: double type: number min: - description: 'The minimum value for the measure used in the histogram - - (values smaller than this one are filtered out).' + description: |- + The minimum value for the measure used in the histogram + (values smaller than this one are filtered out). example: 50 format: double type: number required: - - interval - - min - - max + - interval + - min + - max type: object RUMGroupByMissing: - description: The value to use for logs that don't have the facet used to group - by. + description: The value to use for logs that don't have the facet used to group by. oneOf: - - $ref: '#/components/schemas/RUMGroupByMissingString' - - $ref: '#/components/schemas/RUMGroupByMissingNumber' + - $ref: "#/components/schemas/RUMGroupByMissingString" + - $ref: "#/components/schemas/RUMGroupByMissingNumber" RUMGroupByMissingNumber: description: The missing value to use if there is a number valued facet. format: double @@ -52025,12 +49436,12 @@ components: type: string RUMGroupByTotal: default: false - description: A resulting object to put the given computes in over all the matching - records. + description: |- + A resulting object to put the given computes in over all the matching records. oneOf: - - $ref: '#/components/schemas/RUMGroupByTotalBoolean' - - $ref: '#/components/schemas/RUMGroupByTotalString' - - $ref: '#/components/schemas/RUMGroupByTotalNumber' + - $ref: "#/components/schemas/RUMGroupByTotalBoolean" + - $ref: "#/components/schemas/RUMGroupByTotalString" + - $ref: "#/components/schemas/RUMGroupByTotalNumber" RUMGroupByTotalBoolean: description: If set to true, creates an additional bucket labeled "$facet_total". type: boolean @@ -52050,79 +49461,71 @@ components: format: int64 type: integer state: - $ref: '#/components/schemas/RUMProductAnalyticsRetentionState' + $ref: "#/components/schemas/RUMProductAnalyticsRetentionState" type: object RUMProductAnalyticsRetentionState: - description: Controls the retention policy for Product Analytics data derived - from RUM events. + description: Controls the retention policy for Product Analytics data derived from RUM events. enum: - - MAX - - NONE + - MAX + - NONE example: MAX type: string x-enum-descriptions: - - Store Product Analytics data for the maximum available retention period - - Do not store Product Analytics data + - Store Product Analytics data for the maximum available retention period + - Do not store Product Analytics data x-enum-varnames: - - MAX - - NONE + - MAX + - NONE RUMProductScales: description: Product Scales configuration for the RUM application. properties: product_analytics_retention_scale: - $ref: '#/components/schemas/RUMProductAnalyticsRetentionScale' + $ref: "#/components/schemas/RUMProductAnalyticsRetentionScale" rum_event_processing_scale: - $ref: '#/components/schemas/RUMEventProcessingScale' + $ref: "#/components/schemas/RUMEventProcessingScale" type: object RUMQueryFilter: description: The search and filter query settings. properties: from: - default: now-15m - description: The minimum time for the requested events; supports date (in - [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with full date, - hours, minutes, and the `Z` UTC indicator - seconds and fractional seconds - are optional), math, and regular timestamps (in milliseconds). - example: now-15m + default: "now-15m" + description: The minimum time for the requested events; supports date (in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with full date, hours, minutes, and the `Z` UTC indicator - seconds and fractional seconds are optional), math, and regular timestamps (in milliseconds). + example: "now-15m" type: string query: - default: '*' + default: "*" description: The search query following the RUM search syntax. - example: '@type:session AND @session.type:user' + example: "@type:session AND @session.type:user" type: string to: - default: now - description: The maximum time for the requested events; supports date (in - [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with full date, - hours, minutes, and the `Z` UTC indicator - seconds and fractional seconds - are optional), math, and regular timestamps (in milliseconds). - example: now + default: "now" + description: The maximum time for the requested events; supports date (in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with full date, hours, minutes, and the `Z` UTC indicator - seconds and fractional seconds are optional), math, and regular timestamps (in milliseconds). + example: "now" type: string type: object RUMQueryOptions: - description: 'Global query options that are used during the query. - - Note: Only supply timezone or time offset, not both. Otherwise, the query - fails.' + description: |- + Global query options that are used during the query. + Note: Only supply timezone or time offset, not both. Otherwise, the query fails. properties: time_offset: description: The time offset (in seconds) to apply to the query. format: int64 type: integer timezone: - default: UTC - description: The timezone can be specified as GMT, UTC, an offset from UTC - (like UTC+1), or as a Timezone Database identifier (like America/New_York). - example: GMT + default: "UTC" + description: |- + The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York). + example: "GMT" type: string type: object RUMQueryPageOptions: description: Paging attributes for listing events. properties: cursor: - description: List following results with a cursor provided in the previous - query. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + List following results with a cursor provided in the previous query. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string limit: default: 10 @@ -52136,11 +49539,10 @@ components: description: Links attributes. properties: next: - description: 'Link for the next set of results. Note that the request can - also be made using the - - POST endpoint.' - example: https://app.datadoghq.com/api/v2/rum/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + Link for the next set of results. Note that the request can also be made using the + POST endpoint. + example: "https://app.datadoghq.com/api/v2/rum/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string type: object RUMResponseMetadata: @@ -52152,88 +49554,81 @@ components: format: int64 type: integer page: - $ref: '#/components/schemas/RUMResponsePage' + $ref: "#/components/schemas/RUMResponsePage" request_id: description: The identifier of the request. - example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR + example: "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR" type: string status: - $ref: '#/components/schemas/RUMResponseStatus' + $ref: "#/components/schemas/RUMResponseStatus" warnings: - description: 'A list of warnings (non-fatal errors) encountered. Partial - results may return if - - warnings are present in the response.' + description: |- + A list of warnings (non-fatal errors) encountered. Partial results may return if + warnings are present in the response. items: - $ref: '#/components/schemas/RUMWarning' + $ref: "#/components/schemas/RUMWarning" type: array type: object RUMResponsePage: description: Paging attributes. properties: after: - description: The cursor to use to get the next results, if any. To make - the next request, use the same parameters with the addition of `page[cursor]`. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string type: object RUMResponseStatus: description: The status of the response. - enum: - - done - - timeout - example: done + enum: ["done", "timeout"] + example: "done" type: string - x-enum-varnames: - - DONE - - TIMEOUT + x-enum-varnames: ["DONE", "TIMEOUT"] RUMSearchEventsRequest: description: The request for a RUM events list. properties: filter: - $ref: '#/components/schemas/RUMQueryFilter' + $ref: "#/components/schemas/RUMQueryFilter" options: - $ref: '#/components/schemas/RUMQueryOptions' + $ref: "#/components/schemas/RUMQueryOptions" page: - $ref: '#/components/schemas/RUMQueryPageOptions' + $ref: "#/components/schemas/RUMQueryPageOptions" sort: - $ref: '#/components/schemas/RUMSort' + $ref: "#/components/schemas/RUMSort" type: object RUMSort: description: Sort parameters when querying events. enum: - - timestamp - - -timestamp + - timestamp + - -timestamp type: string x-enum-varnames: - - TIMESTAMP_ASCENDING - - TIMESTAMP_DESCENDING + - TIMESTAMP_ASCENDING + - TIMESTAMP_DESCENDING RUMSortOrder: description: The order to use, ascending or descending. enum: - - asc - - desc - example: asc + - "asc" + - "desc" + example: "asc" type: string x-enum-varnames: - - ASCENDING - - DESCENDING + - "ASCENDING" + - "DESCENDING" RUMWarning: - description: A warning message indicating something that went wrong with the - query. + description: A warning message indicating something that went wrong with the query. properties: code: description: A unique code for this type of warning. - example: unknown_index + example: "unknown_index" type: string detail: description: A detailed explanation of this specific warning. - example: 'indexes: foo, bar' + example: "indexes: foo, bar" type: string title: description: A short human-readable summary of the warning. - example: One or several indexes are missing or invalid, results hold data - from the other indexes + example: "One or several indexes are missing or invalid, results hold data from the other indexes" type: string type: object RawErrorBudgetRemaining: @@ -52249,158 +49644,146 @@ components: format: double type: number required: - - value - - unit + - value + - unit type: object ReadinessGate: description: Used to merge multiple branches into a single branch. properties: thresholdType: - $ref: '#/components/schemas/ReadinessGateThresholdType' + $ref: "#/components/schemas/ReadinessGateThresholdType" required: - - thresholdType + - thresholdType type: object ReadinessGateThresholdType: description: The definition of `ReadinessGateThresholdType` object. enum: - - ANY - - ALL + - ANY + - ALL example: ANY type: string x-enum-varnames: - - ANY - - ALL + - ANY + - ALL RecommendationAttributes: - description: Attributes of the SPA Recommendation resource. Contains recommendations - for both driver and executor components. + description: Attributes of the SPA Recommendation resource. Contains recommendations for both driver and executor components. properties: confidence_level: format: double type: number driver: - $ref: '#/components/schemas/ComponentRecommendation' + $ref: "#/components/schemas/ComponentRecommendation" executor: - $ref: '#/components/schemas/ComponentRecommendation' - required: - - driver - - executor + $ref: "#/components/schemas/ComponentRecommendation" + required: [driver, executor] type: object RecommendationData: - description: JSON:API resource object for SPA Recommendation. Includes type, - optional ID, and resource attributes with structured recommendations. + description: JSON:API resource object for SPA Recommendation. Includes type, optional ID, and resource attributes with structured recommendations. properties: attributes: - $ref: '#/components/schemas/RecommendationAttributes' + $ref: "#/components/schemas/RecommendationAttributes" id: description: Resource identifier for the recommendation. Optional in responses. type: string type: - $ref: '#/components/schemas/RecommendationType' - required: - - type - - attributes + $ref: "#/components/schemas/RecommendationType" + required: [type, attributes] type: object RecommendationDocument: - description: JSON:API document containing a single Recommendation resource. - Returned by SPA when the Spark Gateway requests recommendations. + description: JSON:API document containing a single Recommendation resource. Returned by SPA when the Spark Gateway requests recommendations. properties: data: - $ref: '#/components/schemas/RecommendationData' - required: - - data + $ref: "#/components/schemas/RecommendationData" + required: [data] type: object RecommendationType: default: recommendation - description: JSON:API resource type for Spark Pod Autosizing recommendations. - Identifies the Recommendation resource returned by SPA. + description: JSON:API resource type for Spark Pod Autosizing recommendations. Identifies the Recommendation resource returned by SPA. enum: - - recommendation + - recommendation example: recommendation type: string x-enum-varnames: - - RECOMMENDATION + - RECOMMENDATION ReferenceTableCreateSourceType: - description: The source type for creating reference table data. Only these source - types can be created through this API. + description: The source type for creating reference table data. Only these source types can be created through this API. enum: - - LOCAL_FILE - - S3 - - GCS - - AZURE - example: LOCAL_FILE + - LOCAL_FILE + - S3 + - GCS + - AZURE + example: "LOCAL_FILE" type: string x-enum-varnames: - - LOCAL_FILE - - S3 - - GCS - - AZURE + - LOCAL_FILE + - S3 + - GCS + - AZURE ReferenceTableSchemaFieldType: description: The field type for reference table schema fields. enum: - - STRING - - INT32 - example: STRING + - STRING + - INT32 + example: "STRING" type: string x-enum-varnames: - - STRING - - INT32 + - STRING + - INT32 ReferenceTableSortType: - default: -updated_at - description: Sort field and direction for reference tables. Use field name for - ascending, prefix with "-" for descending. - enum: - - updated_at - - table_name - - status - - -updated_at - - -table_name - - -status - type: string - x-enum-varnames: - - UPDATED_AT - - TABLE_NAME - - STATUS - - MINUS_UPDATED_AT - - MINUS_TABLE_NAME - - MINUS_STATUS + default: "-updated_at" + description: Sort field and direction for reference tables. Use field name for ascending, prefix with "-" for descending. + enum: + - updated_at + - table_name + - status + - "-updated_at" + - "-table_name" + - "-status" + type: string + x-enum-varnames: + - UPDATED_AT + - TABLE_NAME + - STATUS + - MINUS_UPDATED_AT + - MINUS_TABLE_NAME + - MINUS_STATUS ReferenceTableSourceType: - description: The source type for reference table data. Includes all possible - source types that can appear in responses. - enum: - - LOCAL_FILE - - S3 - - GCS - - AZURE - - SERVICENOW - - SALESFORCE - - DATABRICKS - - SNOWFLAKE - example: LOCAL_FILE - type: string - x-enum-varnames: - - LOCAL_FILE - - S3 - - GCS - - AZURE - - SERVICENOW - - SALESFORCE - - DATABRICKS - - SNOWFLAKE + description: The source type for reference table data. Includes all possible source types that can appear in responses. + enum: + - LOCAL_FILE + - S3 + - GCS + - AZURE + - SERVICENOW + - SALESFORCE + - DATABRICKS + - SNOWFLAKE + example: "LOCAL_FILE" + type: string + x-enum-varnames: + - LOCAL_FILE + - S3 + - GCS + - AZURE + - SERVICENOW + - SALESFORCE + - DATABRICKS + - SNOWFLAKE RegisterAppKeyResponse: description: The response object after creating an app key registration. properties: data: - $ref: '#/components/schemas/AppKeyRegistrationData' + $ref: "#/components/schemas/AppKeyRegistrationData" type: object RelationAttributes: description: Relation attributes. properties: from: - $ref: '#/components/schemas/RelationEntity' + $ref: "#/components/schemas/RelationEntity" to: - $ref: '#/components/schemas/RelationEntity' + $ref: "#/components/schemas/RelationEntity" type: - $ref: '#/components/schemas/RelationType' + $ref: "#/components/schemas/RelationType" type: object RelationEntity: description: Relation entity reference. @@ -52418,12 +49801,12 @@ components: RelationIncludeType: description: Supported include types for relations. enum: - - entity - - schema + - entity + - schema type: string x-enum-varnames: - - ENTITY - - SCHEMA + - ENTITY + - SCHEMA RelationMeta: description: Relation metadata. properties: @@ -52446,32 +49829,32 @@ components: description: Relation relationships. properties: fromEntity: - $ref: '#/components/schemas/RelationToEntity' + $ref: "#/components/schemas/RelationToEntity" toEntity: - $ref: '#/components/schemas/RelationToEntity' + $ref: "#/components/schemas/RelationToEntity" type: object RelationResponse: description: Relation response data. properties: attributes: - $ref: '#/components/schemas/RelationAttributes' + $ref: "#/components/schemas/RelationAttributes" id: description: Relation ID. type: string meta: - $ref: '#/components/schemas/RelationMeta' + $ref: "#/components/schemas/RelationMeta" relationships: - $ref: '#/components/schemas/RelationRelationships' + $ref: "#/components/schemas/RelationRelationships" subtype: description: Relation subtype. type: string type: - $ref: '#/components/schemas/RelationResponseType' + $ref: "#/components/schemas/RelationResponseType" type: object RelationResponseData: description: Array of relation responses items: - $ref: '#/components/schemas/RelationResponse' + $ref: "#/components/schemas/RelationResponse" type: array RelationResponseMeta: description: Relation response metadata. @@ -52487,48 +49870,47 @@ components: type: object RelationResponseType: description: Relation type. - enum: - - relation + enum: [relation] type: string x-enum-varnames: - - RELATION + - RELATION RelationToEntity: description: Relation to entity. properties: data: - $ref: '#/components/schemas/RelationshipItem' + $ref: "#/components/schemas/RelationshipItem" meta: - $ref: '#/components/schemas/EntityMeta' + $ref: "#/components/schemas/EntityMeta" type: object RelationType: description: Supported relation types. enum: - - RelationTypeOwns - - RelationTypeOwnedBy - - RelationTypeDependsOn - - RelationTypeDependencyOf - - RelationTypePartsOf - - RelationTypeHasPart - - RelationTypeOtherOwns - - RelationTypeOtherOwnedBy - - RelationTypeImplementedBy - - RelationTypeImplements - type: string - x-enum-varnames: - - RELATIONTYPEOWNS - - RELATIONTYPEOWNEDBY - - RELATIONTYPEDEPENDSON - - RELATIONTYPEDEPENDENCYOF - - RELATIONTYPEPARTSOF - - RELATIONTYPEHASPART - - RELATIONTYPEOTHEROWNS - - RELATIONTYPEOTHEROWNEDBY - - RELATIONTYPEIMPLEMENTEDBY - - RELATIONTYPEIMPLEMENTS + - RelationTypeOwns + - RelationTypeOwnedBy + - RelationTypeDependsOn + - RelationTypeDependencyOf + - RelationTypePartsOf + - RelationTypeHasPart + - RelationTypeOtherOwns + - RelationTypeOtherOwnedBy + - RelationTypeImplementedBy + - RelationTypeImplements + type: string + x-enum-varnames: + - RELATIONTYPEOWNS + - RELATIONTYPEOWNEDBY + - RELATIONTYPEDEPENDSON + - RELATIONTYPEDEPENDENCYOF + - RELATIONTYPEPARTSOF + - RELATIONTYPEHASPART + - RELATIONTYPEOTHEROWNS + - RELATIONTYPEOTHEROWNEDBY + - RELATIONTYPEIMPLEMENTEDBY + - RELATIONTYPEIMPLEMENTS RelationshipArray: description: Relationships. items: - $ref: '#/components/schemas/RelationshipItem' + $ref: "#/components/schemas/RelationshipItem" type: array RelationshipItem: description: Relationship entry. @@ -52544,59 +49926,60 @@ components: description: Relationship to incident. properties: data: - $ref: '#/components/schemas/RelationshipToIncidentData' + $ref: "#/components/schemas/RelationshipToIncidentData" required: - - data + - data type: object RelationshipToIncidentAttachment: description: A relationship reference for attachments. properties: data: - description: An array of incident attachments. + description: |- + An array of incident attachments. items: - $ref: '#/components/schemas/RelationshipToIncidentAttachmentData' + $ref: "#/components/schemas/RelationshipToIncidentAttachmentData" type: array required: - - data + - data type: object RelationshipToIncidentAttachmentData: description: The attachment relationship data. properties: id: description: A unique identifier that represents the attachment. - example: 00000000-0000-abcd-1000-000000000000 + example: "00000000-0000-abcd-1000-000000000000" type: string type: - $ref: '#/components/schemas/IncidentAttachmentType' + $ref: "#/components/schemas/IncidentAttachmentType" required: - - id - - type + - id + - type type: object RelationshipToIncidentData: description: Relationship to incident object. properties: id: description: A unique identifier that represents the incident. - example: 00000000-0000-0000-1234-000000000000 + example: "00000000-0000-0000-1234-000000000000" type: string type: - $ref: '#/components/schemas/IncidentType' + $ref: "#/components/schemas/IncidentType" required: - - id - - type + - id + - type type: object RelationshipToIncidentImpactData: description: Relationship to impact object. properties: id: description: A unique identifier that represents the impact. - example: 00000000-0000-0000-2345-000000000000 + example: "00000000-0000-0000-2345-000000000000" type: string type: - $ref: '#/components/schemas/IncidentImpactsType' + $ref: "#/components/schemas/IncidentImpactsType" required: - - id - - type + - id + - type type: object RelationshipToIncidentImpacts: description: Relationship to impacts. @@ -52604,119 +49987,103 @@ components: data: description: An array of incident impacts. items: - $ref: '#/components/schemas/RelationshipToIncidentImpactData' + $ref: "#/components/schemas/RelationshipToIncidentImpactData" type: array required: - - data + - data type: object RelationshipToIncidentIntegrationMetadataData: description: A relationship reference for an integration metadata object. - example: - id: 00000000-abcd-0002-0000-000000000000 - type: incident_integrations + example: {"id": "00000000-abcd-0002-0000-000000000000", "type": "incident_integrations"} properties: id: description: A unique identifier that represents the integration metadata. - example: 00000000-abcd-0001-0000-000000000000 + example: "00000000-abcd-0001-0000-000000000000" type: string type: - $ref: '#/components/schemas/IncidentIntegrationMetadataType' + $ref: "#/components/schemas/IncidentIntegrationMetadataType" required: - - id - - type + - id + - type type: object RelationshipToIncidentIntegrationMetadatas: description: A relationship reference for multiple integration metadata objects. - example: - data: - - id: 00000000-abcd-0005-0000-000000000000 - type: incident_integrations - - id: 00000000-abcd-0006-0000-000000000000 - type: incident_integrations + example: {"data": [{"id": "00000000-abcd-0005-0000-000000000000", "type": "incident_integrations"}, {"id": "00000000-abcd-0006-0000-000000000000", "type": "incident_integrations"}]} properties: data: description: Integration metadata relationship array - example: - - id: 00000000-abcd-0003-0000-000000000000 - type: incident_integrations - - id: 00000000-abcd-0004-0000-000000000000 - type: incident_integrations + example: [{"id": "00000000-abcd-0003-0000-000000000000", "type": "incident_integrations"}, {"id": "00000000-abcd-0004-0000-000000000000", "type": "incident_integrations"}] items: - $ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadataData' + $ref: "#/components/schemas/RelationshipToIncidentIntegrationMetadataData" type: array required: - - data + - data type: object RelationshipToIncidentNotificationTemplate: description: A relationship reference to a notification template. properties: data: - $ref: '#/components/schemas/RelationshipToIncidentNotificationTemplateData' + $ref: "#/components/schemas/RelationshipToIncidentNotificationTemplateData" required: - - data + - data type: object RelationshipToIncidentNotificationTemplateData: description: The notification template relationship data. properties: id: description: The unique identifier of the notification template. - example: 00000000-0000-0000-0000-000000000001 + example: "00000000-0000-0000-0000-000000000001" format: uuid type: string type: - $ref: '#/components/schemas/IncidentNotificationTemplateType' + $ref: "#/components/schemas/IncidentNotificationTemplateType" required: - - id - - type + - id + - type type: object RelationshipToIncidentPostmortem: description: A relationship reference for postmortems. - example: - data: - id: 00000000-0000-abcd-3000-000000000000 - type: incident_postmortems + example: {"data": {"id": "00000000-0000-abcd-3000-000000000000", "type": "incident_postmortems"}} properties: data: - $ref: '#/components/schemas/RelationshipToIncidentPostmortemData' + $ref: "#/components/schemas/RelationshipToIncidentPostmortemData" required: - - data + - data type: object RelationshipToIncidentPostmortemData: description: The postmortem relationship data. - example: - id: 00000000-0000-abcd-2000-000000000000 - type: incident_postmortems + example: {"id": "00000000-0000-abcd-2000-000000000000", "type": "incident_postmortems"} properties: id: description: A unique identifier that represents the postmortem. - example: 00000000-0000-abcd-1000-000000000000 + example: "00000000-0000-abcd-1000-000000000000" type: string type: - $ref: '#/components/schemas/IncidentPostmortemType' + $ref: "#/components/schemas/IncidentPostmortemType" required: - - id - - type + - id + - type type: object RelationshipToIncidentRequest: description: Relationship to incident request properties: data: - $ref: '#/components/schemas/IncidentRelationshipData' + $ref: "#/components/schemas/IncidentRelationshipData" required: - - data + - data type: object RelationshipToIncidentResponderData: description: Relationship to impact object. properties: id: description: A unique identifier that represents the responder. - example: 00000000-0000-0000-2345-000000000000 + example: "00000000-0000-0000-2345-000000000000" type: string type: - $ref: '#/components/schemas/IncidentRespondersType' + $ref: "#/components/schemas/IncidentRespondersType" required: - - id - - type + - id + - type type: object RelationshipToIncidentResponders: description: Relationship to incident responders. @@ -52724,44 +50091,44 @@ components: data: description: An array of incident responders. items: - $ref: '#/components/schemas/RelationshipToIncidentResponderData' + $ref: "#/components/schemas/RelationshipToIncidentResponderData" type: array required: - - data + - data type: object RelationshipToIncidentType: description: Relationship to an incident type. properties: data: - $ref: '#/components/schemas/RelationshipToIncidentTypeData' + $ref: "#/components/schemas/RelationshipToIncidentTypeData" required: - - data + - data type: object RelationshipToIncidentTypeData: description: Relationship to incident type object. properties: id: description: The incident type's ID. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string type: - $ref: '#/components/schemas/IncidentTypeType' + $ref: "#/components/schemas/IncidentTypeType" required: - - id - - type + - id + - type type: object RelationshipToIncidentUserDefinedFieldData: description: Relationship to impact object. properties: id: description: A unique identifier that represents the responder. - example: 00000000-0000-0000-2345-000000000000 + example: "00000000-0000-0000-2345-000000000000" type: string type: - $ref: '#/components/schemas/IncidentUserDefinedFieldType' + $ref: "#/components/schemas/IncidentUserDefinedFieldType" required: - - id - - type + - id + - type type: object RelationshipToIncidentUserDefinedFields: description: Relationship to incident user defined fields. @@ -52769,31 +50136,31 @@ components: data: description: An array of user defined fields. items: - $ref: '#/components/schemas/RelationshipToIncidentUserDefinedFieldData' + $ref: "#/components/schemas/RelationshipToIncidentUserDefinedFieldData" type: array required: - - data + - data type: object RelationshipToOrganization: description: Relationship to an organization. properties: data: - $ref: '#/components/schemas/RelationshipToOrganizationData' + $ref: "#/components/schemas/RelationshipToOrganizationData" required: - - data + - data type: object RelationshipToOrganizationData: description: Relationship to organization object. properties: id: description: ID of the organization. - example: 00000000-0000-beef-0000-000000000000 + example: "00000000-0000-beef-0000-000000000000" type: string type: - $ref: '#/components/schemas/OrganizationsType' + $ref: "#/components/schemas/OrganizationsType" required: - - id - - type + - id + - type type: object RelationshipToOrganizations: description: Relationship to organizations. @@ -52802,31 +50169,30 @@ components: description: Relationships to organization objects. example: [] items: - $ref: '#/components/schemas/RelationshipToOrganizationData' + $ref: "#/components/schemas/RelationshipToOrganizationData" type: array required: - - data + - data type: object RelationshipToOutcome: description: The JSON:API relationship to a scorecard outcome. properties: data: - $ref: '#/components/schemas/RelationshipToOutcomeData' + $ref: "#/components/schemas/RelationshipToOutcomeData" type: object RelationshipToOutcomeData: - description: The JSON:API relationship to an outcome, which returns the related - rule id. + description: The JSON:API relationship to an outcome, which returns the related rule id. properties: id: - $ref: '#/components/schemas/RuleId' + $ref: "#/components/schemas/RuleId" type: - $ref: '#/components/schemas/RuleType' + $ref: "#/components/schemas/RuleType" type: object RelationshipToPermission: description: Relationship to a permissions object. properties: data: - $ref: '#/components/schemas/RelationshipToPermissionData' + $ref: "#/components/schemas/RelationshipToPermissionData" type: object RelationshipToPermissionData: description: Relationship to permission object. @@ -52835,7 +50201,7 @@ components: description: ID of the permission. type: string type: - $ref: '#/components/schemas/PermissionsType' + $ref: "#/components/schemas/PermissionsType" type: object RelationshipToPermissions: description: Relationship to multiple permissions objects. @@ -52843,24 +50209,24 @@ components: data: description: Relationships to permission objects. items: - $ref: '#/components/schemas/RelationshipToPermissionData' + $ref: "#/components/schemas/RelationshipToPermissionData" type: array type: object RelationshipToRole: description: Relationship to role. properties: data: - $ref: '#/components/schemas/RelationshipToRoleData' + $ref: "#/components/schemas/RelationshipToRoleData" type: object RelationshipToRoleData: description: Relationship to role object. properties: id: description: The unique identifier of the role. - example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + example: "3653d3c6-0c75-11ea-ad28-fb5701eabc7d" type: string type: - $ref: '#/components/schemas/RolesType' + $ref: "#/components/schemas/RolesType" type: object RelationshipToRoles: description: Relationship to roles. @@ -52868,20 +50234,20 @@ components: data: description: An array containing type and the unique identifier of a role. items: - $ref: '#/components/schemas/RelationshipToRoleData' + $ref: "#/components/schemas/RelationshipToRoleData" type: array type: object RelationshipToRule: description: Scorecard create rule response relationship. properties: scorecard: - $ref: '#/components/schemas/RelationshipToRuleData' + $ref: "#/components/schemas/RelationshipToRuleData" type: object RelationshipToRuleData: description: Relationship data for a rule. properties: data: - $ref: '#/components/schemas/RelationshipToRuleDataObject' + $ref: "#/components/schemas/RelationshipToRuleDataObject" type: object RelationshipToRuleDataObject: description: Rule relationship data. @@ -52891,34 +50257,34 @@ components: example: q8MQxk8TCqrHnWkp type: string type: - $ref: '#/components/schemas/ScorecardType' + $ref: "#/components/schemas/ScorecardType" type: object RelationshipToSAMLAssertionAttribute: description: AuthN Mapping relationship to SAML Assertion Attribute. properties: data: - $ref: '#/components/schemas/RelationshipToSAMLAssertionAttributeData' + $ref: "#/components/schemas/RelationshipToSAMLAssertionAttributeData" required: - - data + - data type: object RelationshipToSAMLAssertionAttributeData: description: Data of AuthN Mapping relationship to SAML Assertion Attribute. properties: id: description: The ID of the SAML assertion attribute. - example: '0' + example: "0" type: string type: - $ref: '#/components/schemas/SAMLAssertionAttributesType' + $ref: "#/components/schemas/SAMLAssertionAttributesType" required: - - id - - type + - id + - type type: object RelationshipToTeam: description: Relationship to team. properties: data: - $ref: '#/components/schemas/RelationshipToTeamData' + $ref: "#/components/schemas/RelationshipToTeamData" type: object RelationshipToTeamData: description: Relationship to Team object. @@ -52928,7 +50294,7 @@ components: example: f9bb8444-af7f-11ec-ac2c-da7ad0900001 type: string type: - $ref: '#/components/schemas/TeamType' + $ref: "#/components/schemas/TeamType" type: object RelationshipToTeamLinkData: description: Relationship between a link and a team @@ -52938,10 +50304,10 @@ components: example: f9bb8444-af7f-11ec-ac2c-da7ad0900001 type: string type: - $ref: '#/components/schemas/TeamLinkType' + $ref: "#/components/schemas/TeamLinkType" required: - - id - - type + - id + - type type: object RelationshipToTeamLinks: description: Relationship between a team and a team link @@ -52949,39 +50315,39 @@ components: data: description: Related team links items: - $ref: '#/components/schemas/RelationshipToTeamLinkData' + $ref: "#/components/schemas/RelationshipToTeamLinkData" type: array links: - $ref: '#/components/schemas/TeamRelationshipsLinks' + $ref: "#/components/schemas/TeamRelationshipsLinks" type: object RelationshipToUser: description: Relationship to user. properties: data: - $ref: '#/components/schemas/RelationshipToUserData' + $ref: "#/components/schemas/RelationshipToUserData" required: - - data + - data type: object RelationshipToUserData: description: Relationship to user object. properties: id: description: A unique identifier that represents the user. - example: 00000000-0000-0000-2345-000000000000 + example: "00000000-0000-0000-2345-000000000000" type: string type: - $ref: '#/components/schemas/UsersType' + $ref: "#/components/schemas/UsersType" required: - - id - - type + - id + - type type: object RelationshipToUserTeamPermission: description: Relationship between a user team permission and a team properties: data: - $ref: '#/components/schemas/RelationshipToUserTeamPermissionData' + $ref: "#/components/schemas/RelationshipToUserTeamPermissionData" links: - $ref: '#/components/schemas/TeamRelationshipsLinks' + $ref: "#/components/schemas/TeamRelationshipsLinks" type: object RelationshipToUserTeamPermissionData: description: Related user team permission data @@ -52992,18 +50358,18 @@ components: example: UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595 type: string type: - $ref: '#/components/schemas/UserTeamPermissionType' + $ref: "#/components/schemas/UserTeamPermissionType" required: - - id - - type + - id + - type type: object RelationshipToUserTeamTeam: description: Relationship between team membership and team properties: data: - $ref: '#/components/schemas/RelationshipToUserTeamTeamData' + $ref: "#/components/schemas/RelationshipToUserTeamTeamData" required: - - data + - data type: object RelationshipToUserTeamTeamData: description: The team associated with the membership @@ -53013,18 +50379,18 @@ components: example: d7e15d9d-d346-43da-81d8-3d9e71d9a5e9 type: string type: - $ref: '#/components/schemas/UserTeamTeamType' + $ref: "#/components/schemas/UserTeamTeamType" required: - - id - - type + - id + - type type: object RelationshipToUserTeamUser: description: Relationship between team membership and user properties: data: - $ref: '#/components/schemas/RelationshipToUserTeamUserData' + $ref: "#/components/schemas/RelationshipToUserTeamUserData" required: - - data + - data type: object RelationshipToUserTeamUserData: description: A user's relationship with a team @@ -53034,10 +50400,10 @@ components: example: b8626d7e-cedd-11eb-abf5-da7ad0900001 type: string type: - $ref: '#/components/schemas/UserTeamUserType' + $ref: "#/components/schemas/UserTeamUserType" required: - - id - - type + - id + - type type: object RelationshipToUsers: description: Relationship to users. @@ -53046,28 +50412,27 @@ components: description: Relationships to user objects. example: [] items: - $ref: '#/components/schemas/RelationshipToUserData' + $ref: "#/components/schemas/RelationshipToUserData" type: array required: - - data + - data type: object Remediation: description: Vulnerability remediation. properties: auto_solvable: - description: Whether the vulnerability can be resolved when recompiling - the package or not. + description: Whether the vulnerability can be resolved when recompiling the package or not. example: false type: boolean avoided_advisories: description: Avoided advisories. items: - $ref: '#/components/schemas/Advisory' + $ref: "#/components/schemas/Advisory" type: array fixed_advisories: description: Remediation fixed advisories. items: - $ref: '#/components/schemas/Advisory' + $ref: "#/components/schemas/Advisory" type: array library_name: description: Library name remediating the vulnerability. @@ -53080,26 +50445,26 @@ components: new_advisories: description: New advisories. items: - $ref: '#/components/schemas/Advisory' + $ref: "#/components/schemas/Advisory" type: array remaining_advisories: description: Remaining advisories. items: - $ref: '#/components/schemas/Advisory' + $ref: "#/components/schemas/Advisory" type: array type: description: Remediation type. example: text type: string required: - - type - - library_name - - library_version - - auto_solvable - - fixed_advisories - - remaining_advisories - - new_advisories - - avoided_advisories + - type + - library_name + - library_version + - auto_solvable + - fixed_advisories + - remaining_advisories + - new_advisories + - avoided_advisories type: object ReorderRetentionFiltersRequest: description: A list of retention filters to reorder. @@ -53107,29 +50472,29 @@ components: data: description: A list of retention filters objects. items: - $ref: '#/components/schemas/RetentionFilterWithoutAttributes' + $ref: "#/components/schemas/RetentionFilterWithoutAttributes" type: array required: - - data + - data type: object ReorderRuleResourceArray: description: The definition of `ReorderRuleResourceArray` object. example: data: - - id: '456' - type: arbitrary_rule - - id: '123' - type: arbitrary_rule - - id: '789' - type: arbitrary_rule + - id: "456" + type: arbitrary_rule + - id: "123" + type: arbitrary_rule + - id: "789" + type: arbitrary_rule properties: data: description: The `ReorderRuleResourceArray` `data`. items: - $ref: '#/components/schemas/ReorderRuleResourceData' + $ref: "#/components/schemas/ReorderRuleResourceData" type: array required: - - data + - data type: object ReorderRuleResourceData: description: The definition of `ReorderRuleResourceData` object. @@ -53138,37 +50503,37 @@ components: description: The `ReorderRuleResourceData` `id`. type: string type: - $ref: '#/components/schemas/ReorderRuleResourceDataType' + $ref: "#/components/schemas/ReorderRuleResourceDataType" required: - - type + - type type: object ReorderRuleResourceDataType: default: arbitrary_rule description: Arbitrary rule resource type. enum: - - arbitrary_rule + - arbitrary_rule example: arbitrary_rule type: string x-enum-varnames: - - ARBITRARY_RULE + - ARBITRARY_RULE ReorderRulesetResourceArray: description: The definition of `ReorderRulesetResourceArray` object. example: data: - - id: 55ef2385-9ae1-4410-90c4-5ac1b60fec10 - type: ruleset - - id: a7b8c9d0-1234-5678-9abc-def012345678 - type: ruleset - - id: f1e2d3c4-b5a6-9780-1234-567890abcdef - type: ruleset + - id: "55ef2385-9ae1-4410-90c4-5ac1b60fec10" + type: ruleset + - id: "a7b8c9d0-1234-5678-9abc-def012345678" + type: ruleset + - id: "f1e2d3c4-b5a6-9780-1234-567890abcdef" + type: ruleset properties: data: description: The `ReorderRulesetResourceArray` `data`. items: - $ref: '#/components/schemas/ReorderRulesetResourceData' + $ref: "#/components/schemas/ReorderRulesetResourceData" type: array required: - - data + - data type: object ReorderRulesetResourceData: description: The definition of `ReorderRulesetResourceData` object. @@ -53177,34 +50542,34 @@ components: description: The `ReorderRulesetResourceData` `id`. type: string type: - $ref: '#/components/schemas/ReorderRulesetResourceDataType' + $ref: "#/components/schemas/ReorderRulesetResourceDataType" required: - - type + - type type: object ReorderRulesetResourceDataType: default: ruleset description: Ruleset resource type. enum: - - ruleset + - ruleset example: ruleset type: string x-enum-varnames: - - RULESET + - RULESET ResolveVulnerableSymbolsRequest: properties: data: - $ref: '#/components/schemas/ResolveVulnerableSymbolsRequestData' + $ref: "#/components/schemas/ResolveVulnerableSymbolsRequestData" type: object ResolveVulnerableSymbolsRequestData: properties: attributes: - $ref: '#/components/schemas/ResolveVulnerableSymbolsRequestDataAttributes' + $ref: "#/components/schemas/ResolveVulnerableSymbolsRequestDataAttributes" id: type: string type: - $ref: '#/components/schemas/ResolveVulnerableSymbolsRequestDataType' + $ref: "#/components/schemas/ResolveVulnerableSymbolsRequestDataType" required: - - type + - type type: object ResolveVulnerableSymbolsRequestDataAttributes: properties: @@ -53216,49 +50581,49 @@ components: ResolveVulnerableSymbolsRequestDataType: default: resolve-vulnerable-symbols-request enum: - - resolve-vulnerable-symbols-request + - resolve-vulnerable-symbols-request example: resolve-vulnerable-symbols-request type: string x-enum-varnames: - - RESOLVE_VULNERABLE_SYMBOLS_REQUEST + - RESOLVE_VULNERABLE_SYMBOLS_REQUEST ResolveVulnerableSymbolsResponse: properties: data: - $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseData' + $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseData" type: object ResolveVulnerableSymbolsResponseData: properties: attributes: - $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseDataAttributes' + $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseDataAttributes" id: type: string type: - $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseDataType' + $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseDataType" required: - - type + - type type: object ResolveVulnerableSymbolsResponseDataAttributes: properties: results: items: - $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseResults' + $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseResults" type: array type: object ResolveVulnerableSymbolsResponseDataType: default: resolve-vulnerable-symbols-response enum: - - resolve-vulnerable-symbols-response + - resolve-vulnerable-symbols-response example: resolve-vulnerable-symbols-response type: string x-enum-varnames: - - RESOLVE_VULNERABLE_SYMBOLS_RESPONSE + - RESOLVE_VULNERABLE_SYMBOLS_RESPONSE ResolveVulnerableSymbolsResponseResults: properties: purl: type: string vulnerable_symbols: items: - $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseResultsVulnerableSymbols' + $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseResultsVulnerableSymbols" type: array type: object ResolveVulnerableSymbolsResponseResultsVulnerableSymbols: @@ -53267,7 +50632,7 @@ components: type: string symbols: items: - $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols' + $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols" type: array type: object ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols: @@ -53283,15 +50648,15 @@ components: description: Attributes of a resource filter. example: aws: - '123456789': - - environment:production - - team:devops + "123456789": + - environment:production + - team:devops azure: sub-001: - - app:frontend + - app:frontend gcp: project-abc: - - region:us-central1 + - region:us-central1 properties: cloud_provider: additionalProperties: @@ -53302,83 +50667,72 @@ components: type: string type: array type: object - description: A map of cloud provider names (e.g., "aws", "gcp", "azure") - to a map of account/resource IDs and their associated tag filters. + description: A map of cloud provider names (e.g., "aws", "gcp", "azure") to a map of account/resource IDs and their associated tag filters. type: object uuid: description: The UUID of the resource filter. type: string required: - - cloud_provider + - cloud_provider type: object ResourceFilterRequestType: description: Constant string to identify the request type. enum: - - csm_resource_filter + - csm_resource_filter example: csm_resource_filter type: string x-enum-varnames: - - CSM_RESOURCE_FILTER + - CSM_RESOURCE_FILTER ResponseMetaAttributes: description: Object describing meta attributes of response. properties: page: - $ref: '#/components/schemas/Pagination' + $ref: "#/components/schemas/Pagination" type: object RestrictionPolicy: description: Restriction policy object. properties: attributes: - $ref: '#/components/schemas/RestrictionPolicyAttributes' + $ref: "#/components/schemas/RestrictionPolicyAttributes" id: - description: The identifier, always equivalent to the value specified in - the `resource_id` path parameter. - example: dashboard:abc-def-ghi + description: The identifier, always equivalent to the value specified in the `resource_id` path parameter. + example: "dashboard:abc-def-ghi" type: string type: - $ref: '#/components/schemas/RestrictionPolicyType' + $ref: "#/components/schemas/RestrictionPolicyType" required: - - type - - id - - attributes + - type + - id + - attributes type: object RestrictionPolicyAttributes: description: Restriction policy attributes. - example: - bindings: [] + example: {"bindings": []} properties: bindings: description: An array of bindings. items: - $ref: '#/components/schemas/RestrictionPolicyBinding' + $ref: "#/components/schemas/RestrictionPolicyBinding" type: array required: - - bindings + - bindings type: object RestrictionPolicyBinding: description: Specifies which principals are associated with a relation. properties: principals: - description: 'An array of principals. A principal is a subject or group - of subjects. - - Each principal is formatted as `type:id`. Supported types: `role`, `team`, - `user`, and `org`. - + description: |- + An array of principals. A principal is a subject or group of subjects. + Each principal is formatted as `type:id`. Supported types: `role`, `team`, `user`, and `org`. The org ID can be obtained through the api/v2/current_user API. - - The user principal type accepts service account IDs.' - example: - - role:00000000-0000-1111-0000-000000000000 + The user principal type accepts service account IDs. + example: ["role:00000000-0000-1111-0000-000000000000"] items: - description: 'Subject or group of subjects. Each principal is formatted - as `type:id`. - + description: |- + Subject or group of subjects. Each principal is formatted as `type:id`. Supported types: `role`, `team`, `user`, and `org`. - The org ID can be obtained through the api/v2/current_user API. - - The user principal type accepts service account IDs.' + The user principal type accepts service account IDs. type: string type: array relation: @@ -53386,63 +50740,62 @@ components: example: editor type: string required: - - relation - - principals + - relation + - principals type: object RestrictionPolicyResponse: description: Response containing information about a single restriction policy. properties: data: - $ref: '#/components/schemas/RestrictionPolicy' + $ref: "#/components/schemas/RestrictionPolicy" required: - - data + - data type: object RestrictionPolicyType: default: restriction_policy description: Restriction policy type. enum: - - restriction_policy + - restriction_policy example: restriction_policy type: string x-enum-varnames: - - RESTRICTION_POLICY + - RESTRICTION_POLICY RestrictionPolicyUpdateRequest: description: Update request for a restriction policy. properties: data: - $ref: '#/components/schemas/RestrictionPolicy' + $ref: "#/components/schemas/RestrictionPolicy" required: - - data + - data type: object RestrictionQueryAttributes: description: Attributes of the restriction query. properties: created_at: description: Creation time of the restriction query. - example: '2020-03-17T21:06:44.000Z' + example: "2020-03-17T21:06:44.000Z" format: date-time readOnly: true type: string last_modifier_email: description: Email of the user who last modified this restriction query. - example: user@example.com + example: "user@example.com" readOnly: true type: string last_modifier_name: description: Name of the user who last modified this restriction query. - example: John Doe + example: "John Doe" readOnly: true type: string modified_at: description: Time of last restriction query modification. - example: '2020-03-17T21:15:15.000Z' + example: "2020-03-17T21:15:15.000Z" format: date-time readOnly: true type: string restriction_query: - description: The query that defines the restriction. Only the content matching - the query can be returned. - example: env:sandbox + description: The query that defines the restriction. Only the content matching the query can be returned. + example: "env:sandbox" type: string role_count: description: Number of roles associated with this restriction query. @@ -53462,24 +50815,24 @@ components: properties: restriction_query: description: The restriction query. - example: env:sandbox + example: "env:sandbox" type: string required: - - restriction_query + - restriction_query type: object RestrictionQueryCreateData: description: Data related to the creation of a restriction query. properties: attributes: - $ref: '#/components/schemas/RestrictionQueryCreateAttributes' + $ref: "#/components/schemas/RestrictionQueryCreateAttributes" type: - $ref: '#/components/schemas/LogsRestrictionQueriesType' + $ref: "#/components/schemas/LogsRestrictionQueriesType" type: object RestrictionQueryCreatePayload: description: Create a restriction query. properties: data: - $ref: '#/components/schemas/RestrictionQueryCreateData' + $ref: "#/components/schemas/RestrictionQueryCreateData" type: object RestrictionQueryListResponse: description: Response containing information about multiple restriction queries. @@ -53487,45 +50840,44 @@ components: data: description: Array of returned restriction queries. items: - $ref: '#/components/schemas/RestrictionQueryWithoutRelationships' + $ref: "#/components/schemas/RestrictionQueryWithoutRelationships" type: array type: object RestrictionQueryResponseIncludedItem: description: An object related to a restriction query. oneOf: - - $ref: '#/components/schemas/RestrictionQueryRole' + - $ref: "#/components/schemas/RestrictionQueryRole" RestrictionQueryRole: description: Partial role object. properties: attributes: - $ref: '#/components/schemas/RestrictionQueryRoleAttribute' + $ref: "#/components/schemas/RestrictionQueryRoleAttribute" id: description: ID of the role. - example: + example: "" type: string type: - $ref: '#/components/schemas/RolesType' + $ref: "#/components/schemas/RolesType" required: - - type - - id - - attributes + - type + - id + - attributes type: object RestrictionQueryRoleAttribute: description: Attributes of the role for a restriction query. properties: name: description: The role name. - example: Datadog Admin Role + example: "Datadog Admin Role" type: string type: object RestrictionQueryRolesResponse: - description: Response containing information about roles attached to a restriction - query. + description: Response containing information about roles attached to a restriction query. properties: data: description: Array of roles. items: - $ref: '#/components/schemas/RestrictionQueryRole' + $ref: "#/components/schemas/RestrictionQueryRole" type: array type: object RestrictionQueryUpdateAttributes: @@ -53533,63 +50885,63 @@ components: properties: restriction_query: description: The restriction query. - example: env:sandbox + example: "env:sandbox" type: string required: - - restriction_query + - restriction_query type: object RestrictionQueryUpdateData: description: Data related to the update of a restriction query. properties: attributes: - $ref: '#/components/schemas/RestrictionQueryUpdateAttributes' + $ref: "#/components/schemas/RestrictionQueryUpdateAttributes" type: - $ref: '#/components/schemas/LogsRestrictionQueriesType' + $ref: "#/components/schemas/LogsRestrictionQueriesType" type: object RestrictionQueryUpdatePayload: description: Update a restriction query. properties: data: - $ref: '#/components/schemas/RestrictionQueryUpdateData' + $ref: "#/components/schemas/RestrictionQueryUpdateData" type: object RestrictionQueryWithRelationships: description: Restriction query object returned by the API. properties: attributes: - $ref: '#/components/schemas/RestrictionQueryAttributes' + $ref: "#/components/schemas/RestrictionQueryAttributes" id: description: ID of the restriction query. - example: 79a0e60a-644a-11ea-ad29-43329f7f58b5 + example: "79a0e60a-644a-11ea-ad29-43329f7f58b5" type: string relationships: - $ref: '#/components/schemas/UserRelationships' + $ref: "#/components/schemas/UserRelationships" type: - $ref: '#/components/schemas/LogsRestrictionQueriesType' + $ref: "#/components/schemas/LogsRestrictionQueriesType" type: object RestrictionQueryWithRelationshipsResponse: description: Response containing information about a single restriction query. properties: data: - $ref: '#/components/schemas/RestrictionQueryWithRelationships' + $ref: "#/components/schemas/RestrictionQueryWithRelationships" included: description: Array of objects related to the restriction query. items: - $ref: '#/components/schemas/RestrictionQueryResponseIncludedItem' + $ref: "#/components/schemas/RestrictionQueryResponseIncludedItem" type: array type: object RestrictionQueryWithoutRelationships: description: Restriction query object returned by the API. properties: attributes: - $ref: '#/components/schemas/RestrictionQueryAttributes' + $ref: "#/components/schemas/RestrictionQueryAttributes" id: description: ID of the restriction query. - example: 79a0e60a-644a-11ea-ad29-43329f7f58b5 + example: "79a0e60a-644a-11ea-ad29-43329f7f58b5" type: string type: default: logs_restriction_queries description: Restriction queries type. - example: logs_restriction_queries + example: "logs_restriction_queries" readOnly: true type: string type: object @@ -53597,39 +50949,39 @@ components: description: Response containing information about a single restriction query. properties: data: - $ref: '#/components/schemas/RestrictionQueryWithoutRelationships' + $ref: "#/components/schemas/RestrictionQueryWithoutRelationships" type: object RetentionFilter: description: The definition of the retention filter. properties: attributes: - $ref: '#/components/schemas/RetentionFilterAttributes' + $ref: "#/components/schemas/RetentionFilterAttributes" id: description: The ID of the retention filter. - example: 7RBOb7dLSYWI01yc3pIH8w + example: "7RBOb7dLSYWI01yc3pIH8w" type: string type: - $ref: '#/components/schemas/ApmRetentionFilterType' + $ref: "#/components/schemas/ApmRetentionFilterType" required: - - id - - type - - attributes + - id + - type + - attributes type: object RetentionFilterAll: description: The definition of the retention filter. properties: attributes: - $ref: '#/components/schemas/RetentionFilterAllAttributes' + $ref: "#/components/schemas/RetentionFilterAllAttributes" id: description: The ID of the retention filter. - example: 7RBOb7dLSYWI01yc3pIH8w + example: "7RBOb7dLSYWI01yc3pIH8w" type: string type: - $ref: '#/components/schemas/ApmRetentionFilterType' + $ref: "#/components/schemas/ApmRetentionFilterType" required: - - id - - type - - attributes + - id + - type + - attributes type: object RetentionFilterAllAttributes: description: The attributes of the retention filter. @@ -53654,9 +51006,9 @@ components: format: int64 type: integer filter: - $ref: '#/components/schemas/SpansFilter' + $ref: "#/components/schemas/SpansFilter" filter_type: - $ref: '#/components/schemas/RetentionFilterAllType' + $ref: "#/components/schemas/RetentionFilterAllType" modified_at: description: The modification timestamp of the retention filter. format: int64 @@ -53669,18 +51021,16 @@ components: example: my retention filter type: string rate: - description: 'Sample rate to apply to spans going through this retention - filter. - - A value of 1.0 keeps all spans matching the query.' + description: |- + Sample rate to apply to spans going through this retention filter. + A value of 1.0 keeps all spans matching the query. example: 1.0 format: double type: number trace_rate: - description: 'Sample rate to apply to traces containing spans going through - this retention filter. - - A value of 1.0 keeps all traces with spans matching the query.' + description: |- + Sample rate to apply to traces containing spans going through this retention filter. + A value of 1.0 keeps all traces with spans matching the query. example: 1.0 format: double type: number @@ -53689,15 +51039,15 @@ components: default: spans-sampling-processor description: The type of retention filter. enum: - - spans-sampling-processor - - spans-errors-sampling-processor - - spans-appsec-sampling-processor + - spans-sampling-processor + - spans-errors-sampling-processor + - spans-appsec-sampling-processor example: spans-sampling-processor type: string x-enum-varnames: - - SPANS_SAMPLING_PROCESSOR - - SPANS_ERRORS_SAMPLING_PROCESSOR - - SPANS_APPSEC_SAMPLING_PROCESSOR + - SPANS_SAMPLING_PROCESSOR + - SPANS_ERRORS_SAMPLING_PROCESSOR + - SPANS_APPSEC_SAMPLING_PROCESSOR RetentionFilterAttributes: description: The attributes of the retention filter. properties: @@ -53721,9 +51071,9 @@ components: format: int64 type: integer filter: - $ref: '#/components/schemas/SpansFilter' + $ref: "#/components/schemas/SpansFilter" filter_type: - $ref: '#/components/schemas/RetentionFilterType' + $ref: "#/components/schemas/RetentionFilterType" modified_at: description: The modification timestamp of the retention filter. format: int64 @@ -53736,176 +51086,168 @@ components: example: my retention filter type: string rate: - description: 'Sample rate to apply to spans going through this retention - filter. - - A value of 1.0 keeps all spans matching the query.' + description: |- + Sample rate to apply to spans going through this retention filter. + A value of 1.0 keeps all spans matching the query. example: 1.0 format: double type: number trace_rate: - description: 'Sample rate to apply to traces containing spans going through - this retention filter. - - A value of 1.0 keeps all traces with spans matching the query.' + description: |- + Sample rate to apply to traces containing spans going through this retention filter. + A value of 1.0 keeps all traces with spans matching the query. example: 1.0 format: double type: number type: object RetentionFilterCreateAttributes: - description: The object describing the configuration of the retention filter - to create/update. + description: The object describing the configuration of the retention filter to create/update. properties: enabled: description: Enable/Disable the retention filter. example: true type: boolean filter: - $ref: '#/components/schemas/SpansFilterCreate' + $ref: "#/components/schemas/SpansFilterCreate" filter_type: - $ref: '#/components/schemas/RetentionFilterType' + $ref: "#/components/schemas/RetentionFilterType" name: description: The name of the retention filter. example: my retention filter type: string rate: - description: 'Sample rate to apply to spans going through this retention - filter. - - A value of 1.0 keeps all spans matching the query.' + description: |- + Sample rate to apply to spans going through this retention filter. + A value of 1.0 keeps all spans matching the query. example: 1.0 format: double type: number trace_rate: - description: 'Sample rate to apply to traces containing spans going through - this retention filter. - - A value of 1.0 keeps all traces with spans matching the query.' + description: |- + Sample rate to apply to traces containing spans going through this retention filter. + A value of 1.0 keeps all traces with spans matching the query. example: 1.0 format: double type: number required: - - name - - filter - - enabled - - filter_type - - rate + - name + - filter + - enabled + - filter_type + - rate type: object RetentionFilterCreateData: description: The body of the retention filter to be created. properties: attributes: - $ref: '#/components/schemas/RetentionFilterCreateAttributes' + $ref: "#/components/schemas/RetentionFilterCreateAttributes" type: - $ref: '#/components/schemas/ApmRetentionFilterType' + $ref: "#/components/schemas/ApmRetentionFilterType" required: - - attributes - - type + - attributes + - type type: object RetentionFilterCreateRequest: description: The body of the retention filter to be created. properties: data: - $ref: '#/components/schemas/RetentionFilterCreateData' + $ref: "#/components/schemas/RetentionFilterCreateData" required: - - data + - data type: object RetentionFilterCreateResponse: description: The retention filters definition. properties: data: - $ref: '#/components/schemas/RetentionFilter' + $ref: "#/components/schemas/RetentionFilter" type: object RetentionFilterResponse: description: The retention filters definition. properties: data: - $ref: '#/components/schemas/RetentionFilterAll' + $ref: "#/components/schemas/RetentionFilterAll" type: object RetentionFilterType: default: spans-sampling-processor description: The type of retention filter. The value should always be spans-sampling-processor. enum: - - spans-sampling-processor + - spans-sampling-processor example: spans-sampling-processor type: string x-enum-varnames: - - SPANS_SAMPLING_PROCESSOR + - SPANS_SAMPLING_PROCESSOR RetentionFilterUpdateAttributes: - description: The object describing the configuration of the retention filter - to create/update. + description: The object describing the configuration of the retention filter to create/update. properties: enabled: description: Enable/Disable the retention filter. example: true type: boolean filter: - $ref: '#/components/schemas/SpansFilterCreate' + $ref: "#/components/schemas/SpansFilterCreate" filter_type: - $ref: '#/components/schemas/RetentionFilterAllType' + $ref: "#/components/schemas/RetentionFilterAllType" name: description: The name of the retention filter. example: my retention filter type: string rate: - description: 'Sample rate to apply to spans going through this retention - filter. - - A value of 1.0 keeps all spans matching the query.' + description: |- + Sample rate to apply to spans going through this retention filter. + A value of 1.0 keeps all spans matching the query. example: 1.0 format: double type: number trace_rate: - description: 'Sample rate to apply to traces containing spans going through - this retention filter. - - A value of 1.0 keeps all traces with spans matching the query.' + description: |- + Sample rate to apply to traces containing spans going through this retention filter. + A value of 1.0 keeps all traces with spans matching the query. example: 1.0 format: double type: number required: - - name - - filter - - enabled - - filter_type - - rate + - name + - filter + - enabled + - filter_type + - rate type: object RetentionFilterUpdateData: description: The body of the retention filter to be updated. properties: attributes: - $ref: '#/components/schemas/RetentionFilterUpdateAttributes' + $ref: "#/components/schemas/RetentionFilterUpdateAttributes" id: description: The ID of the retention filter. - example: retention-filter-id + example: "retention-filter-id" type: string type: - $ref: '#/components/schemas/ApmRetentionFilterType' + $ref: "#/components/schemas/ApmRetentionFilterType" required: - - id - - attributes - - type + - id + - attributes + - type type: object RetentionFilterUpdateRequest: description: The body of the retention filter to be updated. properties: data: - $ref: '#/components/schemas/RetentionFilterUpdateData' + $ref: "#/components/schemas/RetentionFilterUpdateData" required: - - data + - data type: object RetentionFilterWithoutAttributes: description: The retention filter object . properties: id: description: The ID of the retention filter. - example: 7RBOb7dLSYWI01yc3pIH8w + example: "7RBOb7dLSYWI01yc3pIH8w" type: string type: - $ref: '#/components/schemas/ApmRetentionFilterType' + $ref: "#/components/schemas/ApmRetentionFilterType" required: - - id - - type + - id + - type type: object RetentionFiltersResponse: description: An ordered list of retention filters. @@ -53913,36 +51255,35 @@ components: data: description: A list of retention filters objects. items: - $ref: '#/components/schemas/RetentionFilterAll' + $ref: "#/components/schemas/RetentionFilterAll" type: array required: - - data + - data type: object RetryStrategy: description: The definition of `RetryStrategy` object. properties: kind: - $ref: '#/components/schemas/RetryStrategyKind' + $ref: "#/components/schemas/RetryStrategyKind" linear: - $ref: '#/components/schemas/RetryStrategyLinear' + $ref: "#/components/schemas/RetryStrategyLinear" required: - - kind + - kind type: object RetryStrategyKind: description: The definition of `RetryStrategyKind` object. enum: - - RETRY_STRATEGY_LINEAR + - RETRY_STRATEGY_LINEAR example: RETRY_STRATEGY_LINEAR type: string x-enum-varnames: - - RETRY_STRATEGY_LINEAR + - RETRY_STRATEGY_LINEAR RetryStrategyLinear: description: The definition of `RetryStrategyLinear` object. properties: interval: - description: The `RetryStrategyLinear` `interval`. The expected format is - the number of seconds ending with an s. For example, 1 day is 86400s - example: '' + description: The `RetryStrategyLinear` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s + example: "" type: string maxRetries: description: The `RetryStrategyLinear` `maxRetries`. @@ -53950,30 +51291,29 @@ components: format: double type: number required: - - interval - - maxRetries + - interval + - maxRetries type: object RevertCustomRuleRevisionDataType: description: Request type - enum: - - revert_custom_rule_revision_request + enum: [revert_custom_rule_revision_request] type: string x-enum-varnames: - - REVERT_CUSTOM_RULE_REVISION_REQUEST + - REVERT_CUSTOM_RULE_REVISION_REQUEST RevertCustomRuleRevisionRequest: properties: data: - $ref: '#/components/schemas/RevertCustomRuleRevisionRequestData' + $ref: "#/components/schemas/RevertCustomRuleRevisionRequestData" type: object RevertCustomRuleRevisionRequestData: properties: attributes: - $ref: '#/components/schemas/RevertCustomRuleRevisionRequestDataAttributes' + $ref: "#/components/schemas/RevertCustomRuleRevisionRequestDataAttributes" id: description: Request identifier type: string type: - $ref: '#/components/schemas/RevertCustomRuleRevisionDataType' + $ref: "#/components/schemas/RevertCustomRuleRevisionDataType" type: object RevertCustomRuleRevisionRequestDataAttributes: properties: @@ -53988,16 +51328,16 @@ components: description: Role object returned by the API. properties: attributes: - $ref: '#/components/schemas/RoleAttributes' + $ref: "#/components/schemas/RoleAttributes" id: description: The unique identifier of the role. type: string relationships: - $ref: '#/components/schemas/RoleResponseRelationships' + $ref: "#/components/schemas/RoleResponseRelationships" type: - $ref: '#/components/schemas/RolesType' + $ref: "#/components/schemas/RolesType" required: - - type + - type type: object RoleAttributes: additionalProperties: {} @@ -54014,18 +51354,13 @@ components: readOnly: true type: string name: - description: The name of the role. The name is neither unique nor a stable - identifier of the role. + description: The name of the role. The name is neither unique nor a stable identifier of the role. type: string receives_permissions_from: - description: 'The managed role from which this role automatically inherits - new permissions. - - Specify one of the following: "Datadog Admin Role", "Datadog Standard - Role", or "Datadog Read Only Role". - - If empty or not specified, the role does not automatically inherit permissions - from any managed role.' + description: |- + The managed role from which this role automatically inherits new permissions. + Specify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role". + If empty or not specified, the role does not automatically inherit permissions from any managed role. items: type: string type: array @@ -54039,43 +51374,38 @@ components: description: Data for the clone role request. properties: attributes: - $ref: '#/components/schemas/RoleCloneAttributes' + $ref: "#/components/schemas/RoleCloneAttributes" type: - $ref: '#/components/schemas/RolesType' + $ref: "#/components/schemas/RolesType" required: - - type - - attributes + - type + - attributes type: object RoleCloneAttributes: - description: Attributes required to create a new role by cloning an existing - one. + description: Attributes required to create a new role by cloning an existing one. properties: name: description: Name of the new role that is cloned. - example: cloned-role + example: "cloned-role" type: string receives_permissions_from: - description: 'The managed role from which this role automatically inherits - new permissions. - - Specify one of the following: "Datadog Admin Role", "Datadog Standard - Role", or "Datadog Read Only Role". - - If empty or not specified, the role does not automatically inherit permissions - from any managed role.' + description: |- + The managed role from which this role automatically inherits new permissions. + Specify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role". + If empty or not specified, the role does not automatically inherit permissions from any managed role. items: type: string type: array required: - - name + - name type: object RoleCloneRequest: description: Request to create a role by cloning an existing role. properties: data: - $ref: '#/components/schemas/RoleClone' + $ref: "#/components/schemas/RoleClone" required: - - data + - data type: object RoleCreateAttributes: description: Attributes of the created role. @@ -54095,78 +51425,74 @@ components: example: developers type: string receives_permissions_from: - description: 'The managed role from which this role automatically inherits - new permissions. - - Specify one of the following: "Datadog Admin Role", "Datadog Standard - Role", or "Datadog Read Only Role". - - If empty or not specified, the role does not automatically inherit permissions - from any managed role.' + description: |- + The managed role from which this role automatically inherits new permissions. + Specify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role". + If empty or not specified, the role does not automatically inherit permissions from any managed role. items: type: string type: array required: - - name + - name type: object RoleCreateData: description: Data related to the creation of a role. properties: attributes: - $ref: '#/components/schemas/RoleCreateAttributes' + $ref: "#/components/schemas/RoleCreateAttributes" relationships: - $ref: '#/components/schemas/RoleRelationships' + $ref: "#/components/schemas/RoleRelationships" type: - $ref: '#/components/schemas/RolesType' + $ref: "#/components/schemas/RolesType" required: - - attributes + - attributes type: object RoleCreateRequest: description: Create a role. properties: data: - $ref: '#/components/schemas/RoleCreateData' + $ref: "#/components/schemas/RoleCreateData" required: - - data + - data type: object RoleCreateResponse: description: Response containing information about a created role. properties: data: - $ref: '#/components/schemas/RoleCreateResponseData' + $ref: "#/components/schemas/RoleCreateResponseData" type: object RoleCreateResponseData: description: Role object returned by the API. properties: attributes: - $ref: '#/components/schemas/RoleCreateAttributes' + $ref: "#/components/schemas/RoleCreateAttributes" id: description: The unique identifier of the role. type: string relationships: - $ref: '#/components/schemas/RoleResponseRelationships' + $ref: "#/components/schemas/RoleResponseRelationships" type: - $ref: '#/components/schemas/RolesType' + $ref: "#/components/schemas/RolesType" required: - - type + - type type: object RoleRelationships: description: Relationships of the role object. properties: permissions: - $ref: '#/components/schemas/RelationshipToPermissions' + $ref: "#/components/schemas/RelationshipToPermissions" type: object RoleResponse: description: Response containing information about a single role. properties: data: - $ref: '#/components/schemas/Role' + $ref: "#/components/schemas/Role" type: object RoleResponseRelationships: description: Relationships of the role object returned by the API. properties: permissions: - $ref: '#/components/schemas/RelationshipToPermissions' + $ref: "#/components/schemas/RelationshipToPermissions" type: object RoleTemplateArray: description: The definition of `RoleTemplateArray` object. @@ -54174,23 +51500,23 @@ components: data: description: The `RoleTemplateArray` `data`. items: - $ref: '#/components/schemas/RoleTemplateData' + $ref: "#/components/schemas/RoleTemplateData" type: array required: - - data + - data type: object RoleTemplateData: description: The definition of `RoleTemplateData` object. properties: attributes: - $ref: '#/components/schemas/RoleTemplateDataAttributes' + $ref: "#/components/schemas/RoleTemplateDataAttributes" id: description: The `RoleTemplateData` `id`. type: string type: - $ref: '#/components/schemas/RoleTemplateDataType' + $ref: "#/components/schemas/RoleTemplateDataType" required: - - type + - type type: object RoleTemplateDataAttributes: description: The definition of `RoleTemplateDataAttributes` object. @@ -54206,11 +51532,11 @@ components: default: roles description: Roles resource type. enum: - - roles + - roles example: roles type: string x-enum-varnames: - - ROLES + - ROLES RoleUpdateAttributes: description: Attributes of the role. properties: @@ -54228,14 +51554,10 @@ components: description: Name of the role. type: string receives_permissions_from: - description: 'The managed role from which this role automatically inherits - new permissions. - - Specify one of the following: "Datadog Admin Role", "Datadog Standard - Role", or "Datadog Read Only Role". - - If empty or not specified, the role does not automatically inherit permissions - from any managed role.' + description: |- + The managed role from which this role automatically inherits new permissions. + Specify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role". + If empty or not specified, the role does not automatically inherit permissions from any managed role. items: type: string type: array @@ -54249,48 +51571,48 @@ components: description: Data related to the update of a role. properties: attributes: - $ref: '#/components/schemas/RoleUpdateAttributes' + $ref: "#/components/schemas/RoleUpdateAttributes" id: description: The unique identifier of the role. - example: 00000000-0000-1111-0000-000000000000 + example: "00000000-0000-1111-0000-000000000000" type: string relationships: - $ref: '#/components/schemas/RoleRelationships' + $ref: "#/components/schemas/RoleRelationships" type: - $ref: '#/components/schemas/RolesType' + $ref: "#/components/schemas/RolesType" required: - - attributes - - type - - id + - attributes + - type + - id type: object RoleUpdateRequest: description: Update a role. properties: data: - $ref: '#/components/schemas/RoleUpdateData' + $ref: "#/components/schemas/RoleUpdateData" required: - - data + - data type: object RoleUpdateResponse: description: Response containing information about an updated role. properties: data: - $ref: '#/components/schemas/RoleUpdateResponseData' + $ref: "#/components/schemas/RoleUpdateResponseData" type: object RoleUpdateResponseData: description: Role object returned by the API. properties: attributes: - $ref: '#/components/schemas/RoleUpdateAttributes' + $ref: "#/components/schemas/RoleUpdateAttributes" id: description: The unique identifier of the role. type: string relationships: - $ref: '#/components/schemas/RoleResponseRelationships' + $ref: "#/components/schemas/RoleResponseRelationships" type: - $ref: '#/components/schemas/RolesType' + $ref: "#/components/schemas/RolesType" required: - - type + - type type: object RolesResponse: description: Response containing information about multiple roles. @@ -54298,125 +51620,119 @@ components: data: description: Array of returned roles. items: - $ref: '#/components/schemas/Role' + $ref: "#/components/schemas/Role" type: array meta: - $ref: '#/components/schemas/ResponseMetaAttributes' + $ref: "#/components/schemas/ResponseMetaAttributes" type: object RolesSort: default: name description: Sorting options for roles. enum: - - name - - -name - - modified_at - - -modified_at - - user_count - - -user_count + - name + - -name + - modified_at + - -modified_at + - user_count + - -user_count type: string x-enum-varnames: - - NAME_ASCENDING - - NAME_DESCENDING - - MODIFIED_AT_ASCENDING - - MODIFIED_AT_DESCENDING - - USER_COUNT_ASCENDING - - USER_COUNT_DESCENDING + - NAME_ASCENDING + - NAME_DESCENDING + - MODIFIED_AT_ASCENDING + - MODIFIED_AT_DESCENDING + - USER_COUNT_ASCENDING + - USER_COUNT_DESCENDING RolesType: default: roles description: Roles type. enum: - - roles + - roles example: roles type: string x-enum-varnames: - - ROLES + - ROLES RoutingRule: - description: Represents a routing rule, including its attributes, relationships, - and unique identifier. + description: Represents a routing rule, including its attributes, relationships, and unique identifier. properties: attributes: - $ref: '#/components/schemas/RoutingRuleAttributes' + $ref: "#/components/schemas/RoutingRuleAttributes" id: description: Specifies the unique identifier of this routing rule. type: string relationships: - $ref: '#/components/schemas/RoutingRuleRelationships' + $ref: "#/components/schemas/RoutingRuleRelationships" type: - $ref: '#/components/schemas/RoutingRuleType' + $ref: "#/components/schemas/RoutingRuleType" required: - - type + - type type: object RoutingRuleAction: - description: Defines an action that is executed when a routing rule matches - certain criteria. + description: "Defines an action that is executed when a routing rule matches certain criteria." oneOf: - - $ref: '#/components/schemas/SendSlackMessageAction' - - $ref: '#/components/schemas/SendTeamsMessageAction' + - $ref: "#/components/schemas/SendSlackMessageAction" + - $ref: "#/components/schemas/SendTeamsMessageAction" RoutingRuleAttributes: - description: Defines the configurable attributes of a routing rule, such as - actions, query, time restriction, and urgency. + description: Defines the configurable attributes of a routing rule, such as actions, query, time restriction, and urgency. properties: actions: - description: Specifies the list of actions to perform when the routing rule - matches. + description: Specifies the list of actions to perform when the routing rule matches. items: - $ref: '#/components/schemas/RoutingRuleAction' + $ref: "#/components/schemas/RoutingRuleAction" type: array query: description: Defines the query or condition that triggers this routing rule. type: string time_restriction: - $ref: '#/components/schemas/TimeRestrictions' + $ref: "#/components/schemas/TimeRestrictions" nullable: true urgency: - $ref: '#/components/schemas/Urgency' + $ref: "#/components/schemas/Urgency" type: object RoutingRuleRelationships: - description: Specifies relationships for a routing rule, linking to associated - policy resources. + description: Specifies relationships for a routing rule, linking to associated policy resources. properties: policy: - $ref: '#/components/schemas/RoutingRuleRelationshipsPolicy' + $ref: "#/components/schemas/RoutingRuleRelationshipsPolicy" type: object RoutingRuleRelationshipsPolicy: description: Defines the relationship that links a routing rule to a policy. properties: data: - $ref: '#/components/schemas/RoutingRuleRelationshipsPolicyData' + $ref: "#/components/schemas/RoutingRuleRelationshipsPolicyData" nullable: true type: object RoutingRuleRelationshipsPolicyData: - description: Represents the policy data reference, containing the policy's ID - and resource type. + description: Represents the policy data reference, containing the policy's ID and resource type. properties: id: description: Specifies the unique identifier of the policy. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/RoutingRuleRelationshipsPolicyDataType' + $ref: "#/components/schemas/RoutingRuleRelationshipsPolicyDataType" required: - - type - - id + - type + - id type: object RoutingRuleRelationshipsPolicyDataType: default: policies - description: Indicates that the resource is of type 'policies'. + description: "Indicates that the resource is of type 'policies'." enum: - - policies + - policies example: policies type: string x-enum-varnames: - - POLICIES + - POLICIES RoutingRuleType: default: team_routing_rules description: Team routing rules resource type. enum: - - team_routing_rules + - team_routing_rules example: team_routing_rules type: string x-enum-varnames: - - TEAM_ROUTING_RULES + - TEAM_ROUTING_RULES RuleAttributes: description: Details of a rule. properties: @@ -54439,7 +51755,7 @@ components: example: true type: boolean level: - $ref: '#/components/schemas/RuleLevel' + $ref: "#/components/schemas/RuleLevel" modified_at: description: Time of the last rule outcome modification. format: date-time @@ -54475,89 +51791,81 @@ components: description: The JSON:API relationship to a scorecard rule. properties: rule: - $ref: '#/components/schemas/RelationshipToOutcome' + $ref: "#/components/schemas/RelationshipToOutcome" type: object RuleSeverity: description: Severity of a security rule. enum: - - critical - - high - - medium - - low - - unknown - - info + - critical + - high + - medium + - low + - unknown + - info example: critical type: string x-enum-varnames: - - CRITICAL - - HIGH - - MEDIUM - - LOW - - UNKNOWN - - INFO + - CRITICAL + - HIGH + - MEDIUM + - LOW + - UNKNOWN + - INFO RuleType: default: rule description: The JSON:API type for scorecard rules. enum: - - rule + - rule example: rule type: string x-enum-varnames: - - RULE + - RULE RuleTypes: description: Security rule types used as filters in security rules. - example: - - misconfiguration - - attack_path + example: [misconfiguration, attack_path] items: - $ref: '#/components/schemas/RuleTypesItems' + $ref: "#/components/schemas/RuleTypesItems" type: array RuleTypesItems: - description: 'Security rule type which can be used in security rules. - - Signal-based notification rules can filter signals based on rule types application_security, - log_detection, - + description: |- + Security rule type which can be used in security rules. + Signal-based notification rules can filter signals based on rule types application_security, log_detection, workload_security, signal_correlation, cloud_configuration and infrastructure_configuration. - - Vulnerability-based notification rules can filter vulnerabilities based on - rule types application_code_vulnerability, - - application_library_vulnerability, attack_path, container_image_vulnerability, - identity_risk, misconfiguration, api_security, host_vulnerability and iac_misconfiguration.' - enum: - - application_security - - log_detection - - workload_security - - signal_correlation - - cloud_configuration - - infrastructure_configuration - - application_code_vulnerability - - application_library_vulnerability - - attack_path - - container_image_vulnerability - - identity_risk - - misconfiguration - - api_security - - host_vulnerability - - iac_misconfiguration - type: string - x-enum-varnames: - - APPLICATION_SECURITY - - LOG_DETECTION - - WORKLOAD_SECURITY - - SIGNAL_CORRELATION - - CLOUD_CONFIGURATION - - INFRASTRUCTURE_CONFIGURATION - - APPLICATION_CODE_VULNERABILITY - - APPLICATION_LIBRARY_VULNERABILITY - - ATTACK_PATH - - CONTAINER_IMAGE_VULNERABILITY - - IDENTITY_RISK - - MISCONFIGURATION - - API_SECURITY - - HOST_VULNERABILITY - - IAC_MISCONFIGURATION + Vulnerability-based notification rules can filter vulnerabilities based on rule types application_code_vulnerability, + application_library_vulnerability, attack_path, container_image_vulnerability, identity_risk, misconfiguration, api_security, host_vulnerability and iac_misconfiguration. + enum: + - application_security + - log_detection + - workload_security + - signal_correlation + - cloud_configuration + - infrastructure_configuration + - application_code_vulnerability + - application_library_vulnerability + - attack_path + - container_image_vulnerability + - identity_risk + - misconfiguration + - api_security + - host_vulnerability + - iac_misconfiguration + type: string + x-enum-varnames: + - APPLICATION_SECURITY + - LOG_DETECTION + - WORKLOAD_SECURITY + - SIGNAL_CORRELATION + - CLOUD_CONFIGURATION + - INFRASTRUCTURE_CONFIGURATION + - APPLICATION_CODE_VULNERABILITY + - APPLICATION_LIBRARY_VULNERABILITY + - ATTACK_PATH + - CONTAINER_IMAGE_VULNERABILITY + - IDENTITY_RISK + - MISCONFIGURATION + - API_SECURITY + - HOST_VULNERABILITY + - IAC_MISCONFIGURATION RuleUser: description: User creating or modifying a rule. properties: @@ -54580,7 +51888,7 @@ components: type: integer data: additionalProperties: - $ref: '#/components/schemas/RuleVersions' + $ref: "#/components/schemas/RuleVersions" description: A rule version with a list of updates. description: The `RuleVersionHistory` `data`. type: object @@ -54591,10 +51899,10 @@ components: changes: description: A list of changes. items: - $ref: '#/components/schemas/VersionHistoryUpdate' + $ref: "#/components/schemas/VersionHistoryUpdate" type: array rule: - $ref: '#/components/schemas/SecurityMonitoringRuleResponse' + $ref: "#/components/schemas/SecurityMonitoringRuleResponse" type: object RulesValidateQueryRequest: description: The definition of `RulesValidateQueryRequest` object. @@ -54605,40 +51913,40 @@ components: type: validate_query properties: data: - $ref: '#/components/schemas/RulesValidateQueryRequestData' + $ref: "#/components/schemas/RulesValidateQueryRequestData" type: object RulesValidateQueryRequestData: description: The definition of `RulesValidateQueryRequestData` object. properties: attributes: - $ref: '#/components/schemas/RulesValidateQueryRequestDataAttributes' + $ref: "#/components/schemas/RulesValidateQueryRequestDataAttributes" id: description: The `RulesValidateQueryRequestData` `id`. type: string type: - $ref: '#/components/schemas/RulesValidateQueryRequestDataType' + $ref: "#/components/schemas/RulesValidateQueryRequestDataType" required: - - type + - type type: object RulesValidateQueryRequestDataAttributes: description: The definition of `RulesValidateQueryRequestDataAttributes` object. properties: Query: description: The `attributes` `Query`. - example: '' + example: "" type: string required: - - Query + - Query type: object RulesValidateQueryRequestDataType: default: validate_query description: Validate query resource type. enum: - - validate_query + - validate_query example: validate_query type: string x-enum-varnames: - - VALIDATE_QUERY + - VALIDATE_QUERY RulesValidateQueryResponse: description: The definition of `RulesValidateQueryResponse` object. example: @@ -54648,40 +51956,40 @@ components: type: validate_response properties: data: - $ref: '#/components/schemas/RulesValidateQueryResponseData' + $ref: "#/components/schemas/RulesValidateQueryResponseData" type: object RulesValidateQueryResponseData: description: The definition of `RulesValidateQueryResponseData` object. properties: attributes: - $ref: '#/components/schemas/RulesValidateQueryResponseDataAttributes' + $ref: "#/components/schemas/RulesValidateQueryResponseDataAttributes" id: description: The `RulesValidateQueryResponseData` `id`. type: string type: - $ref: '#/components/schemas/RulesValidateQueryResponseDataType' + $ref: "#/components/schemas/RulesValidateQueryResponseDataType" required: - - type + - type type: object RulesValidateQueryResponseDataAttributes: description: The definition of `RulesValidateQueryResponseDataAttributes` object. properties: Canonical: description: The `attributes` `Canonical`. - example: '' + example: "" type: string required: - - Canonical + - Canonical type: object RulesValidateQueryResponseDataType: default: validate_response description: Validate response resource type. enum: - - validate_response + - validate_response example: validate_response type: string x-enum-varnames: - - VALIDATE_RESPONSE + - VALIDATE_RESPONSE RulesetItemMetadata: additionalProperties: type: string @@ -54693,178 +52001,178 @@ components: example: data: attributes: - created: null + created: enabled: true - last_modified_user_uuid: '' - modified: null + last_modified_user_uuid: "" + modified: name: Example Ruleset position: 0 rules: - - enabled: false - mapping: null - metadata: null - name: RC test rule edited1 - query: - addition: - key: abc - value: ww - case_insensitivity: false - if_tag_exists: do_not_apply - query: billingcurrency:"USD" AND account_name:"SZA96462" AND billingcurrency:"USD" - reference_table: null - - enabled: true - mapping: - destination_key: h - if_tag_exists: do_not_apply - source_keys: - - accountname - - accountownerid - metadata: null - name: rule with empty source key - query: null - reference_table: null - - enabled: true - mapping: null - metadata: null - name: New table rule with new UI - query: null - reference_table: - case_insensitivity: true - field_pairs: - - input_column: status_type - output_key: status - - input_column: status_description - output_key: dess - if_tag_exists: append - source_keys: - - http_status - - status_description - table_name: http_status_codes + - enabled: false + mapping: + metadata: + name: RC test rule edited1 + query: + addition: + key: abc + value: ww + case_insensitivity: false + if_tag_exists: do_not_apply + query: billingcurrency:"USD" AND account_name:"SZA96462" AND billingcurrency:"USD" + reference_table: + - enabled: true + mapping: + destination_key: h + if_tag_exists: do_not_apply + source_keys: + - accountname + - accountownerid + metadata: + name: rule with empty source key + query: + reference_table: + - enabled: true + mapping: + metadata: + name: New table rule with new UI + query: + reference_table: + case_insensitivity: true + field_pairs: + - input_column: status_type + output_key: status + - input_column: status_description + output_key: dess + if_tag_exists: append + source_keys: + - http_status + - status_description + table_name: http_status_codes version: 1 - id: '12345' + id: "12345" type: ruleset properties: data: - $ref: '#/components/schemas/RulesetRespData' + $ref: "#/components/schemas/RulesetRespData" type: object RulesetRespArray: description: The definition of `RulesetRespArray` object. example: data: - - attributes: - created: null - enabled: true - last_modified_user_uuid: '' - modified: null - name: Production Cost Allocation Rules - position: 0 - rules: - - enabled: true - mapping: null - metadata: null - name: AWS Production Account Tagging - query: - addition: - key: environment - value: production - case_insensitivity: false - if_tag_exists: do_not_apply - query: billingcurrency:"USD" AND account_name:"prod-account" - reference_table: null - - enabled: true - mapping: - destination_key: team_owner - if_tag_exists: do_not_apply - source_keys: - - account_name - - service - metadata: null - name: Team Mapping Rule - query: null - reference_table: null - - enabled: true - mapping: null - metadata: null - name: New table rule with new UI - query: null - reference_table: - case_insensitivity: true - field_pairs: - - input_column: status_type - output_key: status - - input_column: status_description - output_key: dess - if_tag_exists: append - source_keys: - - http_status - - status_description - table_name: http_status_codes - version: 2 - id: 55ef2385-9ae1-4410-90c4-5ac1b60fec10 - type: ruleset - - attributes: - created: null - enabled: true - last_modified_user_uuid: '' - modified: null - name: Development Environment Rules - position: 0 - rules: - - enabled: true - mapping: null - metadata: null - name: Dev Account Cost Center - query: - addition: - key: cost_center - value: engineering - case_insensitivity: true - if_tag_exists: do_not_apply - query: account_name:"dev-*" - reference_table: null - version: 1 - id: a7b8c9d0-1234-5678-9abc-def012345678 - type: ruleset + - attributes: + created: + enabled: true + last_modified_user_uuid: "" + modified: + name: Production Cost Allocation Rules + position: 0 + rules: + - enabled: true + mapping: + metadata: + name: AWS Production Account Tagging + query: + addition: + key: environment + value: production + case_insensitivity: false + if_tag_exists: do_not_apply + query: billingcurrency:"USD" AND account_name:"prod-account" + reference_table: + - enabled: true + mapping: + destination_key: team_owner + if_tag_exists: do_not_apply + source_keys: + - account_name + - service + metadata: + name: Team Mapping Rule + query: + reference_table: + - enabled: true + mapping: + metadata: + name: New table rule with new UI + query: + reference_table: + case_insensitivity: true + field_pairs: + - input_column: status_type + output_key: status + - input_column: status_description + output_key: dess + if_tag_exists: append + source_keys: + - http_status + - status_description + table_name: http_status_codes + version: 2 + id: "55ef2385-9ae1-4410-90c4-5ac1b60fec10" + type: ruleset + - attributes: + created: + enabled: true + last_modified_user_uuid: "" + modified: + name: Development Environment Rules + position: 0 + rules: + - enabled: true + mapping: + metadata: + name: Dev Account Cost Center + query: + addition: + key: cost_center + value: engineering + case_insensitivity: true + if_tag_exists: do_not_apply + query: account_name:"dev-*" + reference_table: + version: 1 + id: "a7b8c9d0-1234-5678-9abc-def012345678" + type: ruleset properties: data: description: The `RulesetRespArray` `data`. items: - $ref: '#/components/schemas/RulesetRespData' + $ref: "#/components/schemas/RulesetRespData" type: array required: - - data + - data type: object RulesetRespData: description: The definition of `RulesetRespData` object. properties: attributes: - $ref: '#/components/schemas/RulesetRespDataAttributes' + $ref: "#/components/schemas/RulesetRespDataAttributes" id: description: The `RulesetRespData` `id`. type: string type: - $ref: '#/components/schemas/RulesetRespDataType' + $ref: "#/components/schemas/RulesetRespDataType" required: - - type + - type type: object RulesetRespDataAttributes: description: The definition of `RulesetRespDataAttributes` object. properties: created: - $ref: '#/components/schemas/RulesetRespDataAttributesCreated' + $ref: "#/components/schemas/RulesetRespDataAttributesCreated" enabled: description: The `attributes` `enabled`. example: false type: boolean last_modified_user_uuid: description: The `attributes` `last_modified_user_uuid`. - example: '' + example: "" type: string modified: - $ref: '#/components/schemas/RulesetRespDataAttributesModified' + $ref: "#/components/schemas/RulesetRespDataAttributesModified" name: description: The `attributes` `name`. - example: '' + example: "" type: string position: description: The `attributes` `position`. @@ -54874,12 +52182,12 @@ components: type: integer processing_status: description: The `attributes` `processing_status`. - example: '' + example: "" type: string rules: description: The `attributes` `rules`. items: - $ref: '#/components/schemas/RulesetRespDataAttributesRulesItems' + $ref: "#/components/schemas/RulesetRespDataAttributesRulesItems" type: array version: description: The `attributes` `version`. @@ -54887,14 +52195,14 @@ components: format: int64 type: integer required: - - created - - enabled - - last_modified_user_uuid - - modified - - name - - position - - rules - - version + - created + - enabled + - last_modified_user_uuid + - modified + - name + - position + - rules + - version type: object RulesetRespDataAttributesCreated: description: The definition of `RulesetRespDataAttributesCreated` object. @@ -54930,27 +52238,27 @@ components: example: false type: boolean mapping: - $ref: '#/components/schemas/DataAttributesRulesItemsMapping' + $ref: "#/components/schemas/DataAttributesRulesItemsMapping" metadata: - $ref: '#/components/schemas/RulesetItemMetadata' + $ref: "#/components/schemas/RulesetItemMetadata" name: description: The `items` `name`. - example: '' + example: "" type: string query: - $ref: '#/components/schemas/RulesetRespDataAttributesRulesItemsQuery' + $ref: "#/components/schemas/RulesetRespDataAttributesRulesItemsQuery" reference_table: - $ref: '#/components/schemas/RulesetRespDataAttributesRulesItemsReferenceTable' + $ref: "#/components/schemas/RulesetRespDataAttributesRulesItemsReferenceTable" required: - - enabled - - name + - enabled + - name type: object RulesetRespDataAttributesRulesItemsQuery: description: The definition of `RulesetRespDataAttributesRulesItemsQuery` object. nullable: true properties: addition: - $ref: '#/components/schemas/RulesetRespDataAttributesRulesItemsQueryAddition' + $ref: "#/components/schemas/RulesetRespDataAttributesRulesItemsQueryAddition" case_insensitivity: description: The `query` `case_insensitivity`. type: boolean @@ -54959,35 +52267,33 @@ components: description: Deprecated. Use `if_tag_exists` instead. The `query` `if_not_exists`. type: boolean if_tag_exists: - $ref: '#/components/schemas/DataAttributesRulesItemsIfTagExists' + $ref: "#/components/schemas/DataAttributesRulesItemsIfTagExists" query: description: The `query` `query`. - example: '' + example: "" type: string required: - - addition - - query + - addition + - query type: object RulesetRespDataAttributesRulesItemsQueryAddition: - description: The definition of `RulesetRespDataAttributesRulesItemsQueryAddition` - object. + description: The definition of `RulesetRespDataAttributesRulesItemsQueryAddition` object. nullable: true properties: key: description: The `addition` `key`. - example: '' + example: "" type: string value: description: The `addition` `value`. - example: '' + example: "" type: string required: - - key - - value + - key + - value type: object RulesetRespDataAttributesRulesItemsReferenceTable: - description: The definition of `RulesetRespDataAttributesRulesItemsReferenceTable` - object. + description: The definition of `RulesetRespDataAttributesRulesItemsReferenceTable` object. nullable: true properties: case_insensitivity: @@ -54996,67 +52302,63 @@ components: field_pairs: description: The `reference_table` `field_pairs`. items: - $ref: '#/components/schemas/RulesetRespDataAttributesRulesItemsReferenceTableFieldPairsItems' + $ref: "#/components/schemas/RulesetRespDataAttributesRulesItemsReferenceTableFieldPairsItems" type: array if_not_exists: deprecated: true - description: Deprecated. Use `if_tag_exists` instead. The `reference_table` - `if_not_exists`. + description: Deprecated. Use `if_tag_exists` instead. The `reference_table` `if_not_exists`. type: boolean if_tag_exists: - $ref: '#/components/schemas/DataAttributesRulesItemsIfTagExists' + $ref: "#/components/schemas/DataAttributesRulesItemsIfTagExists" source_keys: description: The `reference_table` `source_keys`. example: - - '' + - "" items: type: string type: array table_name: description: The `reference_table` `table_name`. - example: '' + example: "" type: string required: - - field_pairs - - source_keys - - table_name + - field_pairs + - source_keys + - table_name type: object RulesetRespDataAttributesRulesItemsReferenceTableFieldPairsItems: - description: The definition of `RulesetRespDataAttributesRulesItemsReferenceTableFieldPairsItems` - object. + description: The definition of `RulesetRespDataAttributesRulesItemsReferenceTableFieldPairsItems` object. properties: input_column: description: The `items` `input_column`. - example: '' + example: "" type: string output_key: description: The `items` `output_key`. - example: '' + example: "" type: string required: - - input_column - - output_key + - input_column + - output_key type: object RulesetRespDataType: default: ruleset description: Ruleset resource type. enum: - - ruleset + - ruleset example: ruleset type: string x-enum-varnames: - - RULESET + - RULESET RumCrossProductSampling: description: The configuration for cross-product retention filters. properties: trace_enabled: - description: Whether the cross-product retention filter for APM traces is - enabled. + description: Whether the cross-product retention filter for APM traces is enabled. example: true type: boolean trace_sample_rate: - description: The sample rate for the APM cross-product retention filter, - between 0 and 100. + description: The sample rate for the APM cross-product retention filter, between 0 and 100. example: 25.0 format: double maximum: 100 @@ -55067,33 +52369,28 @@ components: description: The configuration for cross-product retention filters. properties: trace_enabled: - description: Whether the cross-product retention filter for APM traces is - enabled. + description: Whether the cross-product retention filter for APM traces is enabled. example: true type: boolean trace_sample_rate: - description: The sample rate for the APM cross-product retention filter, - between 0 and 100. + description: The sample rate for the APM cross-product retention filter, between 0 and 100. example: 25.0 format: double maximum: 100 minimum: 0 type: number required: - - trace_sample_rate + - trace_sample_rate type: object RumCrossProductSamplingUpdate: - description: The configuration for cross-product retention filters. All fields - are optional for partial updates. + description: The configuration for cross-product retention filters. All fields are optional for partial updates. properties: trace_enabled: - description: Whether the cross-product retention filter for APM traces is - enabled. + description: Whether the cross-product retention filter for APM traces is enabled. example: true type: boolean trace_sample_rate: - description: The sample rate for the APM cross-product retention filter, - between 0 and 100. + description: The sample rate for the APM cross-product retention filter, between 0 and 100. example: 25.0 format: double maximum: 100 @@ -55104,276 +52401,241 @@ components: description: The compute rule to compute the rum-based metric. properties: aggregation_type: - $ref: '#/components/schemas/RumMetricComputeAggregationType' + $ref: "#/components/schemas/RumMetricComputeAggregationType" include_percentiles: - $ref: '#/components/schemas/RumMetricComputeIncludePercentiles' + $ref: "#/components/schemas/RumMetricComputeIncludePercentiles" path: - description: 'The path to the value the rum-based metric will aggregate - on. - - Only present when `aggregation_type` is `distribution`.' - example: '@duration' + description: |- + The path to the value the rum-based metric will aggregate on. + Only present when `aggregation_type` is `distribution`. + example: "@duration" type: string required: - - aggregation_type + - aggregation_type type: object RumMetricComputeAggregationType: description: The type of aggregation to use. - enum: - - count - - distribution - example: distribution + enum: ["count", "distribution"] + example: "distribution" type: string - x-enum-varnames: - - COUNT - - DISTRIBUTION + x-enum-varnames: ["COUNT", "DISTRIBUTION"] RumMetricComputeIncludePercentiles: - description: 'Toggle to include or exclude percentile aggregations for distribution - metrics. - - Only present when `aggregation_type` is `distribution`.' + description: |- + Toggle to include or exclude percentile aggregations for distribution metrics. + Only present when `aggregation_type` is `distribution`. example: true type: boolean RumMetricCreateAttributes: description: The object describing the Datadog rum-based metric to create. properties: compute: - $ref: '#/components/schemas/RumMetricCompute' + $ref: "#/components/schemas/RumMetricCompute" event_type: - $ref: '#/components/schemas/RumMetricEventType' + $ref: "#/components/schemas/RumMetricEventType" filter: - $ref: '#/components/schemas/RumMetricFilter' + $ref: "#/components/schemas/RumMetricFilter" group_by: description: The rules for the group by. items: - $ref: '#/components/schemas/RumMetricGroupBy' + $ref: "#/components/schemas/RumMetricGroupBy" type: array uniqueness: - $ref: '#/components/schemas/RumMetricUniqueness' + $ref: "#/components/schemas/RumMetricUniqueness" required: - - event_type - - compute + - event_type + - compute type: object RumMetricCreateData: description: The new rum-based metric properties. properties: attributes: - $ref: '#/components/schemas/RumMetricCreateAttributes' + $ref: "#/components/schemas/RumMetricCreateAttributes" id: - $ref: '#/components/schemas/RumMetricID' + $ref: "#/components/schemas/RumMetricID" type: - $ref: '#/components/schemas/RumMetricType' + $ref: "#/components/schemas/RumMetricType" required: - - id - - type - - attributes + - id + - type + - attributes type: object RumMetricCreateRequest: description: The new rum-based metric body. properties: data: - $ref: '#/components/schemas/RumMetricCreateData' + $ref: "#/components/schemas/RumMetricCreateData" required: - - data + - data type: object RumMetricEventType: description: The type of RUM events to filter on. - enum: - - session - - view - - action - - error - - resource - - long_task - - vital - example: session - type: string - x-enum-varnames: - - SESSION - - VIEW - - ACTION - - ERROR - - RESOURCE - - LONG_TASK - - VITAL + enum: ["session", "view", "action", "error", "resource", "long_task", "vital"] + example: "session" + type: string + x-enum-varnames: ["SESSION", "VIEW", "ACTION", "ERROR", "RESOURCE", "LONG_TASK", "VITAL"] RumMetricFilter: - description: The rum-based metric filter. Events matching this filter will be - aggregated in this metric. + description: The rum-based metric filter. Events matching this filter will be aggregated in this metric. properties: query: - default: '*' + default: "*" description: The search query - following the RUM search syntax. - example: '@service:web-ui:' + example: "@service:web-ui:" type: string required: - - query + - query type: object RumMetricGroupBy: description: A group by rule. properties: path: - description: The path to the value the rum-based metric will be aggregated - over. - example: '@browser.name' + description: The path to the value the rum-based metric will be aggregated over. + example: "@browser.name" type: string tag_name: - description: Eventual name of the tag that gets created. By default, `path` - is used as the tag name. - example: browser_name + description: Eventual name of the tag that gets created. By default, `path` is used as the tag name. + example: "browser_name" type: string required: - - path + - path type: object RumMetricID: description: The name of the rum-based metric. - example: rum.sessions.webui.count + example: "rum.sessions.webui.count" type: string RumMetricResponse: description: The rum-based metric object. properties: data: - $ref: '#/components/schemas/RumMetricResponseData' + $ref: "#/components/schemas/RumMetricResponseData" type: object RumMetricResponseAttributes: description: The object describing a Datadog rum-based metric. properties: compute: - $ref: '#/components/schemas/RumMetricResponseCompute' + $ref: "#/components/schemas/RumMetricResponseCompute" event_type: - $ref: '#/components/schemas/RumMetricEventType' + $ref: "#/components/schemas/RumMetricEventType" filter: - $ref: '#/components/schemas/RumMetricResponseFilter' + $ref: "#/components/schemas/RumMetricResponseFilter" group_by: description: The rules for the group by. items: - $ref: '#/components/schemas/RumMetricResponseGroupBy' + $ref: "#/components/schemas/RumMetricResponseGroupBy" type: array uniqueness: - $ref: '#/components/schemas/RumMetricResponseUniqueness' + $ref: "#/components/schemas/RumMetricResponseUniqueness" type: object RumMetricResponseCompute: description: The compute rule to compute the rum-based metric. properties: aggregation_type: - $ref: '#/components/schemas/RumMetricComputeAggregationType' + $ref: "#/components/schemas/RumMetricComputeAggregationType" include_percentiles: - $ref: '#/components/schemas/RumMetricComputeIncludePercentiles' + $ref: "#/components/schemas/RumMetricComputeIncludePercentiles" path: - description: 'The path to the value the rum-based metric will aggregate - on. - - Only present when `aggregation_type` is `distribution`.' - example: '@duration' + description: |- + The path to the value the rum-based metric will aggregate on. + Only present when `aggregation_type` is `distribution`. + example: "@duration" type: string type: object RumMetricResponseData: description: The rum-based metric properties. properties: attributes: - $ref: '#/components/schemas/RumMetricResponseAttributes' + $ref: "#/components/schemas/RumMetricResponseAttributes" id: - $ref: '#/components/schemas/RumMetricID' + $ref: "#/components/schemas/RumMetricID" type: - $ref: '#/components/schemas/RumMetricType' + $ref: "#/components/schemas/RumMetricType" type: object RumMetricResponseFilter: - description: The rum-based metric filter. RUM events matching this filter will - be aggregated in this metric. + description: The rum-based metric filter. RUM events matching this filter will be aggregated in this metric. properties: query: description: The search query - following the RUM search syntax. - example: service:web* AND @http.status_code:[200 TO 299] + example: "service:web* AND @http.status_code:[200 TO 299]" type: string type: object RumMetricResponseGroupBy: description: A group by rule. properties: path: - description: The path to the value the rum-based metric will be aggregated - over. - example: '@http.status_code' + description: The path to the value the rum-based metric will be aggregated over. + example: "@http.status_code" type: string tag_name: - description: Eventual name of the tag that gets created. By default, `path` - is used as the tag name. - example: status_code + description: Eventual name of the tag that gets created. By default, `path` is used as the tag name. + example: "status_code" type: string type: object RumMetricResponseUniqueness: - description: The rule to count updatable events. Is only set if `event_type` - is `session` or `view`. + description: The rule to count updatable events. Is only set if `event_type` is `session` or `view`. properties: when: - $ref: '#/components/schemas/RumMetricUniquenessWhen' + $ref: "#/components/schemas/RumMetricUniquenessWhen" type: object RumMetricType: default: rum_metrics description: The type of the resource. The value should always be rum_metrics. enum: - - rum_metrics + - rum_metrics example: rum_metrics type: string - x-enum-varnames: - - RUM_METRICS + x-enum-varnames: ["RUM_METRICS"] RumMetricUniqueness: - description: The rule to count updatable events. Is only set if `event_type` - is `sessions` or `views`. + description: The rule to count updatable events. Is only set if `event_type` is `sessions` or `views`. properties: when: - $ref: '#/components/schemas/RumMetricUniquenessWhen' + $ref: "#/components/schemas/RumMetricUniquenessWhen" required: - - when + - when type: object RumMetricUniquenessWhen: - description: When to count updatable events. `match` when the event is first - seen, or `end` when the event is complete. - enum: - - match - - end - example: match + description: When to count updatable events. `match` when the event is first seen, or `end` when the event is complete. + enum: ["match", "end"] + example: "match" type: string - x-enum-varnames: - - WHEN_MATCH - - WHEN_END + x-enum-varnames: ["WHEN_MATCH", "WHEN_END"] RumMetricUpdateAttributes: description: The rum-based metric properties that will be updated. properties: compute: - $ref: '#/components/schemas/RumMetricUpdateCompute' + $ref: "#/components/schemas/RumMetricUpdateCompute" filter: - $ref: '#/components/schemas/RumMetricFilter' + $ref: "#/components/schemas/RumMetricFilter" group_by: description: The rules for the group by. items: - $ref: '#/components/schemas/RumMetricGroupBy' + $ref: "#/components/schemas/RumMetricGroupBy" type: array type: object RumMetricUpdateCompute: description: The compute rule to compute the rum-based metric. properties: include_percentiles: - $ref: '#/components/schemas/RumMetricComputeIncludePercentiles' + $ref: "#/components/schemas/RumMetricComputeIncludePercentiles" type: object RumMetricUpdateData: description: The new rum-based metric properties. properties: attributes: - $ref: '#/components/schemas/RumMetricUpdateAttributes' + $ref: "#/components/schemas/RumMetricUpdateAttributes" id: - $ref: '#/components/schemas/RumMetricID' + $ref: "#/components/schemas/RumMetricID" type: - $ref: '#/components/schemas/RumMetricType' + $ref: "#/components/schemas/RumMetricType" required: - - type - - attributes + - type + - attributes type: object RumMetricUpdateRequest: description: The new rum-based metric body. properties: data: - $ref: '#/components/schemas/RumMetricUpdateData' + $ref: "#/components/schemas/RumMetricUpdateData" required: - - data + - data type: object RumMetricsResponse: description: All the available rum-based metric objects. @@ -55381,73 +52643,73 @@ components: data: description: A list of rum-based metric objects. items: - $ref: '#/components/schemas/RumMetricResponseData' + $ref: "#/components/schemas/RumMetricResponseData" type: array type: object RumRetentionFilterAttributes: description: The object describing attributes of a RUM retention filter. properties: cross_product_sampling: - $ref: '#/components/schemas/RumCrossProductSampling' + $ref: "#/components/schemas/RumCrossProductSampling" enabled: - $ref: '#/components/schemas/RumRetentionFilterEnabled' + $ref: "#/components/schemas/RumRetentionFilterEnabled" event_type: - $ref: '#/components/schemas/RumRetentionFilterEventType' + $ref: "#/components/schemas/RumRetentionFilterEventType" name: - $ref: '#/components/schemas/RunRetentionFilterName' + $ref: "#/components/schemas/RunRetentionFilterName" query: - $ref: '#/components/schemas/RumRetentionFilterQuery' + $ref: "#/components/schemas/RumRetentionFilterQuery" sample_rate: - $ref: '#/components/schemas/RumRetentionFilterSampleRate' + $ref: "#/components/schemas/RumRetentionFilterSampleRate" type: object RumRetentionFilterCreateAttributes: description: The object describing attributes of a RUM retention filter to create. properties: cross_product_sampling: - $ref: '#/components/schemas/RumCrossProductSamplingCreate' + $ref: "#/components/schemas/RumCrossProductSamplingCreate" enabled: - $ref: '#/components/schemas/RumRetentionFilterEnabled' + $ref: "#/components/schemas/RumRetentionFilterEnabled" event_type: - $ref: '#/components/schemas/RumRetentionFilterEventType' + $ref: "#/components/schemas/RumRetentionFilterEventType" name: - $ref: '#/components/schemas/RunRetentionFilterName' + $ref: "#/components/schemas/RunRetentionFilterName" query: - $ref: '#/components/schemas/RumRetentionFilterQuery' + $ref: "#/components/schemas/RumRetentionFilterQuery" sample_rate: - $ref: '#/components/schemas/RumRetentionFilterSampleRate' + $ref: "#/components/schemas/RumRetentionFilterSampleRate" required: - - event_type - - name - - sample_rate + - event_type + - name + - sample_rate type: object RumRetentionFilterCreateData: description: The new RUM retention filter properties to create. properties: attributes: - $ref: '#/components/schemas/RumRetentionFilterCreateAttributes' + $ref: "#/components/schemas/RumRetentionFilterCreateAttributes" type: - $ref: '#/components/schemas/RumRetentionFilterType' + $ref: "#/components/schemas/RumRetentionFilterType" required: - - type - - attributes + - type + - attributes type: object RumRetentionFilterCreateRequest: description: The RUM retention filter body to create. properties: data: - $ref: '#/components/schemas/RumRetentionFilterCreateData' + $ref: "#/components/schemas/RumRetentionFilterCreateData" required: - - data + - data type: object RumRetentionFilterData: description: The RUM retention filter. properties: attributes: - $ref: '#/components/schemas/RumRetentionFilterAttributes' + $ref: "#/components/schemas/RumRetentionFilterAttributes" id: - $ref: '#/components/schemas/RumRetentionFilterID' + $ref: "#/components/schemas/RumRetentionFilterID" type: - $ref: '#/components/schemas/RumRetentionFilterType' + $ref: "#/components/schemas/RumRetentionFilterType" type: object RumRetentionFilterEnabled: description: Whether the retention filter is enabled. @@ -55455,37 +52717,23 @@ components: type: boolean RumRetentionFilterEventType: description: The type of RUM events to filter on. - enum: - - session - - view - - action - - error - - resource - - long_task - - vital - example: session - type: string - x-enum-varnames: - - SESSION - - VIEW - - ACTION - - ERROR - - RESOURCE - - LONG_TASK - - VITAL + enum: ["session", "view", "action", "error", "resource", "long_task", "vital"] + example: "session" + type: string + x-enum-varnames: ["SESSION", "VIEW", "ACTION", "ERROR", "RESOURCE", "LONG_TASK", "VITAL"] RumRetentionFilterID: description: ID of retention filter in UUID. - example: 051601eb-54a0-abc0-03f9-cc02efa18892 + example: "051601eb-54a0-abc0-03f9-cc02efa18892" type: string RumRetentionFilterQuery: description: The query string for a RUM retention filter. - example: '@session.has_replay:true' + example: "@session.has_replay:true" type: string RumRetentionFilterResponse: description: The RUM retention filter object. properties: data: - $ref: '#/components/schemas/RumRetentionFilterData' + $ref: "#/components/schemas/RumRetentionFilterData" type: object RumRetentionFilterSampleRate: description: The sample rate for a RUM retention filter, between 0.1 and 100. @@ -55498,71 +52746,68 @@ components: default: retention_filters description: The type of the resource. The value should always be retention_filters. enum: - - retention_filters + - retention_filters example: retention_filters type: string - x-enum-varnames: - - RETENTION_FILTERS + x-enum-varnames: ["RETENTION_FILTERS"] RumRetentionFilterUpdateAttributes: description: The object describing attributes of a RUM retention filter to update. properties: cross_product_sampling: - $ref: '#/components/schemas/RumCrossProductSamplingUpdate' + $ref: "#/components/schemas/RumCrossProductSamplingUpdate" enabled: - $ref: '#/components/schemas/RumRetentionFilterEnabled' + $ref: "#/components/schemas/RumRetentionFilterEnabled" event_type: - $ref: '#/components/schemas/RumRetentionFilterEventType' + $ref: "#/components/schemas/RumRetentionFilterEventType" name: - $ref: '#/components/schemas/RunRetentionFilterName' + $ref: "#/components/schemas/RunRetentionFilterName" query: - $ref: '#/components/schemas/RumRetentionFilterQuery' + $ref: "#/components/schemas/RumRetentionFilterQuery" sample_rate: - $ref: '#/components/schemas/RumRetentionFilterSampleRate' + $ref: "#/components/schemas/RumRetentionFilterSampleRate" type: object RumRetentionFilterUpdateData: description: The new RUM retention filter properties to update. properties: attributes: - $ref: '#/components/schemas/RumRetentionFilterUpdateAttributes' + $ref: "#/components/schemas/RumRetentionFilterUpdateAttributes" id: - $ref: '#/components/schemas/RumRetentionFilterID' + $ref: "#/components/schemas/RumRetentionFilterID" type: - $ref: '#/components/schemas/RumRetentionFilterType' + $ref: "#/components/schemas/RumRetentionFilterType" required: - - id - - type - - attributes + - id + - type + - attributes type: object RumRetentionFilterUpdateRequest: description: The RUM retention filter body to update. properties: data: - $ref: '#/components/schemas/RumRetentionFilterUpdateData' + $ref: "#/components/schemas/RumRetentionFilterUpdateData" required: - - data + - data type: object RumRetentionFiltersOrderData: description: The RUM retention filter data for ordering. properties: id: - $ref: '#/components/schemas/RumRetentionFilterID' + $ref: "#/components/schemas/RumRetentionFilterID" type: - $ref: '#/components/schemas/RumRetentionFilterType' + $ref: "#/components/schemas/RumRetentionFilterType" required: - - id - - type + - id + - type type: object RumRetentionFiltersOrderRequest: - description: 'The list of RUM retention filter IDs along with their corresponding - type to reorder. - - All retention filter IDs should be included in the list created for a RUM - application.' + description: |- + The list of RUM retention filter IDs along with their corresponding type to reorder. + All retention filter IDs should be included in the list created for a RUM application. properties: data: description: A list of RUM retention filter IDs along with type. items: - $ref: '#/components/schemas/RumRetentionFiltersOrderData' + $ref: "#/components/schemas/RumRetentionFiltersOrderData" type: array type: object RumRetentionFiltersOrderResponse: @@ -55571,7 +52816,7 @@ components: data: description: A list of RUM retention filter IDs along with type. items: - $ref: '#/components/schemas/RumRetentionFiltersOrderData' + $ref: "#/components/schemas/RumRetentionFiltersOrderData" type: array type: object RumRetentionFiltersResponse: @@ -55580,71 +52825,69 @@ components: data: description: A list of RUM retention filters. items: - $ref: '#/components/schemas/RumRetentionFilterData' + $ref: "#/components/schemas/RumRetentionFilterData" type: array type: object RunRetentionFilterName: description: The name of a RUM retention filter. - example: Retention filter for session + example: "Retention filter for session" type: string RunThreatHuntingJobRequest: description: Run a threat hunting job request. properties: data: - $ref: '#/components/schemas/RunThreatHuntingJobRequestData' + $ref: "#/components/schemas/RunThreatHuntingJobRequestData" type: object RunThreatHuntingJobRequestAttributes: description: Run a threat hunting job request. properties: fromRule: - $ref: '#/components/schemas/JobDefinitionFromRule' + $ref: "#/components/schemas/JobDefinitionFromRule" id: description: Request ID. type: string jobDefinition: - $ref: '#/components/schemas/JobDefinition' + $ref: "#/components/schemas/JobDefinition" type: object RunThreatHuntingJobRequestData: description: Data for running a threat hunting job request. properties: attributes: - $ref: '#/components/schemas/RunThreatHuntingJobRequestAttributes' + $ref: "#/components/schemas/RunThreatHuntingJobRequestAttributes" type: - $ref: '#/components/schemas/RunThreatHuntingJobRequestDataType' + $ref: "#/components/schemas/RunThreatHuntingJobRequestDataType" type: object RunThreatHuntingJobRequestDataType: description: Type of data. enum: - - historicalDetectionsJobCreate + - historicalDetectionsJobCreate type: string x-enum-varnames: - - HISTORICALDETECTIONSJOBCREATE + - HISTORICALDETECTIONSJOBCREATE SAMLAssertionAttribute: description: SAML assertion attribute. properties: attributes: - $ref: '#/components/schemas/SAMLAssertionAttributeAttributes' + $ref: "#/components/schemas/SAMLAssertionAttributeAttributes" id: description: The ID of the SAML assertion attribute. - example: '0' + example: "0" type: string type: - $ref: '#/components/schemas/SAMLAssertionAttributesType' + $ref: "#/components/schemas/SAMLAssertionAttributesType" required: - - id - - type + - id + - type type: object SAMLAssertionAttributeAttributes: description: Key/Value pair of attributes used in SAML assertion attributes. properties: attribute_key: - description: Key portion of a key/value pair of the attribute sent from - the Identity Provider. + description: Key portion of a key/value pair of the attribute sent from the Identity Provider. example: member-of type: string attribute_value: - description: Value portion of a key/value pair of the attribute sent from - the Identity Provider. + description: Value portion of a key/value pair of the attribute sent from the Identity Provider. example: Development type: string type: object @@ -55652,109 +52895,100 @@ components: default: saml_assertion_attributes description: SAML assertion attributes resource type. enum: - - saml_assertion_attributes + - saml_assertion_attributes example: saml_assertion_attributes type: string x-enum-varnames: - - SAML_ASSERTION_ATTRIBUTES + - SAML_ASSERTION_ATTRIBUTES SBOM: description: A single SBOM properties: attributes: - $ref: '#/components/schemas/SBOMAttributes' + $ref: "#/components/schemas/SBOMAttributes" id: - description: The unique ID for this SBOM (it is equivalent to the `asset_name` - or `asset_name@repo_digest` (Image) - example: github.com/datadog/datadog-agent + description: The unique ID for this SBOM (it is equivalent to the `asset_name` or `asset_name@repo_digest` (Image) + example: "github.com/datadog/datadog-agent" type: string type: - $ref: '#/components/schemas/SBOMType' + $ref: "#/components/schemas/SBOMType" type: object SBOMAttributes: description: The JSON:API attributes of the SBOM. properties: bomFormat: - description: Specifies the format of the BOM. This helps to identify the - file as CycloneDX since BOM do not have a filename convention nor does - JSON schema support namespaces. This value MUST be `CycloneDX`. + description: Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOM do not have a filename convention nor does JSON schema support namespaces. This value MUST be `CycloneDX`. example: CycloneDX type: string components: description: A list of software and hardware components. items: - $ref: '#/components/schemas/SBOMComponent' + $ref: "#/components/schemas/SBOMComponent" type: array dependencies: description: List of dependencies between components of the SBOM. items: - $ref: '#/components/schemas/SBOMComponentDependency' + $ref: "#/components/schemas/SBOMComponentDependency" type: array metadata: - $ref: '#/components/schemas/SBOMMetadata' + $ref: "#/components/schemas/SBOMMetadata" serialNumber: - description: Every BOM generated has a unique serial number, even if the - contents of the BOM have not changed overt time. The serial number follows - [RFC-4122](https://datatracker.ietf.org/doc/html/rfc4122) + description: Every BOM generated has a unique serial number, even if the contents of the BOM have not changed overt time. The serial number follows [RFC-4122](https://datatracker.ietf.org/doc/html/rfc4122) example: urn:uuid:f7119d2f-1vgh-24b5-91f0-12010db72da7 type: string specVersion: - $ref: '#/components/schemas/SpecVersion' + $ref: "#/components/schemas/SpecVersion" version: - description: It increments when a BOM is modified. The default value is - 1. + description: It increments when a BOM is modified. The default value is 1. example: 1 format: int64 type: integer required: - - bomFormat - - specVersion - - components - - metadata - - serialNumber - - version - - dependencies + - bomFormat + - specVersion + - components + - metadata + - serialNumber + - version + - dependencies type: object SBOMComponent: description: Software or hardware component. properties: bom-ref: - description: An optional identifier that can be used to reference the component - elsewhere in the BOM. - example: pkg:golang/google.golang.org/grpc@1.68.1 + description: An optional identifier that can be used to reference the component elsewhere in the BOM. + example: "pkg:golang/google.golang.org/grpc@1.68.1" type: string licenses: description: The software licenses of the SBOM component. items: - $ref: '#/components/schemas/SBOMComponentLicense' + $ref: "#/components/schemas/SBOMComponentLicense" type: array name: - description: The name of the component. This will often be a shortened, - single name of the component. - example: google.golang.org/grpc + description: The name of the component. This will often be a shortened, single name of the component. + example: "google.golang.org/grpc" type: string properties: description: The custom properties of the component of the SBOM. items: - $ref: '#/components/schemas/SBOMComponentProperty' + $ref: "#/components/schemas/SBOMComponentProperty" type: array purl: - description: Specifies the package-url (purl). The purl, if specified, MUST - be valid and conform to the [specification](https://github.com/package-url/purl-spec). - example: pkg:golang/google.golang.org/grpc@1.68.1 + description: Specifies the package-url (purl). The purl, if specified, MUST be valid and conform to the [specification](https://github.com/package-url/purl-spec). + example: "pkg:golang/google.golang.org/grpc@1.68.1" type: string supplier: - $ref: '#/components/schemas/SBOMComponentSupplier' + $ref: "#/components/schemas/SBOMComponentSupplier" type: - $ref: '#/components/schemas/SBOMComponentType' + $ref: "#/components/schemas/SBOMComponentType" version: description: The component version. - example: 1.68.1 + example: "1.68.1" type: string required: - - type - - name - - version - - supplier + - type + - name + - version + - supplier type: object SBOMComponentDependency: description: The dependencies of a component of the SBOM. @@ -55765,8 +52999,8 @@ components: example: pkg:golang/google.golang.org/grpc@1.68.1 type: string required: - - ref - - dependsOn + - ref + - dependsOn type: array ref: description: The identifier for the related component. @@ -55777,9 +53011,9 @@ components: description: The software license of the component of the SBOM. properties: license: - $ref: '#/components/schemas/SBOMComponentLicenseLicense' + $ref: "#/components/schemas/SBOMComponentLicenseLicense" required: - - license + - license type: object SBOMComponentLicenseLicense: description: The software license of the component of the SBOM. @@ -55789,30 +53023,30 @@ components: example: MIT type: string required: - - name + - name type: object SBOMComponentLicenseType: description: The SBOM component license type. enum: - - network_strong_copyleft - - non_standard_copyleft - - other_non_free - - other_non_standard - - permissive - - public_domain - - strong_copyleft - - weak_copyleft + - network_strong_copyleft + - non_standard_copyleft + - other_non_free + - other_non_standard + - permissive + - public_domain + - strong_copyleft + - weak_copyleft example: application type: string x-enum-varnames: - - NETWORK_STRONG_COPYLEFT - - NON_STANDARD_COPYLEFT - - OTHER_NON_FREE - - OTHER_NON_STANDARD - - PERMISSIVE - - PUBLIC_DOMAIN - - STRONG_COPYLEFT - - WEAK_COPYLEFT + - NETWORK_STRONG_COPYLEFT + - NON_STANDARD_COPYLEFT + - OTHER_NON_FREE + - OTHER_NON_STANDARD + - PERMISSIVE + - PUBLIC_DOMAIN + - STRONG_COPYLEFT + - WEAK_COPYLEFT SBOMComponentProperty: description: The custom property of the component of the SBOM. properties: @@ -55825,8 +53059,8 @@ components: example: permissive type: string required: - - name - - value + - name + - value type: object SBOMComponentSupplier: description: The supplier of the component. @@ -55836,61 +53070,61 @@ components: example: https://go.dev type: string required: - - name + - name type: object SBOMComponentType: description: The SBOM component type enum: - - application - - container - - data - - device - - device-driver - - file - - firmware - - framework - - library - - machine-learning-model - - operating-system - - platform + - application + - container + - data + - device + - device-driver + - file + - firmware + - framework + - library + - machine-learning-model + - operating-system + - platform example: application type: string x-enum-varnames: - - APPLICATION - - CONTAINER - - DATA - - DEVICE - - DEVICE_DRIVER - - FILE - - FIRMWARE - - FRAMEWORK - - LIBRARY - - MACHINE_LEARNING_MODEL - - OPERATING_SYSTEM - - PLATFORM + - APPLICATION + - CONTAINER + - DATA + - DEVICE + - DEVICE_DRIVER + - FILE + - FIRMWARE + - FRAMEWORK + - LIBRARY + - MACHINE_LEARNING_MODEL + - OPERATING_SYSTEM + - PLATFORM SBOMFormat: description: The SBOM standard enum: - - CycloneDX - - SPDX + - CycloneDX + - SPDX example: CycloneDX type: string x-enum-varnames: - - CYCLONEDX - - SPDX + - CYCLONEDX + - SPDX SBOMMetadata: description: Provides additional information about a BOM. properties: authors: description: List of authors of the SBOM. items: - $ref: '#/components/schemas/SBOMMetadataAuthor' + $ref: "#/components/schemas/SBOMMetadataAuthor" type: array component: - $ref: '#/components/schemas/SBOMMetadataComponent' + $ref: "#/components/schemas/SBOMMetadataComponent" timestamp: description: The timestamp of the SBOM creation. - example: '2025-07-08T07:24:53Z' + example: "2025-07-08T07:24:53Z" type: string type: object SBOMMetadataAuthor: @@ -55898,16 +53132,15 @@ components: properties: name: description: The identifier of the Author of the SBOM. - example: Datadog, Inc. + example: "Datadog, Inc." type: string type: object SBOMMetadataComponent: description: The component that the BOM describes. properties: name: - description: The name of the component. This will often be a shortened, - single name of the component. - example: github.com/datadog/datadog-agent + description: The name of the component. This will often be a shortened, single name of the component. + example: "github.com/datadog/datadog-agent" type: string type: description: Specifies the type of the component. @@ -55917,117 +53150,118 @@ components: SBOMType: description: The JSON:API type. enum: - - sboms + - sboms example: sboms type: string x-enum-varnames: - - SBOMS + - SBOMS SLOReportInterval: - description: The frequency at which report data is to be generated. + description: |- + The frequency at which report data is to be generated. enum: - - daily - - weekly - - monthly + - daily + - weekly + - monthly example: weekly type: string x-enum-varnames: - - DAILY - - WEEKLY - - MONTHLY + - DAILY + - WEEKLY + - MONTHLY SLOReportPostResponse: description: The SLO report response. properties: data: - $ref: '#/components/schemas/SLOReportPostResponseData' + $ref: "#/components/schemas/SLOReportPostResponseData" type: object SLOReportPostResponseData: description: The data portion of the SLO report response. properties: id: description: The ID of the report job. - example: dc8d92aa-e0af-11ee-af21-1feeaccaa3a3 + example: "dc8d92aa-e0af-11ee-af21-1feeaccaa3a3" type: string type: description: The type of ID. - example: report_id + example: "report_id" type: string type: object SLOReportStatus: description: The status of the SLO report job. enum: - - in_progress - - completed - - completed_with_errors - - failed - example: completed + - in_progress + - completed + - completed_with_errors + - failed + example: "completed" type: string x-enum-varnames: - - IN_PROGRESS - - COMPLETED - - COMPLETED_WITH_ERRORS - - FAILED + - IN_PROGRESS + - COMPLETED + - COMPLETED_WITH_ERRORS + - FAILED SLOReportStatusGetResponse: description: The SLO report status response. properties: data: - $ref: '#/components/schemas/SLOReportStatusGetResponseData' + $ref: "#/components/schemas/SLOReportStatusGetResponseData" type: object SLOReportStatusGetResponseAttributes: description: The attributes portion of the SLO report status response. properties: status: - $ref: '#/components/schemas/SLOReportStatus' + $ref: "#/components/schemas/SLOReportStatus" type: object SLOReportStatusGetResponseData: description: The data portion of the SLO report status response. properties: attributes: - $ref: '#/components/schemas/SLOReportStatusGetResponseAttributes' + $ref: "#/components/schemas/SLOReportStatusGetResponseAttributes" id: description: The ID of the report job. - example: dc8d92aa-e0af-11ee-af21-1feeaccaa3a3 + example: "dc8d92aa-e0af-11ee-af21-1feeaccaa3a3" type: string type: description: The type of ID. - example: report_id + example: "report_id" type: string type: object ScaRequest: properties: data: - $ref: '#/components/schemas/ScaRequestData' + $ref: "#/components/schemas/ScaRequestData" type: object ScaRequestData: properties: attributes: - $ref: '#/components/schemas/ScaRequestDataAttributes' + $ref: "#/components/schemas/ScaRequestDataAttributes" id: type: string type: - $ref: '#/components/schemas/ScaRequestDataType' + $ref: "#/components/schemas/ScaRequestDataType" required: - - type + - type type: object ScaRequestDataAttributes: properties: commit: - $ref: '#/components/schemas/ScaRequestDataAttributesCommit' + $ref: "#/components/schemas/ScaRequestDataAttributesCommit" dependencies: items: - $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItems' + $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItems" type: array env: type: string files: items: - $ref: '#/components/schemas/ScaRequestDataAttributesFilesItems' + $ref: "#/components/schemas/ScaRequestDataAttributesFilesItems" type: array relations: items: - $ref: '#/components/schemas/ScaRequestDataAttributesRelationsItems' + $ref: "#/components/schemas/ScaRequestDataAttributesRelationsItems" type: array repository: - $ref: '#/components/schemas/ScaRequestDataAttributesRepository' + $ref: "#/components/schemas/ScaRequestDataAttributesRepository" service: type: string tags: @@ -56036,7 +53270,7 @@ components: type: object vulnerabilities: items: - $ref: '#/components/schemas/ScaRequestDataAttributesVulnerabilitiesItems' + $ref: "#/components/schemas/ScaRequestDataAttributesVulnerabilitiesItems" type: array type: object ScaRequestDataAttributesCommit: @@ -56072,7 +53306,7 @@ components: type: string locations: items: - $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItems' + $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItems" type: array name: type: string @@ -56082,7 +53316,7 @@ components: type: string reachable_symbol_properties: items: - $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems' + $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems" type: array version: type: string @@ -56090,22 +53324,22 @@ components: ScaRequestDataAttributesDependenciesItemsLocationsItems: properties: block: - $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition' + $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition" name: - $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition' + $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition" namespace: - $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition' + $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition" version: - $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition' + $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition" type: object ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition: properties: end: - $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition' + $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition" file_name: type: string start: - $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition' + $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition" type: object ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition: properties: @@ -56150,7 +53384,7 @@ components: properties: affects: items: - $ref: '#/components/schemas/ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems' + $ref: "#/components/schemas/ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems" type: array bom_ref: type: string @@ -56165,47 +53399,47 @@ components: ScaRequestDataType: default: scarequests enum: - - scarequests + - scarequests example: scarequests type: string x-enum-varnames: - - SCAREQUESTS + - SCAREQUESTS ScalarColumn: description: A single column in a scalar query response. oneOf: - - $ref: '#/components/schemas/GroupScalarColumn' - - $ref: '#/components/schemas/DataScalarColumn' + - $ref: "#/components/schemas/GroupScalarColumn" + - $ref: "#/components/schemas/DataScalarColumn" ScalarColumnTypeGroup: default: group description: The type of column present for groups. enum: - - group + - group example: group type: string x-enum-varnames: - - GROUP + - GROUP ScalarColumnTypeNumber: default: number description: The type of column present for numbers. enum: - - number + - number example: number type: string x-enum-varnames: - - NUMBER + - NUMBER ScalarFormulaQueryRequest: description: A wrapper request around one scalar query to be executed. properties: data: - $ref: '#/components/schemas/ScalarFormulaRequest' + $ref: "#/components/schemas/ScalarFormulaRequest" required: - - data + - data type: object ScalarFormulaQueryResponse: description: A message containing one or more responses to scalar queries. properties: data: - $ref: '#/components/schemas/ScalarResponse' + $ref: "#/components/schemas/ScalarResponse" errors: description: An error generated when processing a request. type: string @@ -56214,12 +53448,12 @@ components: description: A single scalar query to be executed. properties: attributes: - $ref: '#/components/schemas/ScalarFormulaRequestAttributes' + $ref: "#/components/schemas/ScalarFormulaRequestAttributes" type: - $ref: '#/components/schemas/ScalarFormulaRequestType' + $ref: "#/components/schemas/ScalarFormulaRequestType" required: - - type - - attributes + - type + - attributes type: object ScalarFormulaRequestAttributes: description: The object describing a scalar formula request. @@ -56227,80 +53461,68 @@ components: formulas: description: List of formulas to be calculated and returned as responses. items: - $ref: '#/components/schemas/QueryFormula' + $ref: "#/components/schemas/QueryFormula" type: array from: - description: Start date (inclusive) of the query in milliseconds since the - Unix epoch. + description: Start date (inclusive) of the query in milliseconds since the Unix epoch. example: 1568899800000 format: int64 type: integer queries: - $ref: '#/components/schemas/ScalarFormulaRequestQueries' + $ref: "#/components/schemas/ScalarFormulaRequestQueries" to: - description: End date (exclusive) of the query in milliseconds since the - Unix epoch. + description: End date (exclusive) of the query in milliseconds since the Unix epoch. example: 1568923200000 format: int64 type: integer required: - - to - - from - - queries + - to + - from + - queries type: object ScalarFormulaRequestQueries: description: List of queries to be run and used as inputs to the formulas. example: - - aggregator: avg - data_source: metrics - query: avg:system.cpu.user{*} by {env} + - aggregator: avg + data_source: metrics + query: "avg:system.cpu.user{*} by {env}" items: - $ref: '#/components/schemas/ScalarQuery' + $ref: "#/components/schemas/ScalarQuery" type: array ScalarFormulaRequestType: - default: scalar_request + default: "scalar_request" description: The type of the resource. The value should always be scalar_request. - enum: - - scalar_request - example: scalar_request + enum: ["scalar_request"] + example: "scalar_request" type: string - x-enum-varnames: - - SCALAR_REQUEST + x-enum-varnames: ["SCALAR_REQUEST"] ScalarFormulaResponseAtrributes: description: The object describing a scalar response. properties: columns: - description: List of response columns, each corresponding to an individual - formula or query in the request and with values in parallel arrays matching - the series list. + description: List of response columns, each corresponding to an individual formula or query in the request and with values in parallel arrays matching the series list. items: - $ref: '#/components/schemas/ScalarColumn' + $ref: "#/components/schemas/ScalarColumn" type: array type: object ScalarFormulaResponseType: - default: scalar_response + default: "scalar_response" description: The type of the resource. The value should always be scalar_response. - enum: - - scalar_response - example: scalar_response + enum: ["scalar_response"] + example: "scalar_response" type: string - x-enum-varnames: - - SCALAR_RESPONSE + x-enum-varnames: ["SCALAR_RESPONSE"] ScalarMeta: description: Metadata for the resulting numerical values. properties: unit: - description: 'Detailed information about the unit. - - First element describes the "primary unit" (for example, `bytes` in `bytes - per second`). - - The second element describes the "per unit" (for example, `second` in - `bytes per second`). - - If the second element is not present, the API returns null.' + description: |- + Detailed information about the unit. + First element describes the "primary unit" (for example, `bytes` in `bytes per second`). + The second element describes the "per unit" (for example, `second` in `bytes per second`). + If the second element is not present, the API returns null. items: - $ref: '#/components/schemas/Unit' + $ref: "#/components/schemas/Unit" nullable: true type: array type: object @@ -56309,82 +53531,81 @@ components: example: aggregator: avg data_source: metrics - query: avg:system.cpu.user{*} by {env} + query: "avg:system.cpu.user{*} by {env}" oneOf: - - $ref: '#/components/schemas/MetricsScalarQuery' - - $ref: '#/components/schemas/EventsScalarQuery' + - $ref: "#/components/schemas/MetricsScalarQuery" + - $ref: "#/components/schemas/EventsScalarQuery" ScalarResponse: description: A message containing the response to a scalar query. properties: attributes: - $ref: '#/components/schemas/ScalarFormulaResponseAtrributes' + $ref: "#/components/schemas/ScalarFormulaResponseAtrributes" type: - $ref: '#/components/schemas/ScalarFormulaResponseType' + $ref: "#/components/schemas/ScalarFormulaResponseType" type: object ScannedAssetMetadata: description: The metadata of a scanned asset. properties: attributes: - $ref: '#/components/schemas/ScannedAssetMetadataAttributes' + $ref: "#/components/schemas/ScannedAssetMetadataAttributes" id: description: The ID of the scanned asset metadata. - example: Host|i-0fc7edef1ab26d7ef + example: "Host|i-0fc7edef1ab26d7ef" type: string required: - - id - - attributes + - id + - attributes type: object ScannedAssetMetadataAsset: description: The asset of a scanned asset metadata. properties: name: description: The name of the asset. - example: i-0fc7edef1ab26d7ef + example: "i-0fc7edef1ab26d7ef" type: string type: - $ref: '#/components/schemas/CloudAssetType' + $ref: "#/components/schemas/CloudAssetType" required: - - type - - name + - type + - name type: object ScannedAssetMetadataAttributes: description: The attributes of a scanned asset metadata. properties: asset: - $ref: '#/components/schemas/ScannedAssetMetadataAsset' + $ref: "#/components/schemas/ScannedAssetMetadataAsset" first_success_timestamp: - description: The timestamp when the scan of the asset was performed for - the first time. - example: '2025-07-08T07:24:53Z' + description: The timestamp when the scan of the asset was performed for the first time. + example: "2025-07-08T07:24:53Z" type: string last_success: - $ref: '#/components/schemas/ScannedAssetMetadataLastSuccess' + $ref: "#/components/schemas/ScannedAssetMetadataLastSuccess" required: - - asset - - last_success - - first_success_timestamp + - asset + - last_success + - first_success_timestamp type: object ScannedAssetMetadataLastSuccess: description: Metadata for the last successful scan of an asset. properties: env: description: The environment of the last success scan of the asset. - example: prod + example: "prod" type: string origin: description: The list of origins of the last success scan of the asset. example: - - production + - production items: example: production type: string type: array timestamp: description: The timestamp of the last success scan of the asset. - example: '2025-07-08T07:24:53Z' + example: "2025-07-08T07:24:53Z" type: string required: - - timestamp + - timestamp type: object ScannedAssetsMetadata: description: The expected response schema when listing scanned assets metadata. @@ -56392,18 +53613,17 @@ components: data: description: List of scanned assets metadata. items: - $ref: '#/components/schemas/ScannedAssetMetadata' + $ref: "#/components/schemas/ScannedAssetMetadata" type: array links: - $ref: '#/components/schemas/Links' + $ref: "#/components/schemas/Links" meta: - $ref: '#/components/schemas/Metadata' + $ref: "#/components/schemas/Metadata" required: - - data + - data type: object Schedule: - description: Top-level container for a schedule object, including both the `data` - payload and any related `included` resources (such as teams, layers, or members). + description: Top-level container for a schedule object, including both the `data` payload and any related `included` resources (such as teams, layers, or members). example: data: attributes: @@ -56413,120 +53633,115 @@ components: relationships: layers: data: - - id: 00000000-0000-0000-0000-000000000001 - type: layers + - id: 00000000-0000-0000-0000-000000000001 + type: layers teams: data: - - id: 00000000-da3a-0000-0000-000000000000 - type: teams + - id: 00000000-da3a-0000-0000-000000000000 + type: teams type: schedules included: - - attributes: - avatar: '' - description: Team 1 description - handle: team1 - name: Team 1 - id: 00000000-da3a-0000-0000-000000000000 - type: teams - - attributes: - effective_date: '2025-02-03T05:00:00Z' - end_date: '2025-12-31T00:00:00Z' - interval: - days: 1 - name: Layer 1 - restrictions: - - end_day: friday - end_time: '17:00:00' - start_day: monday - start_time: 09:00:00 - rotation_start: '2025-02-01T00:00:00Z' - id: 00000000-0000-0000-0000-000000000001 - relationships: - members: - data: - - id: 00000000-0000-0000-0000-000000000002 - type: members - type: layers - - id: 00000000-0000-0000-0000-000000000002 - relationships: - user: - data: - id: 00000000-aba1-0000-0000-000000000000 - type: users - type: members - - attributes: - email: foo@bar.com - name: User 1 - id: 00000000-aba1-0000-0000-000000000000 - type: users + - attributes: + avatar: "" + description: Team 1 description + handle: team1 + name: Team 1 + id: 00000000-da3a-0000-0000-000000000000 + type: teams + - attributes: + effective_date: "2025-02-03T05:00:00Z" + end_date: "2025-12-31T00:00:00Z" + interval: + days: 1 + name: Layer 1 + restrictions: + - end_day: friday + end_time: "17:00:00" + start_day: monday + start_time: "09:00:00" + rotation_start: "2025-02-01T00:00:00Z" + id: 00000000-0000-0000-0000-000000000001 + relationships: + members: + data: + - id: 00000000-0000-0000-0000-000000000002 + type: members + type: layers + - id: 00000000-0000-0000-0000-000000000002 + relationships: + user: + data: + id: 00000000-aba1-0000-0000-000000000000 + type: users + type: members + - attributes: + email: foo@bar.com + name: User 1 + id: 00000000-aba1-0000-0000-000000000000 + type: users properties: data: - $ref: '#/components/schemas/ScheduleData' + $ref: "#/components/schemas/ScheduleData" included: - description: Any additional resources related to this schedule, such as - teams and layers. + description: Any additional resources related to this schedule, such as teams and layers. items: - $ref: '#/components/schemas/ScheduleDataIncludedItem' + $ref: "#/components/schemas/ScheduleDataIncludedItem" type: array type: object ScheduleCreateRequest: - description: The top-level request body for schedule creation, wrapping a `data` - object. + description: The top-level request body for schedule creation, wrapping a `data` object. example: data: attributes: layers: - - effective_date: '2025-02-03T05:00:00Z' - end_date: '2025-12-31T00:00:00Z' - interval: - days: 1 - members: - - user: - id: 00000000-aba1-0000-0000-000000000000 - name: Layer 1 - restrictions: - - end_day: friday - end_time: '17:00:00' - start_day: monday - start_time: 09:00:00 - rotation_start: '2025-02-01T00:00:00Z' + - effective_date: "2025-02-03T05:00:00Z" + end_date: "2025-12-31T00:00:00Z" + interval: + days: 1 + members: + - user: + id: 00000000-aba1-0000-0000-000000000000 + name: Layer 1 + restrictions: + - end_day: friday + end_time: "17:00:00" + start_day: monday + start_time: "09:00:00" + rotation_start: "2025-02-01T00:00:00Z" name: On-Call Schedule time_zone: America/New_York relationships: teams: data: - - id: 00000000-da3a-0000-0000-000000000000 - type: teams + - id: 00000000-da3a-0000-0000-000000000000 + type: teams type: schedules properties: data: - $ref: '#/components/schemas/ScheduleCreateRequestData' + $ref: "#/components/schemas/ScheduleCreateRequestData" required: - - data + - data type: object ScheduleCreateRequestData: - description: The core data wrapper for creating a schedule, encompassing attributes, - relationships, and the resource type. + description: The core data wrapper for creating a schedule, encompassing attributes, relationships, and the resource type. properties: attributes: - $ref: '#/components/schemas/ScheduleCreateRequestDataAttributes' + $ref: "#/components/schemas/ScheduleCreateRequestDataAttributes" relationships: - $ref: '#/components/schemas/ScheduleCreateRequestDataRelationships' + $ref: "#/components/schemas/ScheduleCreateRequestDataRelationships" type: - $ref: '#/components/schemas/ScheduleCreateRequestDataType' + $ref: "#/components/schemas/ScheduleCreateRequestDataType" required: - - type - - attributes + - type + - attributes type: object ScheduleCreateRequestDataAttributes: - description: Describes the main attributes for creating a new schedule, including - name, layers, and time zone. + description: Describes the main attributes for creating a new schedule, including name, layers, and time zone. properties: layers: - description: The layers of On-Call coverage that define rotation intervals - and restrictions. + description: The layers of On-Call coverage that define rotation intervals and restrictions. items: - $ref: '#/components/schemas/ScheduleCreateRequestDataAttributesLayersItems' + $ref: "#/components/schemas/ScheduleCreateRequestDataAttributesLayersItems" type: array name: description: A human-readable name for the new schedule. @@ -56537,94 +53752,89 @@ components: example: America/New_York type: string required: - - name - - time_zone - - layers + - name + - time_zone + - layers type: object ScheduleCreateRequestDataAttributesLayersItems: - description: Describes a schedule layer, including rotation intervals, members, - restrictions, and timeline settings. + description: |- + Describes a schedule layer, including rotation intervals, members, restrictions, and timeline settings. properties: effective_date: description: The date/time when this layer becomes active (in ISO 8601). - example: '2025-01-01T00:00:00Z' + example: "2025-01-01T00:00:00Z" format: date-time type: string end_date: - description: The date/time after which this layer no longer applies (in - ISO 8601). + description: The date/time after which this layer no longer applies (in ISO 8601). format: date-time type: string interval: - $ref: '#/components/schemas/LayerAttributesInterval' + $ref: "#/components/schemas/LayerAttributesInterval" members: description: A list of members who participate in this layer's rotation. items: - $ref: '#/components/schemas/ScheduleRequestDataAttributesLayersItemsMembersItems' + $ref: "#/components/schemas/ScheduleRequestDataAttributesLayersItemsMembersItems" type: array name: description: The name of this layer. example: Primary On-Call Layer type: string restrictions: - description: Zero or more time-based restrictions (for example, only weekdays, - during business hours). + description: Zero or more time-based restrictions (for example, only weekdays, during business hours). items: - $ref: '#/components/schemas/TimeRestriction' + $ref: "#/components/schemas/TimeRestriction" type: array rotation_start: - description: The date/time when the rotation for this layer starts (in ISO - 8601). - example: '2025-01-01T00:00:00Z' + description: The date/time when the rotation for this layer starts (in ISO 8601). + example: "2025-01-01T00:00:00Z" format: date-time type: string time_zone: description: The time zone for this layer. - example: America/New_York + example: "America/New_York" type: string required: - - name - - interval - - rotation_start - - effective_date - - members + - name + - interval + - rotation_start + - effective_date + - members type: object ScheduleCreateRequestDataRelationships: - description: Gathers relationship objects for the schedule creation request, - including the teams to associate. + description: Gathers relationship objects for the schedule creation request, including the teams to associate. properties: teams: - $ref: '#/components/schemas/DataRelationshipsTeams' + $ref: "#/components/schemas/DataRelationshipsTeams" type: object ScheduleCreateRequestDataType: default: schedules - description: Schedules resource type. + description: |- + Schedules resource type. enum: - - schedules + - schedules example: schedules type: string x-enum-varnames: - - SCHEDULES + - SCHEDULES ScheduleData: - description: Represents the primary data object for a schedule, linking attributes - and relationships. + description: Represents the primary data object for a schedule, linking attributes and relationships. properties: attributes: - $ref: '#/components/schemas/ScheduleDataAttributes' + $ref: "#/components/schemas/ScheduleDataAttributes" id: description: The schedule's unique identifier. - example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + example: "3653d3c6-0c75-11ea-ad28-fb5701eabc7d" type: string relationships: - $ref: '#/components/schemas/ScheduleDataRelationships' + $ref: "#/components/schemas/ScheduleDataRelationships" type: - $ref: '#/components/schemas/ScheduleDataType' + $ref: "#/components/schemas/ScheduleDataType" required: - - type + - type type: object ScheduleDataAttributes: - description: Provides core properties of a schedule object such as its name - and time zone. + description: Provides core properties of a schedule object such as its name and time zone. properties: name: description: A short name for the schedule. @@ -56636,21 +53846,19 @@ components: type: string type: object ScheduleDataIncludedItem: - description: Any additional resources related to this schedule, such as teams - and layers. + description: Any additional resources related to this schedule, such as teams and layers. oneOf: - - $ref: '#/components/schemas/TeamReference' - - $ref: '#/components/schemas/Layer' - - $ref: '#/components/schemas/ScheduleMember' - - $ref: '#/components/schemas/ScheduleUser' + - $ref: "#/components/schemas/TeamReference" + - $ref: "#/components/schemas/Layer" + - $ref: "#/components/schemas/ScheduleMember" + - $ref: "#/components/schemas/ScheduleUser" ScheduleDataRelationships: - description: Groups the relationships for a schedule object, referencing layers - and teams. + description: Groups the relationships for a schedule object, referencing layers and teams. properties: layers: - $ref: '#/components/schemas/ScheduleDataRelationshipsLayers' + $ref: "#/components/schemas/ScheduleDataRelationshipsLayers" teams: - $ref: '#/components/schemas/DataRelationshipsTeams' + $ref: "#/components/schemas/DataRelationshipsTeams" type: object ScheduleDataRelationshipsLayers: description: Associates layers with this schedule in a data structure. @@ -56658,238 +53866,233 @@ components: data: description: An array of layer references for this schedule. items: - $ref: '#/components/schemas/ScheduleDataRelationshipsLayersDataItems' + $ref: "#/components/schemas/ScheduleDataRelationshipsLayersDataItems" type: array type: object ScheduleDataRelationshipsLayersDataItems: - description: Relates a layer to this schedule, identified by `id` and `type` - (must be `layers`). + description: |- + Relates a layer to this schedule, identified by `id` and `type` (must be `layers`). properties: id: description: The unique identifier of the layer in this relationship. - example: 00000000-0000-0000-0000-000000000001 + example: "00000000-0000-0000-0000-000000000001" type: string type: - $ref: '#/components/schemas/ScheduleDataRelationshipsLayersDataItemsType' + $ref: "#/components/schemas/ScheduleDataRelationshipsLayersDataItemsType" required: - - type - - id + - type + - id type: object ScheduleDataRelationshipsLayersDataItemsType: default: layers - description: Layers resource type. + description: |- + Layers resource type. enum: - - layers + - layers example: layers type: string x-enum-varnames: - - LAYERS + - LAYERS ScheduleDataType: default: schedules - description: Schedules resource type. + description: |- + Schedules resource type. enum: - - schedules + - schedules example: schedules type: string x-enum-varnames: - - SCHEDULES + - SCHEDULES ScheduleMember: - description: Represents a single member entry in a schedule, referencing a specific - user. + description: Represents a single member entry in a schedule, referencing a specific user. properties: id: description: The unique identifier for this schedule member. type: string relationships: - $ref: '#/components/schemas/ScheduleMemberRelationships' + $ref: "#/components/schemas/ScheduleMemberRelationships" type: - $ref: '#/components/schemas/ScheduleMemberType' + $ref: "#/components/schemas/ScheduleMemberType" required: - - type + - type type: object ScheduleMemberRelationships: - description: Defines relationships for a schedule member, primarily referencing - a single user. + description: Defines relationships for a schedule member, primarily referencing a single user. properties: user: - $ref: '#/components/schemas/ScheduleMemberRelationshipsUser' + $ref: "#/components/schemas/ScheduleMemberRelationshipsUser" type: object ScheduleMemberRelationshipsUser: description: Wraps the user data reference for a schedule member. properties: data: - $ref: '#/components/schemas/ScheduleMemberRelationshipsUserData' + $ref: "#/components/schemas/ScheduleMemberRelationshipsUserData" required: - - data + - data type: object ScheduleMemberRelationshipsUserData: - description: Points to the user data associated with this schedule member, including - an ID and type. + description: Points to the user data associated with this schedule member, including an ID and type. properties: id: description: The user's unique identifier. - example: 00000000-aba1-0000-0000-000000000000 + example: "00000000-aba1-0000-0000-000000000000" type: string type: - $ref: '#/components/schemas/ScheduleMemberRelationshipsUserDataType' + $ref: "#/components/schemas/ScheduleMemberRelationshipsUserDataType" required: - - type - - id + - type + - id type: object ScheduleMemberRelationshipsUserDataType: default: users - description: Users resource type. + description: |- + Users resource type. enum: - - users + - users example: users type: string x-enum-varnames: - - USERS + - USERS ScheduleMemberType: default: members - description: Schedule Members resource type. + description: |- + Schedule Members resource type. enum: - - members + - members example: members type: string x-enum-varnames: - - MEMBERS + - MEMBERS ScheduleRequestDataAttributesLayersItemsMembersItems: - description: Defines a single member within a schedule layer, including the - reference to the underlying user. + description: |- + Defines a single member within a schedule layer, including the reference to the underlying user. properties: user: - $ref: '#/components/schemas/ScheduleRequestDataAttributesLayersItemsMembersItemsUser' + $ref: "#/components/schemas/ScheduleRequestDataAttributesLayersItemsMembersItemsUser" type: object ScheduleRequestDataAttributesLayersItemsMembersItemsUser: - description: Identifies the user participating in this layer as a single object - with an `id`. + description: Identifies the user participating in this layer as a single object with an `id`. properties: id: description: The user's ID. - example: 00000000-aba1-0000-0000-000000000000 + example: "00000000-aba1-0000-0000-000000000000" type: string type: object ScheduleTarget: - description: Represents a schedule target for an escalation policy step, including - its ID and resource type. This is a shortcut for a configured schedule target - with position set to 'current'. + description: "Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'." properties: id: - description: Specifies the unique identifier of the schedule resource. - example: 00000000-aba1-0000-0000-000000000000 + description: "Specifies the unique identifier of the schedule resource." + example: "00000000-aba1-0000-0000-000000000000" type: string type: - $ref: '#/components/schemas/ScheduleTargetType' + $ref: "#/components/schemas/ScheduleTargetType" required: - - type - - id + - type + - id type: object ScheduleTargetPosition: - description: Specifies the position of a schedule target (example `previous`, - `current`, or `next`). + description: "Specifies the position of a schedule target (example `previous`, `current`, or `next`)." enum: - - previous - - current - - next + - previous + - current + - next example: previous type: string x-enum-varnames: - - PREVIOUS - - CURRENT - - NEXT + - PREVIOUS + - CURRENT + - NEXT ScheduleTargetType: default: schedules - description: Indicates that the resource is of type `schedules`. + description: "Indicates that the resource is of type `schedules`." enum: - - schedules + - schedules example: schedules type: string x-enum-varnames: - - SCHEDULES + - SCHEDULES ScheduleTrigger: - description: Trigger a workflow from a Schedule. The workflow must be published. + description: "Trigger a workflow from a Schedule. The workflow must be published." properties: rruleExpression: - description: Recurrence rule expression for scheduling. - example: '' + description: "Recurrence rule expression for scheduling." + example: "" type: string required: - - rruleExpression + - rruleExpression type: object ScheduleTriggerWrapper: - description: Schema for a Schedule-based trigger. + description: "Schema for a Schedule-based trigger." properties: scheduleTrigger: - $ref: '#/components/schemas/ScheduleTrigger' + $ref: "#/components/schemas/ScheduleTrigger" startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - scheduleTrigger + - scheduleTrigger type: object ScheduleUpdateRequest: - description: A top-level wrapper for a schedule update request, referring to - the `data` object with the new details. + description: A top-level wrapper for a schedule update request, referring to the `data` object with the new details. example: data: attributes: layers: - - effective_date: '2025-02-03T05:00:00Z' - end_date: '2025-12-31T00:00:00Z' - interval: - seconds: 3600 - members: - - user: - id: 00000000-aba1-0000-0000-000000000000 - name: Layer 1 - restrictions: - - end_day: friday - end_time: '17:00:00' - start_day: monday - start_time: 09:00:00 - rotation_start: '2025-02-01T00:00:00Z' + - effective_date: "2025-02-03T05:00:00Z" + end_date: "2025-12-31T00:00:00Z" + interval: + seconds: 3600 + members: + - user: + id: 00000000-aba1-0000-0000-000000000000 + name: Layer 1 + restrictions: + - end_day: friday + end_time: "17:00:00" + start_day: monday + start_time: "09:00:00" + rotation_start: "2025-02-01T00:00:00Z" name: On-Call Schedule Updated time_zone: America/New_York id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d relationships: teams: data: - - id: 00000000-da3a-0000-0000-000000000000 - type: teams + - id: 00000000-da3a-0000-0000-000000000000 + type: teams type: schedules properties: data: - $ref: '#/components/schemas/ScheduleUpdateRequestData' + $ref: "#/components/schemas/ScheduleUpdateRequestData" required: - - data + - data type: object ScheduleUpdateRequestData: - description: Contains all data needed to update an existing schedule, including - its attributes (such as name and time zone) and any relationships to teams. + description: Contains all data needed to update an existing schedule, including its attributes (such as name and time zone) and any relationships to teams. properties: attributes: - $ref: '#/components/schemas/ScheduleUpdateRequestDataAttributes' + $ref: "#/components/schemas/ScheduleUpdateRequestDataAttributes" id: description: The ID of the schedule to be updated. - example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + example: "3653d3c6-0c75-11ea-ad28-fb5701eabc7d" type: string relationships: - $ref: '#/components/schemas/ScheduleUpdateRequestDataRelationships' + $ref: "#/components/schemas/ScheduleUpdateRequestDataRelationships" type: - $ref: '#/components/schemas/ScheduleUpdateRequestDataType' + $ref: "#/components/schemas/ScheduleUpdateRequestDataType" required: - - type - - id - - attributes + - type + - id + - attributes type: object ScheduleUpdateRequestDataAttributes: - description: Defines the updatable attributes for a schedule, such as name, - time zone, and layers. + description: |- + Defines the updatable attributes for a schedule, such as name, time zone, and layers. properties: layers: description: The updated list of layers (rotations) for this schedule. items: - $ref: '#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItems' + $ref: "#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItems" type: array name: description: A short name for the schedule. @@ -56900,189 +54103,187 @@ components: example: America/New_York type: string required: - - name - - time_zone - - layers + - name + - time_zone + - layers type: object ScheduleUpdateRequestDataAttributesLayersItems: - description: 'Represents a layer within a schedule update, including rotation - details, members, - - and optional restrictions.' + description: |- + Represents a layer within a schedule update, including rotation details, members, + and optional restrictions. properties: effective_date: description: When this updated layer takes effect (ISO 8601 format). - example: '2025-02-03T05:00:00Z' + example: "2025-02-03T05:00:00Z" format: date-time type: string end_date: - description: When this updated layer should stop being active (ISO 8601 - format). - example: '2025-12-31T00:00:00Z' + description: When this updated layer should stop being active (ISO 8601 format). + example: "2025-12-31T00:00:00Z" format: date-time type: string id: description: A unique identifier for the layer being updated. - example: 00000000-0000-0000-0000-000000000001 + example: "00000000-0000-0000-0000-000000000001" type: string interval: - $ref: '#/components/schemas/LayerAttributesInterval' + $ref: "#/components/schemas/LayerAttributesInterval" members: description: The members assigned to this layer. items: - $ref: '#/components/schemas/ScheduleRequestDataAttributesLayersItemsMembersItems' + $ref: "#/components/schemas/ScheduleRequestDataAttributesLayersItemsMembersItems" type: array name: description: The name for this layer (for example, "Secondary Coverage"). - example: Primary On-Call Layer + example: "Primary On-Call Layer" type: string restrictions: description: Any time restrictions that define when this layer is active. items: - $ref: '#/components/schemas/TimeRestriction' + $ref: "#/components/schemas/TimeRestriction" type: array rotation_start: description: The date/time at which the rotation begins (ISO 8601 format). - example: '2025-02-01T00:00:00Z' + example: "2025-02-01T00:00:00Z" format: date-time type: string time_zone: description: The time zone for this layer. - example: America/New_York + example: "America/New_York" type: string required: - - effective_date - - interval - - members - - name - - rotation_start + - effective_date + - interval + - members + - name + - rotation_start type: object ScheduleUpdateRequestDataRelationships: - description: Houses relationships for the schedule update, typically referencing - teams. + description: |- + Houses relationships for the schedule update, typically referencing teams. properties: teams: - $ref: '#/components/schemas/DataRelationshipsTeams' + $ref: "#/components/schemas/DataRelationshipsTeams" type: object ScheduleUpdateRequestDataType: default: schedules - description: Schedules resource type. + description: |- + Schedules resource type. enum: - - schedules + - schedules example: schedules type: string x-enum-varnames: - - SCHEDULES + - SCHEDULES ScheduleUser: - description: Represents a user object in the context of a schedule, including - their `id`, type, and basic attributes. + description: Represents a user object in the context of a schedule, including their `id`, type, and basic attributes. properties: attributes: - $ref: '#/components/schemas/ScheduleUserAttributes' + $ref: "#/components/schemas/ScheduleUserAttributes" id: description: The unique user identifier. type: string type: - $ref: '#/components/schemas/ScheduleUserType' + $ref: "#/components/schemas/ScheduleUserType" required: - - type + - type type: object ScheduleUserAttributes: - description: Provides basic user information for a schedule, including a name - and email address. + description: Provides basic user information for a schedule, including a name and email address. properties: email: description: The user's email address. - example: jane.doe@example.com + example: "jane.doe@example.com" type: string name: description: The user's name. - example: Jane Doe + example: "Jane Doe" type: string status: - $ref: '#/components/schemas/UserAttributesStatus' + $ref: "#/components/schemas/UserAttributesStatus" type: object ScheduleUserType: default: users - description: Users resource type. + description: |- + Users resource type. enum: - - users + - users example: users type: string x-enum-varnames: - - USERS + - USERS ScorecardType: default: scorecard description: The JSON:API type for scorecard. enum: - - scorecard + - scorecard example: scorecard type: string x-enum-varnames: - - SCORECARD + - SCORECARD SearchIssuesIncludeQueryParameterItem: description: Relationship object that should be included in the search response. enum: - - issue - - issue.assignee - - issue.case - - issue.team_owners - example: issue.case + - issue + - issue.assignee + - issue.case + - issue.team_owners + example: "issue.case" type: string x-enum-varnames: - - ISSUE - - ISSUE_ASSIGNEE - - ISSUE_CASE - - ISSUE_TEAM_OWNERS + - ISSUE + - ISSUE_ASSIGNEE + - ISSUE_CASE + - ISSUE_TEAM_OWNERS SeatAssignmentsDataType: default: seat-assignments description: Seat assignments resource type. enum: - - seat-assignments + - seat-assignments example: seat-assignments type: string x-enum-varnames: - - SEAT_ASSIGNMENTS + - SEAT_ASSIGNMENTS SeatUserData: properties: attributes: - $ref: '#/components/schemas/SeatUserDataAttributes' + $ref: "#/components/schemas/SeatUserDataAttributes" description: The attributes of the seat user. id: description: The ID of the seat user. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" nullable: true type: string type: - $ref: '#/components/schemas/SeatUserDataType' + $ref: "#/components/schemas/SeatUserDataType" type: object SeatUserDataArray: properties: data: description: The list of seat users. items: - $ref: '#/components/schemas/SeatUserData' + $ref: "#/components/schemas/SeatUserData" type: array meta: - $ref: '#/components/schemas/SeatUserMeta' + $ref: "#/components/schemas/SeatUserMeta" description: The metadata of the seat users. type: object SeatUserDataAttributes: properties: assigned_at: description: The date and time the seat was assigned. - example: '2021-01-01T00:00:00Z' + example: "2021-01-01T00:00:00Z" format: date-time nullable: true type: string email: description: The email of the user. - example: user@example.com + example: "user@example.com" nullable: true type: string name: description: The name of the user. - example: John Doe + example: "John Doe" nullable: true type: string type: object @@ -57090,11 +54291,11 @@ components: default: seat-users description: Seat users resource type. enum: - - seat-users + - seat-users example: seat-users type: string x-enum-varnames: - - SEAT_USERS + - SEAT_USERS SeatUserMeta: properties: cursor: @@ -57112,21 +54313,21 @@ components: properties: data: items: - $ref: '#/components/schemas/SecretRuleData' + $ref: "#/components/schemas/SecretRuleData" type: array required: - - data + - data type: object SecretRuleData: properties: attributes: - $ref: '#/components/schemas/SecretRuleDataAttributes' + $ref: "#/components/schemas/SecretRuleDataAttributes" id: type: string type: - $ref: '#/components/schemas/SecretRuleDataType' + $ref: "#/components/schemas/SecretRuleDataType" required: - - type + - type type: object SecretRuleDataAttributes: properties: @@ -57139,7 +54340,7 @@ components: license: type: string match_validation: - $ref: '#/components/schemas/SecretRuleDataAttributesMatchValidation' + $ref: "#/components/schemas/SecretRuleDataAttributesMatchValidation" name: type: string pattern: @@ -57165,7 +54366,7 @@ components: type: string invalid_http_status_code: items: - $ref: '#/components/schemas/SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems' + $ref: "#/components/schemas/SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems" type: array request_headers: additionalProperties: @@ -57173,26 +54374,26 @@ components: type: object timeout_seconds: format: int64 - maximum: 1.8446744073709552e+19 + maximum: 1.8446744073709551e+19 minimum: 0 type: integer type: type: string valid_http_status_code: items: - $ref: '#/components/schemas/SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems' + $ref: "#/components/schemas/SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems" type: array type: object SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems: properties: end: format: int64 - maximum: 1.8446744073709552e+19 + maximum: 1.8446744073709551e+19 minimum: 0 type: integer start: format: int64 - maximum: 1.8446744073709552e+19 + maximum: 1.8446744073709551e+19 minimum: 0 type: integer type: object @@ -57200,12 +54401,12 @@ components: properties: end: format: int64 - maximum: 1.8446744073709552e+19 + maximum: 1.8446744073709551e+19 minimum: 0 type: integer start: format: int64 - maximum: 1.8446744073709552e+19 + maximum: 1.8446744073709551e+19 minimum: 0 type: integer type: object @@ -57213,11 +54414,11 @@ components: default: secret_rule description: Secret rule resource type. enum: - - secret_rule + - secret_rule example: secret_rule type: string x-enum-varnames: - - SECRET_RULE + - SECRET_RULE SecurityEntityConfigRisks: description: Configuration risks associated with the entity properties: @@ -57246,124 +54447,111 @@ components: example: true type: boolean required: - - hasMisconfiguration - - hasIdentityRisk - - isPubliclyAccessible - - isProduction - - hasPrivilegedRole - - isPrivileged + - hasMisconfiguration + - hasIdentityRisk + - isPubliclyAccessible + - isProduction + - hasPrivilegedRole + - isPrivileged type: object SecurityEntityMetadata: description: Metadata about the entity from cloud providers properties: accountID: description: Cloud account ID (AWS) - example: '123456789012' + example: "123456789012" type: string environments: description: Environment tags associated with the entity - example: - - production - - us-east-1 + example: ["production", "us-east-1"] items: type: string type: array mitreTactics: description: MITRE ATT&CK tactics detected - example: - - Credential Access - - Privilege Escalation + example: ["Credential Access", "Privilege Escalation"] items: type: string type: array mitreTechniques: description: MITRE ATT&CK techniques detected - example: - - T1078 - - T1098 + example: ["T1078", "T1098"] items: type: string type: array projectID: description: Cloud project ID (GCP) - example: my-gcp-project + example: "my-gcp-project" type: string services: description: Services associated with the entity - example: - - api-gateway - - lambda + example: ["api-gateway", "lambda"] items: type: string type: array sources: description: Data sources that detected this entity - example: - - cloudtrail - - cloud-security-posture-management + example: ["cloudtrail", "cloud-security-posture-management"] items: type: string type: array subscriptionID: description: Cloud subscription ID (Azure) - example: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890" type: string required: - - sources - - environments - - services - - mitreTactics - - mitreTechniques + - sources + - environments + - services + - mitreTactics + - mitreTechniques type: object SecurityEntityRiskScore: description: An entity risk score containing security risk assessment information properties: attributes: - $ref: '#/components/schemas/SecurityEntityRiskScoreAttributes' + $ref: "#/components/schemas/SecurityEntityRiskScoreAttributes" id: description: Unique identifier for the entity - example: arn:aws:iam::123456789012:user/john.doe + example: "arn:aws:iam::123456789012:user/john.doe" type: string type: - $ref: '#/components/schemas/SecurityEntityRiskScoreType' + $ref: "#/components/schemas/SecurityEntityRiskScoreType" required: - - id - - type - - attributes + - id + - type + - attributes type: object SecurityEntityRiskScoreAttributes: description: Attributes of an entity risk score properties: configRisks: - $ref: '#/components/schemas/SecurityEntityConfigRisks' + $ref: "#/components/schemas/SecurityEntityConfigRisks" entityID: description: Unique identifier for the entity - example: arn:aws:iam::123456789012:user/john.doe + example: "arn:aws:iam::123456789012:user/john.doe" type: string entityMetadata: - $ref: '#/components/schemas/SecurityEntityMetadata' + $ref: "#/components/schemas/SecurityEntityMetadata" entityName: description: Human-readable name of the entity - example: john.doe + example: "john.doe" type: string entityProviders: description: Cloud providers associated with the entity - example: - - aws + example: ["aws"] items: type: string type: array entityRoles: description: Roles associated with the entity - example: - - Admin - - Developer + example: ["Admin", "Developer"] items: type: string type: array entityType: description: Type of the entity (e.g., aws_iam_user, aws_ec2_instance) - example: aws_iam_user + example: "aws_iam_user" type: string firstDetected: description: Timestamp when the entity was first detected (Unix milliseconds) @@ -57372,7 +54560,7 @@ components: type: integer lastActivityTitle: description: Title of the most recent signal detected for this entity - example: Suspicious API call detected + example: "Suspicious API call detected" type: string lastDetected: description: Timestamp when the entity was last detected (Unix milliseconds) @@ -57390,50 +54578,50 @@ components: format: double type: number severity: - $ref: '#/components/schemas/SecurityEntityRiskScoreAttributesSeverity' + $ref: "#/components/schemas/SecurityEntityRiskScoreAttributesSeverity" signalsDetected: description: Number of security signals detected for this entity example: 15 format: int64 type: integer required: - - entityID - - entityType - - entityProviders - - riskScore - - riskScoreEvolution - - severity - - firstDetected - - lastDetected - - lastActivityTitle - - signalsDetected - - configRisks - - entityMetadata + - entityID + - entityType + - entityProviders + - riskScore + - riskScoreEvolution + - severity + - firstDetected + - lastDetected + - lastActivityTitle + - signalsDetected + - configRisks + - entityMetadata type: object SecurityEntityRiskScoreAttributesSeverity: description: Severity level based on risk score enum: - - critical - - high - - medium - - low - - info - example: critical + - critical + - high + - medium + - low + - info + example: "critical" type: string x-enum-varnames: - - CRITICAL - - HIGH - - MEDIUM - - LOW - - INFO + - CRITICAL + - HIGH + - MEDIUM + - LOW + - INFO SecurityEntityRiskScoreType: description: Resource type enum: - - security_entity_risk_score + - security_entity_risk_score example: security_entity_risk_score type: string x-enum-varnames: - - SECURITY_ENTITY_RISK_SCORE + - SECURITY_ENTITY_RISK_SCORE SecurityEntityRiskScoresMeta: description: Metadata for pagination properties: @@ -57449,7 +54637,7 @@ components: type: integer queryId: description: Query ID for pagination consistency - example: abc123def456 + example: "abc123def456" type: string totalRowCount: description: Total number of entities matching the query @@ -57457,33 +54645,33 @@ components: format: int64 type: integer required: - - queryId - - totalRowCount - - pageSize - - pageNumber + - queryId + - totalRowCount + - pageSize + - pageNumber type: object SecurityEntityRiskScoresResponse: description: Response containing a list of entity risk scores properties: data: items: - $ref: '#/components/schemas/SecurityEntityRiskScore' + $ref: "#/components/schemas/SecurityEntityRiskScore" type: array meta: - $ref: '#/components/schemas/SecurityEntityRiskScoresMeta' + $ref: "#/components/schemas/SecurityEntityRiskScoresMeta" required: - - data - - meta + - data + - meta type: object SecurityFilter: description: The security filter's properties. properties: attributes: - $ref: '#/components/schemas/SecurityFilterAttributes' + $ref: "#/components/schemas/SecurityFilterAttributes" id: - $ref: '#/components/schemas/SecurityFilterID' + $ref: "#/components/schemas/SecurityFilterID" type: - $ref: '#/components/schemas/SecurityFilterType' + $ref: "#/components/schemas/SecurityFilterType" type: object SecurityFilterAttributes: description: The object describing a security filter. @@ -57491,10 +54679,10 @@ components: exclusion_filters: description: The list of exclusion filters applied in this security filter. items: - $ref: '#/components/schemas/SecurityFilterExclusionFilterResponse' + $ref: "#/components/schemas/SecurityFilterExclusionFilterResponse" type: array filtered_data_type: - $ref: '#/components/schemas/SecurityFilterFilteredDataType' + $ref: "#/components/schemas/SecurityFilterFilteredDataType" is_builtin: description: Whether the security filter is the built-in filter. example: false @@ -57508,8 +54696,7 @@ components: example: Custom security filter type: string query: - description: The security filter query. Logs accepted by this query will - be accepted by this filter. + description: The security filter query. Logs accepted by this query will be accepted by this filter. example: service:api type: string version: @@ -57525,13 +54712,13 @@ components: exclusion_filters: description: Exclusion filters to exclude some logs from the security filter. example: - - name: Exclude staging - query: source:staging + - name: Exclude staging + query: source:staging items: - $ref: '#/components/schemas/SecurityFilterExclusionFilter' + $ref: "#/components/schemas/SecurityFilterExclusionFilter" type: array filtered_data_type: - $ref: '#/components/schemas/SecurityFilterFilteredDataType' + $ref: "#/components/schemas/SecurityFilterFilteredDataType" is_enabled: description: Whether the security filter is enabled. example: true @@ -57545,31 +54732,30 @@ components: example: service:api type: string required: - - name - - query - - exclusion_filters - - filtered_data_type - - is_enabled + - name + - query + - exclusion_filters + - filtered_data_type + - is_enabled type: object SecurityFilterCreateData: description: Object for a single security filter. properties: attributes: - $ref: '#/components/schemas/SecurityFilterCreateAttributes' + $ref: "#/components/schemas/SecurityFilterCreateAttributes" type: - $ref: '#/components/schemas/SecurityFilterType' + $ref: "#/components/schemas/SecurityFilterType" required: - - type - - attributes + - type + - attributes type: object SecurityFilterCreateRequest: - description: Request object that includes the security filter that you would - like to create. + description: Request object that includes the security filter that you would like to create. properties: data: - $ref: '#/components/schemas/SecurityFilterCreateData' + $ref: "#/components/schemas/SecurityFilterCreateData" required: - - data + - data type: object SecurityFilterExclusionFilter: description: Exclusion filter for the security filter. @@ -57582,13 +54768,12 @@ components: example: Exclude staging type: string query: - description: Exclusion filter query. Logs that match this query are excluded - from the security filter. + description: Exclusion filter query. Logs that match this query are excluded from the security filter. example: source:staging type: string required: - - name - - query + - name + - query type: object SecurityFilterExclusionFilterResponse: description: A single exclusion filter. @@ -57605,11 +54790,11 @@ components: SecurityFilterFilteredDataType: description: The filtered data type. enum: - - logs + - logs example: logs type: string x-enum-varnames: - - LOGS + - LOGS SecurityFilterID: description: The ID of the security filter. example: 3dd-0uc-h1s @@ -57619,27 +54804,26 @@ components: properties: warning: description: A warning message. - example: All the security filters are disabled. As a result, no logs are - being analyzed. + example: All the security filters are disabled. As a result, no logs are being analyzed. type: string type: object SecurityFilterResponse: description: Response object which includes a single security filter. properties: data: - $ref: '#/components/schemas/SecurityFilter' + $ref: "#/components/schemas/SecurityFilter" meta: - $ref: '#/components/schemas/SecurityFilterMeta' + $ref: "#/components/schemas/SecurityFilterMeta" type: object SecurityFilterType: default: security_filters description: The type of the resource. The value should always be `security_filters`. enum: - - security_filters + - security_filters example: security_filters type: string x-enum-varnames: - - SECURITY_FILTERS + - SECURITY_FILTERS SecurityFilterUpdateAttributes: description: The security filters properties to be updated. properties: @@ -57647,10 +54831,10 @@ components: description: Exclusion filters to exclude some logs from the security filter. example: [] items: - $ref: '#/components/schemas/SecurityFilterExclusionFilter' + $ref: "#/components/schemas/SecurityFilterExclusionFilter" type: array filtered_data_type: - $ref: '#/components/schemas/SecurityFilterFilteredDataType' + $ref: "#/components/schemas/SecurityFilterFilteredDataType" is_enabled: description: Whether the security filter is enabled. example: true @@ -57674,20 +54858,20 @@ components: description: The new security filter properties. properties: attributes: - $ref: '#/components/schemas/SecurityFilterUpdateAttributes' + $ref: "#/components/schemas/SecurityFilterUpdateAttributes" type: - $ref: '#/components/schemas/SecurityFilterType' + $ref: "#/components/schemas/SecurityFilterType" required: - - type - - attributes + - type + - attributes type: object SecurityFilterUpdateRequest: description: The new security filter body. properties: data: - $ref: '#/components/schemas/SecurityFilterUpdateData' + $ref: "#/components/schemas/SecurityFilterUpdateData" required: - - data + - data type: object SecurityFiltersResponse: description: All the available security filters objects. @@ -57695,10 +54879,10 @@ components: data: description: A list of security filters objects. items: - $ref: '#/components/schemas/SecurityFilter' + $ref: "#/components/schemas/SecurityFilter" type: array meta: - $ref: '#/components/schemas/SecurityFilterMeta' + $ref: "#/components/schemas/SecurityFilterMeta" type: object SecurityFindingsAttributes: description: The JSON object containing all attributes of the security finding. @@ -57706,21 +54890,18 @@ components: attributes: additionalProperties: {} description: The custom attributes of the security finding. - example: - severity: high - status: open + example: {"severity": "high", "status": "open"} type: object tags: description: List of tags associated with the security finding. example: - - team:platform - - env:prod + - "team:platform" + - "env:prod" items: type: string type: array timestamp: - description: The Unix timestamp at which the detection changed for the resource. - Same value as @detection_changed_at. + description: The Unix timestamp at which the detection changed for the resource. Same value as @detection_changed_at. example: 1765901760 format: int64 type: integer @@ -57729,30 +54910,29 @@ components: description: A single security finding. properties: attributes: - $ref: '#/components/schemas/SecurityFindingsAttributes' + $ref: "#/components/schemas/SecurityFindingsAttributes" id: description: The unique ID of the security finding. - example: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw== + example: "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==" type: string type: - $ref: '#/components/schemas/SecurityFindingsDataType' + $ref: "#/components/schemas/SecurityFindingsDataType" type: object SecurityFindingsDataType: default: finding description: The type of the security finding resource. enum: - - finding + - finding example: finding type: string x-enum-varnames: - - FINDING + - FINDING SecurityFindingsLinks: description: Links for pagination. properties: next: - description: Link for the next page of results. Note that paginated requests - can also be made using the POST endpoint. - example: https://app.datadoghq.com/api/v2/security/findings?page[cursor]=eyJhZnRlciI6IkF3QUFBWnPcm1pd0FBQUJbVlBQUKBa1pqRTVdZUzSTBNemN0YWiIsLTE3Mjk0MzYwMjFdfQ==&page[limit]=25 + description: Link for the next page of results. Note that paginated requests can also be made using the POST endpoint. + example: "https://app.datadoghq.com/api/v2/security/findings?page[cursor]=eyJhZnRlciI6IkF3QUFBWnPcm1pd0FBQUJbVlBQUKBa1pqRTVdZUzSTBNemN0YWiIsLTE3Mjk0MzYwMjFdfQ==&page[limit]=25" type: string type: object SecurityFindingsMeta: @@ -57764,54 +54944,53 @@ components: format: int64 type: integer page: - $ref: '#/components/schemas/SecurityFindingsPage' + $ref: "#/components/schemas/SecurityFindingsPage" request_id: description: The identifier of the request. - example: pddv1ChZwVlMxMUdYRFRMQ1lyb3B4MGNYbFlnIi0KHQu35LDbucx + example: "pddv1ChZwVlMxMUdYRFRMQ1lyb3B4MGNYbFlnIi0KHQu35LDbucx" type: string status: - $ref: '#/components/schemas/SecurityFindingsStatus' + $ref: "#/components/schemas/SecurityFindingsStatus" type: object SecurityFindingsPage: description: Pagination information. properties: after: description: The cursor used to get the next page of results. - example: eyJhZnRlciI6IkFRQUFBWWJiaEJXQS1OY1dqUUFBQUFCQldXSmlhRUpYUVVGQlJFSktkbTlDTUdaWFRVbDNRVUUiLCJ2YWx1ZXMiOlsiY3JpdGljYWwiXX0= + example: "eyJhZnRlciI6IkFRQUFBWWJiaEJXQS1OY1dqUUFBQUFCQldXSmlhRUpYUVVGQlJFSktkbTlDTUdaWFRVbDNRVUUiLCJ2YWx1ZXMiOlsiY3JpdGljYWwiXX0=" type: string type: object SecurityFindingsSearchRequest: description: The request body for searching security findings. properties: data: - $ref: '#/components/schemas/SecurityFindingsSearchRequestData' + $ref: "#/components/schemas/SecurityFindingsSearchRequestData" type: object SecurityFindingsSearchRequestData: description: Request data for searching security findings. properties: attributes: - $ref: '#/components/schemas/SecurityFindingsSearchRequestDataAttributes' + $ref: "#/components/schemas/SecurityFindingsSearchRequestDataAttributes" type: object SecurityFindingsSearchRequestDataAttributes: description: Request attributes for searching security findings. properties: filter: - default: '*' + default: "*" description: The search query following log search syntax. - example: '@severity:(critical OR high) @status:open team:platform' + example: "@severity:(critical OR high) @status:open team:platform" type: string page: - $ref: '#/components/schemas/SecurityFindingsSearchRequestPage' + $ref: "#/components/schemas/SecurityFindingsSearchRequestPage" sort: - $ref: '#/components/schemas/SecurityFindingsSort' + $ref: "#/components/schemas/SecurityFindingsSort" type: object SecurityFindingsSearchRequestPage: description: Pagination attributes for the search request. properties: cursor: - description: Get the next page of results with a cursor provided in the - previous query. - example: eyJhZnRlciI6IkF3QUFBWnPcm1pd0FBQUJbVlBQUKBa1pqRTVdZUzSTBNemN0YWiIsLTE3Mjk0MzYwMjFdfQ== + description: Get the next page of results with a cursor provided in the previous query. + example: "eyJhZnRlciI6IkF3QUFBWnPcm1pd0FBQUJbVlBQUKBa1pqRTVdZUzSTBNemN0YWiIsLTE3Mjk0MzYwMjFdfQ==" type: string limit: default: 10 @@ -57823,181 +55002,178 @@ components: type: integer type: object SecurityFindingsSort: - default: -@detection_changed_at + default: "-@detection_changed_at" description: The sort parameters when querying security findings. enum: - - '@detection_changed_at' - - -@detection_changed_at + - "@detection_changed_at" + - "-@detection_changed_at" type: string x-enum-varnames: - - DETECTION_CHANGED_AT_ASC - - DETECTION_CHANGED_AT_DESC + - DETECTION_CHANGED_AT_ASC + - DETECTION_CHANGED_AT_DESC SecurityFindingsStatus: description: The status of the response. enum: - - done - - timeout + - done + - timeout example: done type: string x-enum-varnames: - - DONE - - TIMEOUT + - DONE + - TIMEOUT SecurityMonitoringContentPackActivation: description: The activation status of a content pack enum: - - never_activated - - activated - - deactivated + - never_activated + - activated + - deactivated example: activated type: string x-enum-varnames: - - NEVER_ACTIVATED - - ACTIVATED - - DEACTIVATED + - NEVER_ACTIVATED + - ACTIVATED + - DEACTIVATED SecurityMonitoringContentPackIntegrationStatus: description: The installation status of the related integration enum: - - installed - - available - - partially_installed - - detected - - error + - installed + - available + - partially_installed + - detected + - error example: installed type: string x-enum-varnames: - - INSTALLED - - AVAILABLE - - PARTIALLY_INSTALLED - - DETECTED - - ERROR + - INSTALLED + - AVAILABLE + - PARTIALLY_INSTALLED + - DETECTED + - ERROR SecurityMonitoringContentPackStateAttributes: description: Attributes of a content pack state properties: cloud_siem_index_incorrect: - description: Whether the cloud SIEM index configuration is incorrect (only - applies to certain pricing models) + description: Whether the cloud SIEM index configuration is incorrect (only applies to certain pricing models) example: false type: boolean cp_activation: - $ref: '#/components/schemas/SecurityMonitoringContentPackActivation' + $ref: "#/components/schemas/SecurityMonitoringContentPackActivation" filters_configured_for_logs: - description: Whether filters (Security Filters or Index Query depending - on the pricing model) are configured for logs + description: Whether filters (Security Filters or Index Query depending on the pricing model) are configured for logs example: true type: boolean integration_installed_status: - $ref: '#/components/schemas/SecurityMonitoringContentPackIntegrationStatus' + $ref: "#/components/schemas/SecurityMonitoringContentPackIntegrationStatus" logs_last_collected: - $ref: '#/components/schemas/SecurityMonitoringContentPackTimestampBucket' + $ref: "#/components/schemas/SecurityMonitoringContentPackTimestampBucket" logs_seen_from_any_index: description: Whether logs have been seen from any index example: true type: boolean state: - $ref: '#/components/schemas/SecurityMonitoringContentPackStatus' + $ref: "#/components/schemas/SecurityMonitoringContentPackStatus" required: - - state - - cp_activation - - logs_seen_from_any_index - - logs_last_collected - - cloud_siem_index_incorrect - - filters_configured_for_logs + - state + - cp_activation + - logs_seen_from_any_index + - logs_last_collected + - cloud_siem_index_incorrect + - filters_configured_for_logs type: object SecurityMonitoringContentPackStateData: description: Content pack state data. properties: attributes: - $ref: '#/components/schemas/SecurityMonitoringContentPackStateAttributes' + $ref: "#/components/schemas/SecurityMonitoringContentPackStateAttributes" id: description: The content pack identifier. example: aws-cloudtrail type: string type: - $ref: '#/components/schemas/SecurityMonitoringContentPackStateType' + $ref: "#/components/schemas/SecurityMonitoringContentPackStateType" required: - - id - - type - - attributes + - id + - type + - attributes type: object SecurityMonitoringContentPackStateMeta: description: Metadata for content pack states properties: cloud_siem_index_incorrect: - description: Whether the cloud SIEM index configuration is incorrect at - the organization level + description: Whether the cloud SIEM index configuration is incorrect at the organization level example: false type: boolean sku: - $ref: '#/components/schemas/SecurityMonitoringSKU' + $ref: "#/components/schemas/SecurityMonitoringSKU" required: - - cloud_siem_index_incorrect - - sku + - cloud_siem_index_incorrect + - sku type: object SecurityMonitoringContentPackStateType: description: Type for content pack state object enum: - - content_pack_state + - content_pack_state example: content_pack_state type: string x-enum-varnames: - - CONTENT_PACK_STATE + - CONTENT_PACK_STATE SecurityMonitoringContentPackStatesResponse: description: Response containing content pack states. properties: data: description: Array of content pack states. items: - $ref: '#/components/schemas/SecurityMonitoringContentPackStateData' + $ref: "#/components/schemas/SecurityMonitoringContentPackStateData" type: array meta: - $ref: '#/components/schemas/SecurityMonitoringContentPackStateMeta' + $ref: "#/components/schemas/SecurityMonitoringContentPackStateMeta" required: - - data - - meta + - data + - meta type: object SecurityMonitoringContentPackStatus: description: The current status of a content pack enum: - - install - - activate - - initializing - - active - - warning - - broken + - install + - activate + - initializing + - active + - warning + - broken example: active type: string x-enum-varnames: - - INSTALL - - ACTIVATE - - INITIALIZING - - ACTIVE - - WARNING - - BROKEN + - INSTALL + - ACTIVATE + - INITIALIZING + - ACTIVE + - WARNING + - BROKEN SecurityMonitoringContentPackTimestampBucket: description: Timestamp bucket indicating when logs were last collected enum: - - not_seen - - within_24_hours - - within_24_to_72_hours - - over_72h_to_30d - - over_30d + - not_seen + - within_24_hours + - within_24_to_72_hours + - over_72h_to_30d + - over_30d example: within_24_hours type: string x-enum-varnames: - - NOT_SEEN - - WITHIN_24_HOURS - - WITHIN_24_TO_72_HOURS - - OVER_72H_TO_30D - - OVER_30D + - NOT_SEEN + - WITHIN_24_HOURS + - WITHIN_24_TO_72_HOURS + - OVER_72H_TO_30D + - OVER_30D SecurityMonitoringCriticalAsset: description: The critical asset's properties. properties: attributes: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetAttributes' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetAttributes" id: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetID' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetID" type: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetType' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetType" type: object SecurityMonitoringCriticalAssetAttributes: description: The attributes of the critical asset. @@ -58008,34 +55184,30 @@ components: format: int64 type: integer creation_date: - description: A Unix millisecond timestamp given the creation date of the - critical asset. + description: A Unix millisecond timestamp given the creation date of the critical asset. format: int64 type: integer creator: - $ref: '#/components/schemas/SecurityMonitoringUser' + $ref: "#/components/schemas/SecurityMonitoringUser" enabled: description: Whether the critical asset is enabled. example: true type: boolean query: - description: The query for the critical asset. It uses the same syntax as - the queries to search signals in the Signals Explorer. + description: The query for the critical asset. It uses the same syntax as the queries to search signals in the Signals Explorer. example: security:monitoring type: string rule_query: - description: The rule query of the critical asset, with the same syntax - as the search bar for detection rules. This determines which rules this - critical asset will apply to. + description: The rule query of the critical asset, with the same syntax as the search bar for detection rules. This determines which rules this critical asset will apply to. example: type:log_detection source:cloudtrail type: string severity: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetSeverity' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetSeverity" tags: description: List of tags associated with the critical asset. example: - - team:database - - source:cloudtrail + - team:database + - source:cloudtrail items: type: string type: array @@ -58045,15 +55217,13 @@ components: format: int64 type: integer update_date: - description: A Unix millisecond timestamp given the update date of the critical - asset. + description: A Unix millisecond timestamp given the update date of the critical asset. format: int64 type: integer updater: - $ref: '#/components/schemas/SecurityMonitoringUser' + $ref: "#/components/schemas/SecurityMonitoringUser" version: - description: The version of the critical asset; it starts at 1, and is incremented - at each update. + description: The version of the critical asset; it starts at 1, and is incremented at each update. example: 2 format: int32 maximum: 2147483647 @@ -58064,56 +55234,50 @@ components: properties: enabled: default: true - description: Whether the critical asset is enabled. Defaults to `true` if - not specified. + description: Whether the critical asset is enabled. Defaults to `true` if not specified. example: true type: boolean query: - description: The query for the critical asset. It uses the same syntax as - the queries to search signals in the Signals Explorer. + description: The query for the critical asset. It uses the same syntax as the queries to search signals in the Signals Explorer. example: security:monitoring type: string rule_query: - description: The rule query of the critical asset, with the same syntax - as the search bar for detection rules. This determines which rules this - critical asset will apply to. - example: type:(log_detection OR signal_correlation OR workload_security - OR application_security) source:cloudtrail + description: The rule query of the critical asset, with the same syntax as the search bar for detection rules. This determines which rules this critical asset will apply to. + example: type:(log_detection OR signal_correlation OR workload_security OR application_security) source:cloudtrail type: string severity: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetSeverity' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetSeverity" tags: description: List of tags associated with the critical asset. example: - - team:database - - source:cloudtrail + - team:database + - source:cloudtrail items: type: string type: array required: - - query - - severity - - rule_query + - query + - severity + - rule_query type: object SecurityMonitoringCriticalAssetCreateData: description: Object for a single critical asset. properties: attributes: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetCreateAttributes' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetCreateAttributes" type: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetType' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetType" required: - - type - - attributes + - type + - attributes type: object SecurityMonitoringCriticalAssetCreateRequest: - description: Request object that includes the critical asset that you would - like to create. + description: Request object that includes the critical asset that you would like to create. properties: data: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetCreateData' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetCreateData" required: - - data + - data type: object SecurityMonitoringCriticalAssetID: description: The ID of the critical asset. @@ -58123,38 +55287,37 @@ components: description: Response object containing a single critical asset. properties: data: - $ref: '#/components/schemas/SecurityMonitoringCriticalAsset' + $ref: "#/components/schemas/SecurityMonitoringCriticalAsset" type: object SecurityMonitoringCriticalAssetSeverity: - description: Severity associated with this critical asset. Either an explicit - severity can be set, or the severity can be increased or decreased. - enum: - - info - - low - - medium - - high - - critical - - increase - - decrease + description: Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased. + enum: + - info + - low + - medium + - high + - critical + - increase + - decrease example: increase type: string x-enum-varnames: - - INFO - - LOW - - MEDIUM - - HIGH - - CRITICAL - - INCREASE - - DECREASE + - INFO + - LOW + - MEDIUM + - HIGH + - CRITICAL + - INCREASE + - DECREASE SecurityMonitoringCriticalAssetType: default: critical_assets description: The type of the resource. The value should always be `critical_assets`. enum: - - critical_assets + - critical_assets example: critical_assets type: string x-enum-varnames: - - CRITICAL_ASSETS + - CRITICAL_ASSETS SecurityMonitoringCriticalAssetUpdateAttributes: description: The critical asset properties to be updated. properties: @@ -58163,29 +55326,25 @@ components: example: true type: boolean query: - description: The query for the critical asset. It uses the same syntax as - the queries to search signals in the Signals Explorer. + description: The query for the critical asset. It uses the same syntax as the queries to search signals in the Signals Explorer. example: security:monitoring type: string rule_query: - description: The rule query of the critical asset, with the same syntax - as the search bar for detection rules. This determines which rules this - critical asset will apply to. + description: The rule query of the critical asset, with the same syntax as the search bar for detection rules. This determines which rules this critical asset will apply to. example: type:log_detection source:cloudtrail type: string severity: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetSeverity' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetSeverity" tags: description: List of tags associated with the critical asset. example: - - technique:T1110-brute-force - - source:cloudtrail + - technique:T1110-brute-force + - source:cloudtrail items: type: string type: array version: - description: The version of the critical asset being updated. Used for optimistic - locking to prevent concurrent modifications. + description: The version of the critical asset being updated. Used for optimistic locking to prevent concurrent modifications. example: 1 format: int32 maximum: 2147483647 @@ -58195,21 +55354,20 @@ components: description: The new critical asset properties; partial updates are supported. properties: attributes: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetUpdateAttributes' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetUpdateAttributes" type: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetType' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetType" required: - - type - - attributes + - type + - attributes type: object SecurityMonitoringCriticalAssetUpdateRequest: - description: Request object containing the fields to update on the critical - asset. + description: Request object containing the fields to update on the critical asset. properties: data: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetUpdateData' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetUpdateData" required: - - data + - data type: object SecurityMonitoringCriticalAssetsResponse: description: Response object containing the available critical assets. @@ -58217,14 +55375,14 @@ components: data: description: A list of critical assets objects. items: - $ref: '#/components/schemas/SecurityMonitoringCriticalAsset' + $ref: "#/components/schemas/SecurityMonitoringCriticalAsset" type: array type: object SecurityMonitoringFilter: description: The rule's suppression filter. properties: action: - $ref: '#/components/schemas/SecurityMonitoringFilterAction' + $ref: "#/components/schemas/SecurityMonitoringFilterAction" query: description: Query for selecting logs to apply the filtering action. type: string @@ -58232,34 +55390,33 @@ components: SecurityMonitoringFilterAction: description: The type of filtering action. enum: - - require - - suppress + - require + - suppress type: string x-enum-varnames: - - REQUIRE - - SUPPRESS + - REQUIRE + - SUPPRESS SecurityMonitoringListRulesResponse: description: List of rules. properties: data: description: Array containing the list of rules. items: - $ref: '#/components/schemas/SecurityMonitoringRuleResponse' + $ref: "#/components/schemas/SecurityMonitoringRuleResponse" type: array meta: - $ref: '#/components/schemas/ResponseMetaAttributes' + $ref: "#/components/schemas/ResponseMetaAttributes" type: object SecurityMonitoringPaginatedSuppressionsResponse: - description: Response object containing the available suppression rules with - pagination metadata. + description: Response object containing the available suppression rules with pagination metadata. properties: data: description: A list of suppressions objects. items: - $ref: '#/components/schemas/SecurityMonitoringSuppression' + $ref: "#/components/schemas/SecurityMonitoringSuppression" type: array meta: - $ref: '#/components/schemas/SecurityMonitoringSuppressionsMeta' + $ref: "#/components/schemas/SecurityMonitoringSuppressionsMeta" type: object SecurityMonitoringReferenceTable: description: Reference tables used in the queries. @@ -58285,131 +55442,120 @@ components: description: Options on anomaly detection method. properties: bucketDuration: - $ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsBucketDuration' + $ref: "#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsBucketDuration" detectionTolerance: - $ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsDetectionTolerance' + $ref: "#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsDetectionTolerance" instantaneousBaseline: - $ref: '#/components/schemas/SecurityMonitoringRuleInstantaneousBaseline' + $ref: "#/components/schemas/SecurityMonitoringRuleInstantaneousBaseline" learningDuration: - $ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsLearningDuration' + $ref: "#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsLearningDuration" learningPeriodBaseline: - description: An optional override baseline to apply while the rule is in - the learning period. Must be greater than or equal to 0. + description: An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0. format: int64 minimum: 0 type: integer type: object SecurityMonitoringRuleAnomalyDetectionOptionsBucketDuration: - description: 'Duration in seconds of the time buckets used to aggregate events - matched by the rule. - - Must be greater than or equal to 300.' - enum: - - 300 - - 600 - - 900 - - 1800 - - 3600 - - 10800 + description: "Duration in seconds of the time buckets used to aggregate events matched by the rule.\nMust be greater than or equal to 300." + enum: + - 300 + - 600 + - 900 + - 1800 + - 3600 + - 10800 example: 300 format: int32 type: integer x-enum-varnames: - - FIVE_MINUTES - - TEN_MINUTES - - FIFTEEN_MINUTES - - THIRTY_MINUTES - - ONE_HOUR - - THREE_HOURS + - FIVE_MINUTES + - TEN_MINUTES + - FIFTEEN_MINUTES + - THIRTY_MINUTES + - ONE_HOUR + - THREE_HOURS SecurityMonitoringRuleAnomalyDetectionOptionsDetectionTolerance: - description: 'An optional parameter that sets how permissive anomaly detection - is. - - Higher values require higher deviations before triggering a signal.' + description: "An optional parameter that sets how permissive anomaly detection is.\nHigher values require higher deviations before triggering a signal." enum: - - 1 - - 2 - - 3 - - 4 - - 5 + - 1 + - 2 + - 3 + - 4 + - 5 example: 5 format: int32 type: integer x-enum-varnames: - - ONE - - TWO - - THREE - - FOUR - - FIVE + - ONE + - TWO + - THREE + - FOUR + - FIVE SecurityMonitoringRuleAnomalyDetectionOptionsLearningDuration: - description: Learning duration in hours. Anomaly detection waits for at least - this amount of historical data before it starts evaluating. - enum: - - 1 - - 6 - - 12 - - 24 - - 48 - - 168 - - 336 + description: Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating. + enum: + - 1 + - 6 + - 12 + - 24 + - 48 + - 168 + - 336 format: int32 type: integer x-enum-varnames: - - ONE_HOUR - - SIX_HOURS - - TWELVE_HOURS - - ONE_DAY - - TWO_DAYS - - ONE_WEEK - - TWO_WEEKS + - ONE_HOUR + - SIX_HOURS + - TWELVE_HOURS + - ONE_DAY + - TWO_DAYS + - ONE_WEEK + - TWO_WEEKS SecurityMonitoringRuleBulkExportAttributes: description: Attributes for bulk exporting security monitoring rules. properties: ruleIds: - description: 'List of rule IDs to export. Each rule will be included in - the resulting ZIP file - - as a separate JSON file.' + description: "List of rule IDs to export. Each rule will be included in the resulting ZIP file\nas a separate JSON file." example: - - def-000-u7q - - def-000-7dd + - def-000-u7q + - def-000-7dd items: type: string minItems: 1 type: array required: - - ruleIds + - ruleIds type: object SecurityMonitoringRuleBulkExportData: description: Data for bulk exporting security monitoring rules. properties: attributes: - $ref: '#/components/schemas/SecurityMonitoringRuleBulkExportAttributes' + $ref: "#/components/schemas/SecurityMonitoringRuleBulkExportAttributes" id: description: Request ID. example: bulk_export type: string type: - $ref: '#/components/schemas/SecurityMonitoringRuleBulkExportDataType' + $ref: "#/components/schemas/SecurityMonitoringRuleBulkExportDataType" required: - - attributes - - type + - attributes + - type type: object SecurityMonitoringRuleBulkExportDataType: description: The type of the resource. enum: - - security_monitoring_rules_bulk_export + - security_monitoring_rules_bulk_export example: security_monitoring_rules_bulk_export type: string x-enum-varnames: - - SECURITY_MONITORING_RULES_BULK_EXPORT + - SECURITY_MONITORING_RULES_BULK_EXPORT SecurityMonitoringRuleBulkExportPayload: description: Payload for bulk exporting security monitoring rules. properties: data: - $ref: '#/components/schemas/SecurityMonitoringRuleBulkExportData' + $ref: "#/components/schemas/SecurityMonitoringRuleBulkExportData" required: - - data + - data type: object SecurityMonitoringRuleCase: description: Case when signal is generated. @@ -58417,16 +55563,13 @@ components: actions: description: Action to perform for each rule case. items: - $ref: '#/components/schemas/SecurityMonitoringRuleCaseAction' + $ref: "#/components/schemas/SecurityMonitoringRuleCaseAction" type: array condition: - description: 'A rule case contains logical operations (`>`,`>=`, `&&`, `||`) - to determine if a signal should be generated - - based on the event counts in the previously defined queries.' + description: "A rule case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated\nbased on the event counts in the previously defined queries." type: string customStatus: - $ref: '#/components/schemas/SecurityMonitoringRuleSeverity' + $ref: "#/components/schemas/SecurityMonitoringRuleSeverity" name: description: Name of the case. type: string @@ -58437,16 +55580,15 @@ components: type: string type: array status: - $ref: '#/components/schemas/SecurityMonitoringRuleSeverity' + $ref: "#/components/schemas/SecurityMonitoringRuleSeverity" type: object SecurityMonitoringRuleCaseAction: - description: Action to perform when a signal is triggered. Only available for - Application Security rule type. + description: Action to perform when a signal is triggered. Only available for Application Security rule type. properties: options: - $ref: '#/components/schemas/SecurityMonitoringRuleCaseActionOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleCaseActionOptions" type: - $ref: '#/components/schemas/SecurityMonitoringRuleCaseActionType' + $ref: "#/components/schemas/SecurityMonitoringRuleCaseActionType" type: object SecurityMonitoringRuleCaseActionOptions: additionalProperties: {} @@ -58459,51 +55601,46 @@ components: minimum: 0 type: integer flaggedIPType: - $ref: '#/components/schemas/SecurityMonitoringRuleCaseActionOptionsFlaggedIPType' + $ref: "#/components/schemas/SecurityMonitoringRuleCaseActionOptionsFlaggedIPType" userBehaviorName: - $ref: '#/components/schemas/SecurityMonitoringRuleCaseActionOptionsUserBehaviorName' + $ref: "#/components/schemas/SecurityMonitoringRuleCaseActionOptionsUserBehaviorName" type: object SecurityMonitoringRuleCaseActionOptionsFlaggedIPType: - description: Used with the case action of type 'flag_ip'. The value specified - in this field is applied as a flag to the IP addresses. + description: Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses. enum: - - SUSPICIOUS - - FLAGGED + - SUSPICIOUS + - FLAGGED example: FLAGGED type: string x-enum-varnames: - - SUSPICIOUS - - FLAGGED + - SUSPICIOUS + - FLAGGED SecurityMonitoringRuleCaseActionOptionsUserBehaviorName: - description: Used with the case action of type 'user_behavior'. The value specified - in this field is applied as a risk tag to all users affected by the rule. + description: Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule. type: string SecurityMonitoringRuleCaseActionType: description: The action type. enum: - - block_ip - - block_user - - user_behavior - - flag_ip + - block_ip + - block_user + - user_behavior + - flag_ip type: string x-enum-varnames: - - BLOCK_IP - - BLOCK_USER - - USER_BEHAVIOR - - FLAG_IP + - BLOCK_IP + - BLOCK_USER + - USER_BEHAVIOR + - FLAG_IP SecurityMonitoringRuleCaseCreate: description: Case when signal is generated. properties: actions: description: Action to perform for each rule case. items: - $ref: '#/components/schemas/SecurityMonitoringRuleCaseAction' + $ref: "#/components/schemas/SecurityMonitoringRuleCaseAction" type: array condition: - description: 'A case contains logical operations (`>`,`>=`, `&&`, `||`) - to determine if a signal should be generated - - based on the event counts in the previously defined queries.' + description: "A case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated\nbased on the event counts in the previously defined queries." type: string name: description: Name of the case. @@ -58515,15 +55652,15 @@ components: type: string type: array status: - $ref: '#/components/schemas/SecurityMonitoringRuleSeverity' + $ref: "#/components/schemas/SecurityMonitoringRuleSeverity" required: - - status + - status type: object SecurityMonitoringRuleConvertPayload: description: Convert a rule from JSON to Terraform. oneOf: - - $ref: '#/components/schemas/SecurityMonitoringStandardRulePayload' - - $ref: '#/components/schemas/SecurityMonitoringSignalRulePayload' + - $ref: "#/components/schemas/SecurityMonitoringStandardRulePayload" + - $ref: "#/components/schemas/SecurityMonitoringSignalRulePayload" SecurityMonitoringRuleConvertResponse: description: Result of the convert rule request containing Terraform content. properties: @@ -58537,296 +55674,269 @@ components: SecurityMonitoringRuleCreatePayload: description: Create a new rule. oneOf: - - $ref: '#/components/schemas/SecurityMonitoringStandardRuleCreatePayload' - - $ref: '#/components/schemas/SecurityMonitoringSignalRuleCreatePayload' - - $ref: '#/components/schemas/CloudConfigurationRuleCreatePayload' + - $ref: "#/components/schemas/SecurityMonitoringStandardRuleCreatePayload" + - $ref: "#/components/schemas/SecurityMonitoringSignalRuleCreatePayload" + - $ref: "#/components/schemas/CloudConfigurationRuleCreatePayload" SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv: - description: 'If true, signals in non-production environments have a lower severity - than what is defined by the rule case, which can reduce signal noise. - - The severity is decreased by one level: `CRITICAL` in production becomes `HIGH` - in non-production, `HIGH` becomes `MEDIUM` and so on. `INFO` remains `INFO`. - - The decrement is applied when the environment tag of the signal starts with - `staging`, `test` or `dev`.' + description: "If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: `CRITICAL` in production becomes `HIGH` in non-production, `HIGH` becomes `MEDIUM` and so on. `INFO` remains `INFO`.\nThe decrement is applied when the environment tag of the signal starts with `staging`, `test` or `dev`." example: false type: boolean SecurityMonitoringRuleDetectionMethod: description: The detection method. enum: - - threshold - - new_value - - anomaly_detection - - impossible_travel - - hardcoded - - third_party - - anomaly_threshold - - sequence_detection - type: string - x-enum-varnames: - - THRESHOLD - - NEW_VALUE - - ANOMALY_DETECTION - - IMPOSSIBLE_TRAVEL - - HARDCODED - - THIRD_PARTY - - ANOMALY_THRESHOLD - - SEQUENCE_DETECTION + - threshold + - new_value + - anomaly_detection + - impossible_travel + - hardcoded + - third_party + - anomaly_threshold + - sequence_detection + type: string + x-enum-varnames: + - THRESHOLD + - NEW_VALUE + - ANOMALY_DETECTION + - IMPOSSIBLE_TRAVEL + - HARDCODED + - THIRD_PARTY + - ANOMALY_THRESHOLD + - SEQUENCE_DETECTION SecurityMonitoringRuleEvaluationWindow: - description: 'A time window is specified to match when at least one of the cases - matches true. This is a sliding window - - and evaluates in real time. For third party detection method, this field is - not used.' - enum: - - 0 - - 60 - - 300 - - 600 - - 900 - - 1800 - - 3600 - - 7200 - - 10800 - - 21600 - - 43200 - - 86400 + description: "A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used." + enum: + - 0 + - 60 + - 300 + - 600 + - 900 + - 1800 + - 3600 + - 7200 + - 10800 + - 21600 + - 43200 + - 86400 format: int32 type: integer x-enum-varnames: - - ZERO_MINUTES - - ONE_MINUTE - - FIVE_MINUTES - - TEN_MINUTES - - FIFTEEN_MINUTES - - THIRTY_MINUTES - - ONE_HOUR - - TWO_HOURS - - THREE_HOURS - - SIX_HOURS - - TWELVE_HOURS - - ONE_DAY + - ZERO_MINUTES + - ONE_MINUTE + - FIVE_MINUTES + - TEN_MINUTES + - FIFTEEN_MINUTES + - THIRTY_MINUTES + - ONE_HOUR + - TWO_HOURS + - THREE_HOURS + - SIX_HOURS + - TWELVE_HOURS + - ONE_DAY SecurityMonitoringRuleHardcodedEvaluatorType: description: Hardcoded evaluator type. enum: - - log4shell + - log4shell type: string x-enum-varnames: - - LOG4SHELL + - LOG4SHELL SecurityMonitoringRuleImpossibleTravelOptions: description: Options on impossible travel detection method. properties: baselineUserLocations: - $ref: '#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocations' + $ref: "#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocations" type: object SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocations: - description: 'If true, signals are suppressed for the first 24 hours. In that - time, Datadog learns the user''s regular - - access locations. This can be helpful to reduce noise and infer VPN usage - or credentialed API access.' + description: "If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access." example: true type: boolean SecurityMonitoringRuleInstantaneousBaseline: - description: When set to true, Datadog uses previous values that fall within - the defined learning window to construct the baseline, enabling the system - to establish an accurate baseline more rapidly rather than relying solely - on gradual learning over time. + description: When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time. example: false type: boolean SecurityMonitoringRuleKeepAlive: - description: 'Once a signal is generated, the signal will remain "open" if a - case is matched at least once within - - this keep alive window. For third party detection method, this field is not - used.' - enum: - - 0 - - 60 - - 300 - - 600 - - 900 - - 1800 - - 3600 - - 7200 - - 10800 - - 21600 - - 43200 - - 86400 + description: 'Once a signal is generated, the signal will remain "open" if a case is matched at least once within + + this keep alive window. For third party detection method, this field is not used.' + enum: + - 0 + - 60 + - 300 + - 600 + - 900 + - 1800 + - 3600 + - 7200 + - 10800 + - 21600 + - 43200 + - 86400 format: int32 type: integer x-enum-varnames: - - ZERO_MINUTES - - ONE_MINUTE - - FIVE_MINUTES - - TEN_MINUTES - - FIFTEEN_MINUTES - - THIRTY_MINUTES - - ONE_HOUR - - TWO_HOURS - - THREE_HOURS - - SIX_HOURS - - TWELVE_HOURS - - ONE_DAY + - ZERO_MINUTES + - ONE_MINUTE + - FIVE_MINUTES + - TEN_MINUTES + - FIFTEEN_MINUTES + - THIRTY_MINUTES + - ONE_HOUR + - TWO_HOURS + - THREE_HOURS + - SIX_HOURS + - TWELVE_HOURS + - ONE_DAY SecurityMonitoringRuleMaxSignalDuration: - description: 'A signal will "close" regardless of the query being matched once - the time exceeds the maximum duration. + description: 'A signal will "close" regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp.' enum: - - 0 - - 60 - - 300 - - 600 - - 900 - - 1800 - - 3600 - - 7200 - - 10800 - - 21600 - - 43200 - - 86400 + - 0 + - 60 + - 300 + - 600 + - 900 + - 1800 + - 3600 + - 7200 + - 10800 + - 21600 + - 43200 + - 86400 format: int32 type: integer x-enum-varnames: - - ZERO_MINUTES - - ONE_MINUTE - - FIVE_MINUTES - - TEN_MINUTES - - FIFTEEN_MINUTES - - THIRTY_MINUTES - - ONE_HOUR - - TWO_HOURS - - THREE_HOURS - - SIX_HOURS - - TWELVE_HOURS - - ONE_DAY + - ZERO_MINUTES + - ONE_MINUTE + - FIVE_MINUTES + - TEN_MINUTES + - FIFTEEN_MINUTES + - THIRTY_MINUTES + - ONE_HOUR + - TWO_HOURS + - THREE_HOURS + - SIX_HOURS + - TWELVE_HOURS + - ONE_DAY SecurityMonitoringRuleNewValueOptions: description: Options on new value detection method. properties: forgetAfter: - $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsForgetAfter' + $ref: "#/components/schemas/SecurityMonitoringRuleNewValueOptionsForgetAfter" instantaneousBaseline: - $ref: '#/components/schemas/SecurityMonitoringRuleInstantaneousBaseline' + $ref: "#/components/schemas/SecurityMonitoringRuleInstantaneousBaseline" learningDuration: - $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningDuration' + $ref: "#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningDuration" learningMethod: - $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningMethod' + $ref: "#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningMethod" learningThreshold: - $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningThreshold' + $ref: "#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningThreshold" type: object SecurityMonitoringRuleNewValueOptionsForgetAfter: description: The duration in days after which a learned value is forgotten. enum: - - 1 - - 2 - - 7 - - 14 - - 21 - - 28 + - 1 + - 2 + - 7 + - 14 + - 21 + - 28 format: int32 type: integer x-enum-varnames: - - ONE_DAY - - TWO_DAYS - - ONE_WEEK - - TWO_WEEKS - - THREE_WEEKS - - FOUR_WEEKS + - ONE_DAY + - TWO_DAYS + - ONE_WEEK + - TWO_WEEKS + - THREE_WEEKS + - FOUR_WEEKS SecurityMonitoringRuleNewValueOptionsLearningDuration: default: 0 - description: 'The duration in days during which values are learned, and after - which signals will be generated for values that - - weren''t learned. If set to 0, a signal will be generated for all new values - after the first value is learned.' + description: "The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned." enum: - - 0 - - 1 - - 7 + - 0 + - 1 + - 7 format: int32 type: integer x-enum-varnames: - - ZERO_DAYS - - ONE_DAY - - SEVEN_DAYS + - ZERO_DAYS + - ONE_DAY + - SEVEN_DAYS SecurityMonitoringRuleNewValueOptionsLearningMethod: default: duration - description: The learning method used to determine when signals should be generated - for values that weren't learned. + description: The learning method used to determine when signals should be generated for values that weren't learned. enum: - - duration - - threshold + - duration + - threshold type: string x-enum-varnames: - - DURATION - - THRESHOLD + - DURATION + - THRESHOLD SecurityMonitoringRuleNewValueOptionsLearningThreshold: default: 0 - description: A number of occurrences after which signals will be generated for - values that weren't learned. + description: A number of occurrences after which signals will be generated for values that weren't learned. enum: - - 0 - - 1 + - 0 + - 1 format: int32 type: integer x-enum-varnames: - - ZERO_OCCURRENCES - - ONE_OCCURRENCE + - ZERO_OCCURRENCES + - ONE_OCCURRENCE SecurityMonitoringRuleOptions: description: Options. properties: anomalyDetectionOptions: - $ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptions" complianceRuleOptions: - $ref: '#/components/schemas/CloudConfigurationComplianceRuleOptions' + $ref: "#/components/schemas/CloudConfigurationComplianceRuleOptions" decreaseCriticalityBasedOnEnv: - $ref: '#/components/schemas/SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv' + $ref: "#/components/schemas/SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv" detectionMethod: - $ref: '#/components/schemas/SecurityMonitoringRuleDetectionMethod' + $ref: "#/components/schemas/SecurityMonitoringRuleDetectionMethod" evaluationWindow: - $ref: '#/components/schemas/SecurityMonitoringRuleEvaluationWindow' + $ref: "#/components/schemas/SecurityMonitoringRuleEvaluationWindow" hardcodedEvaluatorType: - $ref: '#/components/schemas/SecurityMonitoringRuleHardcodedEvaluatorType' + $ref: "#/components/schemas/SecurityMonitoringRuleHardcodedEvaluatorType" impossibleTravelOptions: - $ref: '#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptions" keepAlive: - $ref: '#/components/schemas/SecurityMonitoringRuleKeepAlive' + $ref: "#/components/schemas/SecurityMonitoringRuleKeepAlive" maxSignalDuration: - $ref: '#/components/schemas/SecurityMonitoringRuleMaxSignalDuration' + $ref: "#/components/schemas/SecurityMonitoringRuleMaxSignalDuration" newValueOptions: - $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleNewValueOptions" sequenceDetectionOptions: - $ref: '#/components/schemas/SecurityMonitoringRuleSequenceDetectionOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleSequenceDetectionOptions" thirdPartyRuleOptions: - $ref: '#/components/schemas/SecurityMonitoringRuleThirdPartyOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleThirdPartyOptions" type: object SecurityMonitoringRuleQuery: description: Query for matching rule. oneOf: - - $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery' - - $ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery' + - $ref: "#/components/schemas/SecurityMonitoringStandardRuleQuery" + - $ref: "#/components/schemas/SecurityMonitoringSignalRuleQuery" SecurityMonitoringRuleQueryAggregation: description: The aggregation type. enum: - - count - - cardinality - - sum - - max - - new_value - - geo_data - - event_count - - none - type: string - x-enum-varnames: - - COUNT - - CARDINALITY - - SUM - - MAX - - NEW_VALUE - - GEO_DATA - - EVENT_COUNT - - NONE + - count + - cardinality + - sum + - max + - new_value + - geo_data + - event_count + - none + type: string + x-enum-varnames: + - COUNT + - CARDINALITY + - SUM + - MAX + - NEW_VALUE + - GEO_DATA + - EVENT_COUNT + - NONE SecurityMonitoringRuleQueryPayload: description: Payload to test a rule query with the expected result. properties: @@ -58841,7 +55951,7 @@ components: minimum: 0 type: integer payload: - $ref: '#/components/schemas/SecurityMonitoringRuleQueryPayloadData' + $ref: "#/components/schemas/SecurityMonitoringRuleQueryPayloadData" type: object SecurityMonitoringRuleQueryPayloadData: additionalProperties: {} @@ -58871,45 +55981,42 @@ components: SecurityMonitoringRuleResponse: description: Create a new rule. oneOf: - - $ref: '#/components/schemas/SecurityMonitoringStandardRuleResponse' - - $ref: '#/components/schemas/SecurityMonitoringSignalRuleResponse' + - $ref: "#/components/schemas/SecurityMonitoringStandardRuleResponse" + - $ref: "#/components/schemas/SecurityMonitoringSignalRuleResponse" SecurityMonitoringRuleSequenceDetectionOptions: description: Options on sequence detection method. properties: stepTransitions: - description: Transitions defining the allowed order of steps and their evaluation - windows. + description: Transitions defining the allowed order of steps and their evaluation windows. items: - $ref: '#/components/schemas/SecurityMonitoringRuleSequenceDetectionStepTransition' + $ref: "#/components/schemas/SecurityMonitoringRuleSequenceDetectionStepTransition" type: array steps: description: Steps that define the conditions to be matched in sequence. items: - $ref: '#/components/schemas/SecurityMonitoringRuleSequenceDetectionStep' + $ref: "#/components/schemas/SecurityMonitoringRuleSequenceDetectionStep" type: array type: object SecurityMonitoringRuleSequenceDetectionStep: - description: Step definition for sequence detection containing the step name, - condition, and evaluation window. + description: Step definition for sequence detection containing the step name, condition, and evaluation window. properties: condition: description: Condition referencing rule queries (e.g., `a > 0`). type: string evaluationWindow: - $ref: '#/components/schemas/SecurityMonitoringRuleEvaluationWindow' + $ref: "#/components/schemas/SecurityMonitoringRuleEvaluationWindow" name: description: Unique name identifying the step. type: string type: object SecurityMonitoringRuleSequenceDetectionStepTransition: - description: Transition from a parent step to a child step within a sequence - detection rule. + description: Transition from a parent step to a child step within a sequence detection rule. properties: child: description: Name of the child step. type: string evaluationWindow: - $ref: '#/components/schemas/SecurityMonitoringRuleEvaluationWindow' + $ref: "#/components/schemas/SecurityMonitoringRuleEvaluationWindow" parent: description: Name of the parent step. type: string @@ -58917,78 +56024,72 @@ components: SecurityMonitoringRuleSeverity: description: Severity of the Security Signal. enum: - - info - - low - - medium - - high - - critical + - info + - low + - medium + - high + - critical example: critical type: string x-enum-varnames: - - INFO - - LOW - - MEDIUM - - HIGH - - CRITICAL + - INFO + - LOW + - MEDIUM + - HIGH + - CRITICAL SecurityMonitoringRuleSort: description: The sort parameters used for querying security monitoring rules. enum: - - name - - creation_date - - update_date - - enabled - - type - - highest_severity - - source - - -name - - -creation_date - - -update_date - - -enabled - - -type - - -highest_severity - - -source - type: string - x-enum-varnames: - - NAME - - CREATION_DATE - - UPDATE_DATE - - ENABLED - - TYPE - - HIGHEST_SEVERITY - - SOURCE - - NAME_DESCENDING - - CREATION_DATE_DESCENDING - - UPDATE_DATE_DESCENDING - - ENABLED_DESCENDING - - TYPE_DESCENDING - - HIGHEST_SEVERITY_DESCENDING - - SOURCE_DESCENDING + - name + - creation_date + - update_date + - enabled + - type + - highest_severity + - source + - -name + - -creation_date + - -update_date + - -enabled + - -type + - -highest_severity + - -source + type: string + x-enum-varnames: + - NAME + - CREATION_DATE + - UPDATE_DATE + - ENABLED + - TYPE + - HIGHEST_SEVERITY + - SOURCE + - NAME_DESCENDING + - CREATION_DATE_DESCENDING + - UPDATE_DATE_DESCENDING + - ENABLED_DESCENDING + - TYPE_DESCENDING + - HIGHEST_SEVERITY_DESCENDING + - SOURCE_DESCENDING SecurityMonitoringRuleTestPayload: description: Test a rule. oneOf: - - $ref: '#/components/schemas/SecurityMonitoringStandardRuleTestPayload' + - $ref: "#/components/schemas/SecurityMonitoringStandardRuleTestPayload" SecurityMonitoringRuleTestRequest: - description: Test the rule queries of a rule (rule property is ignored when - applied to an existing rule) + description: Test the rule queries of a rule (rule property is ignored when applied to an existing rule) properties: rule: - $ref: '#/components/schemas/SecurityMonitoringRuleTestPayload' + $ref: "#/components/schemas/SecurityMonitoringRuleTestPayload" ruleQueryPayloads: description: Data payloads used to test rules query with the expected result. items: - $ref: '#/components/schemas/SecurityMonitoringRuleQueryPayload' + $ref: "#/components/schemas/SecurityMonitoringRuleQueryPayload" type: array type: object SecurityMonitoringRuleTestResponse: description: Result of the test of the rule queries. properties: results: - description: 'Assert results are returned in the same order as the rule - query payloads. - - For each payload, it returns True if the result matched the expected result, - - False otherwise.' + description: "Assert results are returned in the same order as the rule query payloads.\nFor each payload, it returns True if the result matched the expected result,\nFalse otherwise." items: type: boolean type: array @@ -58997,109 +56098,99 @@ components: description: Options on third party detection method. properties: defaultNotifications: - description: Notification targets for the logs that do not correspond to - any of the cases. + description: Notification targets for the logs that do not correspond to any of the cases. items: description: Notification. type: string type: array defaultStatus: - $ref: '#/components/schemas/SecurityMonitoringRuleSeverity' + $ref: "#/components/schemas/SecurityMonitoringRuleSeverity" rootQueries: - description: Queries to be combined with third party case queries. Each - of them can have different group by fields, to aggregate differently based - on the type of alert. + description: Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert. items: - $ref: '#/components/schemas/SecurityMonitoringThirdPartyRootQuery' + $ref: "#/components/schemas/SecurityMonitoringThirdPartyRootQuery" type: array signalTitleTemplate: - description: A template for the signal title; if omitted, the title is generated - based on the case name. + description: A template for the signal title; if omitted, the title is generated based on the case name. type: string type: object SecurityMonitoringRuleTypeCreate: description: The rule type. enum: - - api_security - - application_security - - log_detection - - workload_activity - - workload_security + - api_security + - application_security + - log_detection + - workload_activity + - workload_security type: string x-enum-varnames: - - API_SECURITY - - APPLICATION_SECURITY - - LOG_DETECTION - - WORKLOAD_ACTIVITY - - WORKLOAD_SECURITY + - API_SECURITY + - APPLICATION_SECURITY + - LOG_DETECTION + - WORKLOAD_ACTIVITY + - WORKLOAD_SECURITY SecurityMonitoringRuleTypeRead: description: The rule type. enum: - - log_detection - - infrastructure_configuration - - workload_security - - cloud_configuration - - application_security - - api_security - - workload_activity - type: string - x-enum-varnames: - - LOG_DETECTION - - INFRASTRUCTURE_CONFIGURATION - - WORKLOAD_SECURITY - - CLOUD_CONFIGURATION - - APPLICATION_SECURITY - - API_SECURITY - - WORKLOAD_ACTIVITY + - log_detection + - infrastructure_configuration + - workload_security + - cloud_configuration + - application_security + - api_security + - workload_activity + type: string + x-enum-varnames: + - LOG_DETECTION + - INFRASTRUCTURE_CONFIGURATION + - WORKLOAD_SECURITY + - CLOUD_CONFIGURATION + - APPLICATION_SECURITY + - API_SECURITY + - WORKLOAD_ACTIVITY SecurityMonitoringRuleTypeTest: description: The rule type. enum: - - log_detection + - log_detection type: string x-enum-varnames: - - LOG_DETECTION + - LOG_DETECTION SecurityMonitoringRuleUpdatePayload: description: Update an existing rule. properties: calculatedFields: - description: Calculated fields. Only allowed for scheduled rules - in other - words, when schedulingOptions is also defined. + description: Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined. items: - $ref: '#/components/schemas/CalculatedField' + $ref: "#/components/schemas/CalculatedField" type: array cases: description: Cases for generating signals. items: - $ref: '#/components/schemas/SecurityMonitoringRuleCase' + $ref: "#/components/schemas/SecurityMonitoringRuleCase" type: array complianceSignalOptions: - $ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions' + $ref: "#/components/schemas/CloudConfigurationRuleComplianceSignalOptions" customMessage: - description: Custom/Overridden Message for generated signals (used in case - of Default rule update). + description: Custom/Overridden Message for generated signals (used in case of Default rule update). type: string customName: description: Custom/Overridden name (used in case of Default rule update). type: string filters: - description: Additional queries to filter matched events before they are - processed. This field is deprecated for log detection, signal correlation, - and workload security rules. + description: Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules. items: - $ref: '#/components/schemas/SecurityMonitoringFilter' + $ref: "#/components/schemas/SecurityMonitoringFilter" type: array groupSignalsBy: - description: Additional grouping to perform on top of the existing groups - in the query section. Must be a subset of the existing groups. + description: Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups. example: - - service + - service items: description: Field to group by. type: string type: array hasExtendedTitle: - description: Whether the notifications include the triggering group-by values - in their title. + description: Whether the notifications include the triggering group-by values in their title. example: true type: boolean isEnabled: @@ -59112,19 +56203,19 @@ components: description: Name of the rule. type: string options: - $ref: '#/components/schemas/SecurityMonitoringRuleOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleOptions" queries: description: Queries for selecting logs which are part of the rule. items: - $ref: '#/components/schemas/SecurityMonitoringRuleQuery' + $ref: "#/components/schemas/SecurityMonitoringRuleQuery" type: array referenceTables: description: Reference tables for the rule. items: - $ref: '#/components/schemas/SecurityMonitoringReferenceTable' + $ref: "#/components/schemas/SecurityMonitoringReferenceTable" type: array schedulingOptions: - $ref: '#/components/schemas/SecurityMonitoringSchedulingOptions' + $ref: "#/components/schemas/SecurityMonitoringSchedulingOptions" tags: description: Tags for generated signals. items: @@ -59132,11 +56223,10 @@ components: type: string type: array thirdPartyCases: - description: Cases for generating signals from third-party rules. Only available - for third-party rules. + description: Cases for generating signals from third-party rules. Only available for third-party rules. example: [] items: - $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCase' + $ref: "#/components/schemas/SecurityMonitoringThirdPartyRuleCase" type: array version: description: The version of the rule being updated. @@ -59148,39 +56238,35 @@ components: SecurityMonitoringRuleValidatePayload: description: Validate a rule. oneOf: - - $ref: '#/components/schemas/SecurityMonitoringStandardRulePayload' - - $ref: '#/components/schemas/SecurityMonitoringSignalRulePayload' - - $ref: '#/components/schemas/CloudConfigurationRulePayload' + - $ref: "#/components/schemas/SecurityMonitoringStandardRulePayload" + - $ref: "#/components/schemas/SecurityMonitoringSignalRulePayload" + - $ref: "#/components/schemas/CloudConfigurationRulePayload" SecurityMonitoringSKU: description: The SIEM pricing model (SKU) for the organization enum: - - per_gb_analyzed - - per_event_in_siem_index_2023 - - add_on_2024 + - per_gb_analyzed + - per_event_in_siem_index_2023 + - add_on_2024 example: add_on_2024 type: string x-enum-varnames: - - PER_GB_ANALYZED - - PER_EVENT_IN_SIEM_INDEX_2023 - - ADD_ON_2024 + - PER_GB_ANALYZED + - PER_EVENT_IN_SIEM_INDEX_2023 + - ADD_ON_2024 SecurityMonitoringSchedulingOptions: - description: Options for scheduled rules. When this field is present, the rule - runs based on the schedule. When absent, it runs real-time on ingested logs. + description: Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs. nullable: true properties: rrule: - description: Schedule for the rule queries, written in RRULE syntax. See - [RFC](https://icalendar.org/iCalendar-RFC-5545/3-8-5-3-recurrence-rule.html) - for syntax reference. + description: Schedule for the rule queries, written in RRULE syntax. See [RFC](https://icalendar.org/iCalendar-RFC-5545/3-8-5-3-recurrence-rule.html) for syntax reference. example: FREQ=HOURLY;INTERVAL=1; type: string start: description: Start date for the schedule, in ISO 8601 format without timezone. - example: '2025-07-14T12:00:00' + example: "2025-07-14T12:00:00" type: string timezone: - description: Time zone of the start date, in the [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) - format. + description: Time zone of the start date, in the [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) format. example: America/New_York type: string type: object @@ -59188,13 +56274,13 @@ components: description: Object description of a security signal. properties: attributes: - $ref: '#/components/schemas/SecurityMonitoringSignalAttributes' + $ref: "#/components/schemas/SecurityMonitoringSignalAttributes" id: description: The unique ID of the security signal. example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA type: string type: - $ref: '#/components/schemas/SecurityMonitoringSignalType' + $ref: "#/components/schemas/SecurityMonitoringSignalType" type: object SecurityMonitoringSignalArchiveComment: description: Optional comment to display on archived signals. @@ -59202,143 +56288,135 @@ components: SecurityMonitoringSignalArchiveReason: description: Reason a signal is archived. enum: - - none - - false_positive - - testing_or_maintenance - - investigated_case_opened - - true_positive_benign - - true_positive_malicious - - other - type: string - x-enum-varnames: - - NONE - - FALSE_POSITIVE - - TESTING_OR_MAINTENANCE - - INVESTIGATED_CASE_OPENED - - TRUE_POSITIVE_BENIGN - - TRUE_POSITIVE_MALICIOUS - - OTHER + - none + - false_positive + - testing_or_maintenance + - investigated_case_opened + - true_positive_benign + - true_positive_malicious + - other + type: string + x-enum-varnames: + - NONE + - FALSE_POSITIVE + - TESTING_OR_MAINTENANCE + - INVESTIGATED_CASE_OPENED + - TRUE_POSITIVE_BENIGN + - TRUE_POSITIVE_MALICIOUS + - OTHER SecurityMonitoringSignalAssigneeUpdateAttributes: description: Attributes describing the new assignee of a security signal. properties: assignee: - $ref: '#/components/schemas/SecurityMonitoringTriageUser' + $ref: "#/components/schemas/SecurityMonitoringTriageUser" version: - $ref: '#/components/schemas/SecurityMonitoringSignalVersion' + $ref: "#/components/schemas/SecurityMonitoringSignalVersion" required: - - assignee + - assignee type: object SecurityMonitoringSignalAssigneeUpdateData: description: Data containing the patch for changing the assignee of a signal. properties: attributes: - $ref: '#/components/schemas/SecurityMonitoringSignalAssigneeUpdateAttributes' + $ref: "#/components/schemas/SecurityMonitoringSignalAssigneeUpdateAttributes" required: - - attributes + - attributes type: object SecurityMonitoringSignalAssigneeUpdateRequest: - description: Request body for changing the assignee of a given security monitoring - signal. + description: Request body for changing the assignee of a given security monitoring signal. properties: data: - $ref: '#/components/schemas/SecurityMonitoringSignalAssigneeUpdateData' + $ref: "#/components/schemas/SecurityMonitoringSignalAssigneeUpdateData" required: - - data + - data type: object SecurityMonitoringSignalAttributes: additionalProperties: {} - description: 'The object containing all signal attributes and their - - associated values.' + description: "The object containing all signal attributes and their\nassociated values." properties: custom: additionalProperties: {} description: A JSON object of attributes in the security signal. example: workflow: - first_seen: '2020-06-23T14:46:01.000Z' - last_seen: '2020-06-23T14:46:49.000Z' + first_seen: "2020-06-23T14:46:01.000Z" + last_seen: "2020-06-23T14:46:49.000Z" rule: id: 0f5-e0c-805 - name: Brute Force Attack Grouped By User + name: "Brute Force Attack Grouped By User" version: 12 type: object message: - description: The message in the security signal defined by the rule that - generated the signal. + description: The message in the security signal defined by the rule that generated the signal. example: Detect Account Take Over (ATO) through brute force attempts type: string tags: description: An array of tags associated with the security signal. example: - - security:attack - - technique:T1110-brute-force + - security:attack + - technique:T1110-brute-force items: description: The tag associated with the security signal. type: string type: array timestamp: description: The timestamp of the security signal. - example: '2019-01-02T09:42:36.320Z' + example: "2019-01-02T09:42:36.320Z" format: date-time type: string type: object SecurityMonitoringSignalIncidentIds: description: Array of incidents that are associated with this signal. example: - - 2066 + - 2066 items: - description: Public ID attribute of the incident that is associated with the - signal. + description: Public ID attribute of the incident that is associated with the signal. example: 2066 format: int64 type: integer type: array SecurityMonitoringSignalIncidentsUpdateAttributes: - description: Attributes describing the new list of related signals for a security - signal. + description: Attributes describing the new list of related signals for a security signal. properties: incident_ids: - $ref: '#/components/schemas/SecurityMonitoringSignalIncidentIds' + $ref: "#/components/schemas/SecurityMonitoringSignalIncidentIds" version: - $ref: '#/components/schemas/SecurityMonitoringSignalVersion' + $ref: "#/components/schemas/SecurityMonitoringSignalVersion" required: - - incident_ids + - incident_ids type: object SecurityMonitoringSignalIncidentsUpdateData: - description: Data containing the patch for changing the related incidents of - a signal. + description: Data containing the patch for changing the related incidents of a signal. properties: attributes: - $ref: '#/components/schemas/SecurityMonitoringSignalIncidentsUpdateAttributes' + $ref: "#/components/schemas/SecurityMonitoringSignalIncidentsUpdateAttributes" required: - - attributes + - attributes type: object SecurityMonitoringSignalIncidentsUpdateRequest: - description: Request body for changing the related incidents of a given security - monitoring signal. + description: Request body for changing the related incidents of a given security monitoring signal. properties: data: - $ref: '#/components/schemas/SecurityMonitoringSignalIncidentsUpdateData' + $ref: "#/components/schemas/SecurityMonitoringSignalIncidentsUpdateData" required: - - data + - data type: object SecurityMonitoringSignalListRequest: description: The request for a security signal list. properties: filter: - $ref: '#/components/schemas/SecurityMonitoringSignalListRequestFilter' + $ref: "#/components/schemas/SecurityMonitoringSignalListRequestFilter" page: - $ref: '#/components/schemas/SecurityMonitoringSignalListRequestPage' + $ref: "#/components/schemas/SecurityMonitoringSignalListRequestPage" sort: - $ref: '#/components/schemas/SecurityMonitoringSignalsSort' + $ref: "#/components/schemas/SecurityMonitoringSignalsSort" type: object SecurityMonitoringSignalListRequestFilter: description: Search filters for listing security signals. properties: from: description: The minimum timestamp for requested security signals. - example: '2019-01-02T09:42:36.320Z' + example: "2019-01-02T09:42:36.320Z" format: date-time type: string query: @@ -59347,7 +56425,7 @@ components: type: string to: description: The maximum timestamp for requested security signals. - example: '2019-01-03T09:42:36.320Z' + example: "2019-01-03T09:42:36.320Z" format: date-time type: string type: object @@ -59355,8 +56433,7 @@ components: description: The paging attributes for listing security signals. properties: cursor: - description: A list of results using the cursor provided in the previous - query. + description: A list of results using the cursor provided in the previous query. example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string limit: @@ -59371,16 +56448,16 @@ components: default: signal_metadata description: The type of event. enum: - - signal_metadata + - signal_metadata example: signal_metadata type: string x-enum-varnames: - - SIGNAL_METADATA + - SIGNAL_METADATA SecurityMonitoringSignalResponse: description: Security Signal response data object. properties: data: - $ref: '#/components/schemas/SecurityMonitoringSignal' + $ref: "#/components/schemas/SecurityMonitoringSignal" type: object SecurityMonitoringSignalRuleCreatePayload: description: Create a new signal correlation rule. @@ -59389,18 +56466,15 @@ components: description: Cases for generating signals. example: [] items: - $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate' + $ref: "#/components/schemas/SecurityMonitoringRuleCaseCreate" type: array filters: - description: Additional queries to filter matched events before they are - processed. This field is deprecated for log detection, signal correlation, - and workload security rules. + description: Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules. items: - $ref: '#/components/schemas/SecurityMonitoringFilter' + $ref: "#/components/schemas/SecurityMonitoringFilter" type: array hasExtendedTitle: - description: Whether the notifications include the triggering group-by values - in their title. + description: Whether the notifications include the triggering group-by values in their title. example: true type: boolean isEnabled: @@ -59409,38 +56483,38 @@ components: type: boolean message: description: Message for generated signals. - example: '' + example: "" type: string name: description: The name of the rule. example: My security monitoring rule. type: string options: - $ref: '#/components/schemas/SecurityMonitoringRuleOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleOptions" queries: description: Queries for selecting signals which are part of the rule. example: [] items: - $ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery' + $ref: "#/components/schemas/SecurityMonitoringSignalRuleQuery" type: array tags: description: Tags for generated signals. example: - - env:prod - - team:security + - env:prod + - team:security items: description: Tag. type: string type: array type: - $ref: '#/components/schemas/SecurityMonitoringSignalRuleType' + $ref: "#/components/schemas/SecurityMonitoringSignalRuleType" required: - - name - - isEnabled - - queries - - options - - cases - - message + - name + - isEnabled + - queries + - options + - cases + - message type: object SecurityMonitoringSignalRulePayload: description: The payload of a signal correlation rule. @@ -59449,26 +56523,21 @@ components: description: Cases for generating signals. example: [] items: - $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate' + $ref: "#/components/schemas/SecurityMonitoringRuleCaseCreate" type: array customMessage: - description: Custom/Overridden message for generated signals (used in case - of Default rule update). + description: Custom/Overridden message for generated signals (used in case of Default rule update). type: string customName: - description: Custom/Overridden name of the rule (used in case of Default - rule update). + description: Custom/Overridden name of the rule (used in case of Default rule update). type: string filters: - description: Additional queries to filter matched events before they are - processed. This field is deprecated for log detection, signal correlation, - and workload security rules. + description: Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules. items: - $ref: '#/components/schemas/SecurityMonitoringFilter' + $ref: "#/components/schemas/SecurityMonitoringFilter" type: array hasExtendedTitle: - description: Whether the notifications include the triggering group-by values - in their title. + description: Whether the notifications include the triggering group-by values in their title. example: true type: boolean isEnabled: @@ -59477,44 +56546,44 @@ components: type: boolean message: description: Message for generated signals. - example: '' + example: "" type: string name: description: The name of the rule. example: My security monitoring rule. type: string options: - $ref: '#/components/schemas/SecurityMonitoringRuleOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleOptions" queries: description: Queries for selecting signals which are part of the rule. example: [] items: - $ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery' + $ref: "#/components/schemas/SecurityMonitoringSignalRuleQuery" type: array tags: description: Tags for generated signals. example: - - env:prod - - team:security + - env:prod + - team:security items: description: Tag. type: string type: array type: - $ref: '#/components/schemas/SecurityMonitoringSignalRuleType' + $ref: "#/components/schemas/SecurityMonitoringSignalRuleType" required: - - name - - isEnabled - - queries - - options - - cases - - message + - name + - isEnabled + - queries + - options + - cases + - message type: object SecurityMonitoringSignalRuleQuery: description: Query for matching rule on signals. properties: aggregation: - $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation' + $ref: "#/components/schemas/SecurityMonitoringRuleQueryAggregation" correlatedByFields: description: Fields to group by. items: @@ -59540,7 +56609,7 @@ components: example: org-ru1-e1d type: string required: - - ruleId + - ruleId type: object SecurityMonitoringSignalRuleResponse: description: Rule. @@ -59548,7 +56617,7 @@ components: cases: description: Cases for generating signals. items: - $ref: '#/components/schemas/SecurityMonitoringRuleCase' + $ref: "#/components/schemas/SecurityMonitoringRuleCase" type: array createdAt: description: When the rule was created, timestamp in milliseconds. @@ -59559,27 +56628,22 @@ components: format: int64 type: integer customMessage: - description: Custom/Overridden message for generated signals (used in case - of Default rule update). + description: Custom/Overridden message for generated signals (used in case of Default rule update). type: string customName: - description: Custom/Overridden name of the rule (used in case of Default - rule update). + description: Custom/Overridden name of the rule (used in case of Default rule update). type: string deprecationDate: description: When the rule will be deprecated, timestamp in milliseconds. format: int64 type: integer filters: - description: Additional queries to filter matched events before they are - processed. This field is deprecated for log detection, signal correlation, - and workload security rules. + description: Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules. items: - $ref: '#/components/schemas/SecurityMonitoringFilter' + $ref: "#/components/schemas/SecurityMonitoringFilter" type: array hasExtendedTitle: - description: Whether the notifications include the triggering group-by values - in their title. + description: Whether the notifications include the triggering group-by values in their title. type: boolean id: description: The ID of the rule. @@ -59600,11 +56664,11 @@ components: description: The name of the rule. type: string options: - $ref: '#/components/schemas/SecurityMonitoringRuleOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleOptions" queries: description: Queries for selecting logs which are part of the rule. items: - $ref: '#/components/schemas/SecurityMonitoringSignalRuleResponseQuery' + $ref: "#/components/schemas/SecurityMonitoringSignalRuleResponseQuery" type: array tags: description: Tags for generated signals. @@ -59613,7 +56677,7 @@ components: type: string type: array type: - $ref: '#/components/schemas/SecurityMonitoringSignalRuleType' + $ref: "#/components/schemas/SecurityMonitoringSignalRuleType" updateAuthorId: description: User ID of the user who updated the rule. format: int64 @@ -59627,7 +56691,7 @@ components: description: Query for matching rule on signals. properties: aggregation: - $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation' + $ref: "#/components/schemas/SecurityMonitoringRuleQueryAggregation" correlatedByFields: description: Fields to correlate by. items: @@ -59672,147 +56736,138 @@ components: SecurityMonitoringSignalRuleType: description: The rule type. enum: - - signal_correlation + - signal_correlation type: string x-enum-varnames: - - SIGNAL_CORRELATION + - SIGNAL_CORRELATION SecurityMonitoringSignalState: description: The new triage state of the signal. enum: - - open - - archived - - under_review + - open + - archived + - under_review example: open type: string x-enum-varnames: - - OPEN - - ARCHIVED - - UNDER_REVIEW + - OPEN + - ARCHIVED + - UNDER_REVIEW SecurityMonitoringSignalStateUpdateAttributes: description: Attributes describing the change of state of a security signal. properties: archive_comment: - $ref: '#/components/schemas/SecurityMonitoringSignalArchiveComment' + $ref: "#/components/schemas/SecurityMonitoringSignalArchiveComment" archive_reason: - $ref: '#/components/schemas/SecurityMonitoringSignalArchiveReason' + $ref: "#/components/schemas/SecurityMonitoringSignalArchiveReason" state: - $ref: '#/components/schemas/SecurityMonitoringSignalState' + $ref: "#/components/schemas/SecurityMonitoringSignalState" version: - $ref: '#/components/schemas/SecurityMonitoringSignalVersion' + $ref: "#/components/schemas/SecurityMonitoringSignalVersion" required: - - state + - state type: object SecurityMonitoringSignalStateUpdateData: description: Data containing the patch for changing the state of a signal. properties: attributes: - $ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateAttributes' + $ref: "#/components/schemas/SecurityMonitoringSignalStateUpdateAttributes" id: description: The unique ID of the security signal. type: - $ref: '#/components/schemas/SecurityMonitoringSignalMetadataType' + $ref: "#/components/schemas/SecurityMonitoringSignalMetadataType" required: - - attributes + - attributes type: object SecurityMonitoringSignalStateUpdateRequest: - description: Request body for changing the state of a given security monitoring - signal. + description: Request body for changing the state of a given security monitoring signal. properties: data: - $ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateData' + $ref: "#/components/schemas/SecurityMonitoringSignalStateUpdateData" required: - - data + - data type: object SecurityMonitoringSignalTriageAttributes: - description: Attributes describing a triage state update operation over a security - signal. + description: Attributes describing a triage state update operation over a security signal. properties: archive_comment: - $ref: '#/components/schemas/SecurityMonitoringSignalArchiveComment' + $ref: "#/components/schemas/SecurityMonitoringSignalArchiveComment" archive_comment_timestamp: description: Timestamp of the last edit to the comment. format: int64 minimum: 0 type: integer archive_comment_user: - $ref: '#/components/schemas/SecurityMonitoringTriageUser' + $ref: "#/components/schemas/SecurityMonitoringTriageUser" archive_reason: - $ref: '#/components/schemas/SecurityMonitoringSignalArchiveReason' + $ref: "#/components/schemas/SecurityMonitoringSignalArchiveReason" assignee: - $ref: '#/components/schemas/SecurityMonitoringTriageUser' + $ref: "#/components/schemas/SecurityMonitoringTriageUser" incident_ids: - $ref: '#/components/schemas/SecurityMonitoringSignalIncidentIds' + $ref: "#/components/schemas/SecurityMonitoringSignalIncidentIds" state: - $ref: '#/components/schemas/SecurityMonitoringSignalState' + $ref: "#/components/schemas/SecurityMonitoringSignalState" state_update_timestamp: description: Timestamp of the last update to the signal state. format: int64 minimum: 0 type: integer state_update_user: - $ref: '#/components/schemas/SecurityMonitoringTriageUser' + $ref: "#/components/schemas/SecurityMonitoringTriageUser" required: - - assignee - - state - - incident_ids + - assignee + - state + - incident_ids type: object SecurityMonitoringSignalTriageUpdateData: description: Data containing the updated triage attributes of the signal. properties: attributes: - $ref: '#/components/schemas/SecurityMonitoringSignalTriageAttributes' + $ref: "#/components/schemas/SecurityMonitoringSignalTriageAttributes" id: description: The unique ID of the security signal. type: string type: - $ref: '#/components/schemas/SecurityMonitoringSignalMetadataType' + $ref: "#/components/schemas/SecurityMonitoringSignalMetadataType" type: object SecurityMonitoringSignalTriageUpdateResponse: - description: The response returned after all triage operations, containing the - updated signal triage data. + description: The response returned after all triage operations, containing the updated signal triage data. properties: data: - $ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateData' + $ref: "#/components/schemas/SecurityMonitoringSignalTriageUpdateData" required: - - data + - data type: object SecurityMonitoringSignalType: default: signal description: The type of event. enum: - - signal + - signal example: signal type: string x-enum-varnames: - - SIGNAL + - SIGNAL SecurityMonitoringSignalVersion: - description: Version of the updated signal. If server side version is higher, - update will be rejected. + description: Version of the updated signal. If server side version is higher, update will be rejected. format: int64 type: integer SecurityMonitoringSignalsListResponse: - description: 'The response object with all security signals matching the request - - and pagination information.' + description: "The response object with all security signals matching the request\nand pagination information." properties: data: description: An array of security signals matching the request. items: - $ref: '#/components/schemas/SecurityMonitoringSignal' + $ref: "#/components/schemas/SecurityMonitoringSignal" type: array links: - $ref: '#/components/schemas/SecurityMonitoringSignalsListResponseLinks' + $ref: "#/components/schemas/SecurityMonitoringSignalsListResponseLinks" meta: - $ref: '#/components/schemas/SecurityMonitoringSignalsListResponseMeta' + $ref: "#/components/schemas/SecurityMonitoringSignalsListResponseMeta" type: object SecurityMonitoringSignalsListResponseLinks: description: Links attributes. properties: next: - description: 'The link for the next set of results. **Note**: The request - can also be made using the - - POST endpoint.' + description: "The link for the next set of results. **Note**: The request can also be made using the\nPOST endpoint." example: https://app.datadoghq.com/api/v2/security_monitoring/signals?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string type: object @@ -59820,83 +56875,75 @@ components: description: Meta attributes. properties: page: - $ref: '#/components/schemas/SecurityMonitoringSignalsListResponseMetaPage' + $ref: "#/components/schemas/SecurityMonitoringSignalsListResponseMetaPage" type: object SecurityMonitoringSignalsListResponseMetaPage: description: Paging attributes. properties: after: - description: 'The cursor used to get the next results, if any. To make the - next request, use the same - - parameters with the addition of the `page[cursor]`.' + description: "The cursor used to get the next results, if any. To make the next request, use the same\nparameters with the addition of the `page[cursor]`." example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== type: string type: object SecurityMonitoringSignalsSort: description: The sort parameters used for querying security signals. enum: - - timestamp - - -timestamp + - timestamp + - -timestamp type: string x-enum-varnames: - - TIMESTAMP_ASCENDING - - TIMESTAMP_DESCENDING + - TIMESTAMP_ASCENDING + - TIMESTAMP_DESCENDING SecurityMonitoringStandardDataSource: default: logs description: Source of events, either logs, audit trail, or Datadog events. enum: - - logs - - audit - - app_sec_spans - - spans - - security_runtime - - network - - events + - logs + - audit + - app_sec_spans + - spans + - security_runtime + - network + - events example: logs type: string x-enum-varnames: - - LOGS - - AUDIT - - APP_SEC_SPANS - - SPANS - - SECURITY_RUNTIME - - NETWORK - - EVENTS + - LOGS + - AUDIT + - APP_SEC_SPANS + - SPANS + - SECURITY_RUNTIME + - NETWORK + - EVENTS SecurityMonitoringStandardRuleCreatePayload: description: Create a new rule. properties: calculatedFields: - description: Calculated fields. Only allowed for scheduled rules - in other - words, when schedulingOptions is also defined. + description: Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined. items: - $ref: '#/components/schemas/CalculatedField' + $ref: "#/components/schemas/CalculatedField" type: array cases: description: Cases for generating signals. example: [] items: - $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate' + $ref: "#/components/schemas/SecurityMonitoringRuleCaseCreate" type: array filters: - description: Additional queries to filter matched events before they are - processed. This field is deprecated for log detection, signal correlation, - and workload security rules. + description: Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules. items: - $ref: '#/components/schemas/SecurityMonitoringFilter' + $ref: "#/components/schemas/SecurityMonitoringFilter" type: array groupSignalsBy: - description: Additional grouping to perform on top of the existing groups - in the query section. Must be a subset of the existing groups. + description: Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups. example: - - service + - service items: description: Field to group by. type: string type: array hasExtendedTitle: - description: Whether the notifications include the triggering group-by values - in their title. + description: Whether the notifications include the triggering group-by values in their title. example: true type: boolean isEnabled: @@ -59905,95 +56952,87 @@ components: type: boolean message: description: Message for generated signals. - example: '' + example: "" type: string name: description: The name of the rule. example: My security monitoring rule. type: string options: - $ref: '#/components/schemas/SecurityMonitoringRuleOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleOptions" queries: description: Queries for selecting logs which are part of the rule. example: [] items: - $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery' + $ref: "#/components/schemas/SecurityMonitoringStandardRuleQuery" type: array referenceTables: description: Reference tables for the rule. items: - $ref: '#/components/schemas/SecurityMonitoringReferenceTable' + $ref: "#/components/schemas/SecurityMonitoringReferenceTable" type: array schedulingOptions: - $ref: '#/components/schemas/SecurityMonitoringSchedulingOptions' + $ref: "#/components/schemas/SecurityMonitoringSchedulingOptions" tags: description: Tags for generated signals. example: - - env:prod - - team:security + - env:prod + - team:security items: description: Tag. type: string type: array thirdPartyCases: - description: Cases for generating signals from third-party rules. Only available - for third-party rules. + description: Cases for generating signals from third-party rules. Only available for third-party rules. example: [] items: - $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate' + $ref: "#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate" type: array type: - $ref: '#/components/schemas/SecurityMonitoringRuleTypeCreate' + $ref: "#/components/schemas/SecurityMonitoringRuleTypeCreate" required: - - name - - isEnabled - - queries - - options - - cases - - message + - name + - isEnabled + - queries + - options + - cases + - message type: object SecurityMonitoringStandardRulePayload: description: The payload of a rule. properties: calculatedFields: - description: Calculated fields. Only allowed for scheduled rules - in other - words, when schedulingOptions is also defined. + description: Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined. items: - $ref: '#/components/schemas/CalculatedField' + $ref: "#/components/schemas/CalculatedField" type: array cases: description: Cases for generating signals. example: [] items: - $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate' + $ref: "#/components/schemas/SecurityMonitoringRuleCaseCreate" type: array customMessage: - description: Custom/Overridden message for generated signals (used in case - of Default rule update). + description: Custom/Overridden message for generated signals (used in case of Default rule update). type: string customName: - description: Custom/Overridden name of the rule (used in case of Default - rule update). + description: Custom/Overridden name of the rule (used in case of Default rule update). type: string filters: - description: Additional queries to filter matched events before they are - processed. This field is deprecated for log detection, signal correlation, - and workload security rules. + description: Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules. items: - $ref: '#/components/schemas/SecurityMonitoringFilter' + $ref: "#/components/schemas/SecurityMonitoringFilter" type: array groupSignalsBy: - description: Additional grouping to perform on top of the existing groups - in the query section. Must be a subset of the existing groups. + description: Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups. example: - - service + - service items: description: Field to group by. type: string type: array hasExtendedTitle: - description: Whether the notifications include the triggering group-by values - in their title. + description: Whether the notifications include the triggering group-by values in their title. example: true type: boolean isEnabled: @@ -60002,64 +57041,63 @@ components: type: boolean message: description: Message for generated signals. - example: '' + example: "" type: string name: description: The name of the rule. example: My security monitoring rule. type: string options: - $ref: '#/components/schemas/SecurityMonitoringRuleOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleOptions" queries: description: Queries for selecting logs which are part of the rule. example: [] items: - $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery' + $ref: "#/components/schemas/SecurityMonitoringStandardRuleQuery" type: array referenceTables: description: Reference tables for the rule. items: - $ref: '#/components/schemas/SecurityMonitoringReferenceTable' + $ref: "#/components/schemas/SecurityMonitoringReferenceTable" type: array schedulingOptions: - $ref: '#/components/schemas/SecurityMonitoringSchedulingOptions' + $ref: "#/components/schemas/SecurityMonitoringSchedulingOptions" tags: description: Tags for generated signals. example: - - env:prod - - team:security + - env:prod + - team:security items: description: Tag. type: string type: array thirdPartyCases: - description: Cases for generating signals from third-party rules. Only available - for third-party rules. + description: Cases for generating signals from third-party rules. Only available for third-party rules. example: [] items: - $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate' + $ref: "#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate" type: array type: - $ref: '#/components/schemas/SecurityMonitoringRuleTypeCreate' + $ref: "#/components/schemas/SecurityMonitoringRuleTypeCreate" required: - - name - - isEnabled - - queries - - options - - cases - - message + - name + - isEnabled + - queries + - options + - cases + - message type: object SecurityMonitoringStandardRuleQuery: description: Query for matching rule. properties: aggregation: - $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation' + $ref: "#/components/schemas/SecurityMonitoringRuleQueryAggregation" customQueryExtension: description: Query extension to append to the logs query. example: a > 3 type: string dataSource: - $ref: '#/components/schemas/SecurityMonitoringStandardDataSource' + $ref: "#/components/schemas/SecurityMonitoringStandardDataSource" distinctFields: description: Field for which the cardinality is measured. Sent as an array. items: @@ -60074,39 +57112,24 @@ components: type: array hasOptionalGroupByFields: default: false - description: When false, events without a group-by value are ignored by - the rule. When true, events with missing group-by fields are processed - with `N/A`, replacing the missing values. + description: When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with `N/A`, replacing the missing values. example: false type: boolean index: - description: '**This field is currently unstable and might be removed in - a minor version upgrade.** - - The index to run the query on, if the `dataSource` is `logs`. Only used - for scheduled rules - in other words, when the `schedulingOptions` field - is present in the rule payload.' + description: "**This field is currently unstable and might be removed in a minor version upgrade.**\nThe index to run the query on, if the `dataSource` is `logs`. Only used for scheduled rules - in other words, when the `schedulingOptions` field is present in the rule payload." type: string indexes: - description: List of indexes to query when the `dataSource` is `logs`. Only - used for scheduled rules, such as when the `schedulingOptions` field is - present in the rule payload. + description: List of indexes to query when the `dataSource` is `logs`. Only used for scheduled rules, such as when the `schedulingOptions` field is present in the rule payload. items: description: Index. type: string type: array metric: deprecated: true - description: '(Deprecated) The target field to aggregate over when using - the sum or max - - aggregations. `metrics` field should be used instead.' + description: "(Deprecated) The target field to aggregate over when using the sum or max\naggregations. `metrics` field should be used instead." type: string metrics: - description: Group of target fields to aggregate over when using the sum, - max, geo data, or new value aggregations. The sum, max, and geo data aggregations - only accept one value in this list, whereas the new value aggregation - accepts up to five values. + description: Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values. items: description: Field. type: string @@ -60123,18 +57146,17 @@ components: description: Rule. properties: calculatedFields: - description: Calculated fields. Only allowed for scheduled rules - in other - words, when schedulingOptions is also defined. + description: Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined. items: - $ref: '#/components/schemas/CalculatedField' + $ref: "#/components/schemas/CalculatedField" type: array cases: description: Cases for generating signals. items: - $ref: '#/components/schemas/SecurityMonitoringRuleCase' + $ref: "#/components/schemas/SecurityMonitoringRuleCase" type: array complianceSignalOptions: - $ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions' + $ref: "#/components/schemas/CloudConfigurationRuleComplianceSignalOptions" createdAt: description: When the rule was created, timestamp in milliseconds. format: int64 @@ -60144,17 +57166,15 @@ components: format: int64 type: integer customMessage: - description: Custom/Overridden message for generated signals (used in case - of Default rule update). + description: Custom/Overridden message for generated signals (used in case of Default rule update). type: string customName: - description: Custom/Overridden name of the rule (used in case of Default - rule update). + description: Custom/Overridden name of the rule (used in case of Default rule update). type: string defaultTags: description: Default Tags for default rules (included in tags) example: - - security:attacks + - security:attacks items: description: Default Tag. type: string @@ -60164,24 +57184,20 @@ components: format: int64 type: integer filters: - description: Additional queries to filter matched events before they are - processed. This field is deprecated for log detection, signal correlation, - and workload security rules. + description: Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules. items: - $ref: '#/components/schemas/SecurityMonitoringFilter' + $ref: "#/components/schemas/SecurityMonitoringFilter" type: array groupSignalsBy: - description: Additional grouping to perform on top of the existing groups - in the query section. Must be a subset of the existing groups. + description: Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups. example: - - service + - service items: description: Field to group by. type: string type: array hasExtendedTitle: - description: Whether the notifications include the triggering group-by values - in their title. + description: Whether the notifications include the triggering group-by values in their title. type: boolean id: description: The ID of the rule. @@ -60202,19 +57218,19 @@ components: description: The name of the rule. type: string options: - $ref: '#/components/schemas/SecurityMonitoringRuleOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleOptions" queries: description: Queries for selecting logs which are part of the rule. items: - $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery' + $ref: "#/components/schemas/SecurityMonitoringStandardRuleQuery" type: array referenceTables: description: Reference tables for the rule. items: - $ref: '#/components/schemas/SecurityMonitoringReferenceTable' + $ref: "#/components/schemas/SecurityMonitoringReferenceTable" type: array schedulingOptions: - $ref: '#/components/schemas/SecurityMonitoringSchedulingOptions' + $ref: "#/components/schemas/SecurityMonitoringSchedulingOptions" tags: description: Tags for generated signals. items: @@ -60222,14 +57238,13 @@ components: type: string type: array thirdPartyCases: - description: Cases for generating signals from third-party rules. Only available - for third-party rules. + description: Cases for generating signals from third-party rules. Only available for third-party rules. example: [] items: - $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCase' + $ref: "#/components/schemas/SecurityMonitoringThirdPartyRuleCase" type: array type: - $ref: '#/components/schemas/SecurityMonitoringRuleTypeRead' + $ref: "#/components/schemas/SecurityMonitoringRuleTypeRead" updateAuthorId: description: User ID of the user who updated the rule. format: int64 @@ -60247,36 +57262,31 @@ components: description: The payload of a rule to test properties: calculatedFields: - description: Calculated fields. Only allowed for scheduled rules - in other - words, when schedulingOptions is also defined. + description: Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined. items: - $ref: '#/components/schemas/CalculatedField' + $ref: "#/components/schemas/CalculatedField" type: array cases: description: Cases for generating signals. example: [] items: - $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate' + $ref: "#/components/schemas/SecurityMonitoringRuleCaseCreate" type: array filters: - description: Additional queries to filter matched events before they are - processed. This field is deprecated for log detection, signal correlation, - and workload security rules. + description: Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules. items: - $ref: '#/components/schemas/SecurityMonitoringFilter' + $ref: "#/components/schemas/SecurityMonitoringFilter" type: array groupSignalsBy: - description: Additional grouping to perform on top of the existing groups - in the query section. Must be a subset of the existing groups. + description: Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups. example: - - service + - service items: description: Field to group by. type: string type: array hasExtendedTitle: - description: Whether the notifications include the triggering group-by values - in their title. + description: Whether the notifications include the triggering group-by values in their title. example: true type: boolean isEnabled: @@ -60285,78 +57295,73 @@ components: type: boolean message: description: Message for generated signals. - example: '' + example: "" type: string name: description: The name of the rule. example: My security monitoring rule. type: string options: - $ref: '#/components/schemas/SecurityMonitoringRuleOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleOptions" queries: description: Queries for selecting logs which are part of the rule. example: [] items: - $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery' + $ref: "#/components/schemas/SecurityMonitoringStandardRuleQuery" type: array referenceTables: description: Reference tables for the rule. items: - $ref: '#/components/schemas/SecurityMonitoringReferenceTable' + $ref: "#/components/schemas/SecurityMonitoringReferenceTable" type: array schedulingOptions: - $ref: '#/components/schemas/SecurityMonitoringSchedulingOptions' + $ref: "#/components/schemas/SecurityMonitoringSchedulingOptions" tags: description: Tags for generated signals. example: - - env:prod - - team:security + - env:prod + - team:security items: description: Tag. type: string type: array thirdPartyCases: - description: Cases for generating signals from third-party rules. Only available - for third-party rules. + description: Cases for generating signals from third-party rules. Only available for third-party rules. example: [] items: - $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate' + $ref: "#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate" type: array type: - $ref: '#/components/schemas/SecurityMonitoringRuleTypeTest' + $ref: "#/components/schemas/SecurityMonitoringRuleTypeTest" required: - - name - - isEnabled - - queries - - options - - cases - - message + - name + - isEnabled + - queries + - options + - cases + - message type: object SecurityMonitoringSuppression: description: The suppression rule's properties. properties: attributes: - $ref: '#/components/schemas/SecurityMonitoringSuppressionAttributes' + $ref: "#/components/schemas/SecurityMonitoringSuppressionAttributes" id: - $ref: '#/components/schemas/SecurityMonitoringSuppressionID' + $ref: "#/components/schemas/SecurityMonitoringSuppressionID" type: - $ref: '#/components/schemas/SecurityMonitoringSuppressionType' + $ref: "#/components/schemas/SecurityMonitoringSuppressionType" type: object SecurityMonitoringSuppressionAttributes: description: The attributes of the suppression rule. properties: creation_date: - description: A Unix millisecond timestamp given the creation date of the - suppression rule. + description: A Unix millisecond timestamp given the creation date of the suppression rule. format: int64 type: integer creator: - $ref: '#/components/schemas/SecurityMonitoringUser' + $ref: "#/components/schemas/SecurityMonitoringUser" data_exclusion_query: - description: An exclusion query on the input data of the security rules, - which could be logs, Agent events, or other types of data based on the - security rule. Events matching this query are ignored by any detection - rules referenced in the suppression rule. + description: An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule. example: source:cloudtrail account_id:12345 type: string description: @@ -60372,8 +57377,7 @@ components: example: true type: boolean expiration_date: - description: A Unix millisecond timestamp giving an expiration date for - the suppression rule. After this date, it won't suppress signals anymore. + description: A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore. example: 1703187336000 format: int64 type: integer @@ -60382,54 +57386,44 @@ components: example: Custom suppression type: string rule_query: - description: The rule query of the suppression rule, with the same syntax - as the search bar for detection rules. + description: The rule query of the suppression rule, with the same syntax as the search bar for detection rules. example: type:log_detection source:cloudtrail type: string start_date: - description: A Unix millisecond timestamp giving the start date for the - suppression rule. After this date, it starts suppressing signals. + description: A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals. example: 1703187336000 format: int64 type: integer suppression_query: - description: The suppression query of the suppression rule. If a signal - matches this query, it is suppressed and not triggered. Same syntax as - the queries to search signals in the signal explorer. + description: The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer. example: env:staging status:low type: string tags: description: List of tags associated with the suppression rule. example: - - technique:T1110-brute-force - - source:cloudtrail + - technique:T1110-brute-force + - source:cloudtrail items: type: string type: array update_date: - description: A Unix millisecond timestamp given the update date of the suppression - rule. + description: A Unix millisecond timestamp given the update date of the suppression rule. format: int64 type: integer updater: - $ref: '#/components/schemas/SecurityMonitoringUser' + $ref: "#/components/schemas/SecurityMonitoringUser" version: - description: The version of the suppression rule; it starts at 1, and is - incremented at each update. + description: The version of the suppression rule; it starts at 1, and is incremented at each update. example: 42 format: int32 maximum: 2147483647 type: integer type: object SecurityMonitoringSuppressionCreateAttributes: - description: Object containing the attributes of the suppression rule to be - created. + description: Object containing the attributes of the suppression rule to be created. properties: data_exclusion_query: - description: An exclusion query on the input data of the security rules, - which could be logs, Agent events, or other types of data based on the - security rule. Events matching this query are ignored by any detection - rules referenced in the suppression rule. + description: An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule. example: source:cloudtrail account_id:12345 type: string description: @@ -60441,8 +57435,7 @@ components: example: true type: boolean expiration_date: - description: A Unix millisecond timestamp giving an expiration date for - the suppression rule. After this date, it won't suppress signals anymore. + description: A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore. example: 1703187336000 format: int64 type: integer @@ -60451,54 +57444,49 @@ components: example: Custom suppression type: string rule_query: - description: The rule query of the suppression rule, with the same syntax - as the search bar for detection rules. + description: The rule query of the suppression rule, with the same syntax as the search bar for detection rules. example: type:log_detection source:cloudtrail type: string start_date: - description: A Unix millisecond timestamp giving the start date for the - suppression rule. After this date, it starts suppressing signals. + description: A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals. example: 1703187336000 format: int64 type: integer suppression_query: - description: The suppression query of the suppression rule. If a signal - matches this query, it is suppressed and is not triggered. It uses the - same syntax as the queries to search signals in the Signals Explorer. + description: The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer. example: env:staging status:low type: string tags: description: List of tags associated with the suppression rule. example: - - technique:T1110-brute-force - - source:cloudtrail + - technique:T1110-brute-force + - source:cloudtrail items: type: string type: array required: - - name - - enabled - - rule_query + - name + - enabled + - rule_query type: object SecurityMonitoringSuppressionCreateData: description: Object for a single suppression rule. properties: attributes: - $ref: '#/components/schemas/SecurityMonitoringSuppressionCreateAttributes' + $ref: "#/components/schemas/SecurityMonitoringSuppressionCreateAttributes" type: - $ref: '#/components/schemas/SecurityMonitoringSuppressionType' + $ref: "#/components/schemas/SecurityMonitoringSuppressionType" required: - - type - - attributes + - type + - attributes type: object SecurityMonitoringSuppressionCreateRequest: - description: Request object that includes the suppression rule that you would - like to create. + description: Request object that includes the suppression rule that you would like to create. properties: data: - $ref: '#/components/schemas/SecurityMonitoringSuppressionCreateData' + $ref: "#/components/schemas/SecurityMonitoringSuppressionCreateData" required: - - data + - data type: object SecurityMonitoringSuppressionID: description: The ID of the suppression rule. @@ -60508,52 +57496,49 @@ components: description: Response object containing a single suppression rule. properties: data: - $ref: '#/components/schemas/SecurityMonitoringSuppression' + $ref: "#/components/schemas/SecurityMonitoringSuppression" type: object SecurityMonitoringSuppressionSort: description: The sort parameters used for querying suppression rules. enum: - - name - - start_date - - expiration_date - - update_date - - enabled - - -name - - -start_date - - -expiration_date - - -update_date - - -creation_date - - -enabled - type: string - x-enum-varnames: - - NAME - - START_DATE - - EXPIRATION_DATE - - UPDATE_DATE - - ENABLED - - NAME_DESCENDING - - START_DATE_DESCENDING - - EXPIRATION_DATE_DESCENDING - - UPDATE_DATE_DESCENDING - - CREATION_DATE_DESCENDING - - ENABLED_DESCENDING + - name + - start_date + - expiration_date + - update_date + - enabled + - -name + - -start_date + - -expiration_date + - -update_date + - -creation_date + - -enabled + type: string + x-enum-varnames: + - NAME + - START_DATE + - EXPIRATION_DATE + - UPDATE_DATE + - ENABLED + - NAME_DESCENDING + - START_DATE_DESCENDING + - EXPIRATION_DATE_DESCENDING + - UPDATE_DATE_DESCENDING + - CREATION_DATE_DESCENDING + - ENABLED_DESCENDING SecurityMonitoringSuppressionType: default: suppressions description: The type of the resource. The value should always be `suppressions`. enum: - - suppressions + - suppressions example: suppressions type: string x-enum-varnames: - - SUPPRESSIONS + - SUPPRESSIONS SecurityMonitoringSuppressionUpdateAttributes: description: The suppression rule properties to be updated. properties: data_exclusion_query: - description: An exclusion query on the input data of the security rules, - which could be logs, Agent events, or other types of data based on the - security rule. Events matching this query are ignored by any detection - rules referenced in the suppression rule. + description: An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule. example: source:cloudtrail account_id:12345 type: string description: @@ -60565,10 +57550,7 @@ components: example: true type: boolean expiration_date: - description: A Unix millisecond timestamp giving an expiration date for - the suppression rule. After this date, it won't suppress signals anymore. - If unset, the expiration date of the suppression rule is left untouched. - If set to `null`, the expiration date is removed. + description: A Unix millisecond timestamp giving an expiration date for the suppression rule. After this date, it won't suppress signals anymore. If unset, the expiration date of the suppression rule is left untouched. If set to `null`, the expiration date is removed. example: 1703187336000 format: int64 nullable: true @@ -60578,36 +57560,29 @@ components: example: Custom suppression type: string rule_query: - description: The rule query of the suppression rule, with the same syntax - as the search bar for detection rules. + description: The rule query of the suppression rule, with the same syntax as the search bar for detection rules. example: type:log_detection source:cloudtrail type: string start_date: - description: A Unix millisecond timestamp giving the start date for the - suppression rule. After this date, it starts suppressing signals. If unset, - the start date of the suppression rule is left untouched. If set to `null`, - the start date is removed. + description: A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals. If unset, the start date of the suppression rule is left untouched. If set to `null`, the start date is removed. example: 1703187336000 format: int64 nullable: true type: integer suppression_query: - description: The suppression query of the suppression rule. If a signal - matches this query, it is suppressed and not triggered. Same syntax as - the queries to search signals in the signal explorer. + description: The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer. example: env:staging status:low type: string tags: description: List of tags associated with the suppression rule. example: - - technique:T1110-brute-force - - source:cloudtrail + - technique:T1110-brute-force + - source:cloudtrail items: type: string type: array version: - description: The current version of the suppression. This is optional, but - it can help prevent concurrent modifications. + description: The current version of the suppression. This is optional, but it can help prevent concurrent modifications. format: int32 maximum: 2147483647 type: integer @@ -60616,27 +57591,26 @@ components: description: The new suppression properties; partial updates are supported. properties: attributes: - $ref: '#/components/schemas/SecurityMonitoringSuppressionUpdateAttributes' + $ref: "#/components/schemas/SecurityMonitoringSuppressionUpdateAttributes" type: - $ref: '#/components/schemas/SecurityMonitoringSuppressionType' + $ref: "#/components/schemas/SecurityMonitoringSuppressionType" required: - - type - - attributes + - type + - attributes type: object SecurityMonitoringSuppressionUpdateRequest: - description: Request object containing the fields to update on the suppression - rule. + description: Request object containing the fields to update on the suppression rule. properties: data: - $ref: '#/components/schemas/SecurityMonitoringSuppressionUpdateData' + $ref: "#/components/schemas/SecurityMonitoringSuppressionUpdateData" required: - - data + - data type: object SecurityMonitoringSuppressionsMeta: description: Metadata for the suppression list response. properties: page: - $ref: '#/components/schemas/SecurityMonitoringSuppressionsPageMeta' + $ref: "#/components/schemas/SecurityMonitoringSuppressionsPageMeta" type: object SecurityMonitoringSuppressionsPageMeta: description: Pagination metadata. @@ -60663,7 +57637,7 @@ components: data: description: A list of suppressions objects. items: - $ref: '#/components/schemas/SecurityMonitoringSuppression' + $ref: "#/components/schemas/SecurityMonitoringSuppression" type: array type: object SecurityMonitoringThirdPartyRootQuery: @@ -60684,7 +57658,7 @@ components: description: Case when signal is generated by a third party rule. properties: customStatus: - $ref: '#/components/schemas/SecurityMonitoringRuleSeverity' + $ref: "#/components/schemas/SecurityMonitoringRuleSeverity" name: description: Name of the case. type: string @@ -60698,7 +57672,7 @@ components: description: A query to map a third party event to this case. type: string status: - $ref: '#/components/schemas/SecurityMonitoringRuleSeverity' + $ref: "#/components/schemas/SecurityMonitoringRuleSeverity" type: object SecurityMonitoringThirdPartyRuleCaseCreate: description: Case when a signal is generated by a third party rule. @@ -60716,9 +57690,9 @@ components: description: A query to map a third party event to this case. type: string status: - $ref: '#/components/schemas/SecurityMonitoringRuleSeverity' + $ref: "#/components/schemas/SecurityMonitoringRuleSeverity" required: - - status + - status type: object SecurityMonitoringTriageUser: description: Object representing a given user entity. @@ -60744,7 +57718,7 @@ components: example: 773b045d-ccf8-4808-bd3b-955ef6a8c940 type: string required: - - uuid + - uuid type: object SecurityMonitoringUser: description: A user. @@ -60760,85 +57734,81 @@ components: type: string type: object SecurityTrigger: - description: Trigger a workflow from a Security Signal or Finding. For automatic - triggering a handle must be configured and the workflow must be published. + description: "Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published." properties: rateLimit: - $ref: '#/components/schemas/TriggerRateLimit' + $ref: "#/components/schemas/TriggerRateLimit" type: object SecurityTriggerWrapper: - description: Schema for a Security-based trigger. + description: "Schema for a Security-based trigger." properties: securityTrigger: - $ref: '#/components/schemas/SecurityTrigger' + $ref: "#/components/schemas/SecurityTrigger" startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - securityTrigger + - securityTrigger type: object Selectors: - description: 'Selectors are used to filter security issues for which notifications - should be generated. - - Users can specify rule severities, rule types, a query to filter security - issues on tags and attributes, and the trigger source. - - Only the trigger_source field is required.' + description: |- + Selectors are used to filter security issues for which notifications should be generated. + Users can specify rule severities, rule types, a query to filter security issues on tags and attributes, and the trigger source. + Only the trigger_source field is required. properties: query: - $ref: '#/components/schemas/NotificationRuleQuery' + $ref: "#/components/schemas/NotificationRuleQuery" rule_types: - $ref: '#/components/schemas/RuleTypes' + $ref: "#/components/schemas/RuleTypes" severities: description: The security rules severities to consider. items: - $ref: '#/components/schemas/RuleSeverity' + $ref: "#/components/schemas/RuleSeverity" type: array trigger_source: - $ref: '#/components/schemas/TriggerSource' + $ref: "#/components/schemas/TriggerSource" required: - - trigger_source + - trigger_source type: object SelfServiceTriggerWrapper: - description: Schema for a Self Service-based trigger. + description: "Schema for a Self Service-based trigger." properties: selfServiceTrigger: - description: Trigger a workflow from Self Service. + description: "Trigger a workflow from Self Service." type: object startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - selfServiceTrigger + - selfServiceTrigger type: object SendSlackMessageAction: - description: Sends a message to a Slack channel. + description: "Sends a message to a Slack channel." properties: channel: - description: The channel ID. + description: "The channel ID." example: CHANNEL type: string type: - $ref: '#/components/schemas/SendSlackMessageActionType' + $ref: "#/components/schemas/SendSlackMessageActionType" workspace: - description: The workspace ID. + description: "The workspace ID." example: WORKSPACE type: string required: - - type - - channel - - workspace + - type + - channel + - workspace type: object SendSlackMessageActionType: default: send_slack_message - description: Indicates that the action is a send Slack message action. + description: "Indicates that the action is a send Slack message action." enum: - - send_slack_message + - send_slack_message example: send_slack_message type: string x-enum-varnames: - - SEND_SLACK_MESSAGE + - SEND_SLACK_MESSAGE SendTeamsMessageAction: - description: Sends a message to a Microsoft Teams channel. + description: "Sends a message to a Microsoft Teams channel." properties: channel: description: The channel ID. @@ -60853,32 +57823,32 @@ components: example: TENANT type: string type: - $ref: '#/components/schemas/SendTeamsMessageActionType' + $ref: "#/components/schemas/SendTeamsMessageActionType" required: - - type - - channel - - tenant - - team + - type + - channel + - tenant + - team type: object SendTeamsMessageActionType: default: send_teams_message - description: Indicates that the action is a send Microsoft Teams message action. + description: "Indicates that the action is a send Microsoft Teams message action." enum: - - send_teams_message + - send_teams_message example: send_teams_message type: string x-enum-varnames: - - SEND_TEAMS_MESSAGE + - SEND_TEAMS_MESSAGE SensitiveDataScannerConfigRequest: description: Group reorder request. properties: data: - $ref: '#/components/schemas/SensitiveDataScannerReorderConfig' + $ref: "#/components/schemas/SensitiveDataScannerReorderConfig" meta: - $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly" required: - - data - - meta + - data + - meta type: object SensitiveDataScannerConfiguration: description: A Sensitive Data Scanner configuration. @@ -60887,44 +57857,44 @@ components: description: ID of the configuration. type: string type: - $ref: '#/components/schemas/SensitiveDataScannerConfigurationType' + $ref: "#/components/schemas/SensitiveDataScannerConfigurationType" type: object SensitiveDataScannerConfigurationData: description: A Sensitive Data Scanner configuration data. properties: data: - $ref: '#/components/schemas/SensitiveDataScannerConfiguration' + $ref: "#/components/schemas/SensitiveDataScannerConfiguration" type: object SensitiveDataScannerConfigurationRelationships: description: Relationships of the configuration. properties: groups: - $ref: '#/components/schemas/SensitiveDataScannerGroupList' + $ref: "#/components/schemas/SensitiveDataScannerGroupList" type: object SensitiveDataScannerConfigurationType: default: sensitive_data_scanner_configuration description: Sensitive Data Scanner configuration type. enum: - - sensitive_data_scanner_configuration + - sensitive_data_scanner_configuration example: sensitive_data_scanner_configuration type: string x-enum-varnames: - - SENSITIVE_DATA_SCANNER_CONFIGURATIONS + - SENSITIVE_DATA_SCANNER_CONFIGURATIONS SensitiveDataScannerCreateGroupResponse: description: Create group response. properties: data: - $ref: '#/components/schemas/SensitiveDataScannerGroupResponse' + $ref: "#/components/schemas/SensitiveDataScannerGroupResponse" meta: - $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly" type: object SensitiveDataScannerCreateRuleResponse: description: Create rule response. properties: data: - $ref: '#/components/schemas/SensitiveDataScannerRuleResponse' + $ref: "#/components/schemas/SensitiveDataScannerRuleResponse" meta: - $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly" type: object SensitiveDataScannerFilter: description: Filter for the Scanning Group. @@ -60936,22 +57906,22 @@ components: SensitiveDataScannerGetConfigIncludedArray: description: Included objects from relationships. items: - $ref: '#/components/schemas/SensitiveDataScannerGetConfigIncludedItem' + $ref: "#/components/schemas/SensitiveDataScannerGetConfigIncludedItem" type: array SensitiveDataScannerGetConfigIncludedItem: description: An object related to the configuration. oneOf: - - $ref: '#/components/schemas/SensitiveDataScannerRuleIncludedItem' - - $ref: '#/components/schemas/SensitiveDataScannerGroupIncludedItem' + - $ref: "#/components/schemas/SensitiveDataScannerRuleIncludedItem" + - $ref: "#/components/schemas/SensitiveDataScannerGroupIncludedItem" SensitiveDataScannerGetConfigResponse: description: Get all groups response. properties: data: - $ref: '#/components/schemas/SensitiveDataScannerGetConfigResponseData' + $ref: "#/components/schemas/SensitiveDataScannerGetConfigResponseData" included: - $ref: '#/components/schemas/SensitiveDataScannerGetConfigIncludedArray' + $ref: "#/components/schemas/SensitiveDataScannerGetConfigIncludedArray" meta: - $ref: '#/components/schemas/SensitiveDataScannerMeta' + $ref: "#/components/schemas/SensitiveDataScannerMeta" type: object SensitiveDataScannerGetConfigResponseData: description: Response data related to the scanning groups. @@ -60964,9 +57934,9 @@ components: description: ID of the configuration. type: string relationships: - $ref: '#/components/schemas/SensitiveDataScannerConfigurationRelationships' + $ref: "#/components/schemas/SensitiveDataScannerConfigurationRelationships" type: - $ref: '#/components/schemas/SensitiveDataScannerConfigurationType' + $ref: "#/components/schemas/SensitiveDataScannerConfigurationType" type: object SensitiveDataScannerGroup: description: A scanning group. @@ -60975,7 +57945,7 @@ components: description: ID of the group. type: string type: - $ref: '#/components/schemas/SensitiveDataScannerGroupType' + $ref: "#/components/schemas/SensitiveDataScannerGroupType" type: object SensitiveDataScannerGroupAttributes: description: Attributes of the Sensitive Data Scanner group. @@ -60984,7 +57954,7 @@ components: description: Description of the group. type: string filter: - $ref: '#/components/schemas/SensitiveDataScannerFilter' + $ref: "#/components/schemas/SensitiveDataScannerFilter" is_enabled: description: Whether or not the group is enabled. type: boolean @@ -60994,67 +57964,67 @@ components: product_list: description: List of products the scanning group applies. items: - $ref: '#/components/schemas/SensitiveDataScannerProduct' + $ref: "#/components/schemas/SensitiveDataScannerProduct" type: array samplings: description: List of sampling rates per product type. items: - $ref: '#/components/schemas/SensitiveDataScannerSamplings' + $ref: "#/components/schemas/SensitiveDataScannerSamplings" type: array type: object SensitiveDataScannerGroupCreate: description: Data related to the creation of a group. properties: attributes: - $ref: '#/components/schemas/SensitiveDataScannerGroupAttributes' + $ref: "#/components/schemas/SensitiveDataScannerGroupAttributes" relationships: - $ref: '#/components/schemas/SensitiveDataScannerGroupRelationships' + $ref: "#/components/schemas/SensitiveDataScannerGroupRelationships" type: - $ref: '#/components/schemas/SensitiveDataScannerGroupType' + $ref: "#/components/schemas/SensitiveDataScannerGroupType" required: - - type - - attributes + - type + - attributes type: object SensitiveDataScannerGroupCreateRequest: description: Create group request. properties: data: - $ref: '#/components/schemas/SensitiveDataScannerGroupCreate' + $ref: "#/components/schemas/SensitiveDataScannerGroupCreate" meta: - $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly" type: object SensitiveDataScannerGroupData: description: A scanning group data. properties: data: - $ref: '#/components/schemas/SensitiveDataScannerGroup' + $ref: "#/components/schemas/SensitiveDataScannerGroup" type: object SensitiveDataScannerGroupDeleteRequest: description: Delete group request. properties: meta: - $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly" required: - - meta + - meta type: object SensitiveDataScannerGroupDeleteResponse: description: Delete group response. properties: meta: - $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly" type: object SensitiveDataScannerGroupIncludedItem: description: A Scanning Group included item. properties: attributes: - $ref: '#/components/schemas/SensitiveDataScannerGroupAttributes' + $ref: "#/components/schemas/SensitiveDataScannerGroupAttributes" id: description: ID of the group. type: string relationships: - $ref: '#/components/schemas/SensitiveDataScannerGroupRelationships' + $ref: "#/components/schemas/SensitiveDataScannerGroupRelationships" type: - $ref: '#/components/schemas/SensitiveDataScannerGroupType' + $ref: "#/components/schemas/SensitiveDataScannerGroupType" type: object SensitiveDataScannerGroupItem: description: Data related to a Sensitive Data Scanner Group. @@ -61063,7 +58033,7 @@ components: description: ID of the group. type: string type: - $ref: '#/components/schemas/SensitiveDataScannerGroupType' + $ref: "#/components/schemas/SensitiveDataScannerGroupType" type: object SensitiveDataScannerGroupList: description: List of groups, ordered. @@ -61071,114 +58041,101 @@ components: data: description: List of groups. The order is important. items: - $ref: '#/components/schemas/SensitiveDataScannerGroupItem' + $ref: "#/components/schemas/SensitiveDataScannerGroupItem" type: array type: object SensitiveDataScannerGroupRelationships: description: Relationships of the group. properties: configuration: - $ref: '#/components/schemas/SensitiveDataScannerConfigurationData' + $ref: "#/components/schemas/SensitiveDataScannerConfigurationData" rules: - $ref: '#/components/schemas/SensitiveDataScannerRuleData' + $ref: "#/components/schemas/SensitiveDataScannerRuleData" type: object SensitiveDataScannerGroupResponse: description: Response data related to the creation of a group. properties: attributes: - $ref: '#/components/schemas/SensitiveDataScannerGroupAttributes' + $ref: "#/components/schemas/SensitiveDataScannerGroupAttributes" id: description: ID of the group. type: string relationships: - $ref: '#/components/schemas/SensitiveDataScannerGroupRelationships' + $ref: "#/components/schemas/SensitiveDataScannerGroupRelationships" type: - $ref: '#/components/schemas/SensitiveDataScannerGroupType' + $ref: "#/components/schemas/SensitiveDataScannerGroupType" type: object SensitiveDataScannerGroupType: default: sensitive_data_scanner_group description: Sensitive Data Scanner group type. enum: - - sensitive_data_scanner_group + - sensitive_data_scanner_group example: sensitive_data_scanner_group type: string x-enum-varnames: - - SENSITIVE_DATA_SCANNER_GROUP + - SENSITIVE_DATA_SCANNER_GROUP SensitiveDataScannerGroupUpdate: description: Data related to the update of a group. properties: attributes: - $ref: '#/components/schemas/SensitiveDataScannerGroupAttributes' + $ref: "#/components/schemas/SensitiveDataScannerGroupAttributes" id: description: ID of the group. type: string relationships: - $ref: '#/components/schemas/SensitiveDataScannerGroupRelationships' + $ref: "#/components/schemas/SensitiveDataScannerGroupRelationships" type: - $ref: '#/components/schemas/SensitiveDataScannerGroupType' + $ref: "#/components/schemas/SensitiveDataScannerGroupType" type: object SensitiveDataScannerGroupUpdateRequest: description: Update group request. properties: data: - $ref: '#/components/schemas/SensitiveDataScannerGroupUpdate' + $ref: "#/components/schemas/SensitiveDataScannerGroupUpdate" meta: - $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly" required: - - data - - meta + - data + - meta type: object SensitiveDataScannerGroupUpdateResponse: description: Update group response. properties: meta: - $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly" type: object SensitiveDataScannerIncludedKeywordConfiguration: - description: 'Object defining a set of keywords and a number of characters that - help reduce noise. - - You can provide a list of keywords you would like to check within a defined - proximity of the matching pattern. - - If any of the keywords are found within the proximity check, the match is - kept. - - If none are found, the match is discarded.' + description: |- + Object defining a set of keywords and a number of characters that help reduce noise. + You can provide a list of keywords you would like to check within a defined proximity of the matching pattern. + If any of the keywords are found within the proximity check, the match is kept. + If none are found, the match is discarded. properties: character_count: - description: 'The number of characters behind a match detected by Sensitive - Data Scanner to look for the keywords defined. - - `character_count` should be greater than the maximum length of a keyword - defined for a rule.' + description: |- + The number of characters behind a match detected by Sensitive Data Scanner to look for the keywords defined. + `character_count` should be greater than the maximum length of a keyword defined for a rule. example: 30 format: int64 maximum: 50 minimum: 1 type: integer keywords: - description: 'Keyword list that will be checked during scanning in order - to validate a match. - - The number of keywords in the list must be less than or equal to 30.' - example: - - email - - address - - login + description: |- + Keyword list that will be checked during scanning in order to validate a match. + The number of keywords in the list must be less than or equal to 30. + example: ["email", "address", "login"] items: type: string type: array use_recommended_keywords: - description: 'Should the rule use the underlying standard pattern keyword - configuration. If set to `true`, the rule must be tied - - to a standard pattern. If set to `false`, the specified keywords and `character_count` - are applied.' + description: |- + Should the rule use the underlying standard pattern keyword configuration. If set to `true`, the rule must be tied + to a standard pattern. If set to `false`, the specified keywords and `character_count` are applied. type: boolean required: - - keywords - - character_count + - keywords + - character_count type: object SensitiveDataScannerMeta: description: Meta response containing information about the API. @@ -61194,17 +58151,14 @@ components: has_highlight_enabled: default: true deprecated: true - description: (Deprecated) Whether or not scanned events are highlighted - in Logs or RUM for the org. + description: (Deprecated) Whether or not scanned events are highlighted in Logs or RUM for the org. type: boolean has_multi_pass_enabled: deprecated: true - description: (Deprecated) Whether or not scanned events have multi-pass - enabled. + description: (Deprecated) Whether or not scanned events have multi-pass enabled. type: boolean is_pci_compliant: - description: Whether or not the org is compliant to the payment card industry - standard. + description: Whether or not the org is compliant to the payment card industry standard. type: boolean version: description: Version of the API. @@ -61227,16 +58181,16 @@ components: default: logs description: Datadog product onto which Sensitive Data Scanner can be activated. enum: - - logs - - rum - - events - - apm + - logs + - rum + - events + - apm type: string x-enum-varnames: - - LOGS - - RUM - - EVENTS - - APM + - LOGS + - RUM + - EVENTS + - APM SensitiveDataScannerReorderConfig: description: Data related to the reordering of scanning groups. properties: @@ -61244,15 +58198,15 @@ components: description: ID of the configuration. type: string relationships: - $ref: '#/components/schemas/SensitiveDataScannerConfigurationRelationships' + $ref: "#/components/schemas/SensitiveDataScannerConfigurationRelationships" type: - $ref: '#/components/schemas/SensitiveDataScannerConfigurationType' + $ref: "#/components/schemas/SensitiveDataScannerConfigurationType" type: object SensitiveDataScannerReorderGroupsResponse: description: Group reorder response. properties: meta: - $ref: '#/components/schemas/SensitiveDataScannerMeta' + $ref: "#/components/schemas/SensitiveDataScannerMeta" type: object SensitiveDataScannerRule: description: Rule item included in the group. @@ -61261,7 +58215,7 @@ components: description: ID of the rule. type: string type: - $ref: '#/components/schemas/SensitiveDataScannerRuleType' + $ref: "#/components/schemas/SensitiveDataScannerRuleType" type: object SensitiveDataScannerRuleAttributes: description: Attributes of the Sensitive Data Scanner rule. @@ -61270,15 +58224,13 @@ components: description: Description of the rule. type: string excluded_namespaces: - description: Attributes excluded from the scan. If namespaces is provided, - it has to be a sub-path of the namespaces array. - example: - - admin.name + description: Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array. + example: ["admin.name"] items: type: string type: array included_keyword_configuration: - $ref: '#/components/schemas/SensitiveDataScannerIncludedKeywordConfiguration' + $ref: "#/components/schemas/SensitiveDataScannerIncludedKeywordConfiguration" is_enabled: description: Whether or not the rule is enabled. type: boolean @@ -61286,12 +58238,10 @@ components: description: Name of the rule. type: string namespaces: - description: 'Attributes included in the scan. If namespaces is empty or - missing, all attributes except excluded_namespaces are scanned. - - If both are missing the whole event is scanned.' - example: - - admin + description: |- + Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned. + If both are missing the whole event is scanned. + example: ["admin"] items: type: string type: array @@ -61305,39 +58255,39 @@ components: minimum: 1 type: integer suppressions: - $ref: '#/components/schemas/SensitiveDataScannerSuppressions' + $ref: "#/components/schemas/SensitiveDataScannerSuppressions" tags: description: List of tags. items: type: string type: array text_replacement: - $ref: '#/components/schemas/SensitiveDataScannerTextReplacement' + $ref: "#/components/schemas/SensitiveDataScannerTextReplacement" type: object SensitiveDataScannerRuleCreate: description: Data related to the creation of a rule. properties: attributes: - $ref: '#/components/schemas/SensitiveDataScannerRuleAttributes' + $ref: "#/components/schemas/SensitiveDataScannerRuleAttributes" relationships: - $ref: '#/components/schemas/SensitiveDataScannerRuleRelationships' + $ref: "#/components/schemas/SensitiveDataScannerRuleRelationships" type: - $ref: '#/components/schemas/SensitiveDataScannerRuleType' + $ref: "#/components/schemas/SensitiveDataScannerRuleType" required: - - type - - attributes - - relationships + - type + - attributes + - relationships type: object SensitiveDataScannerRuleCreateRequest: description: Create rule request. properties: data: - $ref: '#/components/schemas/SensitiveDataScannerRuleCreate' + $ref: "#/components/schemas/SensitiveDataScannerRuleCreate" meta: - $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly" required: - - data - - meta + - data + - meta type: object SensitiveDataScannerRuleData: description: Rules included in the group. @@ -61345,101 +58295,101 @@ components: data: description: Rules included in the group. The order is important. items: - $ref: '#/components/schemas/SensitiveDataScannerRule' + $ref: "#/components/schemas/SensitiveDataScannerRule" type: array type: object SensitiveDataScannerRuleDeleteRequest: description: Delete rule request. properties: meta: - $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly" required: - - meta + - meta type: object SensitiveDataScannerRuleDeleteResponse: description: Delete rule response. properties: meta: - $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly" type: object SensitiveDataScannerRuleIncludedItem: description: A Scanning Rule included item. properties: attributes: - $ref: '#/components/schemas/SensitiveDataScannerRuleAttributes' + $ref: "#/components/schemas/SensitiveDataScannerRuleAttributes" id: description: ID of the rule. type: string relationships: - $ref: '#/components/schemas/SensitiveDataScannerRuleRelationships' + $ref: "#/components/schemas/SensitiveDataScannerRuleRelationships" type: - $ref: '#/components/schemas/SensitiveDataScannerRuleType' + $ref: "#/components/schemas/SensitiveDataScannerRuleType" type: object SensitiveDataScannerRuleRelationships: description: Relationships of a scanning rule. properties: group: - $ref: '#/components/schemas/SensitiveDataScannerGroupData' + $ref: "#/components/schemas/SensitiveDataScannerGroupData" standard_pattern: - $ref: '#/components/schemas/SensitiveDataScannerStandardPatternData' + $ref: "#/components/schemas/SensitiveDataScannerStandardPatternData" type: object SensitiveDataScannerRuleResponse: description: Response data related to the creation of a rule. properties: attributes: - $ref: '#/components/schemas/SensitiveDataScannerRuleAttributes' + $ref: "#/components/schemas/SensitiveDataScannerRuleAttributes" id: description: ID of the rule. type: string relationships: - $ref: '#/components/schemas/SensitiveDataScannerRuleRelationships' + $ref: "#/components/schemas/SensitiveDataScannerRuleRelationships" type: - $ref: '#/components/schemas/SensitiveDataScannerRuleType' + $ref: "#/components/schemas/SensitiveDataScannerRuleType" type: object SensitiveDataScannerRuleType: default: sensitive_data_scanner_rule description: Sensitive Data Scanner rule type. enum: - - sensitive_data_scanner_rule + - sensitive_data_scanner_rule example: sensitive_data_scanner_rule type: string x-enum-varnames: - - SENSITIVE_DATA_SCANNER_RULE + - SENSITIVE_DATA_SCANNER_RULE SensitiveDataScannerRuleUpdate: description: Data related to the update of a rule. properties: attributes: - $ref: '#/components/schemas/SensitiveDataScannerRuleAttributes' + $ref: "#/components/schemas/SensitiveDataScannerRuleAttributes" id: description: ID of the rule. type: string relationships: - $ref: '#/components/schemas/SensitiveDataScannerRuleRelationships' + $ref: "#/components/schemas/SensitiveDataScannerRuleRelationships" type: - $ref: '#/components/schemas/SensitiveDataScannerRuleType' + $ref: "#/components/schemas/SensitiveDataScannerRuleType" type: object SensitiveDataScannerRuleUpdateRequest: description: Update rule request. properties: data: - $ref: '#/components/schemas/SensitiveDataScannerRuleUpdate' + $ref: "#/components/schemas/SensitiveDataScannerRuleUpdate" meta: - $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly" required: - - data - - meta + - data + - meta type: object SensitiveDataScannerRuleUpdateResponse: description: Update rule response. properties: meta: - $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly" type: object SensitiveDataScannerSamplings: description: Sampling configurations for the Scanning Group. properties: product: - $ref: '#/components/schemas/SensitiveDataScannerProduct' + $ref: "#/components/schemas/SensitiveDataScannerProduct" rate: description: Rate at which data in product type will be scanned, as a percentage. example: 100.0 @@ -61455,7 +58405,7 @@ components: description: ID of the standard pattern. type: string type: - $ref: '#/components/schemas/SensitiveDataScannerStandardPatternType' + $ref: "#/components/schemas/SensitiveDataScannerStandardPatternType" type: object SensitiveDataScannerStandardPatternAttributes: description: Attributes of the Sensitive Data Scanner standard pattern. @@ -61473,13 +58423,10 @@ components: type: string pattern: deprecated: true - description: (Deprecated) Regex to match, optionally documented for older - standard rules. Refer to the `description` field to understand what the - rule does. + description: (Deprecated) Regex to match, optionally documented for older standard rules. Refer to the `description` field to understand what the rule does. type: string priority: - description: Integer from 1 (high) to 5 (low) indicating standard pattern - issue severity. + description: Integer from 1 (high) to 5 (low) indicating standard pattern issue severity. format: int64 maximum: 5 minimum: 1 @@ -61494,70 +58441,59 @@ components: description: A standard pattern. properties: data: - $ref: '#/components/schemas/SensitiveDataScannerStandardPattern' + $ref: "#/components/schemas/SensitiveDataScannerStandardPattern" type: object SensitiveDataScannerStandardPatternType: default: sensitive_data_scanner_standard_pattern description: Sensitive Data Scanner standard pattern type. enum: - - sensitive_data_scanner_standard_pattern + - sensitive_data_scanner_standard_pattern example: sensitive_data_scanner_standard_pattern type: string x-enum-varnames: - - SENSITIVE_DATA_SCANNER_STANDARD_PATTERN + - SENSITIVE_DATA_SCANNER_STANDARD_PATTERN SensitiveDataScannerStandardPatternsResponse: description: List Standard patterns response. items: - $ref: '#/components/schemas/SensitiveDataScannerStandardPatternsResponseItem' + $ref: "#/components/schemas/SensitiveDataScannerStandardPatternsResponseItem" type: array SensitiveDataScannerStandardPatternsResponseData: description: List Standard patterns response data. properties: data: - $ref: '#/components/schemas/SensitiveDataScannerStandardPatternsResponse' + $ref: "#/components/schemas/SensitiveDataScannerStandardPatternsResponse" type: object SensitiveDataScannerStandardPatternsResponseItem: description: Standard pattern item. properties: attributes: - $ref: '#/components/schemas/SensitiveDataScannerStandardPatternAttributes' + $ref: "#/components/schemas/SensitiveDataScannerStandardPatternAttributes" id: description: ID of the standard pattern. type: string type: - $ref: '#/components/schemas/SensitiveDataScannerStandardPatternType' + $ref: "#/components/schemas/SensitiveDataScannerStandardPatternType" type: object SensitiveDataScannerSuppressions: - description: 'Object describing the suppressions for a rule. There are three - types of suppressions, `starts_with`, `ends_with`, and `exact_match`. - - Suppressed matches are not obfuscated, counted in metrics, or displayed in - the Findings page.' + description: |- + Object describing the suppressions for a rule. There are three types of suppressions, `starts_with`, `ends_with`, and `exact_match`. + Suppressed matches are not obfuscated, counted in metrics, or displayed in the Findings page. properties: ends_with: - description: List of strings to use for suppression of matches ending with - these strings. - example: - - '@example.com' - - another.example.com + description: List of strings to use for suppression of matches ending with these strings. + example: ["@example.com", "another.example.com"] items: type: string type: array exact_match: - description: List of strings to use for suppression of matches exactly matching - these strings. - example: - - admin@example.com - - user@example.com + description: List of strings to use for suppression of matches exactly matching these strings. + example: ["admin@example.com", "user@example.com"] items: type: string type: array starts_with: - description: List of strings to use for suppression of matches starting - with these strings. - example: - - admin - - user + description: List of strings to use for suppression of matches starting with these strings. + example: ["admin", "user"] items: type: string type: array @@ -61566,9 +58502,9 @@ components: description: Object describing how the scanned event will be replaced. properties: number_of_chars: - description: 'Required if type == ''partial_replacement_from_beginning'' - - or ''partial_replacement_from_end''. It must be > 0.' + description: |- + Required if type == 'partial_replacement_from_beginning' + or 'partial_replacement_from_end'. It must be > 0. format: int64 minimum: 0 type: integer @@ -61576,46 +58512,39 @@ components: description: Required if type == 'replacement_string'. type: string should_save_match: - description: "Only valid when type == `replacement_string`. When enabled, - matches can be unmasked in logs by users with \u2018Data Scanner Unmask\u2019 - permission. As a security best practice, avoid masking for highly-sensitive, - long-lived data." + description: Only valid when type == `replacement_string`. When enabled, matches can be unmasked in logs by users with ‘Data Scanner Unmask’ permission. As a security best practice, avoid masking for highly-sensitive, long-lived data. type: boolean type: - $ref: '#/components/schemas/SensitiveDataScannerTextReplacementType' + $ref: "#/components/schemas/SensitiveDataScannerTextReplacementType" type: object SensitiveDataScannerTextReplacementType: default: none - description: 'Type of the replacement text. None means no replacement. - + description: |- + Type of the replacement text. None means no replacement. hash means the data will be stubbed. replacement_string means that - one can chose a text to replace the data. partial_replacement_from_beginning - allows a user to partially replace the data from the beginning, and - partial_replacement_from_end on the other hand, allows to replace data from - - the end.' + the end. enum: - - none - - hash - - replacement_string - - partial_replacement_from_beginning - - partial_replacement_from_end + - none + - hash + - replacement_string + - partial_replacement_from_beginning + - partial_replacement_from_end type: string x-enum-varnames: - - NONE - - HASH - - REPLACEMENT_STRING - - PARTIAL_REPLACEMENT_FROM_BEGINNING - - PARTIAL_REPLACEMENT_FROM_END + - NONE + - HASH + - REPLACEMENT_STRING + - PARTIAL_REPLACEMENT_FROM_BEGINNING + - PARTIAL_REPLACEMENT_FROM_END ServiceAccountCreateAttributes: description: Attributes of the created user. properties: email: description: The email of the user. - example: jane.doe@example.com + example: "jane.doe@example.com" type: string name: description: The name of the user. @@ -61628,29 +58557,29 @@ components: description: The title of the user. type: string required: - - email - - service_account + - email + - service_account type: object ServiceAccountCreateData: description: Object to create a service account User. properties: attributes: - $ref: '#/components/schemas/ServiceAccountCreateAttributes' + $ref: "#/components/schemas/ServiceAccountCreateAttributes" relationships: - $ref: '#/components/schemas/UserRelationships' + $ref: "#/components/schemas/UserRelationships" type: - $ref: '#/components/schemas/UsersType' + $ref: "#/components/schemas/UsersType" required: - - attributes - - type + - attributes + - type type: object ServiceAccountCreateRequest: description: Create a service account. properties: data: - $ref: '#/components/schemas/ServiceAccountCreateData' + $ref: "#/components/schemas/ServiceAccountCreateData" required: - - data + - data type: object ServiceDefinitionCreateResponse: description: Create service definitions response. @@ -61658,14 +58587,14 @@ components: data: description: Create service definitions response payload. items: - $ref: '#/components/schemas/ServiceDefinitionData' + $ref: "#/components/schemas/ServiceDefinitionData" type: array type: object ServiceDefinitionData: description: Service definition data. properties: attributes: - $ref: '#/components/schemas/ServiceDefinitionDataAttributes' + $ref: "#/components/schemas/ServiceDefinitionDataAttributes" id: description: Service definition id. type: string @@ -61677,15 +58606,15 @@ components: description: Service definition attributes. properties: meta: - $ref: '#/components/schemas/ServiceDefinitionMeta' + $ref: "#/components/schemas/ServiceDefinitionMeta" schema: - $ref: '#/components/schemas/ServiceDefinitionSchema' + $ref: "#/components/schemas/ServiceDefinitionSchema" type: object ServiceDefinitionGetResponse: description: Get service definition response. properties: data: - $ref: '#/components/schemas/ServiceDefinitionData' + $ref: "#/components/schemas/ServiceDefinitionData" type: object ServiceDefinitionMeta: description: Metadata about a service definition. @@ -61711,7 +58640,7 @@ components: warnings: description: A list of schema validation warnings. items: - $ref: '#/components/schemas/ServiceDefinitionMetaWarnings' + $ref: "#/components/schemas/ServiceDefinitionMetaWarnings" type: array type: object ServiceDefinitionMetaWarnings: @@ -61729,79 +58658,74 @@ components: type: object ServiceDefinitionRaw: description: Service Definition in raw JSON/YAML representation. - example: '--- - + example: |- + --- schema-version: v2 - - dd-service: my-service' + dd-service: my-service type: string ServiceDefinitionSchema: description: Service definition schema. oneOf: - - $ref: '#/components/schemas/ServiceDefinitionV1' - - $ref: '#/components/schemas/ServiceDefinitionV2' - - $ref: '#/components/schemas/ServiceDefinitionV2Dot1' - - $ref: '#/components/schemas/ServiceDefinitionV2Dot2' + - $ref: "#/components/schemas/ServiceDefinitionV1" + - $ref: "#/components/schemas/ServiceDefinitionV2" + - $ref: "#/components/schemas/ServiceDefinitionV2Dot1" + - $ref: "#/components/schemas/ServiceDefinitionV2Dot2" ServiceDefinitionSchemaVersions: description: Schema versions enum: - - v1 - - v2 - - v2.1 - - v2.2 + - v1 + - v2 + - v2.1 + - v2.2 type: string x-enum-varnames: - - V1 - - V2 - - V2_1 - - V2_2 + - V1 + - V2 + - V2_1 + - V2_2 ServiceDefinitionV1: deprecated: true - description: Deprecated - Service definition V1 for providing additional service - metadata and integrations. + description: Deprecated - Service definition V1 for providing additional service metadata and integrations. properties: contact: - $ref: '#/components/schemas/ServiceDefinitionV1Contact' + $ref: "#/components/schemas/ServiceDefinitionV1Contact" extensions: additionalProperties: {} description: Extensions to V1 schema. - example: - myorg/extension: extensionValue + example: {"myorg/extension": "extensionValue"} type: object external-resources: description: A list of external links related to the services. items: - $ref: '#/components/schemas/ServiceDefinitionV1Resource' + $ref: "#/components/schemas/ServiceDefinitionV1Resource" type: array info: - $ref: '#/components/schemas/ServiceDefinitionV1Info' + $ref: "#/components/schemas/ServiceDefinitionV1Info" integrations: - $ref: '#/components/schemas/ServiceDefinitionV1Integrations' + $ref: "#/components/schemas/ServiceDefinitionV1Integrations" org: - $ref: '#/components/schemas/ServiceDefinitionV1Org' + $ref: "#/components/schemas/ServiceDefinitionV1Org" schema-version: - $ref: '#/components/schemas/ServiceDefinitionV1Version' + $ref: "#/components/schemas/ServiceDefinitionV1Version" tags: description: A set of custom tags. - example: - - my:tag - - service:tag + example: ["my:tag", "service:tag"] items: type: string type: array required: - - schema-version - - info + - schema-version + - info type: object ServiceDefinitionV1Contact: description: Contact information about the service. properties: email: - description: "Service owner\u2019s email." + description: Service owner’s email. example: contact@datadoghq.com type: string slack: - description: "Service owner\u2019s Slack channel." + description: Service owner’s Slack channel. example: https://yourcompany.slack.com/archives/channel123 type: string type: object @@ -61809,8 +58733,7 @@ components: description: Basic information about a service. properties: dd-service: - description: Unique identifier of the service. Must be unique across all - services and is used to match with a service in Datadog. + description: Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog. example: myservice type: string description: @@ -61825,14 +58748,13 @@ components: description: Service tier. example: Tier 1 type: string - required: - - dd-service + required: [dd-service] type: object ServiceDefinitionV1Integrations: description: Third party integrations that Datadog supports. properties: pagerduty: - $ref: '#/components/schemas/ServiceDefinitionV1Pagerduty' + $ref: "#/components/schemas/ServiceDefinitionV1Pagerduty" type: object ServiceDefinitionV1Org: description: Org related information about the service. @@ -61858,97 +58780,92 @@ components: example: Runbook type: string type: - $ref: '#/components/schemas/ServiceDefinitionV1ResourceType' + $ref: "#/components/schemas/ServiceDefinitionV1ResourceType" url: description: Link URL. example: https://my-runbook type: string required: - - name - - type - - url + - name + - type + - url type: object ServiceDefinitionV1ResourceType: description: Link type. enum: - - doc - - wiki - - runbook - - url - - repo - - dashboard - - oncall - - code - - link + - doc + - wiki + - runbook + - url + - repo + - dashboard + - oncall + - code + - link example: runbook type: string x-enum-varnames: - - DOC - - WIKI - - RUNBOOK - - URL - - REPO - - DASHBOARD - - ONCALL - - CODE - - LINK + - DOC + - WIKI + - RUNBOOK + - URL + - REPO + - DASHBOARD + - ONCALL + - CODE + - LINK ServiceDefinitionV1Version: default: v1 description: Schema version being used. enum: - - v1 + - v1 example: v1 type: string x-enum-varnames: - - V1 + - V1 ServiceDefinitionV2: description: Service definition V2 for providing service metadata and integrations. properties: contacts: description: A list of contacts related to the services. items: - $ref: '#/components/schemas/ServiceDefinitionV2Contact' + $ref: "#/components/schemas/ServiceDefinitionV2Contact" type: array dd-service: - description: Unique identifier of the service. Must be unique across all - services and is used to match with a service in Datadog. + description: Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog. example: my-service type: string dd-team: - description: Experimental feature. A Team handle that matches a Team in - the Datadog Teams product. + description: Experimental feature. A Team handle that matches a Team in the Datadog Teams product. example: my-team type: string docs: description: A list of documentation related to the services. items: - $ref: '#/components/schemas/ServiceDefinitionV2Doc' + $ref: "#/components/schemas/ServiceDefinitionV2Doc" type: array extensions: additionalProperties: {} description: Extensions to V2 schema. - example: - myorg/extension: extensionValue + example: {"myorg/extension": "extensionValue"} type: object integrations: - $ref: '#/components/schemas/ServiceDefinitionV2Integrations' + $ref: "#/components/schemas/ServiceDefinitionV2Integrations" links: description: A list of links related to the services. items: - $ref: '#/components/schemas/ServiceDefinitionV2Link' + $ref: "#/components/schemas/ServiceDefinitionV2Link" type: array repos: description: A list of code repositories related to the services. items: - $ref: '#/components/schemas/ServiceDefinitionV2Repo' + $ref: "#/components/schemas/ServiceDefinitionV2Repo" type: array schema-version: - $ref: '#/components/schemas/ServiceDefinitionV2Version' + $ref: "#/components/schemas/ServiceDefinitionV2Version" tags: description: A set of custom tags. - example: - - my:tag - - service:tag + example: ["my:tag", "service:tag"] items: type: string type: array @@ -61957,15 +58874,15 @@ components: example: my-team type: string required: - - schema-version - - dd-service + - schema-version + - dd-service type: object ServiceDefinitionV2Contact: description: Service owner's contacts information. oneOf: - - $ref: '#/components/schemas/ServiceDefinitionV2Email' - - $ref: '#/components/schemas/ServiceDefinitionV2Slack' - - $ref: '#/components/schemas/ServiceDefinitionV2MSTeams' + - $ref: "#/components/schemas/ServiceDefinitionV2Email" + - $ref: "#/components/schemas/ServiceDefinitionV2Slack" + - $ref: "#/components/schemas/ServiceDefinitionV2MSTeams" ServiceDefinitionV2Doc: description: Service documents. properties: @@ -61979,28 +58896,26 @@ components: type: string url: description: Document URL. - example: https://gdrive/mydoc + example: "https://gdrive/mydoc" type: string required: - - name - - url + - name + - url type: object ServiceDefinitionV2Dot1: description: Service definition v2.1 for providing service metadata and integrations. properties: application: - description: Identifier for a group of related services serving a product - feature, which the service is a part of. + description: Identifier for a group of related services serving a product feature, which the service is a part of. example: my-app type: string contacts: description: A list of contacts related to the services. items: - $ref: '#/components/schemas/ServiceDefinitionV2Dot1Contact' + $ref: "#/components/schemas/ServiceDefinitionV2Dot1Contact" type: array dd-service: - description: Unique identifier of the service. Must be unique across all - services and is used to match with a service in Datadog. + description: Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog. example: my-service type: string description: @@ -62010,11 +58925,10 @@ components: extensions: additionalProperties: {} description: Extensions to v2.1 schema. - example: - myorg/extension: extensionValue + example: {"myorg/extension": "extensionValue"} type: object integrations: - $ref: '#/components/schemas/ServiceDefinitionV2Dot1Integrations' + $ref: "#/components/schemas/ServiceDefinitionV2Dot1Integrations" lifecycle: description: The current life cycle phase of the service. example: sandbox @@ -62022,21 +58936,18 @@ components: links: description: A list of links related to the services. items: - $ref: '#/components/schemas/ServiceDefinitionV2Dot1Link' + $ref: "#/components/schemas/ServiceDefinitionV2Dot1Link" type: array schema-version: - $ref: '#/components/schemas/ServiceDefinitionV2Dot1Version' + $ref: "#/components/schemas/ServiceDefinitionV2Dot1Version" tags: description: A set of custom tags. - example: - - my:tag - - service:tag + example: ["my:tag", "service:tag"] items: type: string type: array team: - description: Team that owns the service. It is used to locate a team defined - in Datadog Teams if it exists. + description: Team that owns the service. It is used to locate a team defined in Datadog Teams if it exists. example: my-team type: string tier: @@ -62044,15 +58955,15 @@ components: example: High type: string required: - - schema-version - - dd-service + - schema-version + - dd-service type: object ServiceDefinitionV2Dot1Contact: description: Service owner's contacts information. oneOf: - - $ref: '#/components/schemas/ServiceDefinitionV2Dot1Email' - - $ref: '#/components/schemas/ServiceDefinitionV2Dot1Slack' - - $ref: '#/components/schemas/ServiceDefinitionV2Dot1MSTeams' + - $ref: "#/components/schemas/ServiceDefinitionV2Dot1Email" + - $ref: "#/components/schemas/ServiceDefinitionV2Dot1Slack" + - $ref: "#/components/schemas/ServiceDefinitionV2Dot1MSTeams" ServiceDefinitionV2Dot1Email: description: Service owner's email. properties: @@ -62065,26 +58976,26 @@ components: example: Team Email type: string type: - $ref: '#/components/schemas/ServiceDefinitionV2Dot1EmailType' + $ref: "#/components/schemas/ServiceDefinitionV2Dot1EmailType" required: - - type - - contact + - type + - contact type: object ServiceDefinitionV2Dot1EmailType: description: Contact type. enum: - - email + - email example: email type: string x-enum-varnames: - - EMAIL + - EMAIL ServiceDefinitionV2Dot1Integrations: description: Third party integrations that Datadog supports. properties: opsgenie: - $ref: '#/components/schemas/ServiceDefinitionV2Dot1Opsgenie' + $ref: "#/components/schemas/ServiceDefinitionV2Dot1Opsgenie" pagerduty: - $ref: '#/components/schemas/ServiceDefinitionV2Dot1Pagerduty' + $ref: "#/components/schemas/ServiceDefinitionV2Dot1Pagerduty" type: object ServiceDefinitionV2Dot1Link: description: Service's external links. @@ -62098,32 +59009,32 @@ components: example: Github type: string type: - $ref: '#/components/schemas/ServiceDefinitionV2Dot1LinkType' + $ref: "#/components/schemas/ServiceDefinitionV2Dot1LinkType" url: description: Link URL. example: https://my-runbook type: string required: - - name - - type - - url + - name + - type + - url type: object ServiceDefinitionV2Dot1LinkType: description: Link type. enum: - - doc - - repo - - runbook - - dashboard - - other + - doc + - repo + - runbook + - dashboard + - other example: runbook type: string x-enum-varnames: - - DOC - - REPO - - RUNBOOK - - DASHBOARD - - OTHER + - DOC + - REPO + - RUNBOOK + - DASHBOARD + - OTHER ServiceDefinitionV2Dot1MSTeams: description: Service owner's Microsoft Teams. properties: @@ -62136,47 +59047,42 @@ components: example: My team channel type: string type: - $ref: '#/components/schemas/ServiceDefinitionV2Dot1MSTeamsType' + $ref: "#/components/schemas/ServiceDefinitionV2Dot1MSTeamsType" required: - - type - - contact + - type + - contact type: object ServiceDefinitionV2Dot1MSTeamsType: description: Contact type. enum: - - microsoft-teams + - microsoft-teams example: microsoft-teams type: string x-enum-varnames: - - MICROSOFT_TEAMS + - MICROSOFT_TEAMS ServiceDefinitionV2Dot1Opsgenie: description: Opsgenie integration for the service. properties: region: - $ref: '#/components/schemas/ServiceDefinitionV2Dot1OpsgenieRegion' + $ref: "#/components/schemas/ServiceDefinitionV2Dot1OpsgenieRegion" service-url: description: Opsgenie service url. - example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000 + example: "https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000" type: string - required: - - service-url + required: [service-url] type: object ServiceDefinitionV2Dot1OpsgenieRegion: description: Opsgenie instance region. - enum: - - US - - EU + enum: [US, EU] example: US type: string - x-enum-varnames: - - US - - EU + x-enum-varnames: [US, EU] ServiceDefinitionV2Dot1Pagerduty: description: PagerDuty integration for the service. properties: service-url: description: PagerDuty service url. - example: https://my-org.pagerduty.com/service-directory/PMyService + example: "https://my-org.pagerduty.com/service-directory/PMyService" type: string type: object ServiceDefinitionV2Dot1Slack: @@ -62191,52 +59097,48 @@ components: example: Team Slack type: string type: - $ref: '#/components/schemas/ServiceDefinitionV2Dot1SlackType' + $ref: "#/components/schemas/ServiceDefinitionV2Dot1SlackType" required: - - type - - contact + - type + - contact type: object ServiceDefinitionV2Dot1SlackType: description: Contact type. enum: - - slack + - slack example: slack type: string x-enum-varnames: - - SLACK + - SLACK ServiceDefinitionV2Dot1Version: default: v2.1 description: Schema version being used. enum: - - v2.1 + - v2.1 example: v2.1 type: string x-enum-varnames: - - V2_1 + - V2_1 ServiceDefinitionV2Dot2: description: Service definition v2.2 for providing service metadata and integrations. properties: application: - description: Identifier for a group of related services serving a product - feature, which the service is a part of. + description: Identifier for a group of related services serving a product feature, which the service is a part of. example: my-app type: string ci-pipeline-fingerprints: description: A set of CI fingerprints. - example: - - j88xdEy0J5lc - - eZ7LMljCk8vo + example: ["j88xdEy0J5lc", "eZ7LMljCk8vo"] items: type: string type: array contacts: description: A list of contacts related to the services. items: - $ref: '#/components/schemas/ServiceDefinitionV2Dot2Contact' + $ref: "#/components/schemas/ServiceDefinitionV2Dot2Contact" type: array dd-service: - description: Unique identifier of the service. Must be unique across all - services and is used to match with a service in Datadog. + description: Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog. example: my-service type: string description: @@ -62246,24 +59148,13 @@ components: extensions: additionalProperties: {} description: Extensions to v2.2 schema. - example: - myorg/extension: extensionValue + example: {"myorg/extension": "extensionValue"} type: object integrations: - $ref: '#/components/schemas/ServiceDefinitionV2Dot2Integrations' + $ref: "#/components/schemas/ServiceDefinitionV2Dot2Integrations" languages: - description: 'The service''s programming language. Datadog recognizes the - following languages: `dotnet`, `go`, `java`, `js`, `php`, `python`, `ruby`, - and `c++`.' - example: - - dotnet - - go - - java - - js - - php - - python - - ruby - - c++ + description: "The service's programming language. Datadog recognizes the following languages: `dotnet`, `go`, `java`, `js`, `php`, `python`, `ruby`, and `c++`." + example: ["dotnet", "go", "java", "js", "php", "python", "ruby", "c++"] items: type: string type: array @@ -62274,21 +59165,18 @@ components: links: description: A list of links related to the services. items: - $ref: '#/components/schemas/ServiceDefinitionV2Dot2Link' + $ref: "#/components/schemas/ServiceDefinitionV2Dot2Link" type: array schema-version: - $ref: '#/components/schemas/ServiceDefinitionV2Dot2Version' + $ref: "#/components/schemas/ServiceDefinitionV2Dot2Version" tags: description: A set of custom tags. - example: - - my:tag - - service:tag + example: ["my:tag", "service:tag"] items: type: string type: array team: - description: Team that owns the service. It is used to locate a team defined - in Datadog Teams if it exists. + description: Team that owns the service. It is used to locate a team defined in Datadog Teams if it exists. example: my-team type: string tier: @@ -62296,10 +59184,10 @@ components: example: High type: string type: - $ref: '#/components/schemas/ServiceDefinitionV2Dot2Type' + $ref: "#/components/schemas/ServiceDefinitionV2Dot2Type" required: - - schema-version - - dd-service + - schema-version + - dd-service type: object ServiceDefinitionV2Dot2Contact: description: Service owner's contacts information. @@ -62313,21 +59201,20 @@ components: example: My team channel type: string type: - description: 'Contact type. Datadog recognizes the following types: `email`, - `slack`, and `microsoft-teams`.' + description: "Contact type. Datadog recognizes the following types: `email`, `slack`, and `microsoft-teams`." example: slack type: string required: - - type - - contact + - type + - contact type: object ServiceDefinitionV2Dot2Integrations: description: Third party integrations that Datadog supports. properties: opsgenie: - $ref: '#/components/schemas/ServiceDefinitionV2Dot2Opsgenie' + $ref: "#/components/schemas/ServiceDefinitionV2Dot2Opsgenie" pagerduty: - $ref: '#/components/schemas/ServiceDefinitionV2Dot2Pagerduty' + $ref: "#/components/schemas/ServiceDefinitionV2Dot2Pagerduty" type: object ServiceDefinitionV2Dot2Link: description: Service's external links. @@ -62341,8 +59228,7 @@ components: example: Github type: string type: - description: 'Link type. Datadog recognizes the following types: `runbook`, - `doc`, `repo`, `dashboard`, and `other`.' + description: "Link type. Datadog recognizes the following types: `runbook`, `doc`, `repo`, `dashboard`, and `other`." example: runbook type: string url: @@ -62350,53 +59236,48 @@ components: example: https://my-runbook type: string required: - - name - - type - - url + - name + - type + - url type: object ServiceDefinitionV2Dot2Opsgenie: description: Opsgenie integration for the service. properties: region: - $ref: '#/components/schemas/ServiceDefinitionV2Dot2OpsgenieRegion' + $ref: "#/components/schemas/ServiceDefinitionV2Dot2OpsgenieRegion" service-url: description: Opsgenie service url. - example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000 + example: "https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000" type: string - required: - - service-url + required: [service-url] type: object ServiceDefinitionV2Dot2OpsgenieRegion: description: Opsgenie instance region. - enum: - - US - - EU + enum: [US, EU] example: US type: string - x-enum-varnames: - - US - - EU + x-enum-varnames: [US, EU] ServiceDefinitionV2Dot2Pagerduty: description: PagerDuty integration for the service. properties: service-url: description: PagerDuty service url. - example: https://my-org.pagerduty.com/service-directory/PMyService + example: "https://my-org.pagerduty.com/service-directory/PMyService" type: string type: object ServiceDefinitionV2Dot2Type: - description: The type of service. + description: "The type of service." example: web type: string ServiceDefinitionV2Dot2Version: default: v2.2 description: Schema version being used. enum: - - v2.2 + - v2.2 example: v2.2 type: string x-enum-varnames: - - V2_2 + - V2_2 ServiceDefinitionV2Email: description: Service owner's email. properties: @@ -62409,26 +59290,26 @@ components: example: Team Email type: string type: - $ref: '#/components/schemas/ServiceDefinitionV2EmailType' + $ref: "#/components/schemas/ServiceDefinitionV2EmailType" required: - - type - - contact + - type + - contact type: object ServiceDefinitionV2EmailType: description: Contact type. enum: - - email + - email example: email type: string x-enum-varnames: - - EMAIL + - EMAIL ServiceDefinitionV2Integrations: description: Third party integrations that Datadog supports. properties: opsgenie: - $ref: '#/components/schemas/ServiceDefinitionV2Opsgenie' + $ref: "#/components/schemas/ServiceDefinitionV2Opsgenie" pagerduty: - $ref: '#/components/schemas/ServiceDefinitionV2Pagerduty' + $ref: "#/components/schemas/ServiceDefinitionV2Pagerduty" type: object ServiceDefinitionV2Link: description: Service's external links. @@ -62438,40 +59319,40 @@ components: example: Runbook type: string type: - $ref: '#/components/schemas/ServiceDefinitionV2LinkType' + $ref: "#/components/schemas/ServiceDefinitionV2LinkType" url: description: Link URL. example: https://my-runbook type: string required: - - name - - type - - url + - name + - type + - url type: object ServiceDefinitionV2LinkType: description: Link type. enum: - - doc - - wiki - - runbook - - url - - repo - - dashboard - - oncall - - code - - link + - doc + - wiki + - runbook + - url + - repo + - dashboard + - oncall + - code + - link example: runbook type: string x-enum-varnames: - - DOC - - WIKI - - RUNBOOK - - URL - - REPO - - DASHBOARD - - ONCALL - - CODE - - LINK + - DOC + - WIKI + - RUNBOOK + - URL + - REPO + - DASHBOARD + - ONCALL + - CODE + - LINK ServiceDefinitionV2MSTeams: description: Service owner's Microsoft Teams. properties: @@ -62484,41 +59365,36 @@ components: example: My team channel type: string type: - $ref: '#/components/schemas/ServiceDefinitionV2MSTeamsType' + $ref: "#/components/schemas/ServiceDefinitionV2MSTeamsType" required: - - type - - contact + - type + - contact type: object ServiceDefinitionV2MSTeamsType: description: Contact type. enum: - - microsoft-teams + - microsoft-teams example: microsoft-teams type: string x-enum-varnames: - - MICROSOFT_TEAMS + - MICROSOFT_TEAMS ServiceDefinitionV2Opsgenie: description: Opsgenie integration for the service. properties: region: - $ref: '#/components/schemas/ServiceDefinitionV2OpsgenieRegion' + $ref: "#/components/schemas/ServiceDefinitionV2OpsgenieRegion" service-url: description: Opsgenie service url. - example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000 + example: "https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000" type: string - required: - - service-url + required: [service-url] type: object ServiceDefinitionV2OpsgenieRegion: description: Opsgenie instance region. - enum: - - US - - EU + enum: [US, EU] example: US type: string - x-enum-varnames: - - US - - EU + x-enum-varnames: [US, EU] ServiceDefinitionV2Pagerduty: description: PagerDuty service URL for the service. example: https://my-org.pagerduty.com/service-directory/PMyService @@ -62536,11 +59412,11 @@ components: type: string url: description: Repository URL. - example: https://github.com/DataDog/schema + example: "https://github.com/DataDog/schema" type: string required: - - name - - url + - name + - url type: object ServiceDefinitionV2Slack: description: Service owner's Slack channel. @@ -62554,65 +59430,65 @@ components: example: Team Slack type: string type: - $ref: '#/components/schemas/ServiceDefinitionV2SlackType' + $ref: "#/components/schemas/ServiceDefinitionV2SlackType" required: - - type - - contact + - type + - contact type: object ServiceDefinitionV2SlackType: description: Contact type. enum: - - slack + - slack example: slack type: string x-enum-varnames: - - SLACK + - SLACK ServiceDefinitionV2Version: default: v2 description: Schema version being used. enum: - - v2 + - v2 example: v2 type: string x-enum-varnames: - - V2 + - V2 ServiceDefinitionsCreateRequest: description: Create service definitions request. oneOf: - - $ref: '#/components/schemas/ServiceDefinitionV2Dot2' - - $ref: '#/components/schemas/ServiceDefinitionV2Dot1' - - $ref: '#/components/schemas/ServiceDefinitionV2' - - $ref: '#/components/schemas/ServiceDefinitionRaw' + - $ref: "#/components/schemas/ServiceDefinitionV2Dot2" + - $ref: "#/components/schemas/ServiceDefinitionV2Dot1" + - $ref: "#/components/schemas/ServiceDefinitionV2" + - $ref: "#/components/schemas/ServiceDefinitionRaw" ServiceDefinitionsListResponse: description: Create service definitions response. properties: data: description: Data representing service definitions. items: - $ref: '#/components/schemas/ServiceDefinitionData' + $ref: "#/components/schemas/ServiceDefinitionData" type: array type: object ServiceList: properties: data: - $ref: '#/components/schemas/ServiceListData' + $ref: "#/components/schemas/ServiceListData" type: object ServiceListData: properties: attributes: - $ref: '#/components/schemas/ServiceListDataAttributes' + $ref: "#/components/schemas/ServiceListDataAttributes" id: type: string type: - $ref: '#/components/schemas/ServiceListDataType' + $ref: "#/components/schemas/ServiceListDataType" required: - - type + - type type: object ServiceListDataAttributes: properties: metadata: items: - $ref: '#/components/schemas/ServiceListDataAttributesMetadataItems' + $ref: "#/components/schemas/ServiceListDataAttributesMetadataItems" type: array services: items: @@ -62630,101 +59506,101 @@ components: default: services_list description: Services list resource type. enum: - - services_list + - services_list example: services_list type: string x-enum-varnames: - - SERVICES_LIST + - SERVICES_LIST ServiceNowAssignmentGroupAttributes: description: Attributes of a ServiceNow assignment group properties: assignment_group_name: description: The name of the assignment group - example: Network Team + example: "Network Team" type: string assignment_group_sys_id: description: The system ID of the assignment group in ServiceNow - example: abc123def456 + example: "abc123def456" type: string instance_id: description: The ID of the ServiceNow instance - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string required: - - instance_id - - assignment_group_name - - assignment_group_sys_id + - instance_id + - assignment_group_name + - assignment_group_sys_id type: object ServiceNowAssignmentGroupData: description: Data object for a ServiceNow assignment group properties: attributes: - $ref: '#/components/schemas/ServiceNowAssignmentGroupAttributes' + $ref: "#/components/schemas/ServiceNowAssignmentGroupAttributes" id: description: Unique identifier for the ServiceNow assignment group - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string type: - $ref: '#/components/schemas/ServiceNowAssignmentGroupType' + $ref: "#/components/schemas/ServiceNowAssignmentGroupType" required: - - id - - type - - attributes + - id + - type + - attributes type: object ServiceNowAssignmentGroupType: description: Type identifier for ServiceNow assignment group resources enum: - - assignment_groups + - assignment_groups example: assignment_groups type: string x-enum-varnames: - - ASSIGNMENT_GROUPS + - ASSIGNMENT_GROUPS ServiceNowAssignmentGroupsData: description: Array of ServiceNow assignment group data objects items: - $ref: '#/components/schemas/ServiceNowAssignmentGroupData' + $ref: "#/components/schemas/ServiceNowAssignmentGroupData" type: array ServiceNowAssignmentGroupsResponse: description: Response containing ServiceNow assignment groups properties: data: - $ref: '#/components/schemas/ServiceNowAssignmentGroupsData' + $ref: "#/components/schemas/ServiceNowAssignmentGroupsData" required: - - data + - data type: object ServiceNowBasicAuth: description: The definition of the `ServiceNowBasicAuth` object. properties: instance: description: The `ServiceNowBasicAuth` `instance`. - example: '' + example: "" type: string password: description: The `ServiceNowBasicAuth` `password`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/ServiceNowBasicAuthType' + $ref: "#/components/schemas/ServiceNowBasicAuthType" username: description: The `ServiceNowBasicAuth` `username`. - example: '' + example: "" type: string required: - - type - - instance - - username - - password + - type + - instance + - username + - password type: object ServiceNowBasicAuthType: description: The definition of the `ServiceNowBasicAuth` object. enum: - - ServiceNowBasicAuth + - ServiceNowBasicAuth example: ServiceNowBasicAuth type: string x-enum-varnames: - - SERVICENOWBASICAUTH + - SERVICENOWBASICAUTH ServiceNowBasicAuthUpdate: description: The definition of the `ServiceNowBasicAuth` object. properties: @@ -62735,168 +59611,168 @@ components: description: The `ServiceNowBasicAuthUpdate` `password`. type: string type: - $ref: '#/components/schemas/ServiceNowBasicAuthType' + $ref: "#/components/schemas/ServiceNowBasicAuthType" username: description: The `ServiceNowBasicAuthUpdate` `username`. type: string required: - - type + - type type: object ServiceNowBusinessServiceAttributes: description: Attributes of a ServiceNow business service properties: instance_id: description: The ID of the ServiceNow instance - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string service_name: description: The name of the business service - example: IT Support + example: "IT Support" type: string service_sys_id: description: The system ID of the business service in ServiceNow - example: abc123def456 + example: "abc123def456" type: string required: - - instance_id - - service_name - - service_sys_id + - instance_id + - service_name + - service_sys_id type: object ServiceNowBusinessServiceData: description: Data object for a ServiceNow business service properties: attributes: - $ref: '#/components/schemas/ServiceNowBusinessServiceAttributes' + $ref: "#/components/schemas/ServiceNowBusinessServiceAttributes" id: description: Unique identifier for the ServiceNow business service - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string type: - $ref: '#/components/schemas/ServiceNowBusinessServiceType' + $ref: "#/components/schemas/ServiceNowBusinessServiceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object ServiceNowBusinessServiceType: description: Type identifier for ServiceNow business service resources enum: - - business_services + - business_services example: business_services type: string x-enum-varnames: - - BUSINESS_SERVICES + - BUSINESS_SERVICES ServiceNowBusinessServicesData: description: Array of ServiceNow business service data objects items: - $ref: '#/components/schemas/ServiceNowBusinessServiceData' + $ref: "#/components/schemas/ServiceNowBusinessServiceData" type: array ServiceNowBusinessServicesResponse: description: Response containing ServiceNow business services properties: data: - $ref: '#/components/schemas/ServiceNowBusinessServicesData' + $ref: "#/components/schemas/ServiceNowBusinessServicesData" required: - - data + - data type: object ServiceNowCredentials: description: The definition of the `ServiceNowCredentials` object. oneOf: - - $ref: '#/components/schemas/ServiceNowBasicAuth' + - $ref: "#/components/schemas/ServiceNowBasicAuth" ServiceNowCredentialsUpdate: description: The definition of the `ServiceNowCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/ServiceNowBasicAuthUpdate' + - $ref: "#/components/schemas/ServiceNowBasicAuthUpdate" ServiceNowInstanceAttributes: description: Attributes of a ServiceNow instance properties: instance_name: description: The name of the ServiceNow instance - example: my-servicenow-instance + example: "my-servicenow-instance" type: string required: - - instance_name + - instance_name type: object ServiceNowInstanceData: description: Data object for a ServiceNow instance properties: attributes: - $ref: '#/components/schemas/ServiceNowInstanceAttributes' + $ref: "#/components/schemas/ServiceNowInstanceAttributes" id: description: Unique identifier for the ServiceNow instance - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string type: - $ref: '#/components/schemas/ServiceNowInstanceType' + $ref: "#/components/schemas/ServiceNowInstanceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object ServiceNowInstanceType: description: Type identifier for ServiceNow instance resources enum: - - instance + - instance example: instance type: string x-enum-varnames: - - INSTANCE + - INSTANCE ServiceNowInstancesData: description: Array of ServiceNow instance data objects items: - $ref: '#/components/schemas/ServiceNowInstanceData' + $ref: "#/components/schemas/ServiceNowInstanceData" type: array ServiceNowInstancesResponse: description: Response containing ServiceNow instances properties: data: - $ref: '#/components/schemas/ServiceNowInstancesData' + $ref: "#/components/schemas/ServiceNowInstancesData" required: - - data + - data type: object ServiceNowIntegration: description: The definition of the `ServiceNowIntegration` object. properties: credentials: - $ref: '#/components/schemas/ServiceNowCredentials' + $ref: "#/components/schemas/ServiceNowCredentials" type: - $ref: '#/components/schemas/ServiceNowIntegrationType' + $ref: "#/components/schemas/ServiceNowIntegrationType" required: - - type - - credentials + - type + - credentials type: object ServiceNowIntegrationType: description: The definition of the `ServiceNowIntegrationType` object. enum: - - ServiceNow + - ServiceNow example: ServiceNow type: string x-enum-varnames: - - SERVICENOW + - SERVICENOW ServiceNowIntegrationUpdate: description: The definition of the `ServiceNowIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/ServiceNowCredentialsUpdate' + $ref: "#/components/schemas/ServiceNowCredentialsUpdate" type: - $ref: '#/components/schemas/ServiceNowIntegrationType' + $ref: "#/components/schemas/ServiceNowIntegrationType" required: - - type + - type type: object ServiceNowTemplateAttributes: description: Attributes of a ServiceNow template properties: assignment_group_id: description: The ID of the assignment group - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string business_service_id: description: The ID of the business service - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string fields_mapping: @@ -62904,51 +59780,51 @@ components: type: string description: Custom field mappings for the template example: - category: software - priority: '1' + category: "software" + priority: "1" type: object handle_name: description: The handle name of the template - example: incident-template + example: "incident-template" type: string instance_id: description: The ID of the ServiceNow instance - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string servicenow_tablename: description: The name of the destination ServiceNow table - example: incident + example: "incident" type: string user_id: description: The ID of the user - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string required: - - instance_id - - handle_name - - servicenow_tablename + - instance_id + - handle_name + - servicenow_tablename type: object ServiceNowTemplateCreateRequest: description: Request to create a ServiceNow template properties: data: - $ref: '#/components/schemas/ServiceNowTemplateCreateRequestData' + $ref: "#/components/schemas/ServiceNowTemplateCreateRequestData" required: - - data + - data type: object ServiceNowTemplateCreateRequestAttributes: description: Attributes for creating a ServiceNow template properties: assignment_group_id: description: The ID of the assignment group - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string business_service_id: description: The ID of the business service - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string fields_mapping: @@ -62956,95 +59832,95 @@ components: type: string description: Custom field mappings for the template example: - category: software - priority: '1' + category: "software" + priority: "1" type: object handle_name: description: The handle name of the template - example: incident-template + example: "incident-template" type: string instance_id: description: The ID of the ServiceNow instance - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string servicenow_tablename: description: The name of the destination ServiceNow table - example: incident + example: "incident" type: string user_id: description: The ID of the user - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string required: - - instance_id - - handle_name - - servicenow_tablename + - instance_id + - handle_name + - servicenow_tablename type: object ServiceNowTemplateCreateRequestData: description: Data object for creating a ServiceNow template properties: attributes: - $ref: '#/components/schemas/ServiceNowTemplateCreateRequestAttributes' + $ref: "#/components/schemas/ServiceNowTemplateCreateRequestAttributes" type: - $ref: '#/components/schemas/ServiceNowTemplateType' + $ref: "#/components/schemas/ServiceNowTemplateType" required: - - type - - attributes + - type + - attributes type: object ServiceNowTemplateData: description: Data object for a ServiceNow template properties: attributes: - $ref: '#/components/schemas/ServiceNowTemplateAttributes' + $ref: "#/components/schemas/ServiceNowTemplateAttributes" id: description: Unique identifier for the ServiceNow template - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string type: - $ref: '#/components/schemas/ServiceNowTemplateType' + $ref: "#/components/schemas/ServiceNowTemplateType" required: - - id - - type - - attributes + - id + - type + - attributes type: object ServiceNowTemplateResponse: description: Response containing a single ServiceNow template properties: data: - $ref: '#/components/schemas/ServiceNowTemplateData' + $ref: "#/components/schemas/ServiceNowTemplateData" required: - - data + - data type: object ServiceNowTemplateType: description: Type identifier for ServiceNow template resources enum: - - servicenow_templates + - servicenow_templates example: servicenow_templates type: string x-enum-varnames: - - SERVICENOW_TEMPLATES + - SERVICENOW_TEMPLATES ServiceNowTemplateUpdateRequest: description: Request to update a ServiceNow template properties: data: - $ref: '#/components/schemas/ServiceNowTemplateUpdateRequestData' + $ref: "#/components/schemas/ServiceNowTemplateUpdateRequestData" required: - - data + - data type: object ServiceNowTemplateUpdateRequestAttributes: description: Attributes for updating a ServiceNow template properties: assignment_group_id: description: The ID of the assignment group - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string business_service_id: description: The ID of the business service - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string fields_mapping: @@ -63052,64 +59928,64 @@ components: type: string description: Custom field mappings for the template example: - category: hardware - priority: '2' + category: "hardware" + priority: "2" type: object handle_name: description: The handle name of the template - example: incident-template-updated + example: "incident-template-updated" type: string instance_id: description: The ID of the ServiceNow instance - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string servicenow_tablename: description: The name of the destination ServiceNow table - example: incident + example: "incident" type: string user_id: description: The ID of the user - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string required: - - instance_id - - handle_name - - servicenow_tablename + - instance_id + - handle_name + - servicenow_tablename type: object ServiceNowTemplateUpdateRequestData: description: Data object for updating a ServiceNow template properties: attributes: - $ref: '#/components/schemas/ServiceNowTemplateUpdateRequestAttributes' + $ref: "#/components/schemas/ServiceNowTemplateUpdateRequestAttributes" type: - $ref: '#/components/schemas/ServiceNowTemplateType' + $ref: "#/components/schemas/ServiceNowTemplateType" required: - - type - - attributes + - type + - attributes type: object ServiceNowTemplatesData: description: Array of ServiceNow template data objects items: - $ref: '#/components/schemas/ServiceNowTemplateData' + $ref: "#/components/schemas/ServiceNowTemplateData" type: array ServiceNowTemplatesResponse: description: Response containing ServiceNow templates properties: data: - $ref: '#/components/schemas/ServiceNowTemplatesData' + $ref: "#/components/schemas/ServiceNowTemplatesData" required: - - data + - data type: object ServiceNowTicket: description: ServiceNow ticket attached to case nullable: true properties: result: - $ref: '#/components/schemas/ServiceNowTicketResult' + $ref: "#/components/schemas/ServiceNowTicketResult" status: - $ref: '#/components/schemas/Case3rdPartyTicketStatus' + $ref: "#/components/schemas/Case3rdPartyTicketStatus" readOnly: true type: object ServiceNowTicketCreateAttributes: @@ -63117,42 +59993,42 @@ components: properties: assignment_group: description: ServiceNow assignment group - example: IT Support + example: "IT Support" type: string instance_name: description: ServiceNow instance name - example: my-instance + example: "my-instance" type: string required: - - instance_name + - instance_name type: object ServiceNowTicketCreateData: description: ServiceNow ticket creation data properties: attributes: - $ref: '#/components/schemas/ServiceNowTicketCreateAttributes' + $ref: "#/components/schemas/ServiceNowTicketCreateAttributes" type: - $ref: '#/components/schemas/ServiceNowTicketResourceType' + $ref: "#/components/schemas/ServiceNowTicketResourceType" required: - - type - - attributes + - type + - attributes type: object ServiceNowTicketCreateRequest: description: ServiceNow ticket creation request properties: data: - $ref: '#/components/schemas/ServiceNowTicketCreateData' + $ref: "#/components/schemas/ServiceNowTicketCreateData" required: - - data + - data type: object ServiceNowTicketResourceType: description: ServiceNow ticket resource type enum: - - tickets + - tickets example: tickets type: string x-enum-varnames: - - TICKETS + - TICKETS ServiceNowTicketResult: description: ServiceNow ticket information properties: @@ -63165,77 +60041,77 @@ components: properties: email: description: The email address of the user - example: john.doe@example.com + example: "john.doe@example.com" type: string full_name: description: The full name of the user - example: John Doe + example: "John Doe" type: string instance_id: description: The ID of the ServiceNow instance - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string user_name: description: The username of the ServiceNow user - example: john.doe + example: "john.doe" type: string user_sys_id: description: The system ID of the user in ServiceNow - example: abc123def456 + example: "abc123def456" type: string required: - - instance_id - - user_name - - user_sys_id - - email + - instance_id + - user_name + - user_sys_id + - email type: object ServiceNowUserData: description: Data object for a ServiceNow user properties: attributes: - $ref: '#/components/schemas/ServiceNowUserAttributes' + $ref: "#/components/schemas/ServiceNowUserAttributes" id: description: Unique identifier for the ServiceNow user - example: 65b3341b-0680-47f9-a6d4-134db45c603e + example: "65b3341b-0680-47f9-a6d4-134db45c603e" format: uuid type: string type: - $ref: '#/components/schemas/ServiceNowUserType' + $ref: "#/components/schemas/ServiceNowUserType" required: - - id - - type - - attributes + - id + - type + - attributes type: object ServiceNowUserType: description: Type identifier for ServiceNow user resources enum: - - users + - users example: users type: string x-enum-varnames: - - USERS + - USERS ServiceNowUsersData: description: Array of ServiceNow user data objects items: - $ref: '#/components/schemas/ServiceNowUserData' + $ref: "#/components/schemas/ServiceNowUserData" type: array ServiceNowUsersResponse: description: Response containing ServiceNow users properties: data: - $ref: '#/components/schemas/ServiceNowUsersData' + $ref: "#/components/schemas/ServiceNowUsersData" required: - - data + - data type: object SessionIdArray: properties: data: items: - $ref: '#/components/schemas/SessionIdData' + $ref: "#/components/schemas/SessionIdData" type: array required: - - data + - data type: object SessionIdData: properties: @@ -63243,17 +60119,17 @@ components: example: 00000000-0000-0000-0000-000000000001 type: string type: - $ref: '#/components/schemas/ViewershipHistorySessionDataType' + $ref: "#/components/schemas/ViewershipHistorySessionDataType" required: - - type + - type type: object Shift: description: An on-call shift with its associated data and relationships. example: data: attributes: - end: '2025-05-07T03:53:01.206662873Z' - start: '2025-05-07T02:53:01.206662814Z' + end: "2025-05-07T03:53:01.206662873Z" + start: "2025-05-07T02:53:01.206662814Z" id: 00000000-0000-0000-0000-000000000000 relationships: user: @@ -63262,36 +60138,36 @@ components: type: users type: shifts included: - - attributes: - email: foo@bar.com - name: User 1 - status: '' - id: 00000000-aba1-0000-0000-000000000000 - type: users + - attributes: + email: foo@bar.com + name: User 1 + status: "" + id: 00000000-aba1-0000-0000-000000000000 + type: users properties: data: - $ref: '#/components/schemas/ShiftData' + $ref: "#/components/schemas/ShiftData" nullable: true included: description: The `Shift` `included`. items: - $ref: '#/components/schemas/ShiftIncluded' + $ref: "#/components/schemas/ShiftIncluded" type: array type: object ShiftData: description: Data for an on-call shift. properties: attributes: - $ref: '#/components/schemas/ShiftDataAttributes' + $ref: "#/components/schemas/ShiftDataAttributes" id: description: The `ShiftData` `id`. type: string relationships: - $ref: '#/components/schemas/ShiftDataRelationships' + $ref: "#/components/schemas/ShiftDataRelationships" type: - $ref: '#/components/schemas/ShiftDataType' + $ref: "#/components/schemas/ShiftDataType" required: - - type + - type type: object ShiftDataAttributes: description: Attributes for an on-call shift. @@ -63309,137 +60185,126 @@ components: description: Relationships for an on-call shift. properties: user: - $ref: '#/components/schemas/ShiftDataRelationshipsUser' + $ref: "#/components/schemas/ShiftDataRelationshipsUser" type: object ShiftDataRelationshipsUser: - description: Defines the relationship between a shift and the user who is working - that shift. + description: "Defines the relationship between a shift and the user who is working that shift." properties: data: - $ref: '#/components/schemas/ShiftDataRelationshipsUserData' + $ref: "#/components/schemas/ShiftDataRelationshipsUserData" required: - - data + - data type: object ShiftDataRelationshipsUserData: - description: Represents a reference to the user assigned to this shift, containing - the user's ID and resource type. + description: "Represents a reference to the user assigned to this shift, containing the user's ID and resource type." properties: id: - description: Specifies the unique identifier of the user. - example: 00000000-0000-0000-0000-000000000000 + description: "Specifies the unique identifier of the user." + example: "00000000-0000-0000-0000-000000000000" type: string type: - $ref: '#/components/schemas/ShiftDataRelationshipsUserDataType' + $ref: "#/components/schemas/ShiftDataRelationshipsUserDataType" required: - - type - - id + - type + - id type: object ShiftDataRelationshipsUserDataType: default: users - description: Indicates that the related resource is of type 'users'. + description: "Indicates that the related resource is of type 'users'." enum: - - users + - users example: users type: string x-enum-varnames: - - USERS + - USERS ShiftDataType: default: shifts - description: Indicates that the resource is of type 'shifts'. + description: "Indicates that the resource is of type 'shifts'." enum: - - shifts + - shifts example: shifts type: string x-enum-varnames: - - SHIFTS + - SHIFTS ShiftIncluded: description: Included data for shift operations. oneOf: - - $ref: '#/components/schemas/ScheduleUser' + - $ref: "#/components/schemas/ScheduleUser" SimpleMonitorUserTemplate: description: A simplified version of a monitor user template. properties: created: - $ref: '#/components/schemas/MonitorUserTemplateCreated' + $ref: "#/components/schemas/MonitorUserTemplateCreated" description: - $ref: '#/components/schemas/MonitorUserTemplateDescription' + $ref: "#/components/schemas/MonitorUserTemplateDescription" id: - description: The unique identifier. The initial version will match the template - ID. - example: 00000000-0000-1234-0000-000000000000 + description: The unique identifier. The initial version will match the template ID. + example: "00000000-0000-1234-0000-000000000000" type: string monitor_definition: additionalProperties: {} - description: A valid monitor definition in the same format as the [V1 Monitor - API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor). - example: - message: You may need to add web hosts if this is consistently high. - name: Bytes received on host0 - query: avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100 - type: query alert + description: A valid monitor definition in the same format as the [V1 Monitor API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor). + example: {"message": "You may need to add web hosts if this is consistently high.", "name": "Bytes received on host0", "query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100", "type": "query alert"} type: object tags: - $ref: '#/components/schemas/MonitorUserTemplateTags' + $ref: "#/components/schemas/MonitorUserTemplateTags" template_variables: - $ref: '#/components/schemas/MonitorUserTemplateTemplateVariables' + $ref: "#/components/schemas/MonitorUserTemplateTemplateVariables" title: - $ref: '#/components/schemas/MonitorUserTemplateTitle' + $ref: "#/components/schemas/MonitorUserTemplateTitle" version: - $ref: '#/components/schemas/MonitorUserTemplateVersion' + $ref: "#/components/schemas/MonitorUserTemplateVersion" type: object SingleAggregatedConnectionResponseArray: description: List of aggregated connections. example: data: - - attributes: - bytes_sent_by_client: 100 - bytes_sent_by_server: 200 - group_bys: - client_team: - - networks - server_service: - - hucklebuck - packets_sent_by_client: 10 - packets_sent_by_server: 20 - rtt_micro_seconds: 800 - tcp_closed_connections: 30 - tcp_established_connections: 40 - tcp_refusals: 7 - tcp_resets: 5 - tcp_retransmits: 30 - tcp_timeouts: 6 - id: client_team:networks, server_service:hucklebuck - type: aggregated_connection + - attributes: + bytes_sent_by_client: 100 + bytes_sent_by_server: 200 + group_bys: + client_team: + - networks + server_service: + - hucklebuck + packets_sent_by_client: 10 + packets_sent_by_server: 20 + rtt_micro_seconds: 800 + tcp_closed_connections: 30 + tcp_established_connections: 40 + tcp_refusals: 7 + tcp_resets: 5 + tcp_retransmits: 30 + tcp_timeouts: 6 + id: client_team:networks, server_service:hucklebuck + type: aggregated_connection properties: data: description: Array of aggregated connection objects. items: - $ref: '#/components/schemas/SingleAggregatedConnectionResponseData' + $ref: "#/components/schemas/SingleAggregatedConnectionResponseData" type: array type: object SingleAggregatedConnectionResponseData: description: Object describing an aggregated connection. properties: attributes: - $ref: '#/components/schemas/SingleAggregatedConnectionResponseDataAttributes' + $ref: "#/components/schemas/SingleAggregatedConnectionResponseDataAttributes" id: - description: A unique identifier for the aggregated connection based on - the group by values. + description: A unique identifier for the aggregated connection based on the group by values. type: string type: - $ref: '#/components/schemas/SingleAggregatedConnectionResponseDataType' + $ref: "#/components/schemas/SingleAggregatedConnectionResponseDataType" type: object SingleAggregatedConnectionResponseDataAttributes: description: Attributes for an aggregated connection. properties: bytes_sent_by_client: - description: The total number of bytes sent by the client over the given - period. + description: The total number of bytes sent by the client over the given period. format: int64 type: integer bytes_sent_by_server: - description: The total number of bytes sent by the server over the given - period. + description: The total number of bytes sent by the server over the given period. format: int64 type: integer group_bys: @@ -63451,34 +60316,27 @@ components: description: The key, value pairs for each group by. type: object packets_sent_by_client: - description: The total number of packets sent by the client over the given - period. + description: The total number of packets sent by the client over the given period. format: int64 type: integer packets_sent_by_server: - description: The total number of packets sent by the server over the given - period. + description: The total number of packets sent by the server over the given period. format: int64 type: integer rtt_micro_seconds: - description: Measured as TCP smoothed round trip time in microseconds (the - time between a TCP frame being sent and acknowledged). + description: Measured as TCP smoothed round trip time in microseconds (the time between a TCP frame being sent and acknowledged). format: int64 type: integer tcp_closed_connections: - description: The number of TCP connections in a closed state. Measured in - connections per second from the client. + description: The number of TCP connections in a closed state. Measured in connections per second from the client. format: int64 type: integer tcp_established_connections: - description: The number of TCP connections in an established state. Measured - in connections per second from the client. + description: The number of TCP connections in an established state. Measured in connections per second from the client. format: int64 type: integer tcp_refusals: - description: The number of TCP connections that were refused by the server. - Typically this indicates an attempt to connect to an IP/port that is not - receiving connections, or a firewall/security misconfiguration. + description: The number of TCP connections that were refused by the server. Typically this indicates an attempt to connect to an IP/port that is not receiving connections, or a firewall/security misconfiguration. format: int64 type: integer tcp_resets: @@ -63486,76 +60344,73 @@ components: format: int64 type: integer tcp_retransmits: - description: TCP Retransmits represent detected failures that are retransmitted - to ensure delivery. Measured in count of retransmits from the client. + description: TCP Retransmits represent detected failures that are retransmitted to ensure delivery. Measured in count of retransmits from the client. format: int64 type: integer tcp_timeouts: - description: The number of TCP connections that timed out from the perspective - of the operating system. This can indicate general connectivity and latency - issues. + description: The number of TCP connections that timed out from the perspective of the operating system. This can indicate general connectivity and latency issues. format: int64 type: integer type: object SingleAggregatedConnectionResponseDataType: default: aggregated_connection - description: Aggregated connection resource type. + description: |- + Aggregated connection resource type. enum: - - aggregated_connection + - aggregated_connection type: string x-enum-varnames: - - AGGREGATED_CONNECTION + - AGGREGATED_CONNECTION SingleAggregatedDnsResponseArray: description: List of aggregated DNS flows. example: data: - - attributes: - group_bys: - - key: client_service - value: example-service - - key: network.dns_query - value: example.com - metrics: - - key: dns_total_requests - value: 100 - - key: dns_failures - value: 7 - - key: dns_successful_responses - value: 93 - - key: dns_failed_responses - value: 5 - - key: dns_timeouts - value: 2 - - key: dns_responses.nxdomain - value: 1 - - key: dns_responses.servfail - value: 1 - - key: dns_responses.other - value: 3 - - key: dns_success_latency_percentile - value: 50 - - key: dns_failure_latency_percentile - value: 75 - id: client_service:example-service,network.dns_query:example.com - type: aggregated_dns + - attributes: + group_bys: + - key: client_service + value: example-service + - key: network.dns_query + value: example.com + metrics: + - key: dns_total_requests + value: 100 + - key: dns_failures + value: 7 + - key: dns_successful_responses + value: 93 + - key: dns_failed_responses + value: 5 + - key: dns_timeouts + value: 2 + - key: dns_responses.nxdomain + value: 1 + - key: dns_responses.servfail + value: 1 + - key: dns_responses.other + value: 3 + - key: dns_success_latency_percentile + value: 50 + - key: dns_failure_latency_percentile + value: 75 + id: client_service:example-service,network.dns_query:example.com + type: aggregated_dns properties: data: description: Array of aggregated DNS objects. items: - $ref: '#/components/schemas/SingleAggregatedDnsResponseData' + $ref: "#/components/schemas/SingleAggregatedDnsResponseData" type: array type: object SingleAggregatedDnsResponseData: description: Object describing an aggregated DNS flow. properties: attributes: - $ref: '#/components/schemas/SingleAggregatedDnsResponseDataAttributes' + $ref: "#/components/schemas/SingleAggregatedDnsResponseDataAttributes" id: - description: A unique identifier for the aggregated DNS traffic based on - the group by values. + description: A unique identifier for the aggregated DNS traffic based on the group by values. type: string type: - $ref: '#/components/schemas/SingleAggregatedDnsResponseDataType' + $ref: "#/components/schemas/SingleAggregatedDnsResponseDataType" type: object SingleAggregatedDnsResponseDataAttributes: description: Attributes for an aggregated DNS flow. @@ -63563,12 +60418,12 @@ components: group_bys: description: The key, value pairs for each group by. items: - $ref: '#/components/schemas/SingleAggregatedDnsResponseDataAttributesGroupByItems' + $ref: "#/components/schemas/SingleAggregatedDnsResponseDataAttributesGroupByItems" type: array metrics: description: Metrics associated with an aggregated DNS flow. items: - $ref: '#/components/schemas/SingleAggregatedDnsResponseDataAttributesMetricsItems' + $ref: "#/components/schemas/SingleAggregatedDnsResponseDataAttributesMetricsItems" type: array type: object SingleAggregatedDnsResponseDataAttributesGroupByItems: @@ -63585,7 +60440,7 @@ components: description: Metrics associated with an aggregated DNS flow. properties: key: - $ref: '#/components/schemas/DnsMetricKey' + $ref: "#/components/schemas/DnsMetricKey" value: description: The metric value. format: int64 @@ -63593,12 +60448,13 @@ components: type: object SingleAggregatedDnsResponseDataType: default: aggregated_dns - description: Aggregated DNS resource type. + description: |- + Aggregated DNS resource type. enum: - - aggregated_dns + - aggregated_dns type: string x-enum-varnames: - - AGGREGATED_DNS + - AGGREGATED_DNS SlackIntegrationMetadata: description: Incident integration metadata for the Slack integration. properties: @@ -63606,10 +60462,10 @@ components: description: Array of Slack channels in this integration metadata. example: [] items: - $ref: '#/components/schemas/SlackIntegrationMetadataChannelItem' + $ref: "#/components/schemas/SlackIntegrationMetadataChannelItem" type: array required: - - channels + - channels type: object SlackIntegrationMetadataChannelItem: description: Item in the Slack integration metadata channel array. @@ -63620,7 +60476,7 @@ components: type: string channel_name: description: Name of the Slack channel. - example: '#example-channel-name' + example: "#example-channel-name" type: string redirect_url: description: URL redirecting to the Slack channel. @@ -63631,28 +60487,28 @@ components: example: T01234567 type: string required: - - channel_id - - channel_name - - redirect_url + - channel_id + - channel_name + - redirect_url type: object SlackTriggerWrapper: - description: Schema for a Slack-based trigger. + description: "Schema for a Slack-based trigger." properties: slackTrigger: - description: Trigger a workflow from Slack. The workflow must be published. + description: "Trigger a workflow from Slack. The workflow must be published." type: object startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - slackTrigger + - slackTrigger type: object SloReportCreateRequest: description: The SLO report request body. properties: data: - $ref: '#/components/schemas/SloReportCreateRequestData' + $ref: "#/components/schemas/SloReportCreateRequestData" required: - - data + - data type: object SloReportCreateRequestAttributes: description: The attributes portion of the SLO report request. @@ -63663,16 +60519,13 @@ components: format: int64 type: integer interval: - $ref: '#/components/schemas/SLOReportInterval' + $ref: "#/components/schemas/SLOReportInterval" query: - description: The query string used to filter SLO results. Some examples - of queries include `service:` and `slo-name`. - example: slo_type:metric + description: The query string used to filter SLO results. Some examples of queries include `service:` and `slo-name`. + example: "slo_type:metric" type: string timezone: - description: The timezone used to determine the start and end of each interval. - For example, weekly intervals start at 12am on Sunday in the specified - timezone. + description: The timezone used to determine the start and end of each interval. For example, weekly intervals start at 12am on Sunday in the specified timezone. example: America/New_York type: string to_ts: @@ -63681,33 +60534,33 @@ components: format: int64 type: integer required: - - query - - from_ts - - to_ts + - query + - from_ts + - to_ts type: object SloReportCreateRequestData: description: The data portion of the SLO report request. properties: attributes: - $ref: '#/components/schemas/SloReportCreateRequestAttributes' + $ref: "#/components/schemas/SloReportCreateRequestAttributes" required: - - attributes + - attributes type: object SloStatusData: description: The data portion of the SLO status response. properties: attributes: - $ref: '#/components/schemas/SloStatusDataAttributes' + $ref: "#/components/schemas/SloStatusDataAttributes" id: description: The ID of the SLO. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string type: - $ref: '#/components/schemas/SloStatusType' + $ref: "#/components/schemas/SloStatusType" required: - - id - - type - - attributes + - id + - type + - attributes type: object SloStatusDataAttributes: description: The attributes of the SLO status. @@ -63718,7 +60571,7 @@ components: format: double type: number raw_error_budget_remaining: - $ref: '#/components/schemas/RawErrorBudgetRemaining' + $ref: "#/components/schemas/RawErrorBudgetRemaining" sli: description: The current Service Level Indicator (SLI) value as a percentage. example: 99.95 @@ -63730,62 +60583,61 @@ components: format: int64 type: integer state: - description: The current state of the SLO (for example, `breached`, `warning`, - `ok`). + description: The current state of the SLO (for example, `breached`, `warning`, `ok`). example: ok type: string required: - - sli - - error_budget_remaining - - raw_error_budget_remaining - - state - - span_precision + - sli + - error_budget_remaining + - raw_error_budget_remaining + - state + - span_precision type: object SloStatusResponse: description: The SLO status response. properties: data: - $ref: '#/components/schemas/SloStatusData' + $ref: "#/components/schemas/SloStatusData" required: - - data + - data type: object SloStatusType: description: The type of the SLO status resource. enum: - - slo_status + - slo_status example: slo_status type: string x-enum-varnames: - - SLO_STATUS + - SLO_STATUS Snapshot: properties: data: - $ref: '#/components/schemas/SnapshotData' + $ref: "#/components/schemas/SnapshotData" type: object SnapshotArray: properties: data: items: - $ref: '#/components/schemas/SnapshotData' + $ref: "#/components/schemas/SnapshotData" type: array required: - - data + - data type: object SnapshotCreateRequest: properties: data: - $ref: '#/components/schemas/SnapshotCreateRequestData' + $ref: "#/components/schemas/SnapshotCreateRequestData" required: - - data + - data type: object SnapshotCreateRequestData: properties: attributes: - $ref: '#/components/schemas/SnapshotCreateRequestDataAttributes' + $ref: "#/components/schemas/SnapshotCreateRequestDataAttributes" type: - $ref: '#/components/schemas/SnapshotUpdateRequestDataType' + $ref: "#/components/schemas/SnapshotUpdateRequestDataType" required: - - type + - type type: object SnapshotCreateRequestDataAttributes: properties: @@ -63816,25 +60668,25 @@ components: example: /home type: string required: - - view_name - - device_type - - application_id - - snapshot_name - - event_id - - start - - is_device_type_selected_by_user + - view_name + - device_type + - application_id + - snapshot_name + - event_id + - start + - is_device_type_selected_by_user type: object SnapshotData: properties: attributes: - $ref: '#/components/schemas/SnapshotDataAttributes' + $ref: "#/components/schemas/SnapshotDataAttributes" id: readOnly: true type: string type: - $ref: '#/components/schemas/SnapshotUpdateRequestDataType' + $ref: "#/components/schemas/SnapshotUpdateRequestDataType" required: - - type + - type type: object SnapshotDataAttributes: properties: @@ -63883,21 +60735,21 @@ components: SnapshotUpdateRequest: properties: data: - $ref: '#/components/schemas/SnapshotUpdateRequestData' + $ref: "#/components/schemas/SnapshotUpdateRequestData" required: - - data + - data type: object SnapshotUpdateRequestData: properties: attributes: - $ref: '#/components/schemas/SnapshotUpdateRequestDataAttributes' + $ref: "#/components/schemas/SnapshotUpdateRequestDataAttributes" id: example: 00000000-0000-0000-0000-000000000001 type: string type: - $ref: '#/components/schemas/SnapshotUpdateRequestDataType' + $ref: "#/components/schemas/SnapshotUpdateRequestDataType" required: - - type + - type type: object SnapshotUpdateRequestDataAttributes: properties: @@ -63916,63 +60768,62 @@ components: view_id: type: string required: - - event_id - - start - - is_device_type_selected_by_user + - event_id + - start + - is_device_type_selected_by_user type: object SnapshotUpdateRequestDataType: default: snapshots description: Snapshots resource type. enum: - - snapshots + - snapshots example: snapshots type: string x-enum-varnames: - - SNAPSHOTS + - SNAPSHOTS SoftwareCatalogTriggerWrapper: - description: Schema for a Software Catalog-based trigger. + description: "Schema for a Software Catalog-based trigger." properties: softwareCatalogTrigger: - description: Trigger a workflow from Software Catalog. + description: "Trigger a workflow from Software Catalog." type: object startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" required: - - softwareCatalogTrigger + - softwareCatalogTrigger type: object SortDirection: default: desc description: The direction to sort by. enum: - - desc - - asc + - desc + - asc type: string x-enum-varnames: - - DESC - - ASC + - DESC + - ASC Span: - description: Object description of a spans after being processed and stored - by Datadog. + description: Object description of a spans after being processed and stored by Datadog. properties: attributes: - $ref: '#/components/schemas/SpansAttributes' + $ref: "#/components/schemas/SpansAttributes" id: description: Unique ID of the Span. - example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA + example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA" type: string type: - $ref: '#/components/schemas/SpansType' + $ref: "#/components/schemas/SpansType" type: object SpansAggregateBucket: description: Spans aggregate. properties: attributes: - $ref: '#/components/schemas/SpansAggregateBucketAttributes' + $ref: "#/components/schemas/SpansAggregateBucketAttributes" id: description: ID of the spans aggregate. type: string type: - $ref: '#/components/schemas/SpansAggregateBucketType' + $ref: "#/components/schemas/SpansAggregateBucketType" type: object SpansAggregateBucketAttributes: description: A bucket values. @@ -63981,34 +60832,29 @@ components: additionalProperties: description: The values for each group by. description: The key, value pairs for each group by. - example: - '@state': success - '@version': abc + example: {"@state": "success", "@version": "abc"} type: object compute: description: The compute data. type: object computes: additionalProperties: - $ref: '#/components/schemas/SpansAggregateBucketValue' - description: A map of the metric name -> value for regular compute or list - of values for a timeseries. + $ref: "#/components/schemas/SpansAggregateBucketValue" + description: A map of the metric name -> value for regular compute or list of values for a timeseries. type: object type: object SpansAggregateBucketType: description: The spans aggregate bucket type. - enum: - - bucket - example: bucket + enum: ["bucket"] + example: "bucket" type: string - x-enum-varnames: - - BUCKET + x-enum-varnames: ["BUCKET"] SpansAggregateBucketValue: description: A bucket value, can be either a timeseries or a single value. oneOf: - - $ref: '#/components/schemas/SpansAggregateBucketValueSingleString' - - $ref: '#/components/schemas/SpansAggregateBucketValueSingleNumber' - - $ref: '#/components/schemas/SpansAggregateBucketValueTimeseries' + - $ref: "#/components/schemas/SpansAggregateBucketValueSingleString" + - $ref: "#/components/schemas/SpansAggregateBucketValueSingleNumber" + - $ref: "#/components/schemas/SpansAggregateBucketValueTimeseries" SpansAggregateBucketValueSingleNumber: description: A single number value. format: double @@ -64019,7 +60865,7 @@ components: SpansAggregateBucketValueTimeseries: description: A timeseries array. items: - $ref: '#/components/schemas/SpansAggregateBucketValueTimeseriesPoint' + $ref: "#/components/schemas/SpansAggregateBucketValueTimeseriesPoint" type: array x-generate-alias-as-model: true SpansAggregateBucketValueTimeseriesPoint: @@ -64027,7 +60873,7 @@ components: properties: time: description: The time value for this point. - example: '2023-06-08T11:55:00Z' + example: "2023-06-08T11:55:00Z" type: string value: description: The value for this point. @@ -64039,55 +60885,52 @@ components: description: The object containing the query content. properties: attributes: - $ref: '#/components/schemas/SpansAggregateRequestAttributes' + $ref: "#/components/schemas/SpansAggregateRequestAttributes" type: - $ref: '#/components/schemas/SpansAggregateRequestType' + $ref: "#/components/schemas/SpansAggregateRequestType" type: object SpansAggregateRequest: - description: The object sent with the request to retrieve a list of aggregated - spans from your organization. + description: The object sent with the request to retrieve a list of aggregated spans from your organization. properties: data: - $ref: '#/components/schemas/SpansAggregateData' + $ref: "#/components/schemas/SpansAggregateData" type: object SpansAggregateRequestAttributes: description: The object containing all the query parameters. properties: compute: - description: The list of metrics or timeseries to compute for the retrieved - buckets. + description: The list of metrics or timeseries to compute for the retrieved buckets. items: - $ref: '#/components/schemas/SpansCompute' + $ref: "#/components/schemas/SpansCompute" type: array filter: - $ref: '#/components/schemas/SpansQueryFilter' + $ref: "#/components/schemas/SpansQueryFilter" group_by: description: The rules for the group by. items: - $ref: '#/components/schemas/SpansGroupBy' + $ref: "#/components/schemas/SpansGroupBy" type: array options: - $ref: '#/components/schemas/SpansQueryOptions' + $ref: "#/components/schemas/SpansQueryOptions" type: object SpansAggregateRequestType: default: aggregate_request description: The type of resource. The value should always be aggregate_request. enum: - - aggregate_request + - aggregate_request example: aggregate_request type: string - x-enum-varnames: - - AGGREGATE_REQUEST + x-enum-varnames: ["AGGREGATE_REQUEST"] SpansAggregateResponse: description: The response object for the spans aggregate API endpoint. properties: data: description: The list of matching buckets, one item per bucket. items: - $ref: '#/components/schemas/SpansAggregateBucket' + $ref: "#/components/schemas/SpansAggregateBucket" type: array meta: - $ref: '#/components/schemas/SpansAggregateResponseMetadata' + $ref: "#/components/schemas/SpansAggregateResponseMetadata" type: object SpansAggregateResponseMetadata: description: The metadata associated with a request. @@ -64099,96 +60942,58 @@ components: type: integer request_id: description: The identifier of the request. - example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR + example: "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR" type: string status: - $ref: '#/components/schemas/SpansAggregateResponseStatus' + $ref: "#/components/schemas/SpansAggregateResponseStatus" warnings: - description: 'A list of warnings (non fatal errors) encountered, partial - results might be returned if - - warnings are present in the response.' + description: |- + A list of warnings (non fatal errors) encountered, partial results might be returned if + warnings are present in the response. items: - $ref: '#/components/schemas/SpansWarning' + $ref: "#/components/schemas/SpansWarning" type: array type: object SpansAggregateResponseStatus: description: The status of the response. - enum: - - done - - timeout - example: done + enum: ["done", "timeout"] + example: "done" type: string - x-enum-varnames: - - DONE - - TIMEOUT + x-enum-varnames: ["DONE", "TIMEOUT"] SpansAggregateSort: description: A sort rule. - example: - aggregation: count - order: asc + example: {"aggregation": "count", "order": "asc"} properties: aggregation: - $ref: '#/components/schemas/SpansAggregationFunction' + $ref: "#/components/schemas/SpansAggregationFunction" metric: description: The metric to sort by (only used for `type=measure`). - example: '@duration' + example: "@duration" type: string order: - $ref: '#/components/schemas/SpansSortOrder' + $ref: "#/components/schemas/SpansSortOrder" type: - $ref: '#/components/schemas/SpansAggregateSortType' + $ref: "#/components/schemas/SpansAggregateSortType" type: object SpansAggregateSortType: - default: alphabetical + default: "alphabetical" description: The type of sorting algorithm. - enum: - - alphabetical - - measure + enum: ["alphabetical", "measure"] type: string - x-enum-varnames: - - ALPHABETICAL - - MEASURE + x-enum-varnames: ["ALPHABETICAL", "MEASURE"] SpansAggregationFunction: description: An aggregation function. - enum: - - count - - cardinality - - pc75 - - pc90 - - pc95 - - pc98 - - pc99 - - sum - - min - - max - - avg - - median - example: pc90 - type: string - x-enum-varnames: - - COUNT - - CARDINALITY - - PERCENTILE_75 - - PERCENTILE_90 - - PERCENTILE_95 - - PERCENTILE_98 - - PERCENTILE_99 - - SUM - - MIN - - MAX - - AVG - - MEDIAN + enum: ["count", "cardinality", "pc75", "pc90", "pc95", "pc98", "pc99", "sum", "min", "max", "avg", "median"] + example: "pc90" + type: string + x-enum-varnames: ["COUNT", "CARDINALITY", "PERCENTILE_75", "PERCENTILE_90", "PERCENTILE_95", "PERCENTILE_98", "PERCENTILE_99", "SUM", "MIN", "MAX", "AVG", "MEDIAN"] SpansAttributes: - description: JSON object containing all span attributes and their associated - values. + description: JSON object containing all span attributes and their associated values. properties: attributes: additionalProperties: {} description: JSON object of attributes from your span. - example: - customAttribute: 123 - duration: 2345 + example: {"customAttribute": 123, "duration": 2345} type: object custom: additionalProperties: {} @@ -64196,153 +61001,147 @@ components: type: object end_timestamp: description: End timestamp of your span. - example: '2023-01-02T09:42:36.420Z' + example: "2023-01-02T09:42:36.420Z" format: date-time type: string env: - description: Name of the environment from where the spans are being sent. - example: prod + description: |- + Name of the environment from where the spans are being sent. + example: "prod" type: string host: - description: Name of the machine from where the spans are being sent. - example: i-0123 + description: |- + Name of the machine from where the spans are being sent. + example: "i-0123" type: string ingestion_reason: description: The reason why the span was ingested. - example: rule + example: "rule" type: string parent_id: description: Id of the span that's parent of this span. - example: '0' + example: "0" type: string resource_hash: description: Unique identifier of the resource. - example: a12345678b91c23d + example: "a12345678b91c23d" type: string resource_name: description: The name of the resource. - example: agent + example: "agent" type: string retained_by: description: The reason why the span was indexed. - example: retention_filter + example: "retention_filter" type: string service: - description: 'The name of the application or service generating the span - events. - + description: |- + The name of the application or service generating the span events. It is used to switch from APM to Logs, so make sure you define the same - - value when you use both products.' - example: agent + value when you use both products. + example: "agent" type: string single_span: - description: Whether or not the span was collected as a stand-alone span. - Always associated to "single_span" ingestion_reason if true. + description: |- + Whether or not the span was collected as a stand-alone span. Always associated to "single_span" ingestion_reason if true. example: true type: boolean span_id: description: Id of the span. - example: '1234567890987654321' + example: "1234567890987654321" type: string start_timestamp: description: Start timestamp of your span. - example: '2023-01-02T09:42:36.320Z' + example: "2023-01-02T09:42:36.320Z" format: date-time type: string tags: description: Array of tags associated with your span. - example: - - team:A + example: ["team:A"] items: description: Tag associated with your span. type: string type: array trace_id: description: Id of the trace to which the span belongs. - example: '1234567890987654321' + example: "1234567890987654321" type: string type: description: The type of the span. - example: web + example: "web" type: string type: object SpansCompute: description: A compute rule to compute metrics or timeseries. properties: aggregation: - $ref: '#/components/schemas/SpansAggregationFunction' + $ref: "#/components/schemas/SpansAggregationFunction" interval: - description: 'The time buckets'' size (only used for type=timeseries) - - Defaults to a resolution of 150 points.' - example: 5m + description: |- + The time buckets' size (only used for type=timeseries) + Defaults to a resolution of 150 points. + example: "5m" type: string metric: description: The metric to use. - example: '@duration' + example: "@duration" type: string type: - $ref: '#/components/schemas/SpansComputeType' + $ref: "#/components/schemas/SpansComputeType" required: - - aggregation + - aggregation type: object SpansComputeType: - default: total + default: "total" description: The type of compute. - enum: - - timeseries - - total + enum: ["timeseries", "total"] type: string - x-enum-varnames: - - TIMESERIES - - TOTAL + x-enum-varnames: ["TIMESERIES", "TOTAL"] SpansFilter: description: The spans filter used to index spans. properties: query: description: The search query - following the [span search syntax](https://docs.datadoghq.com/tracing/trace_explorer/query_syntax/). - example: '@http.status_code:200 service:my-service' + example: "@http.status_code:200 service:my-service" type: string type: object SpansFilterCreate: - description: The spans filter. Spans matching this filter will be indexed and - stored. + description: The spans filter. Spans matching this filter will be indexed and stored. properties: query: description: The search query - following the [span search syntax](https://docs.datadoghq.com/tracing/trace_explorer/query_syntax/). - example: '@http.status_code:200 service:my-service' + example: "@http.status_code:200 service:my-service" type: string required: - - query + - query type: object SpansGroupBy: description: A group by rule. properties: facet: description: The name of the facet to use (required). - example: host + example: "host" type: string histogram: - $ref: '#/components/schemas/SpansGroupByHistogram' + $ref: "#/components/schemas/SpansGroupByHistogram" limit: default: 10 description: The maximum buckets to return for this group by. format: int64 type: integer missing: - $ref: '#/components/schemas/SpansGroupByMissing' + $ref: "#/components/schemas/SpansGroupByMissing" sort: - $ref: '#/components/schemas/SpansAggregateSort' + $ref: "#/components/schemas/SpansAggregateSort" total: - $ref: '#/components/schemas/SpansGroupByTotal' + $ref: "#/components/schemas/SpansGroupByTotal" required: - - facet + - facet type: object SpansGroupByHistogram: - description: 'Used to perform a histogram computation (only for measure facets). - - Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.' + description: |- + Used to perform a histogram computation (only for measure facets). + Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval. properties: interval: description: The bin size of the histogram buckets. @@ -64350,30 +61149,29 @@ components: format: double type: number max: - description: 'The maximum value for the measure used in the histogram - - (values greater than this one are filtered out).' + description: |- + The maximum value for the measure used in the histogram + (values greater than this one are filtered out). example: 100 format: double type: number min: - description: 'The minimum value for the measure used in the histogram - - (values smaller than this one are filtered out).' + description: |- + The minimum value for the measure used in the histogram + (values smaller than this one are filtered out). example: 50 format: double type: number required: - - interval - - min - - max + - interval + - min + - max type: object SpansGroupByMissing: - description: The value to use for spans that don't have the facet used to group - by. + description: The value to use for spans that don't have the facet used to group by. oneOf: - - $ref: '#/components/schemas/SpansGroupByMissingString' - - $ref: '#/components/schemas/SpansGroupByMissingNumber' + - $ref: "#/components/schemas/SpansGroupByMissingString" + - $ref: "#/components/schemas/SpansGroupByMissingNumber" SpansGroupByMissingNumber: description: The missing value to use if there is a number valued facet. format: double @@ -64383,12 +61181,12 @@ components: type: string SpansGroupByTotal: default: false - description: A resulting object to put the given computes in over all the matching - records. + description: |- + A resulting object to put the given computes in over all the matching records. oneOf: - - $ref: '#/components/schemas/SpansGroupByTotalBoolean' - - $ref: '#/components/schemas/SpansGroupByTotalString' - - $ref: '#/components/schemas/SpansGroupByTotalNumber' + - $ref: "#/components/schemas/SpansGroupByTotalBoolean" + - $ref: "#/components/schemas/SpansGroupByTotalString" + - $ref: "#/components/schemas/SpansGroupByTotalNumber" SpansGroupByTotalBoolean: description: If set to true, creates an additional bucket labeled "$facet_total". type: boolean @@ -64403,35 +61201,35 @@ components: description: The request for a spans list. properties: data: - $ref: '#/components/schemas/SpansListRequestData' + $ref: "#/components/schemas/SpansListRequestData" type: object SpansListRequestAttributes: description: The object containing all the query parameters. properties: filter: - $ref: '#/components/schemas/SpansQueryFilter' + $ref: "#/components/schemas/SpansQueryFilter" options: - $ref: '#/components/schemas/SpansQueryOptions' + $ref: "#/components/schemas/SpansQueryOptions" page: - $ref: '#/components/schemas/SpansListRequestPage' + $ref: "#/components/schemas/SpansListRequestPage" sort: - $ref: '#/components/schemas/SpansSort' + $ref: "#/components/schemas/SpansSort" type: object SpansListRequestData: description: The object containing the query content. properties: attributes: - $ref: '#/components/schemas/SpansListRequestAttributes' + $ref: "#/components/schemas/SpansListRequestAttributes" type: - $ref: '#/components/schemas/SpansListRequestType' + $ref: "#/components/schemas/SpansListRequestType" type: object SpansListRequestPage: description: Paging attributes for listing spans. properties: cursor: - description: List following results with a cursor provided in the previous - query. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + List following results with a cursor provided in the previous query. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string limit: default: 10 @@ -64445,34 +61243,31 @@ components: default: search_request description: The type of resource. The value should always be search_request. enum: - - search_request + - search_request example: search_request type: string - x-enum-varnames: - - SEARCH_REQUEST + x-enum-varnames: ["SEARCH_REQUEST"] SpansListResponse: - description: Response object with all spans matching the request and pagination - information. + description: Response object with all spans matching the request and pagination information. properties: data: description: Array of spans matching the request. items: - $ref: '#/components/schemas/Span' + $ref: "#/components/schemas/Span" type: array links: - $ref: '#/components/schemas/SpansListResponseLinks' + $ref: "#/components/schemas/SpansListResponseLinks" meta: - $ref: '#/components/schemas/SpansListResponseMetadata' + $ref: "#/components/schemas/SpansListResponseMetadata" type: object SpansListResponseLinks: description: Links attributes. properties: next: - description: 'Link for the next set of results. Note that the request can - also be made using the - - POST endpoint.' - example: https://app.datadoghq.com/api/v2/spans/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + Link for the next set of results. Note that the request can also be made using the + POST endpoint. + example: "https://app.datadoghq.com/api/v2/spans/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string type: object SpansListResponseMetadata: @@ -64484,232 +61279,217 @@ components: format: int64 type: integer page: - $ref: '#/components/schemas/SpansResponseMetadataPage' + $ref: "#/components/schemas/SpansResponseMetadataPage" request_id: description: The identifier of the request. - example: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR + example: "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR" type: string status: - $ref: '#/components/schemas/SpansAggregateResponseStatus' + $ref: "#/components/schemas/SpansAggregateResponseStatus" warnings: - description: 'A list of warnings (non fatal errors) encountered, partial - results might be returned if - - warnings are present in the response.' + description: |- + A list of warnings (non fatal errors) encountered, partial results might be returned if + warnings are present in the response. items: - $ref: '#/components/schemas/SpansWarning' + $ref: "#/components/schemas/SpansWarning" type: array type: object SpansMetricCompute: description: The compute rule to compute the span-based metric. properties: aggregation_type: - $ref: '#/components/schemas/SpansMetricComputeAggregationType' + $ref: "#/components/schemas/SpansMetricComputeAggregationType" include_percentiles: - $ref: '#/components/schemas/SpansMetricComputeIncludePercentiles' + $ref: "#/components/schemas/SpansMetricComputeIncludePercentiles" path: - description: The path to the value the span-based metric will aggregate - on (only used if the aggregation type is a "distribution"). - example: '@duration' + description: The path to the value the span-based metric will aggregate on (only used if the aggregation type is a "distribution"). + example: "@duration" type: string required: - - aggregation_type + - aggregation_type type: object SpansMetricComputeAggregationType: description: The type of aggregation to use. - enum: - - count - - distribution - example: distribution + enum: ["count", "distribution"] + example: "distribution" type: string - x-enum-varnames: - - COUNT - - DISTRIBUTION + x-enum-varnames: ["COUNT", "DISTRIBUTION"] SpansMetricComputeIncludePercentiles: - description: 'Toggle to include or exclude percentile aggregations for distribution - metrics. - - Only present when the `aggregation_type` is `distribution`.' + description: |- + Toggle to include or exclude percentile aggregations for distribution metrics. + Only present when the `aggregation_type` is `distribution`. example: false type: boolean SpansMetricCreateAttributes: description: The object describing the Datadog span-based metric to create. properties: compute: - $ref: '#/components/schemas/SpansMetricCompute' + $ref: "#/components/schemas/SpansMetricCompute" filter: - $ref: '#/components/schemas/SpansMetricFilter' + $ref: "#/components/schemas/SpansMetricFilter" group_by: description: The rules for the group by. items: - $ref: '#/components/schemas/SpansMetricGroupBy' + $ref: "#/components/schemas/SpansMetricGroupBy" type: array required: - - compute + - compute type: object SpansMetricCreateData: description: The new span-based metric properties. properties: attributes: - $ref: '#/components/schemas/SpansMetricCreateAttributes' + $ref: "#/components/schemas/SpansMetricCreateAttributes" id: - $ref: '#/components/schemas/SpansMetricID' + $ref: "#/components/schemas/SpansMetricID" type: - $ref: '#/components/schemas/SpansMetricType' + $ref: "#/components/schemas/SpansMetricType" required: - - id - - type - - attributes + - id + - type + - attributes type: object SpansMetricCreateRequest: description: The new span-based metric body. properties: data: - $ref: '#/components/schemas/SpansMetricCreateData' + $ref: "#/components/schemas/SpansMetricCreateData" required: - - data + - data type: object SpansMetricFilter: - description: The span-based metric filter. Spans matching this filter will be - aggregated in this metric. + description: The span-based metric filter. Spans matching this filter will be aggregated in this metric. properties: query: - default: '*' + default: "*" description: The search query - following the span search syntax. - example: '@http.status_code:200 service:my-service' + example: "@http.status_code:200 service:my-service" type: string type: object SpansMetricGroupBy: description: A group by rule. properties: path: - description: The path to the value the span-based metric will be aggregated - over. - example: resource_name + description: The path to the value the span-based metric will be aggregated over. + example: "resource_name" type: string tag_name: - description: Eventual name of the tag that gets created. By default, the - path attribute is used as the tag name. - example: resource_name + description: Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. + example: "resource_name" type: string required: - - path + - path type: object SpansMetricID: description: The name of the span-based metric. - example: my.metric + example: "my.metric" type: string SpansMetricResponse: description: The span-based metric object. properties: data: - $ref: '#/components/schemas/SpansMetricResponseData' + $ref: "#/components/schemas/SpansMetricResponseData" type: object SpansMetricResponseAttributes: description: The object describing a Datadog span-based metric. properties: compute: - $ref: '#/components/schemas/SpansMetricResponseCompute' + $ref: "#/components/schemas/SpansMetricResponseCompute" filter: - $ref: '#/components/schemas/SpansMetricResponseFilter' + $ref: "#/components/schemas/SpansMetricResponseFilter" group_by: description: The rules for the group by. items: - $ref: '#/components/schemas/SpansMetricResponseGroupBy' + $ref: "#/components/schemas/SpansMetricResponseGroupBy" type: array type: object SpansMetricResponseCompute: description: The compute rule to compute the span-based metric. properties: aggregation_type: - $ref: '#/components/schemas/SpansMetricComputeAggregationType' + $ref: "#/components/schemas/SpansMetricComputeAggregationType" include_percentiles: - $ref: '#/components/schemas/SpansMetricComputeIncludePercentiles' + $ref: "#/components/schemas/SpansMetricComputeIncludePercentiles" path: - description: The path to the value the span-based metric will aggregate - on (only used if the aggregation type is a "distribution"). - example: '@duration' + description: The path to the value the span-based metric will aggregate on (only used if the aggregation type is a "distribution"). + example: "@duration" type: string type: object SpansMetricResponseData: description: The span-based metric properties. properties: attributes: - $ref: '#/components/schemas/SpansMetricResponseAttributes' + $ref: "#/components/schemas/SpansMetricResponseAttributes" id: - $ref: '#/components/schemas/SpansMetricID' + $ref: "#/components/schemas/SpansMetricID" type: - $ref: '#/components/schemas/SpansMetricType' + $ref: "#/components/schemas/SpansMetricType" type: object SpansMetricResponseFilter: - description: The span-based metric filter. Spans matching this filter will be - aggregated in this metric. + description: The span-based metric filter. Spans matching this filter will be aggregated in this metric. properties: query: description: The search query - following the span search syntax. - example: '@http.status_code:200 service:my-service' + example: "@http.status_code:200 service:my-service" type: string type: object SpansMetricResponseGroupBy: description: A group by rule. properties: path: - description: The path to the value the span-based metric will be aggregated - over. - example: resource_name + description: The path to the value the span-based metric will be aggregated over. + example: "resource_name" type: string tag_name: - description: Eventual name of the tag that gets created. By default, the - path attribute is used as the tag name. - example: resource_name + description: Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. + example: "resource_name" type: string type: object SpansMetricType: default: spans_metrics description: The type of resource. The value should always be spans_metrics. enum: - - spans_metrics + - spans_metrics example: spans_metrics type: string - x-enum-varnames: - - SPANS_METRICS + x-enum-varnames: ["SPANS_METRICS"] SpansMetricUpdateAttributes: description: The span-based metric properties that will be updated. properties: compute: - $ref: '#/components/schemas/SpansMetricUpdateCompute' + $ref: "#/components/schemas/SpansMetricUpdateCompute" filter: - $ref: '#/components/schemas/SpansMetricFilter' + $ref: "#/components/schemas/SpansMetricFilter" group_by: description: The rules for the group by. items: - $ref: '#/components/schemas/SpansMetricGroupBy' + $ref: "#/components/schemas/SpansMetricGroupBy" type: array type: object SpansMetricUpdateCompute: description: The compute rule to compute the span-based metric. properties: include_percentiles: - $ref: '#/components/schemas/SpansMetricComputeIncludePercentiles' + $ref: "#/components/schemas/SpansMetricComputeIncludePercentiles" type: object SpansMetricUpdateData: description: The new span-based metric properties. properties: attributes: - $ref: '#/components/schemas/SpansMetricUpdateAttributes' + $ref: "#/components/schemas/SpansMetricUpdateAttributes" type: - $ref: '#/components/schemas/SpansMetricType' + $ref: "#/components/schemas/SpansMetricType" required: - - type - - attributes + - type + - attributes type: object SpansMetricUpdateRequest: description: The new span-based metric body. properties: data: - $ref: '#/components/schemas/SpansMetricUpdateData' + $ref: "#/components/schemas/SpansMetricUpdateData" required: - - data + - data type: object SpansMetricsResponse: description: All the available span-based metric objects. @@ -64717,178 +61497,168 @@ components: data: description: A list of span-based metric objects. items: - $ref: '#/components/schemas/SpansMetricResponseData' + $ref: "#/components/schemas/SpansMetricResponseData" type: array type: object SpansQueryFilter: description: The search and filter query settings. properties: from: - default: now-15m - description: The minimum time for the requested spans, supports date-time - ISO8601, date math, and regular timestamps (milliseconds). - example: now-15m + default: "now-15m" + description: The minimum time for the requested spans, supports date-time ISO8601, date math, and regular timestamps (milliseconds). + example: "now-15m" type: string query: - default: '*' + default: "*" description: The search query - following the span search syntax. - example: service:web* AND @http.status_code:[200 TO 299] + example: "service:web* AND @http.status_code:[200 TO 299]" type: string to: - default: now - description: The maximum time for the requested spans, supports date-time - ISO8601, date math, and regular timestamps (milliseconds). - example: now + default: "now" + description: The maximum time for the requested spans, supports date-time ISO8601, date math, and regular timestamps (milliseconds). + example: "now" type: string type: object SpansQueryOptions: - description: 'Global query options that are used during the query. - - Note: You should only supply timezone or time offset but not both otherwise - the query will fail.' + description: |- + Global query options that are used during the query. + Note: You should only supply timezone or time offset but not both otherwise the query will fail. properties: timeOffset: description: The time offset (in seconds) to apply to the query. format: int64 type: integer timezone: - default: UTC - description: The timezone can be specified as GMT, UTC, an offset from UTC - (like UTC+1), or as a Timezone Database identifier (like America/New_York). - example: GMT + default: "UTC" + description: |- + The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York). + example: "GMT" type: string type: object SpansResponseMetadataPage: description: Paging attributes. properties: after: - description: 'The cursor to use to get the next results, if any. To make - the next request, use the same - - parameters with the addition of the `page[cursor]`.' - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + description: |- + The cursor to use to get the next results, if any. To make the next request, use the same + parameters with the addition of the `page[cursor]`. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" type: string type: object SpansSort: description: Sort parameters when querying spans. enum: - - timestamp - - -timestamp + - timestamp + - -timestamp type: string x-enum-varnames: - - TIMESTAMP_ASCENDING - - TIMESTAMP_DESCENDING + - TIMESTAMP_ASCENDING + - TIMESTAMP_DESCENDING SpansSortOrder: description: The order to use, ascending or descending. enum: - - asc - - desc - example: asc + - "asc" + - "desc" + example: "asc" type: string x-enum-varnames: - - ASCENDING - - DESCENDING + - "ASCENDING" + - "DESCENDING" SpansType: default: spans description: Type of the span. enum: - - spans - example: spans + - spans + example: "spans" type: string x-enum-varnames: - - SPANS + - SPANS SpansWarning: - description: A warning message indicating something that went wrong with the - query. + description: A warning message indicating something that went wrong with the query. properties: code: description: A unique code for this type of warning. - example: unknown_index + example: "unknown_index" type: string detail: description: A detailed explanation of this specific warning. - example: 'indexes: foo, bar' + example: "indexes: foo, bar" type: string title: description: A short human-readable summary of the warning. - example: One or several indexes are missing or invalid, results hold data - from the other indexes + example: "One or several indexes are missing or invalid, results hold data from the other indexes" type: string type: object Spec: description: The spec defines what the workflow does. properties: annotations: - description: A list of annotations used in the workflow. These are like - sticky notes for your workflow! + description: "A list of annotations used in the workflow. These are like sticky notes for your workflow!" items: - $ref: '#/components/schemas/Annotation' + $ref: "#/components/schemas/Annotation" type: array connectionEnvs: description: A list of connections or connection groups used in the workflow. items: - $ref: '#/components/schemas/ConnectionEnv' + $ref: "#/components/schemas/ConnectionEnv" type: array handle: - description: Unique identifier used to trigger workflows automatically in - Datadog. + description: Unique identifier used to trigger workflows automatically in Datadog. type: string inputSchema: - $ref: '#/components/schemas/InputSchema' + $ref: "#/components/schemas/InputSchema" outputSchema: - $ref: '#/components/schemas/OutputSchema' + $ref: "#/components/schemas/OutputSchema" steps: - description: A `Step` is a sub-component of a workflow. Each `Step` performs - an action. + description: A `Step` is a sub-component of a workflow. Each `Step` performs an action. items: - $ref: '#/components/schemas/Step' + $ref: "#/components/schemas/Step" type: array triggers: - description: The list of triggers that activate this workflow. At least - one trigger is required, and each trigger type may appear at most once. + description: The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once. items: - $ref: '#/components/schemas/Trigger' + $ref: "#/components/schemas/Trigger" type: array type: object SpecVersion: description: The version of the CycloneDX specification a BOM conforms to. enum: - - '1.0' - - '1.1' - - '1.2' - - '1.3' - - '1.4' - - '1.5' - example: '1.5' - type: string - x-enum-varnames: - - ONE_ZERO - - ONE_ONE - - ONE_TWO - - ONE_THREE - - ONE_FOUR - - ONE_FIVE + - "1.0" + - "1.1" + - "1.2" + - "1.3" + - "1.4" + - "1.5" + example: "1.5" + type: string + x-enum-varnames: + - ONE_ZERO + - ONE_ONE + - ONE_TWO + - ONE_THREE + - ONE_FOUR + - ONE_FIVE SplitAPIKey: description: The definition of the `SplitAPIKey` object. properties: api_key: description: The `SplitAPIKey` `api_key`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/SplitAPIKeyType' + $ref: "#/components/schemas/SplitAPIKeyType" required: - - type - - api_key + - type + - api_key type: object SplitAPIKeyType: description: The definition of the `SplitAPIKey` object. enum: - - SplitAPIKey + - SplitAPIKey example: SplitAPIKey type: string x-enum-varnames: - - SPLITAPIKEY + - SPLITAPIKEY SplitAPIKeyUpdate: description: The definition of the `SplitAPIKey` object. properties: @@ -64896,70 +61666,63 @@ components: description: The `SplitAPIKeyUpdate` `api_key`. type: string type: - $ref: '#/components/schemas/SplitAPIKeyType' + $ref: "#/components/schemas/SplitAPIKeyType" required: - - type + - type type: object SplitCredentials: description: The definition of the `SplitCredentials` object. oneOf: - - $ref: '#/components/schemas/SplitAPIKey' + - $ref: "#/components/schemas/SplitAPIKey" SplitCredentialsUpdate: description: The definition of the `SplitCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/SplitAPIKeyUpdate' + - $ref: "#/components/schemas/SplitAPIKeyUpdate" SplitIntegration: description: The definition of the `SplitIntegration` object. properties: credentials: - $ref: '#/components/schemas/SplitCredentials' + $ref: "#/components/schemas/SplitCredentials" type: - $ref: '#/components/schemas/SplitIntegrationType' + $ref: "#/components/schemas/SplitIntegrationType" required: - - type - - credentials + - type + - credentials type: object SplitIntegrationType: description: The definition of the `SplitIntegrationType` object. enum: - - Split + - Split example: Split type: string x-enum-varnames: - - SPLIT + - SPLIT SplitIntegrationUpdate: description: The definition of the `SplitIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/SplitCredentialsUpdate' + $ref: "#/components/schemas/SplitCredentialsUpdate" type: - $ref: '#/components/schemas/SplitIntegrationType' + $ref: "#/components/schemas/SplitIntegrationType" required: - - type + - type type: object StartStepNames: - description: A list of steps that run first after a trigger fires. + description: "A list of steps that run first after a trigger fires." example: - - '' + - "" items: description: The `StartStepNames` `items`. type: string type: array State: description: The state of the rule evaluation. - enum: - - pass - - fail - - skip + enum: [pass, fail, skip] example: pass type: string - x-enum-varnames: - - PASS - - FAIL - - SKIP + x-enum-varnames: [PASS, FAIL, SKIP] StateVariable: - description: A variable, which can be set and read by other components in the - app. + description: A variable, which can be set and read by other components in the app. properties: id: description: The ID of the state variable. @@ -64967,57 +61730,56 @@ components: format: uuid type: string name: - description: A unique identifier for this state variable. This name is also - used to access the variable's value throughout the app. - example: ordersToSubmit + description: A unique identifier for this state variable. This name is also used to access the variable's value throughout the app. + example: "ordersToSubmit" type: string properties: - $ref: '#/components/schemas/StateVariableProperties' + $ref: "#/components/schemas/StateVariableProperties" type: - $ref: '#/components/schemas/StateVariableType' + $ref: "#/components/schemas/StateVariableType" required: - - id - - name - - type - - properties + - id + - name + - type + - properties type: object StateVariableProperties: description: The properties of the state variable. properties: defaultValue: description: The default value of the state variable. - example: ${['order_3145', 'order_4920']} + example: "${['order_3145', 'order_4920']}" type: object StateVariableType: default: stateVariable description: The state variable type. enum: - - stateVariable + - stateVariable example: stateVariable type: string x-enum-varnames: - - STATEVARIABLE + - STATEVARIABLE StatsigAPIKey: description: The definition of the `StatsigAPIKey` object. properties: api_key: description: The `StatsigAPIKey` `api_key`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/StatsigAPIKeyType' + $ref: "#/components/schemas/StatsigAPIKeyType" required: - - type - - api_key + - type + - api_key type: object StatsigAPIKeyType: description: The definition of the `StatsigAPIKey` object. enum: - - StatsigAPIKey + - StatsigAPIKey example: StatsigAPIKey type: string x-enum-varnames: - - STATSIGAPIKEY + - STATSIGAPIKEY StatsigAPIKeyUpdate: description: The definition of the `StatsigAPIKey` object. properties: @@ -65025,93 +61787,91 @@ components: description: The `StatsigAPIKeyUpdate` `api_key`. type: string type: - $ref: '#/components/schemas/StatsigAPIKeyType' + $ref: "#/components/schemas/StatsigAPIKeyType" required: - - type + - type type: object StatsigCredentials: description: The definition of the `StatsigCredentials` object. oneOf: - - $ref: '#/components/schemas/StatsigAPIKey' + - $ref: "#/components/schemas/StatsigAPIKey" StatsigCredentialsUpdate: description: The definition of the `StatsigCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/StatsigAPIKeyUpdate' + - $ref: "#/components/schemas/StatsigAPIKeyUpdate" StatsigIntegration: description: The definition of the `StatsigIntegration` object. properties: credentials: - $ref: '#/components/schemas/StatsigCredentials' + $ref: "#/components/schemas/StatsigCredentials" type: - $ref: '#/components/schemas/StatsigIntegrationType' + $ref: "#/components/schemas/StatsigIntegrationType" required: - - type - - credentials + - type + - credentials type: object StatsigIntegrationType: description: The definition of the `StatsigIntegrationType` object. enum: - - Statsig + - Statsig example: Statsig type: string x-enum-varnames: - - STATSIG + - STATSIG StatsigIntegrationUpdate: description: The definition of the `StatsigIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/StatsigCredentialsUpdate' + $ref: "#/components/schemas/StatsigCredentialsUpdate" type: - $ref: '#/components/schemas/StatsigIntegrationType' + $ref: "#/components/schemas/StatsigIntegrationType" required: - - type + - type type: object StatusPage: properties: data: - $ref: '#/components/schemas/StatusPageData' + $ref: "#/components/schemas/StatusPageData" included: - description: The included related resources of a status page. Client must - explicitly request these resources by name in the `include` query parameter. + description: The included related resources of a status page. Client must explicitly request these resources by name in the `include` query parameter. items: - $ref: '#/components/schemas/StatusPageArrayIncluded' + $ref: "#/components/schemas/StatusPageArrayIncluded" type: array type: object StatusPageArray: properties: data: items: - $ref: '#/components/schemas/StatusPageData' + $ref: "#/components/schemas/StatusPageData" type: array included: - description: The included related resources of a status page. Client must - explicitly request these resources by name in the `include` query parameter. + description: The included related resources of a status page. Client must explicitly request these resources by name in the `include` query parameter. items: - $ref: '#/components/schemas/StatusPageArrayIncluded' + $ref: "#/components/schemas/StatusPageArrayIncluded" type: array meta: - $ref: '#/components/schemas/PaginationMeta' + $ref: "#/components/schemas/PaginationMeta" required: - - data + - data type: object StatusPageArrayIncluded: oneOf: - - $ref: '#/components/schemas/StatusPagesUser' + - $ref: "#/components/schemas/StatusPagesUser" StatusPageAsIncluded: description: The included status page resource. properties: attributes: - $ref: '#/components/schemas/StatusPageAsIncludedAttributes' + $ref: "#/components/schemas/StatusPageAsIncludedAttributes" id: description: The ID of the status page. format: uuid type: string relationships: - $ref: '#/components/schemas/StatusPageAsIncludedRelationships' + $ref: "#/components/schemas/StatusPageAsIncludedRelationships" type: - $ref: '#/components/schemas/StatusPageDataType' + $ref: "#/components/schemas/StatusPageDataType" required: - - type + - type type: object StatusPageAsIncludedAttributes: description: The attributes of a status page. @@ -65122,7 +61882,7 @@ components: components: description: Components displayed on the status page. items: - $ref: '#/components/schemas/StatusPageAsIncludedAttributesComponentsItems' + $ref: "#/components/schemas/StatusPageAsIncludedAttributesComponentsItems" type: array created_at: description: Timestamp of when the status page was created. @@ -65135,12 +61895,10 @@ components: description: Whether the custom domain is configured. type: boolean domain_prefix: - description: The subdomain of the status page's url taking the form `https://{domain_prefix}.statuspage.datadoghq.com`. - Globally unique across Datadog Status Pages. + description: The subdomain of the status page's url taking the form `https://{domain_prefix}.statuspage.datadoghq.com`. Globally unique across Datadog Status Pages. type: string email_header_image: - description: Base64-encoded image data included in email notifications sent - to status page subscribers. + description: Base64-encoded image data included in email notifications sent to status page subscribers. type: string enabled: description: Whether the status page is enabled. @@ -65162,15 +61920,15 @@ components: description: Whether users can subscribe to the status page. type: boolean type: - $ref: '#/components/schemas/CreateStatusPageRequestDataAttributesType' + $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesType" visualization_type: - $ref: '#/components/schemas/CreateStatusPageRequestDataAttributesVisualizationType' + $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesVisualizationType" type: object StatusPageAsIncludedAttributesComponentsItems: properties: components: items: - $ref: '#/components/schemas/StatusPageAsIncludedAttributesComponentsItemsComponentsItems' + $ref: "#/components/schemas/StatusPageAsIncludedAttributesComponentsItemsComponentsItems" type: array id: description: The ID of the component. @@ -65185,9 +61943,9 @@ components: format: int64 type: integer status: - $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus' + $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus" type: - $ref: '#/components/schemas/CreateComponentRequestDataAttributesType' + $ref: "#/components/schemas/CreateComponentRequestDataAttributesType" type: object StatusPageAsIncludedAttributesComponentsItemsComponentsItems: properties: @@ -65200,77 +61958,76 @@ components: description: The name of the grouped component. type: string position: - description: The zero-indexed position of the grouped component. Relative - to the other components in the group. + description: The zero-indexed position of the grouped component. Relative to the other components in the group. format: int64 type: integer status: - $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus' + $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus" type: - $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType' + $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType" type: object StatusPageAsIncludedRelationships: description: The relationships of a status page. properties: created_by_user: - $ref: '#/components/schemas/StatusPageAsIncludedRelationshipsCreatedByUser' + $ref: "#/components/schemas/StatusPageAsIncludedRelationshipsCreatedByUser" description: The Datadog user who created the status page. last_modified_by_user: - $ref: '#/components/schemas/StatusPageAsIncludedRelationshipsLastModifiedByUser' + $ref: "#/components/schemas/StatusPageAsIncludedRelationshipsLastModifiedByUser" description: The Datadog user who last modified the status page. type: object StatusPageAsIncludedRelationshipsCreatedByUser: properties: data: - $ref: '#/components/schemas/StatusPageAsIncludedRelationshipsCreatedByUserData' + $ref: "#/components/schemas/StatusPageAsIncludedRelationshipsCreatedByUserData" required: - - data + - data type: object StatusPageAsIncludedRelationshipsCreatedByUserData: properties: id: description: The ID of the Datadog user who created the status page. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/StatusPagesUserType' + $ref: "#/components/schemas/StatusPagesUserType" required: - - type - - id + - type + - id type: object StatusPageAsIncludedRelationshipsLastModifiedByUser: properties: data: - $ref: '#/components/schemas/StatusPageAsIncludedRelationshipsLastModifiedByUserData' + $ref: "#/components/schemas/StatusPageAsIncludedRelationshipsLastModifiedByUserData" required: - - data + - data type: object StatusPageAsIncludedRelationshipsLastModifiedByUserData: properties: id: description: The ID of the Datadog user who last modified the status page. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/StatusPagesUserType' + $ref: "#/components/schemas/StatusPagesUserType" required: - - type - - id + - type + - id type: object StatusPageData: properties: attributes: - $ref: '#/components/schemas/StatusPageDataAttributes' + $ref: "#/components/schemas/StatusPageDataAttributes" id: description: The ID of the status page. format: uuid type: string relationships: - $ref: '#/components/schemas/StatusPageDataRelationships' + $ref: "#/components/schemas/StatusPageDataRelationships" type: - $ref: '#/components/schemas/StatusPageDataType' + $ref: "#/components/schemas/StatusPageDataType" required: - - type + - type type: object StatusPageDataAttributes: description: The attributes of a status page. @@ -65282,7 +62039,7 @@ components: components: description: Components displayed on the status page. items: - $ref: '#/components/schemas/StatusPageDataAttributesComponentsItems' + $ref: "#/components/schemas/StatusPageDataAttributesComponentsItems" type: array created_at: description: Timestamp of when the status page was created. @@ -65296,12 +62053,10 @@ components: description: Whether the custom domain is configured. type: boolean domain_prefix: - description: The subdomain of the status page's url taking the form `https://{domain_prefix}.statuspage.datadoghq.com`. - Globally unique across Datadog Status Pages. + description: The subdomain of the status page's url taking the form `https://{domain_prefix}.statuspage.datadoghq.com`. Globally unique across Datadog Status Pages. type: string email_header_image: - description: Base64-encoded image data included in email notifications sent - to status page subscribers. + description: Base64-encoded image data included in email notifications sent to status page subscribers. nullable: true type: string enabled: @@ -65325,17 +62080,16 @@ components: description: Whether users can subscribe to the status page. type: boolean type: - $ref: '#/components/schemas/CreateStatusPageRequestDataAttributesType' + $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesType" visualization_type: - $ref: '#/components/schemas/CreateStatusPageRequestDataAttributesVisualizationType' + $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesVisualizationType" type: object StatusPageDataAttributesComponentsItems: properties: components: - description: If the component is of type `group`, the components within - the group. + description: If the component is of type `group`, the components within the group. items: - $ref: '#/components/schemas/StatusPageDataAttributesComponentsItemsComponentsItems' + $ref: "#/components/schemas/StatusPageDataAttributesComponentsItemsComponentsItems" type: array id: description: The ID of the component. @@ -65349,9 +62103,9 @@ components: format: int64 type: integer status: - $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus' + $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus" type: - $ref: '#/components/schemas/CreateComponentRequestDataAttributesType' + $ref: "#/components/schemas/CreateComponentRequestDataAttributesType" type: object StatusPageDataAttributesComponentsItemsComponentsItems: properties: @@ -65363,126 +62117,122 @@ components: description: The name of the component. type: string position: - description: The zero-indexed position of the component. Relative to the - other components in the group. + description: The zero-indexed position of the component. Relative to the other components in the group. format: int64 type: integer status: - $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus' + $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus" type: - $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType' + $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType" type: object StatusPageDataRelationships: description: The relationships of a status page. properties: created_by_user: - $ref: '#/components/schemas/StatusPageDataRelationshipsCreatedByUser' + $ref: "#/components/schemas/StatusPageDataRelationshipsCreatedByUser" description: The Datadog user who created the status page. last_modified_by_user: - $ref: '#/components/schemas/StatusPageDataRelationshipsLastModifiedByUser' + $ref: "#/components/schemas/StatusPageDataRelationshipsLastModifiedByUser" description: The Datadog user who last modified the status page. type: object StatusPageDataRelationshipsCreatedByUser: properties: data: - $ref: '#/components/schemas/StatusPageDataRelationshipsCreatedByUserData' + $ref: "#/components/schemas/StatusPageDataRelationshipsCreatedByUserData" required: - - data + - data type: object StatusPageDataRelationshipsCreatedByUserData: properties: id: description: The ID of the Datadog user who created the status page. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/StatusPagesUserType' + $ref: "#/components/schemas/StatusPagesUserType" required: - - type - - id + - type + - id type: object StatusPageDataRelationshipsLastModifiedByUser: properties: data: - $ref: '#/components/schemas/StatusPageDataRelationshipsLastModifiedByUserData' + $ref: "#/components/schemas/StatusPageDataRelationshipsLastModifiedByUserData" required: - - data + - data type: object StatusPageDataRelationshipsLastModifiedByUserData: properties: id: description: The ID of the Datadog user who last modified the status page. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/StatusPagesUserType' + $ref: "#/components/schemas/StatusPagesUserType" required: - - type - - id + - type + - id type: object StatusPageDataType: default: status_pages description: Status pages resource type. enum: - - status_pages + - status_pages example: status_pages type: string x-enum-varnames: - - STATUS_PAGES + - STATUS_PAGES StatusPagesComponent: properties: data: - $ref: '#/components/schemas/StatusPagesComponentData' + $ref: "#/components/schemas/StatusPagesComponentData" included: - description: The included related resources of a component. Client must - explicitly request these resources by name in the `include` query parameter. + description: The included related resources of a component. Client must explicitly request these resources by name in the `include` query parameter. items: - $ref: '#/components/schemas/StatusPagesComponentArrayIncluded' + $ref: "#/components/schemas/StatusPagesComponentArrayIncluded" type: array type: object StatusPagesComponentArray: properties: data: items: - $ref: '#/components/schemas/StatusPagesComponentData' + $ref: "#/components/schemas/StatusPagesComponentData" type: array included: - description: The included related resources of a component. Client must - explicitly request these resources by name in the `include` query parameter. + description: The included related resources of a component. Client must explicitly request these resources by name in the `include` query parameter. items: - $ref: '#/components/schemas/StatusPagesComponentArrayIncluded' + $ref: "#/components/schemas/StatusPagesComponentArrayIncluded" type: array required: - - data + - data type: object StatusPagesComponentArrayIncluded: oneOf: - - $ref: '#/components/schemas/StatusPagesUser' - - $ref: '#/components/schemas/StatusPageAsIncluded' - - $ref: '#/components/schemas/StatusPagesComponentGroup' + - $ref: "#/components/schemas/StatusPagesUser" + - $ref: "#/components/schemas/StatusPageAsIncluded" + - $ref: "#/components/schemas/StatusPagesComponentGroup" StatusPagesComponentData: properties: attributes: - $ref: '#/components/schemas/StatusPagesComponentDataAttributes' + $ref: "#/components/schemas/StatusPagesComponentDataAttributes" id: description: The ID of the component. format: uuid type: string relationships: - $ref: '#/components/schemas/StatusPagesComponentDataRelationships' + $ref: "#/components/schemas/StatusPagesComponentDataRelationships" type: - $ref: '#/components/schemas/StatusPagesComponentGroupType' + $ref: "#/components/schemas/StatusPagesComponentGroupType" required: - - type + - type type: object StatusPagesComponentDataAttributes: description: The attributes of a component. properties: components: - description: If the component is of type `group`, the components within - the group. + description: If the component is of type `group`, the components within the group. items: - $ref: '#/components/schemas/StatusPagesComponentDataAttributesComponentsItems' + $ref: "#/components/schemas/StatusPagesComponentDataAttributesComponentsItems" type: array created_at: description: Timestamp of when the component was created. @@ -65500,11 +62250,11 @@ components: format: int64 type: integer status: - $ref: '#/components/schemas/StatusPagesComponentDataAttributesStatus' + $ref: "#/components/schemas/StatusPagesComponentDataAttributesStatus" type: - $ref: '#/components/schemas/CreateComponentRequestDataAttributesType' + $ref: "#/components/schemas/CreateComponentRequestDataAttributesType" required: - - type + - type type: object StatusPagesComponentDataAttributesComponentsItems: properties: @@ -65518,145 +62268,144 @@ components: format: int64 type: integer status: - $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus' + $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus" type: - $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType' + $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType" type: object StatusPagesComponentDataAttributesStatus: description: The status of the component. enum: - - operational - - degraded - - partial_outage - - major_outage - - maintenance + - operational + - degraded + - partial_outage + - major_outage + - maintenance example: operational type: string x-enum-varnames: - - OPERATIONAL - - DEGRADED - - PARTIAL_OUTAGE - - MAJOR_OUTAGE - - MAINTENANCE + - OPERATIONAL + - DEGRADED + - PARTIAL_OUTAGE + - MAJOR_OUTAGE + - MAINTENANCE StatusPagesComponentDataRelationships: description: The relationships of a component. properties: created_by_user: - $ref: '#/components/schemas/StatusPagesComponentDataRelationshipsCreatedByUser' + $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsCreatedByUser" description: The Datadog user who created the component. group: - $ref: '#/components/schemas/StatusPagesComponentDataRelationshipsGroup' + $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsGroup" description: The group the component belongs to. last_modified_by_user: - $ref: '#/components/schemas/StatusPagesComponentDataRelationshipsLastModifiedByUser' + $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsLastModifiedByUser" description: The Datadog user who last modified the component. status_page: - $ref: '#/components/schemas/StatusPagesComponentDataRelationshipsStatusPage' + $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsStatusPage" description: The status page the component belongs to. type: object StatusPagesComponentDataRelationshipsCreatedByUser: properties: data: - $ref: '#/components/schemas/StatusPagesComponentDataRelationshipsCreatedByUserData' + $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsCreatedByUserData" required: - - data + - data type: object StatusPagesComponentDataRelationshipsCreatedByUserData: properties: id: description: The ID of the Datadog user who created the component. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/StatusPagesUserType' + $ref: "#/components/schemas/StatusPagesUserType" required: - - type - - id + - type + - id type: object StatusPagesComponentDataRelationshipsGroup: properties: data: - $ref: '#/components/schemas/StatusPagesComponentDataRelationshipsGroupData' + $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsGroupData" required: - - data + - data type: object StatusPagesComponentDataRelationshipsGroupData: nullable: true properties: id: description: The ID of the group the component belongs to. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string type: - $ref: '#/components/schemas/StatusPagesComponentGroupType' + $ref: "#/components/schemas/StatusPagesComponentGroupType" required: - - type - - id + - type + - id type: object StatusPagesComponentDataRelationshipsLastModifiedByUser: properties: data: - $ref: '#/components/schemas/StatusPagesComponentDataRelationshipsLastModifiedByUserData' + $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsLastModifiedByUserData" required: - - data + - data type: object StatusPagesComponentDataRelationshipsLastModifiedByUserData: properties: id: description: The ID of the Datadog user who last modified the component. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/StatusPagesUserType' + $ref: "#/components/schemas/StatusPagesUserType" required: - - type - - id + - type + - id type: object StatusPagesComponentDataRelationshipsStatusPage: properties: data: - $ref: '#/components/schemas/StatusPagesComponentDataRelationshipsStatusPageData' + $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsStatusPageData" required: - - data + - data type: object StatusPagesComponentDataRelationshipsStatusPageData: properties: id: description: The ID of the status page the component belongs to. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string type: - $ref: '#/components/schemas/StatusPageDataType' + $ref: "#/components/schemas/StatusPageDataType" required: - - type - - id + - type + - id type: object StatusPagesComponentGroup: description: The included component group resource. properties: attributes: - $ref: '#/components/schemas/StatusPagesComponentGroupAttributes' + $ref: "#/components/schemas/StatusPagesComponentGroupAttributes" id: description: The ID of the component. format: uuid type: string relationships: - $ref: '#/components/schemas/StatusPagesComponentGroupRelationships' + $ref: "#/components/schemas/StatusPagesComponentGroupRelationships" type: - $ref: '#/components/schemas/StatusPagesComponentGroupType' + $ref: "#/components/schemas/StatusPagesComponentGroupType" required: - - type + - type type: object StatusPagesComponentGroupAttributes: description: The attributes of a component group. properties: components: - description: If the component is of type `group`, the components within - the group. + description: If the component is of type `group`, the components within the group. items: - $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItems' + $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItems" type: array created_at: description: Timestamp of when the component was created. @@ -65674,11 +62423,11 @@ components: format: int64 type: integer status: - $ref: '#/components/schemas/StatusPagesComponentDataAttributesStatus' + $ref: "#/components/schemas/StatusPagesComponentDataAttributesStatus" type: - $ref: '#/components/schemas/CreateComponentRequestDataAttributesType' + $ref: "#/components/schemas/CreateComponentRequestDataAttributesType" required: - - type + - type type: object StatusPagesComponentGroupAttributesComponentsItems: properties: @@ -65691,156 +62440,154 @@ components: description: The name of the grouped component. type: string position: - description: The zero-indexed position of the grouped component. Relative - to the other components in the group. + description: The zero-indexed position of the grouped component. Relative to the other components in the group. format: int64 type: integer status: - $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus' + $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus" type: - $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType' + $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType" type: object StatusPagesComponentGroupAttributesComponentsItemsStatus: description: The status of the component. enum: - - operational - - degraded - - partial_outage - - major_outage - - maintenance + - operational + - degraded + - partial_outage + - major_outage + - maintenance readOnly: true type: string x-enum-varnames: - - OPERATIONAL - - DEGRADED - - PARTIAL_OUTAGE - - MAJOR_OUTAGE - - MAINTENANCE + - OPERATIONAL + - DEGRADED + - PARTIAL_OUTAGE + - MAJOR_OUTAGE + - MAINTENANCE StatusPagesComponentGroupAttributesComponentsItemsType: description: The type of the component. enum: - - component + - component example: component type: string x-enum-varnames: - - COMPONENT + - COMPONENT StatusPagesComponentGroupRelationships: description: The relationships of a component group. properties: created_by_user: - $ref: '#/components/schemas/StatusPagesComponentGroupRelationshipsCreatedByUser' + $ref: "#/components/schemas/StatusPagesComponentGroupRelationshipsCreatedByUser" group: - $ref: '#/components/schemas/StatusPagesComponentGroupRelationshipsGroup' + $ref: "#/components/schemas/StatusPagesComponentGroupRelationshipsGroup" last_modified_by_user: - $ref: '#/components/schemas/StatusPagesComponentGroupRelationshipsLastModifiedByUser' + $ref: "#/components/schemas/StatusPagesComponentGroupRelationshipsLastModifiedByUser" status_page: - $ref: '#/components/schemas/StatusPagesComponentGroupRelationshipsStatusPage' + $ref: "#/components/schemas/StatusPagesComponentGroupRelationshipsStatusPage" type: object StatusPagesComponentGroupRelationshipsCreatedByUser: description: The Datadog user who created the component group. properties: data: - $ref: '#/components/schemas/StatusPagesComponentGroupRelationshipsCreatedByUserData' + $ref: "#/components/schemas/StatusPagesComponentGroupRelationshipsCreatedByUserData" required: - - data + - data type: object StatusPagesComponentGroupRelationshipsCreatedByUserData: properties: id: description: The ID of the Datadog user who created the component group. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/StatusPagesUserType' + $ref: "#/components/schemas/StatusPagesUserType" required: - - type - - id + - type + - id type: object StatusPagesComponentGroupRelationshipsGroup: description: The group the component group belongs to. properties: data: - $ref: '#/components/schemas/StatusPagesComponentGroupRelationshipsGroupData' + $ref: "#/components/schemas/StatusPagesComponentGroupRelationshipsGroupData" required: - - data + - data type: object StatusPagesComponentGroupRelationshipsGroupData: nullable: true properties: id: - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string type: - $ref: '#/components/schemas/StatusPagesComponentGroupType' + $ref: "#/components/schemas/StatusPagesComponentGroupType" required: - - type - - id + - type + - id type: object StatusPagesComponentGroupRelationshipsLastModifiedByUser: description: The Datadog user who last modified the component group. properties: data: - $ref: '#/components/schemas/StatusPagesComponentGroupRelationshipsLastModifiedByUserData' + $ref: "#/components/schemas/StatusPagesComponentGroupRelationshipsLastModifiedByUserData" required: - - data + - data type: object StatusPagesComponentGroupRelationshipsLastModifiedByUserData: properties: id: - description: The ID of the Datadog user who last modified the component - group. - example: '' + description: The ID of the Datadog user who last modified the component group. + example: "" type: string type: - $ref: '#/components/schemas/StatusPagesUserType' + $ref: "#/components/schemas/StatusPagesUserType" required: - - type - - id + - type + - id type: object StatusPagesComponentGroupRelationshipsStatusPage: description: The status page the component group belongs to. properties: data: - $ref: '#/components/schemas/StatusPagesComponentGroupRelationshipsStatusPageData' + $ref: "#/components/schemas/StatusPagesComponentGroupRelationshipsStatusPageData" required: - - data + - data type: object StatusPagesComponentGroupRelationshipsStatusPageData: properties: id: description: The ID of the status page. - example: 1234abcd-12ab-34cd-56ef-123456abcdef + example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string type: - $ref: '#/components/schemas/StatusPageDataType' + $ref: "#/components/schemas/StatusPageDataType" required: - - type - - id + - type + - id type: object StatusPagesComponentGroupType: default: components description: Components resource type. enum: - - components + - components example: components type: string x-enum-varnames: - - COMPONENTS + - COMPONENTS StatusPagesUser: description: The included Datadog user resource. properties: attributes: - $ref: '#/components/schemas/StatusPagesUserAttributes' + $ref: "#/components/schemas/StatusPagesUserAttributes" id: description: The ID of the Datadog user. format: uuid type: string type: - $ref: '#/components/schemas/StatusPagesUserType' + $ref: "#/components/schemas/StatusPagesUserType" required: - - type + - type type: object StatusPagesUserAttributes: description: Attributes of the Datadog user. @@ -65865,56 +62612,55 @@ components: default: users description: Users resource type. enum: - - users + - users example: users type: string x-enum-varnames: - - USERS + - USERS Step: - description: A Step is a sub-component of a workflow. Each Step performs an - action. + description: A Step is a sub-component of a workflow. Each Step performs an action. properties: actionId: description: The unique identifier of an action. - example: '' + example: "" type: string completionGate: - $ref: '#/components/schemas/CompletionGate' + $ref: "#/components/schemas/CompletionGate" connectionLabel: description: The unique identifier of a connection defined in the spec. type: string display: - $ref: '#/components/schemas/StepDisplay' + $ref: "#/components/schemas/StepDisplay" errorHandlers: description: The `Step` `errorHandlers`. items: - $ref: '#/components/schemas/ErrorHandler' + $ref: "#/components/schemas/ErrorHandler" type: array name: description: Name of the step. - example: '' + example: "" type: string outboundEdges: description: A list of subsequent actions to run. items: - $ref: '#/components/schemas/OutboundEdge' + $ref: "#/components/schemas/OutboundEdge" type: array parameters: description: A list of inputs for an action. items: - $ref: '#/components/schemas/Parameter' + $ref: "#/components/schemas/Parameter" type: array readinessGate: - $ref: '#/components/schemas/ReadinessGate' + $ref: "#/components/schemas/ReadinessGate" required: - - name - - actionId + - name + - actionId type: object StepDisplay: description: The definition of `StepDisplay` object. properties: bounds: - $ref: '#/components/schemas/StepDisplayBounds' + $ref: "#/components/schemas/StepDisplayBounds" type: object StepDisplayBounds: description: The definition of `StepDisplayBounds` object. @@ -65931,28 +62677,28 @@ components: SuiteCreateEdit: properties: attributes: - $ref: '#/components/schemas/SyntheticsSuite' + $ref: "#/components/schemas/SyntheticsSuite" type: - $ref: '#/components/schemas/SyntheticsSuiteTypes' + $ref: "#/components/schemas/SyntheticsSuiteTypes" required: - - attributes - - type + - attributes + - type type: object SuiteCreateEditRequest: properties: data: - $ref: '#/components/schemas/SuiteCreateEdit' + $ref: "#/components/schemas/SuiteCreateEdit" required: - - data + - data type: object SuiteSearchResponseType: default: suites_search enum: - - suites_search + - suites_search example: suites_search type: string x-enum-varnames: - - SUITES_SEARCH + - SUITES_SEARCH SuppressionVersionHistory: description: Response object containing the version history of a suppression. properties: @@ -65963,7 +62709,7 @@ components: type: integer data: additionalProperties: - $ref: '#/components/schemas/SuppressionVersions' + $ref: "#/components/schemas/SuppressionVersions" description: A suppression version with a list of updates. description: The version history of a suppression. type: object @@ -65974,10 +62720,10 @@ components: changes: description: A list of changes. items: - $ref: '#/components/schemas/VersionHistoryUpdate' + $ref: "#/components/schemas/VersionHistoryUpdate" type: array suppression: - $ref: '#/components/schemas/SecurityMonitoringSuppressionAttributes' + $ref: "#/components/schemas/SecurityMonitoringSuppressionAttributes" type: object SyncProperty: description: Sync property configuration @@ -66003,10 +62749,10 @@ components: description: Synthetic global variable. properties: attributes: - $ref: '#/components/schemas/SyntheticsGlobalVariableAttributes' + $ref: "#/components/schemas/SyntheticsGlobalVariableAttributes" description: description: Description of the global variable. - example: Example description + example: "Example description" type: string id: description: Unique identifier of the global variable. @@ -66019,98 +62765,90 @@ components: description: Determines if the global variable is a TOTP/MFA variable. type: boolean name: - description: Name of the global variable. Unique across Synthetic global - variables. - example: MY_VARIABLE + description: Name of the global variable. Unique across Synthetic global variables. + example: "MY_VARIABLE" type: string parse_test_options: - $ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptions' + $ref: "#/components/schemas/SyntheticsGlobalVariableParseTestOptions" parse_test_public_id: - description: A Synthetic test ID to use as a test to generate the variable - value. - example: abc-def-123 + description: A Synthetic test ID to use as a test to generate the variable value. + example: "abc-def-123" type: string tags: description: Tags of the global variable. - example: - - team:front - - test:workflow-1 + example: ["team:front", "test:workflow-1"] items: description: Tag name. type: string type: array value: - $ref: '#/components/schemas/SyntheticsGlobalVariableValue' + $ref: "#/components/schemas/SyntheticsGlobalVariableValue" required: - - description - - name - - tags - - value + - description + - name + - tags + - value type: object SyntheticsGlobalVariableAttributes: description: Attributes of the global variable. properties: restricted_roles: - $ref: '#/components/schemas/SyntheticsRestrictedRoles' + $ref: "#/components/schemas/SyntheticsRestrictedRoles" type: object SyntheticsGlobalVariableOptions: description: Options for the Global Variable for MFA. properties: totp_parameters: - $ref: '#/components/schemas/SyntheticsGlobalVariableTOTPParameters' + $ref: "#/components/schemas/SyntheticsGlobalVariableTOTPParameters" type: object SyntheticsGlobalVariableParseTestOptions: - description: Parser options to use for retrieving a Synthetic global variable - from a Synthetic test. Used in conjunction with `parse_test_public_id`. + description: Parser options to use for retrieving a Synthetic global variable from a Synthetic test. Used in conjunction with `parse_test_public_id`. properties: field: - description: When type is `http_header`, name of the header to use to extract - the value. - example: content-type + description: When type is `http_header`, name of the header to use to extract the value. + example: "content-type" type: string localVariableName: - description: When type is `local_variable`, name of the local variable to - use to extract the value. - example: LOCAL_VARIABLE + description: When type is `local_variable`, name of the local variable to use to extract the value. + example: "LOCAL_VARIABLE" type: string parser: - $ref: '#/components/schemas/SyntheticsVariableParser' + $ref: "#/components/schemas/SyntheticsVariableParser" type: - $ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptionsType' + $ref: "#/components/schemas/SyntheticsGlobalVariableParseTestOptionsType" required: - - type + - type type: object SyntheticsGlobalVariableParseTestOptionsType: description: Type of value to extract from a test for a Synthetic global variable. enum: - - http_body - - http_header - - http_status_code - - local_variable + - http_body + - http_header + - http_status_code + - local_variable example: http_body type: string x-enum-varnames: - - HTTP_BODY - - HTTP_HEADER - - HTTP_STATUS_CODE - - LOCAL_VARIABLE + - HTTP_BODY + - HTTP_HEADER + - HTTP_STATUS_CODE + - LOCAL_VARIABLE SyntheticsGlobalVariableParserType: - description: Type of parser for a Synthetic global variable from a synthetics - test. + description: Type of parser for a Synthetic global variable from a synthetics test. enum: - - raw - - json_path - - regex - - x_path + - raw + - json_path + - regex + - x_path example: raw type: string x-enum-varnames: - - RAW - - JSON_PATH - - REGEX - - X_PATH + - RAW + - JSON_PATH + - REGEX + - X_PATH SyntheticsGlobalVariableTOTPParameters: - description: Parameters for the TOTP/MFA variable + description: "Parameters for the TOTP/MFA variable" properties: digits: description: Number of digits for the OTP code. @@ -66134,132 +62872,131 @@ components: value: value properties: options: - $ref: '#/components/schemas/SyntheticsGlobalVariableOptions' + $ref: "#/components/schemas/SyntheticsGlobalVariableOptions" secure: description: Determines if the value of the variable is hidden. type: boolean value: - description: 'Value of the global variable. When reading a global variable, - - the value will not be present if the variable is hidden with the `secure` - property.' - example: example-value + description: |- + Value of the global variable. When reading a global variable, + the value will not be present if the variable is hidden with the `secure` property. + example: "example-value" type: string type: object SyntheticsNetworkAssertion: description: Object describing an assertion for a Network Path test. oneOf: - - $ref: '#/components/schemas/SyntheticsNetworkAssertionLatency' - - $ref: '#/components/schemas/SyntheticsNetworkAssertionMultiNetworkHop' - - $ref: '#/components/schemas/SyntheticsNetworkAssertionPacketLossPercentage' - - $ref: '#/components/schemas/SyntheticsNetworkAssertionJitter' + - $ref: "#/components/schemas/SyntheticsNetworkAssertionLatency" + - $ref: "#/components/schemas/SyntheticsNetworkAssertionMultiNetworkHop" + - $ref: "#/components/schemas/SyntheticsNetworkAssertionPacketLossPercentage" + - $ref: "#/components/schemas/SyntheticsNetworkAssertionJitter" SyntheticsNetworkAssertionJitter: description: Jitter assertion for a Network Path test. properties: operator: - $ref: '#/components/schemas/SyntheticsNetworkAssertionOperator' + $ref: "#/components/schemas/SyntheticsNetworkAssertionOperator" target: description: Target value in milliseconds. example: 5 format: double type: number type: - $ref: '#/components/schemas/SyntheticsNetworkAssertionJitterType' + $ref: "#/components/schemas/SyntheticsNetworkAssertionJitterType" required: - - operator - - target - - type + - operator + - target + - type type: object SyntheticsNetworkAssertionJitterType: default: jitter description: Type of the jitter assertion. enum: - - jitter + - jitter example: jitter type: string x-enum-varnames: - - JITTER + - JITTER SyntheticsNetworkAssertionLatency: description: Network latency assertion for a Network Path test. properties: operator: - $ref: '#/components/schemas/SyntheticsNetworkAssertionOperator' + $ref: "#/components/schemas/SyntheticsNetworkAssertionOperator" property: - $ref: '#/components/schemas/SyntheticsNetworkAssertionProperty' + $ref: "#/components/schemas/SyntheticsNetworkAssertionProperty" target: description: Target value in milliseconds. example: 500 format: double type: number type: - $ref: '#/components/schemas/SyntheticsNetworkAssertionLatencyType' + $ref: "#/components/schemas/SyntheticsNetworkAssertionLatencyType" required: - - operator - - property - - target - - type + - operator + - property + - target + - type type: object SyntheticsNetworkAssertionLatencyType: default: latency description: Type of the latency assertion. enum: - - latency + - latency example: latency type: string x-enum-varnames: - - LATENCY + - LATENCY SyntheticsNetworkAssertionMultiNetworkHop: description: Multi-network hop assertion for a Network Path test. properties: operator: - $ref: '#/components/schemas/SyntheticsNetworkAssertionOperator' + $ref: "#/components/schemas/SyntheticsNetworkAssertionOperator" property: - $ref: '#/components/schemas/SyntheticsNetworkAssertionProperty' + $ref: "#/components/schemas/SyntheticsNetworkAssertionProperty" target: description: Target value in number of hops. example: 3 format: double type: number type: - $ref: '#/components/schemas/SyntheticsNetworkAssertionMultiNetworkHopType' + $ref: "#/components/schemas/SyntheticsNetworkAssertionMultiNetworkHopType" required: - - operator - - property - - target - - type + - operator + - property + - target + - type type: object SyntheticsNetworkAssertionMultiNetworkHopType: default: multiNetworkHop description: Type of the multi-network hop assertion. enum: - - multiNetworkHop + - multiNetworkHop example: multiNetworkHop type: string x-enum-varnames: - - MULTI_NETWORK_HOP + - MULTI_NETWORK_HOP SyntheticsNetworkAssertionOperator: description: Assertion operator to apply. enum: - - is - - isNot - - lessThan - - lessThanOrEqual - - moreThan - - moreThanOrEqual + - is + - isNot + - lessThan + - lessThanOrEqual + - moreThan + - moreThanOrEqual example: lessThan type: string x-enum-varnames: - - IS - - IS_NOT - - LESS_THAN - - LESS_THAN_OR_EQUAL - - MORE_THAN - - MORE_THAN_OR_EQUAL + - IS + - IS_NOT + - LESS_THAN + - LESS_THAN_OR_EQUAL + - MORE_THAN + - MORE_THAN_OR_EQUAL SyntheticsNetworkAssertionPacketLossPercentage: description: Packet loss percentage assertion for a Network Path test. properties: operator: - $ref: '#/components/schemas/SyntheticsNetworkAssertionOperator' + $ref: "#/components/schemas/SyntheticsNetworkAssertionOperator" target: description: Target value as a percentage (0 to 1). example: 0.05 @@ -66268,54 +63005,50 @@ components: minimum: 0 type: number type: - $ref: '#/components/schemas/SyntheticsNetworkAssertionPacketLossPercentageType' + $ref: "#/components/schemas/SyntheticsNetworkAssertionPacketLossPercentageType" required: - - operator - - target - - type + - operator + - target + - type type: object SyntheticsNetworkAssertionPacketLossPercentageType: default: packetLossPercentage description: Type of the packet loss percentage assertion. enum: - - packetLossPercentage + - packetLossPercentage example: packetLossPercentage type: string x-enum-varnames: - - PACKET_LOSS_PERCENTAGE + - PACKET_LOSS_PERCENTAGE SyntheticsNetworkAssertionProperty: description: The associated assertion property. enum: - - avg - - max - - min + - avg + - max + - min example: avg type: string x-enum-varnames: - - AVG - - MAX - - MIN + - AVG + - MAX + - MIN SyntheticsNetworkTest: description: Object containing details about a Network Path test. properties: config: - $ref: '#/components/schemas/SyntheticsNetworkTestConfig' + $ref: "#/components/schemas/SyntheticsNetworkTestConfig" locations: - description: 'Array of locations used to run the test. Network Path tests - can be run from managed locations to test public endpoints, - - or from a [Datadog Agent](https://docs.datadoghq.com/synthetics/network_path_tests/#agent-configuration) - to test private environments.' - example: - - aws:us-east-1 - - agent:my-agent-name + description: |- + Array of locations used to run the test. Network Path tests can be run from managed locations to test public endpoints, + or from a [Datadog Agent](https://docs.datadoghq.com/synthetics/network_path_tests/#agent-configuration) to test private environments. + example: ["aws:us-east-1", "agent:my-agent-name"] items: description: A location to run the test from. type: string type: array message: description: Notification message associated with the test. - example: Network Path test notification + example: "Network Path test notification" type: string monitor_id: description: The associated monitor ID. @@ -66325,36 +63058,35 @@ components: type: integer name: description: Name of the test. - example: Example Network Path test + example: "Example Network Path test" type: string options: - $ref: '#/components/schemas/SyntheticsTestOptions' + $ref: "#/components/schemas/SyntheticsTestOptions" public_id: description: The public ID for the test. example: abc-def-123 readOnly: true type: string status: - $ref: '#/components/schemas/SyntheticsTestPauseStatus' + $ref: "#/components/schemas/SyntheticsTestPauseStatus" subtype: - $ref: '#/components/schemas/SyntheticsNetworkTestSubType' + $ref: "#/components/schemas/SyntheticsNetworkTestSubType" tags: description: Array of tags attached to the test. - example: - - env:production + example: ["env:production"] items: description: A tag attached to the test. type: string type: array type: - $ref: '#/components/schemas/SyntheticsNetworkTestType' + $ref: "#/components/schemas/SyntheticsNetworkTestType" required: - - name - - config - - locations - - options - - type - - message + - name + - config + - locations + - options + - type + - message type: object SyntheticsNetworkTestConfig: description: Configuration object for a Network Path test. @@ -66362,73 +63094,63 @@ components: assertions: default: [] description: Array of assertions used for the test. - example: - - operator: lessThan - property: avg - target: 500 - type: latency + example: [{"operator": "lessThan", "property": "avg", "target": 500, "type": "latency"}] items: - $ref: '#/components/schemas/SyntheticsNetworkAssertion' + $ref: "#/components/schemas/SyntheticsNetworkAssertion" type: array request: - $ref: '#/components/schemas/SyntheticsNetworkTestRequest' + $ref: "#/components/schemas/SyntheticsNetworkTestRequest" type: object SyntheticsNetworkTestEdit: properties: attributes: - $ref: '#/components/schemas/SyntheticsNetworkTest' + $ref: "#/components/schemas/SyntheticsNetworkTest" type: - $ref: '#/components/schemas/SyntheticsNetworkTestType' + $ref: "#/components/schemas/SyntheticsNetworkTestType" required: - - attributes - - type + - attributes + - type type: object SyntheticsNetworkTestEditRequest: description: Network Path test request. properties: data: - $ref: '#/components/schemas/SyntheticsNetworkTestEdit' + $ref: "#/components/schemas/SyntheticsNetworkTestEdit" required: - - data + - data type: object SyntheticsNetworkTestRequest: description: Object describing the request for a Network Path test. properties: destination_service: - description: An optional label displayed for the destination host in the - Network Path visualization. + description: An optional label displayed for the destination host in the Network Path visualization. type: string e2e_queries: - description: The number of packets sent to probe the destination to measure - packet loss, latency and jitter. + description: The number of packets sent to probe the destination to measure packet loss, latency and jitter. example: 50 format: int64 type: integer host: description: Host name to query. - example: '' + example: "" type: string max_ttl: - description: The maximum time-to-live (max number of hops) used in outgoing - probe packets. + description: The maximum time-to-live (max number of hops) used in outgoing probe packets. example: 30 format: int64 type: integer port: - description: 'For TCP or UDP tests, the port to use when performing the - test. - - If not set on a UDP test, a random port is assigned, which may affect - the results.' + description: |- + For TCP or UDP tests, the port to use when performing the test. + If not set on a UDP test, a random port is assigned, which may affect the results. example: 443 format: int64 type: integer source_service: - description: An optional label displayed for the source host in the Network - Path visualization. + description: An optional label displayed for the source host in the Network Path visualization. type: string tcp_method: - $ref: '#/components/schemas/SyntheticsNetworkTestRequestTCPMethod' + $ref: "#/components/schemas/SyntheticsNetworkTestRequestTCPMethod" timeout: description: Timeout in seconds. format: int64 @@ -66439,79 +63161,77 @@ components: format: int64 type: integer required: - - host - - max_ttl - - e2e_queries - - traceroute_queries + - host + - max_ttl + - e2e_queries + - traceroute_queries type: object SyntheticsNetworkTestRequestTCPMethod: description: For TCP tests, the TCP traceroute strategy. enum: - - prefer_sack - - syn - - sack + - prefer_sack + - syn + - sack example: prefer_sack type: string x-enum-varnames: - - PREFER_SACK - - SYN - - SACK + - PREFER_SACK + - SYN + - SACK SyntheticsNetworkTestResponse: description: Network Path test response. properties: data: - $ref: '#/components/schemas/SyntheticsNetworkTestResponseData' + $ref: "#/components/schemas/SyntheticsNetworkTestResponseData" type: object SyntheticsNetworkTestResponseData: description: Network Path test response data. properties: attributes: - $ref: '#/components/schemas/SyntheticsNetworkTest' + $ref: "#/components/schemas/SyntheticsNetworkTest" id: description: The public ID of the Network Path test. example: abc-def-123 readOnly: true type: string type: - $ref: '#/components/schemas/SyntheticsNetworkTestResponseType' + $ref: "#/components/schemas/SyntheticsNetworkTestResponseType" type: object SyntheticsNetworkTestResponseType: - default: network_test + default: "network_test" description: Type of response, `network_test`. enum: - - network_test + - network_test example: network_test type: string x-enum-varnames: - - NETWORK_TEST + - NETWORK_TEST SyntheticsNetworkTestSubType: - description: 'Subtype of the Synthetic Network Path test: `tcp`, `udp`, or `icmp`.' + description: |- + Subtype of the Synthetic Network Path test: `tcp`, `udp`, or `icmp`. enum: - - tcp - - udp - - icmp + - tcp + - udp + - icmp example: tcp type: string x-enum-varnames: - - TCP - - UDP - - ICMP + - TCP + - UDP + - ICMP SyntheticsNetworkTestType: - default: network + default: "network" description: Type of the Synthetic test, `network`. enum: - - network + - network example: network type: string x-enum-varnames: - - NETWORK + - NETWORK SyntheticsRestrictedRoles: deprecated: true - description: A list of role identifiers that can be pulled from the Roles API, - for restricting read and write access. This field is deprecated. Use the restriction - policies API to manage permissions. - example: - - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + description: A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions. + example: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"] items: description: UUID for a role. example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx @@ -66532,10 +63252,10 @@ components: type: integer name: description: Name of the suite. - example: Example suite name + example: "Example suite name" type: string options: - $ref: '#/components/schemas/SyntheticsSuiteOptions' + $ref: "#/components/schemas/SyntheticsSuiteOptions" public_id: description: The public ID for the test. example: 123-abc-456 @@ -66543,30 +63263,28 @@ components: type: string tags: description: Array of tags attached to the suite. - example: - - env:production + example: ["env:production"] items: description: A tag attached to the suite. type: string type: array tests: items: - $ref: '#/components/schemas/SyntheticsSuiteTest' + $ref: "#/components/schemas/SyntheticsSuiteTest" type: array type: - $ref: '#/components/schemas/SyntheticsSuiteType' + $ref: "#/components/schemas/SyntheticsSuiteType" required: - - name - - type - - tests - - options + - name + - type + - tests + - options type: object SyntheticsSuiteOptions: description: Object describing the extra options for a Synthetic suite. properties: alerting_threshold: - description: Percentage of critical tests failure needed for a suite to - fail. + description: Percentage of critical tests failure needed for a suite to fail. format: double maximum: 1 minimum: 0 @@ -66576,44 +63294,44 @@ components: description: Synthetics suite response properties: data: - $ref: '#/components/schemas/SyntheticsSuiteResponseData' + $ref: "#/components/schemas/SyntheticsSuiteResponseData" type: object SyntheticsSuiteResponseData: description: Synthetics suite response data properties: attributes: - $ref: '#/components/schemas/SyntheticsSuite' + $ref: "#/components/schemas/SyntheticsSuite" id: description: The public ID for the suite. example: 123-abc-456 readOnly: true type: string type: - $ref: '#/components/schemas/SyntheticsSuiteTypes' + $ref: "#/components/schemas/SyntheticsSuiteTypes" type: object SyntheticsSuiteSearchResponse: description: Synthetics suite search response properties: data: - $ref: '#/components/schemas/SyntheticsSuiteSearchResponseData' + $ref: "#/components/schemas/SyntheticsSuiteSearchResponseData" type: object SyntheticsSuiteSearchResponseData: description: Synthetics suite search response data properties: attributes: - $ref: '#/components/schemas/SyntheticsSuiteSearchResponseDataAttributes' + $ref: "#/components/schemas/SyntheticsSuiteSearchResponseDataAttributes" id: format: uuid type: string type: - $ref: '#/components/schemas/SuiteSearchResponseType' + $ref: "#/components/schemas/SuiteSearchResponseType" type: object SyntheticsSuiteSearchResponseDataAttributes: description: Synthetics suite search response data attributes properties: suites: items: - $ref: '#/components/schemas/SyntheticsSuite' + $ref: "#/components/schemas/SyntheticsSuite" type: array total: format: int32 @@ -66621,45 +63339,44 @@ components: type: integer type: object SyntheticsSuiteTest: - description: Object containing details about a Synthetic test included in a - Synthetic suite. + description: Object containing details about a Synthetic test included in a Synthetic suite. properties: alerting_criticality: - $ref: '#/components/schemas/SyntheticsSuiteTestAlertingCriticality' + $ref: "#/components/schemas/SyntheticsSuiteTestAlertingCriticality" public_id: - example: '' + example: "" type: string required: - - public_id + - public_id type: object SyntheticsSuiteTestAlertingCriticality: description: Alerting criticality for each the test. enum: - - ignore - - critical + - ignore + - critical example: critical type: string x-enum-varnames: - - IGNORE - - CRITICAL + - IGNORE + - CRITICAL SyntheticsSuiteType: - default: suite + default: "suite" description: Type of the Synthetic suite, `suite`. enum: - - suite + - suite example: suite type: string x-enum-varnames: - - SUITE + - SUITE SyntheticsSuiteTypes: - default: suites + default: "suites" description: Type for the Synthetics suites responses, `suites`. enum: - - suites + - suites example: suites type: string x-enum-varnames: - - SUITES + - SUITES SyntheticsTestOptions: description: Object describing the extra options for a Synthetic test. properties: @@ -66668,17 +63385,16 @@ components: format: int64 type: integer min_location_failed: - description: 'Minimum number of locations in failure required to trigger - - an alert.' + description: |- + Minimum number of locations in failure required to trigger + an alert. format: int64 type: integer monitor_name: - description: The monitor name is used for the alert title as well as for - all monitor dashboard widgets and SLOs. + description: The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs. type: string monitor_options: - $ref: '#/components/schemas/SyntheticsTestOptionsMonitorOptions' + $ref: "#/components/schemas/SyntheticsTestOptionsMonitorOptions" monitor_priority: description: Integer from 1 (high) to 5 (low) indicating alert severity. format: int32 @@ -66686,11 +63402,11 @@ components: minimum: 1 type: integer restricted_roles: - $ref: '#/components/schemas/SyntheticsRestrictedRoles' + $ref: "#/components/schemas/SyntheticsRestrictedRoles" retry: - $ref: '#/components/schemas/SyntheticsTestOptionsRetry' + $ref: "#/components/schemas/SyntheticsTestOptionsRetry" scheduling: - $ref: '#/components/schemas/SyntheticsTestOptionsScheduling' + $ref: "#/components/schemas/SyntheticsTestOptionsScheduling" tick_every: description: The frequency at which to run the Synthetic test (in seconds). format: int64 @@ -66699,19 +63415,19 @@ components: type: integer type: object SyntheticsTestOptionsMonitorOptions: - description: 'Object containing the options for a Synthetic test as a monitor - - (for example, renotification).' + description: |- + Object containing the options for a Synthetic test as a monitor + (for example, renotification). properties: escalation_message: description: Message to include in the escalation notification. type: string notification_preset_name: - $ref: '#/components/schemas/SyntheticsTestOptionsMonitorOptionsNotificationPresetName' + $ref: "#/components/schemas/SyntheticsTestOptionsMonitorOptionsNotificationPresetName" renotify_interval: - description: 'Time interval before renotifying if the test is still failing - - (in minutes).' + description: |- + Time interval before renotifying if the test is still failing + (in minutes). format: int64 minimum: 0 type: integer @@ -66723,37 +63439,35 @@ components: SyntheticsTestOptionsMonitorOptionsNotificationPresetName: description: The name of the preset for the notification for the monitor. enum: - - show_all - - hide_all - - hide_query - - hide_handles - - hide_query_and_handles - - show_only_snapshot - - hide_handles_and_footer - type: string - x-enum-varnames: - - SHOW_ALL - - HIDE_ALL - - HIDE_QUERY - - HIDE_HANDLES - - HIDE_QUERY_AND_HANDLES - - SHOW_ONLY_SNAPSHOT - - HIDE_HANDLES_AND_FOOTER + - show_all + - hide_all + - hide_query + - hide_handles + - hide_query_and_handles + - show_only_snapshot + - hide_handles_and_footer + type: string + x-enum-varnames: + - SHOW_ALL + - HIDE_ALL + - HIDE_QUERY + - HIDE_HANDLES + - HIDE_QUERY_AND_HANDLES + - SHOW_ONLY_SNAPSHOT + - HIDE_HANDLES_AND_FOOTER SyntheticsTestOptionsRetry: description: Object describing the retry strategy to apply to a Synthetic test. properties: count: - description: 'Number of times a test needs to be retried before marking - a - - location as failed. Defaults to 0.' + description: |- + Number of times a test needs to be retried before marking a + location as failed. Defaults to 0. format: int64 type: integer interval: - description: 'Time interval between retries (in milliseconds). Defaults - to - - 300ms.' + description: |- + Time interval between retries (in milliseconds). Defaults to + 300ms. format: double type: number type: object @@ -66761,25 +63475,18 @@ components: description: Object containing timeframes and timezone used for advanced scheduling. properties: timeframes: - description: Array containing objects describing the scheduling pattern - to apply to each day. - example: - - day: 1 - from: 07:00 - to: '16:00' - - day: 3 - from: 07:00 - to: '16:00' + description: Array containing objects describing the scheduling pattern to apply to each day. + example: [{"day": 1, "from": "07:00", "to": "16:00"}, {"day": 3, "from": "07:00", "to": "16:00"}] items: - $ref: '#/components/schemas/SyntheticsTestOptionsSchedulingTimeframe' + $ref: "#/components/schemas/SyntheticsTestOptionsSchedulingTimeframe" type: array timezone: description: Timezone in which the timeframe is based. - example: America/New_York + example: "America/New_York" type: string required: - - timeframes - - timezone + - timeframes + - timezone type: object SyntheticsTestOptionsSchedulingTimeframe: description: Object describing a timeframe. @@ -66793,30 +63500,29 @@ components: type: integer from: description: The hour of the day on which scheduling starts. - example: 07:00 + example: "07:00" type: string to: description: The hour of the day on which scheduling ends. - example: '16:00' + example: "16:00" type: string required: - - day - - from - - to + - day + - from + - to type: object SyntheticsTestPauseStatus: - description: 'Define whether you want to start (`live`) or pause (`paused`) - a - - Synthetic test.' + description: |- + Define whether you want to start (`live`) or pause (`paused`) a + Synthetic test. enum: - - live - - paused + - live + - paused example: live type: string x-enum-varnames: - - LIVE - - PAUSED + - LIVE + - PAUSED SyntheticsVariableParser: description: Details of the parser to use for the global variable. example: @@ -66824,17 +63530,15 @@ components: value: .* properties: type: - $ref: '#/components/schemas/SyntheticsGlobalVariableParserType' + $ref: "#/components/schemas/SyntheticsGlobalVariableParserType" value: - description: Regex or JSON path used for the parser. Not used with type - `raw`. + description: Regex or JSON path used for the parser. Not used with type `raw`. type: string required: - - type + - type type: object TableResultV2: - description: A reference table resource containing its full configuration and - state. + description: A reference table resource containing its full configuration and state. example: data: attributes: @@ -66843,423 +63547,404 @@ components: file_metadata: access_details: aws_detail: - aws_account_id: '123456789000' - aws_bucket_name: my-bucket - file_path: path/to/file.csv + aws_account_id: "123456789000" + aws_bucket_name: "my-bucket" + file_path: "path/to/file.csv" sync_enabled: true last_updated_by: 00000000-0000-0000-0000-000000000000 row_count: 5 schema: fields: - - name: id - type: INT32 - - name: name - type: STRING + - name: id + type: INT32 + - name: name + type: STRING primary_keys: - - id + - id source: S3 status: DONE table_name: test_reference_table tags: - - tag1 - - tag2 - updated_at: '2000-01-01T01:00:00+00:00' + - tag1 + - tag2 + updated_at: "2000-01-01T01:00:00+00:00" id: 00000000-0000-0000-0000-000000000000 type: reference_table properties: data: - $ref: '#/components/schemas/TableResultV2Data' + $ref: "#/components/schemas/TableResultV2Data" type: object TableResultV2Array: description: List of reference tables. example: data: - - attributes: - created_by: 00000000-0000-0000-0000-000000000000 - description: example description - file_metadata: - access_details: {} - error_message: '' - error_row_count: 0 - upload_id: 00000000-0000-0000-0000-000000000000 - last_updated_by: '' - row_count: 5 - schema: - fields: - - name: id - type: INT32 - - name: name - type: STRING - primary_keys: - - id - source: LOCAL_FILE - status: DONE - table_name: test_reference_table - tags: - - tag1 - - tag2 - updated_at: '2000-01-01T01:00:00+00:00' - id: 00000000-0000-0000-0000-000000000000 - type: reference_table - - attributes: - created_by: 00000000-0000-0000-0000-000000000000 - description: example description - file_metadata: - access_details: - aws_detail: - aws_account_id: test-account-id - aws_bucket_name: test-bucket - file_path: test_rt.csv - error_message: '' - error_row_count: 0 - sync_enabled: true - last_updated_by: 00000000-0000-0000-0000-000000000000 - row_count: 5 - schema: - fields: - - name: location - type: STRING - - name: file_name - type: STRING - primary_keys: - - location - source: S3 - status: DONE - table_name: test_reference_table_2 - tags: - - test_tag1 - - tag2 - - '3' - updated_at: '2000-01-01T01:00:00+00:00' - id: 00000000-0000-0000-0000-000000000000 - type: reference_table + - attributes: + created_by: 00000000-0000-0000-0000-000000000000 + description: example description + file_metadata: + access_details: {} + error_message: "" + error_row_count: 0 + upload_id: 00000000-0000-0000-0000-000000000000 + last_updated_by: "" + row_count: 5 + schema: + fields: + - name: id + type: INT32 + - name: name + type: STRING + primary_keys: + - id + source: LOCAL_FILE + status: DONE + table_name: test_reference_table + tags: + - tag1 + - tag2 + updated_at: "2000-01-01T01:00:00+00:00" + id: 00000000-0000-0000-0000-000000000000 + type: reference_table + - attributes: + created_by: 00000000-0000-0000-0000-000000000000 + description: example description + file_metadata: + access_details: + aws_detail: + aws_account_id: test-account-id + aws_bucket_name: test-bucket + file_path: test_rt.csv + error_message: "" + error_row_count: 0 + sync_enabled: true + last_updated_by: 00000000-0000-0000-0000-000000000000 + row_count: 5 + schema: + fields: + - name: location + type: STRING + - name: file_name + type: STRING + primary_keys: + - location + source: S3 + status: DONE + table_name: test_reference_table_2 + tags: + - test_tag1 + - tag2 + - "3" + updated_at: "2000-01-01T01:00:00+00:00" + id: 00000000-0000-0000-0000-000000000000 + type: reference_table properties: data: description: The reference tables. items: - $ref: '#/components/schemas/TableResultV2Data' + $ref: "#/components/schemas/TableResultV2Data" type: array required: - - data + - data type: object TableResultV2Data: additionalProperties: false - description: The data object containing the reference table configuration and - state. + description: The data object containing the reference table configuration and state. properties: attributes: - $ref: '#/components/schemas/TableResultV2DataAttributes' + $ref: "#/components/schemas/TableResultV2DataAttributes" id: description: Unique identifier for the reference table. type: string type: - $ref: '#/components/schemas/TableResultV2DataType' + $ref: "#/components/schemas/TableResultV2DataType" required: - - type + - type type: object TableResultV2DataAttributes: - description: Attributes that define the reference table's configuration and - properties. + description: Attributes that define the reference table's configuration and properties. properties: created_by: description: UUID of the user who created the reference table. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string description: - description: Optional text describing the purpose or contents of this reference - table. - example: example description + description: Optional text describing the purpose or contents of this reference table. + example: "example description" type: string file_metadata: - $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadata' + $ref: "#/components/schemas/TableResultV2DataAttributesFileMetadata" last_updated_by: description: UUID of the user who last updated the reference table. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string row_count: - description: The number of successfully processed rows in the reference - table. + description: The number of successfully processed rows in the reference table. example: 5 format: int64 type: integer schema: - $ref: '#/components/schemas/TableResultV2DataAttributesSchema' + $ref: "#/components/schemas/TableResultV2DataAttributesSchema" source: - $ref: '#/components/schemas/ReferenceTableSourceType' + $ref: "#/components/schemas/ReferenceTableSourceType" status: description: The processing status of the table. - example: DONE + example: "DONE" type: string table_name: - description: Unique name to identify this reference table. Used in enrichment - processors and API calls. - example: table_1 + description: Unique name to identify this reference table. Used in enrichment processors and API calls. + example: "table_1" type: string tags: description: Tags for organizing and filtering reference tables. example: - - tag_1 - - tag_2 + - "tag_1" + - "tag_2" items: type: string type: array updated_at: description: When the reference table was last updated, in ISO 8601 format. - example: '2000-01-01T01:00:00+00:00' + example: "2000-01-01T01:00:00+00:00" type: string type: object TableResultV2DataAttributesFileMetadata: additionalProperties: false - description: "Metadata specifying where and how to access the reference table's - data file.\n\nFor cloud storage tables (S3/GCS/Azure):\n - sync_enabled and - access_details will always be present\n - error fields (error_message, error_row_count, - error_type) are present only when errors occur\n\nFor local file tables:\n - \ - error fields (error_message, error_row_count) are present only when errors - occur\n - sync_enabled, access_details are never present" + description: |- + Metadata specifying where and how to access the reference table's data file. + + For cloud storage tables (S3/GCS/Azure): + - sync_enabled and access_details will always be present + - error fields (error_message, error_row_count, error_type) are present only when errors occur + + For local file tables: + - error fields (error_message, error_row_count) are present only when errors occur + - sync_enabled, access_details are never present properties: access_details: - $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetails' - description: Cloud storage access configuration. Only present for cloud - storage sources (S3, GCS, Azure). + $ref: "#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetails" + description: Cloud storage access configuration. Only present for cloud storage sources (S3, GCS, Azure). error_message: - description: The error message returned from the last operation (sync for - cloud storage, upload for local file). + description: The error message returned from the last operation (sync for cloud storage, upload for local file). type: string error_row_count: description: The number of rows that failed to process. format: int64 type: integer error_type: - $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataCloudStorageErrorType' - description: The type of error that occurred during file processing. Only - applicable for cloud storage sources. + $ref: "#/components/schemas/TableResultV2DataAttributesFileMetadataCloudStorageErrorType" + description: The type of error that occurred during file processing. Only applicable for cloud storage sources. sync_enabled: - description: Whether this table is synced automatically from cloud storage. - Only applicable for cloud storage sources. + description: Whether this table is synced automatically from cloud storage. Only applicable for cloud storage sources. type: boolean title: FileMetadataV2 type: object TableResultV2DataAttributesFileMetadataCloudStorageErrorType: - description: The type of error that occurred during file processing. This field - provides high-level error categories for easier troubleshooting and is only - present when there are errors. - enum: - - TABLE_SCHEMA_ERROR - - FILE_FORMAT_ERROR - - CONFIGURATION_ERROR - - QUOTA_EXCEEDED - - CONFLICT_ERROR - - VALIDATION_ERROR - - STATE_ERROR - - OPERATION_ERROR - - SYSTEM_ERROR - type: string - x-enum-varnames: - - TABLE_SCHEMA_ERROR - - FILE_FORMAT_ERROR - - CONFIGURATION_ERROR - - QUOTA_EXCEEDED - - CONFLICT_ERROR - - VALIDATION_ERROR - - STATE_ERROR - - OPERATION_ERROR - - SYSTEM_ERROR + description: The type of error that occurred during file processing. This field provides high-level error categories for easier troubleshooting and is only present when there are errors. + enum: + - TABLE_SCHEMA_ERROR + - FILE_FORMAT_ERROR + - CONFIGURATION_ERROR + - QUOTA_EXCEEDED + - CONFLICT_ERROR + - VALIDATION_ERROR + - STATE_ERROR + - OPERATION_ERROR + - SYSTEM_ERROR + type: string + x-enum-varnames: + - TABLE_SCHEMA_ERROR + - FILE_FORMAT_ERROR + - CONFIGURATION_ERROR + - QUOTA_EXCEEDED + - CONFLICT_ERROR + - VALIDATION_ERROR + - STATE_ERROR + - OPERATION_ERROR + - SYSTEM_ERROR TableResultV2DataAttributesFileMetadataOneOfAccessDetails: - description: Cloud storage access configuration for the reference table data - file. + description: Cloud storage access configuration for the reference table data file. properties: aws_detail: - $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail' + $ref: "#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail" azure_detail: - $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail' + $ref: "#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail" gcp_detail: - $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail' + $ref: "#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail" type: object TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail: description: Amazon Web Services S3 storage access configuration. properties: aws_account_id: description: AWS account ID where the S3 bucket is located. - example: '123456789000' + example: "123456789000" type: string aws_bucket_name: description: S3 bucket containing the CSV file. - example: example-data-bucket + example: "example-data-bucket" type: string file_path: description: The relative file path from the S3 bucket root to the CSV file. - example: reference-tables/users.csv + example: "reference-tables/users.csv" type: string type: object x-oneOf-parent: - - AwsDetail + - AwsDetail TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail: description: Azure Blob Storage access configuration. properties: azure_client_id: - description: Azure service principal (application) client ID with permissions - to read from the container. - example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb + description: Azure service principal (application) client ID with permissions to read from the container. + example: "aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb" type: string azure_container_name: description: Azure Blob Storage container containing the CSV file. - example: reference-data + example: "reference-data" type: string azure_storage_account_name: description: Azure storage account where the container is located. - example: examplestorageaccount + example: "examplestorageaccount" type: string azure_tenant_id: description: Azure Active Directory tenant ID. - example: cccccccc-4444-5555-6666-dddddddddddd + example: "cccccccc-4444-5555-6666-dddddddddddd" type: string file_path: - description: The relative file path from the Azure container root to the - CSV file. - example: tables/users.csv + description: The relative file path from the Azure container root to the CSV file. + example: "tables/users.csv" type: string type: object x-oneOf-parent: - - AzureDetail + - AzureDetail TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail: description: Google Cloud Platform storage access configuration. properties: file_path: - description: The relative file path from the GCS bucket root to the CSV - file. - example: data/reference_tables/users.csv + description: The relative file path from the GCS bucket root to the CSV file. + example: "data/reference_tables/users.csv" type: string gcp_bucket_name: description: GCP bucket containing the CSV file. - example: example-data-bucket + example: "example-data-bucket" type: string gcp_project_id: description: GCP project ID where the bucket is located. - example: example-gcp-project-12345 + example: "example-gcp-project-12345" type: string gcp_service_account_email: description: Service account email with read permissions for the GCS bucket. - example: example-service@example-gcp-project-12345.iam.gserviceaccount.com + example: "example-service@example-gcp-project-12345.iam.gserviceaccount.com" type: string type: object x-oneOf-parent: - - GcpDetail + - GcpDetail TableResultV2DataAttributesSchema: description: Schema defining the structure and columns of the reference table. properties: fields: description: The schema fields. items: - $ref: '#/components/schemas/TableResultV2DataAttributesSchemaFieldsItems' + $ref: "#/components/schemas/TableResultV2DataAttributesSchemaFieldsItems" type: array primary_keys: - description: List of field names that serve as primary keys for the table. - Only one primary key is supported, and it is used as an ID to retrieve - rows. + description: List of field names that serve as primary keys for the table. Only one primary key is supported, and it is used as an ID to retrieve rows. example: - - field_1 + - "field_1" items: type: string type: array required: - - fields - - primary_keys + - fields + - primary_keys type: object TableResultV2DataAttributesSchemaFieldsItems: description: A single field (column) in the reference table schema to be returned. properties: name: description: The field name. - example: field_1 + example: "field_1" type: string type: - $ref: '#/components/schemas/ReferenceTableSchemaFieldType' + $ref: "#/components/schemas/ReferenceTableSchemaFieldType" required: - - name - - type + - name + - type type: object TableResultV2DataType: default: reference_table description: Reference table resource type. enum: - - reference_table + - reference_table example: reference_table type: string x-enum-varnames: - - REFERENCE_TABLE + - REFERENCE_TABLE TableRowResourceArray: description: List of rows from a reference table query. properties: data: description: The rows. items: - $ref: '#/components/schemas/TableRowResourceData' + $ref: "#/components/schemas/TableRowResourceData" type: array required: - - data + - data type: object TableRowResourceData: additionalProperties: false description: The data object containing the row column names and values. properties: attributes: - $ref: '#/components/schemas/TableRowResourceDataAttributes' + $ref: "#/components/schemas/TableRowResourceDataAttributes" id: description: Row identifier, corresponding to the primary key value. type: string type: - $ref: '#/components/schemas/TableRowResourceDataType' + $ref: "#/components/schemas/TableRowResourceDataType" required: - - type + - type type: object TableRowResourceDataAttributes: additionalProperties: false description: Column values for this row in the reference table. properties: values: - description: Key-value pairs representing the row data, where keys are field - names from the schema. + description: Key-value pairs representing the row data, where keys are field names from the schema. type: object type: object TableRowResourceDataType: default: row description: Row resource type. enum: - - row + - row example: row type: string x-enum-varnames: - - ROW + - ROW TableRowResourceIdentifier: description: Row resource containing a single row identifier. properties: id: - example: primary_key_value + example: "primary_key_value" type: string type: - $ref: '#/components/schemas/TableRowResourceDataType' + $ref: "#/components/schemas/TableRowResourceDataType" required: - - type - - id + - type + - id type: object TagsEventAttribute: description: Array of tags associated with your event. - example: - - team:A + example: ["team:A"] items: description: Tag associated with your event. type: string type: array Targets: - description: 'List of recipients to notify when a notification rule is triggered. - Many different target types are supported, - + description: |- + List of recipients to notify when a notification rule is triggered. Many different target types are supported, such as email addresses, Slack channels, and PagerDuty services. - - The appropriate integrations need to be properly configured to send notifications - to the specified targets.' - example: - - '@john.doe@email.com' + The appropriate integrations need to be properly configured to send notifications to the specified targets. + example: ["@john.doe@email.com"] items: description: Recipients to notify. type: string @@ -67268,27 +63953,26 @@ components: description: A team properties: attributes: - $ref: '#/components/schemas/TeamAttributes' + $ref: "#/components/schemas/TeamAttributes" id: description: The team's identifier example: aeadc05e-98a8-11ec-ac2c-da7ad0900001 type: string relationships: - $ref: '#/components/schemas/TeamRelationships' + $ref: "#/components/schemas/TeamRelationships" type: - $ref: '#/components/schemas/TeamType' + $ref: "#/components/schemas/TeamType" required: - - attributes - - id - - type + - attributes + - id + - type type: object TeamAttributes: description: Team attributes properties: avatar: - description: Unicode representation of the avatar for the team, limited - to a single grapheme - example: "\U0001F951" + description: Unicode representation of the avatar for the team, limited to a single grapheme + example: "🥑" nullable: true type: string banner: @@ -67353,50 +64037,49 @@ components: nullable: true type: array required: - - handle - - name + - handle + - name type: object TeamConnection: - description: A relationship between a Datadog team and a team from another external - system. + description: A relationship between a Datadog team and a team from another external system. properties: attributes: - $ref: '#/components/schemas/TeamConnectionAttributes' + $ref: "#/components/schemas/TeamConnectionAttributes" id: description: The unique identifier of the team connection. - example: 12345678-1234-5678-9abc-123456789012 + example: "12345678-1234-5678-9abc-123456789012" type: string relationships: - $ref: '#/components/schemas/TeamConnectionRelationships' + $ref: "#/components/schemas/TeamConnectionRelationships" type: - $ref: '#/components/schemas/TeamConnectionType' + $ref: "#/components/schemas/TeamConnectionType" required: - - id - - type + - id + - type type: object TeamConnectionAttributes: description: Attributes of the team connection. properties: managed_by: description: The entity that manages this team connection. - example: github_sync + example: "github_sync" type: string source: description: The name of the external source. - example: github + example: "github" type: string type: object TeamConnectionCreateData: description: Data for creating a team connection. properties: attributes: - $ref: '#/components/schemas/TeamConnectionAttributes' + $ref: "#/components/schemas/TeamConnectionAttributes" relationships: - $ref: '#/components/schemas/TeamConnectionRelationships' + $ref: "#/components/schemas/TeamConnectionRelationships" type: - $ref: '#/components/schemas/TeamConnectionType' + $ref: "#/components/schemas/TeamConnectionType" required: - - type + - type type: object TeamConnectionCreateRequest: description: Request for creating team connections. @@ -67404,10 +64087,10 @@ components: data: description: Array of team connections to create. items: - $ref: '#/components/schemas/TeamConnectionCreateData' + $ref: "#/components/schemas/TeamConnectionCreateData" type: array required: - - data + - data type: object TeamConnectionDeleteRequest: description: Request for deleting team connections. @@ -67415,72 +64098,71 @@ components: data: description: Array of team connection IDs to delete. items: - $ref: '#/components/schemas/TeamConnectionDeleteRequestDataItem' + $ref: "#/components/schemas/TeamConnectionDeleteRequestDataItem" type: array required: - - data + - data type: object TeamConnectionDeleteRequestDataItem: description: A collection of connection ids to delete. properties: id: description: The unique identifier of the team connection to delete. - example: 12345678-1234-5678-9abc-123456789012 + example: "12345678-1234-5678-9abc-123456789012" type: string type: - $ref: '#/components/schemas/TeamConnectionType' + $ref: "#/components/schemas/TeamConnectionType" required: - - id - - type + - id + - type type: object TeamConnectionRelationships: description: Relationships of the team connection. properties: connected_team: - $ref: '#/components/schemas/ConnectedTeamRef' + $ref: "#/components/schemas/ConnectedTeamRef" team: - $ref: '#/components/schemas/TeamRef' + $ref: "#/components/schemas/TeamRef" type: object TeamConnectionType: - default: team_connection + default: "team_connection" description: Team connection resource type. enum: - - team_connection - example: team_connection + - team_connection + example: "team_connection" type: string x-enum-varnames: - - TEAM_CONNECTION + - TEAM_CONNECTION TeamConnectionsResponse: description: Response containing information about multiple team connections. properties: data: description: Array of team connections. items: - $ref: '#/components/schemas/TeamConnection' + $ref: "#/components/schemas/TeamConnection" type: array meta: - $ref: '#/components/schemas/ConnectionsResponseMeta' + $ref: "#/components/schemas/ConnectionsResponseMeta" type: object TeamCreate: description: Team create properties: attributes: - $ref: '#/components/schemas/TeamCreateAttributes' + $ref: "#/components/schemas/TeamCreateAttributes" relationships: - $ref: '#/components/schemas/TeamCreateRelationships' + $ref: "#/components/schemas/TeamCreateRelationships" type: - $ref: '#/components/schemas/TeamType' + $ref: "#/components/schemas/TeamType" required: - - attributes - - type + - attributes + - type type: object TeamCreateAttributes: description: Team creation attributes properties: avatar: - description: Unicode representation of the avatar for the team, limited - to a single grapheme - example: "\U0001F951" + description: Unicode representation of the avatar for the team, limited to a single grapheme + example: "🥑" nullable: true type: string banner: @@ -67514,154 +64196,149 @@ components: type: string type: array required: - - handle - - name + - handle + - name type: object TeamCreateRelationships: description: Relationships formed with the team on creation properties: users: - $ref: '#/components/schemas/RelationshipToUsers' + $ref: "#/components/schemas/RelationshipToUsers" type: object TeamCreateRequest: description: Request to create a team properties: data: - $ref: '#/components/schemas/TeamCreate' + $ref: "#/components/schemas/TeamCreate" required: - - data + - data type: object TeamHierarchyLink: description: Team hierarchy link properties: attributes: - $ref: '#/components/schemas/TeamHierarchyLinkAttributes' + $ref: "#/components/schemas/TeamHierarchyLinkAttributes" id: description: The team hierarchy link's identifier example: b8626d7e-cedd-11eb-abf5-da7ad0900001 type: string relationships: - $ref: '#/components/schemas/TeamHierarchyLinkRelationships' + $ref: "#/components/schemas/TeamHierarchyLinkRelationships" type: - $ref: '#/components/schemas/TeamHierarchyLinkType' + $ref: "#/components/schemas/TeamHierarchyLinkType" required: - - attributes - - id - - type + - attributes + - id + - type type: object TeamHierarchyLinkAttributes: description: Team hierarchy link attributes properties: created_at: description: Timestamp when the team hierarchy link was created - example: '' + example: "" format: date-time type: string provisioned_by: description: The provisioner of the team hierarchy link - example: system + example: "system" type: string required: - - provisioned_by - - created_at + - provisioned_by + - created_at type: object TeamHierarchyLinkCreate: description: Data provided when creating a team hierarchy link properties: relationships: - $ref: '#/components/schemas/TeamHierarchyLinkCreateRelationships' + $ref: "#/components/schemas/TeamHierarchyLinkCreateRelationships" type: - $ref: '#/components/schemas/TeamHierarchyLinkType' + $ref: "#/components/schemas/TeamHierarchyLinkType" required: - - relationships - - type + - relationships + - type type: object TeamHierarchyLinkCreateRelationships: - description: The related teams that will be connected by the team hierarchy - link + description: The related teams that will be connected by the team hierarchy link properties: parent_team: - $ref: '#/components/schemas/TeamHierarchyLinkCreateTeamRelationship' + $ref: "#/components/schemas/TeamHierarchyLinkCreateTeamRelationship" sub_team: - $ref: '#/components/schemas/TeamHierarchyLinkCreateTeamRelationship' + $ref: "#/components/schemas/TeamHierarchyLinkCreateTeamRelationship" required: - - parent_team - - sub_team + - parent_team + - sub_team type: object TeamHierarchyLinkCreateRequest: description: Request to create a team hierarchy link properties: data: - $ref: '#/components/schemas/TeamHierarchyLinkCreate' + $ref: "#/components/schemas/TeamHierarchyLinkCreate" required: - - data + - data type: object TeamHierarchyLinkCreateTeam: - description: This schema defines the attributes about each team that has to - be provided when creating a team hierarchy link + description: This schema defines the attributes about each team that has to be provided when creating a team hierarchy link properties: id: description: The team's identifier example: 692e8073-12c4-4c71-8408-5090bd44c9c8 type: string type: - $ref: '#/components/schemas/TeamType' + $ref: "#/components/schemas/TeamType" required: - - id - - type + - id + - type type: object TeamHierarchyLinkCreateTeamRelationship: - description: Data about each team that will be connected by the team hierarchy - link + description: Data about each team that will be connected by the team hierarchy link properties: data: - $ref: '#/components/schemas/TeamHierarchyLinkCreateTeam' + $ref: "#/components/schemas/TeamHierarchyLinkCreateTeam" required: - - data + - data type: object TeamHierarchyLinkRelationships: description: Team hierarchy link relationships properties: parent_team: - $ref: '#/components/schemas/TeamHierarchyLinkTeamRelationship' + $ref: "#/components/schemas/TeamHierarchyLinkTeamRelationship" sub_team: - $ref: '#/components/schemas/TeamHierarchyLinkTeamRelationship' + $ref: "#/components/schemas/TeamHierarchyLinkTeamRelationship" required: - - parent_team - - sub_team + - parent_team + - sub_team type: object TeamHierarchyLinkResponse: description: Team hierarchy link response properties: data: - $ref: '#/components/schemas/TeamHierarchyLink' + $ref: "#/components/schemas/TeamHierarchyLink" included: description: Included teams items: - $ref: '#/components/schemas/TeamHierarchyLinkTeam' + $ref: "#/components/schemas/TeamHierarchyLinkTeam" type: array links: - $ref: '#/components/schemas/TeamsHierarchyLinksResponseLinks' + $ref: "#/components/schemas/TeamsHierarchyLinksResponseLinks" type: object TeamHierarchyLinkTeam: - description: Team hierarchy links connect different teams. This represents team - objects that are connected by the team hierarchy link. + description: Team hierarchy links connect different teams. This represents team objects that are connected by the team hierarchy link. properties: attributes: - $ref: '#/components/schemas/TeamHierarchyLinkTeamAttributes' + $ref: "#/components/schemas/TeamHierarchyLinkTeamAttributes" id: description: The team's identifier example: 692e8073-12c4-4c71-8408-5090bd44c9c8 type: string type: - $ref: '#/components/schemas/TeamType' + $ref: "#/components/schemas/TeamType" required: - - id - - type + - id + - type type: object TeamHierarchyLinkTeamAttributes: - description: Team hierarchy links connect different teams. This represents attributes - from teams that are connected by the team hierarchy link. + description: Team hierarchy links connect different teams. This represents attributes from teams that are connected by the team hierarchy link. properties: avatar: description: The team's avatar @@ -67698,65 +64375,65 @@ components: format: int64 type: integer required: - - handle - - name + - handle + - name type: object TeamHierarchyLinkTeamRelationship: description: Team hierarchy link team relationship properties: data: - $ref: '#/components/schemas/TeamHierarchyLinkTeam' + $ref: "#/components/schemas/TeamHierarchyLinkTeam" required: - - data + - data type: object TeamHierarchyLinkType: default: team_hierarchy_links description: Team hierarchy link type enum: - - team_hierarchy_links + - team_hierarchy_links example: team_hierarchy_links type: string x-enum-varnames: - - TEAM_HIERARCHY_LINKS + - TEAM_HIERARCHY_LINKS TeamHierarchyLinksResponse: description: Team hierarchy links response properties: data: description: Team hierarchy links response data items: - $ref: '#/components/schemas/TeamHierarchyLink' + $ref: "#/components/schemas/TeamHierarchyLink" type: array included: description: Included teams items: - $ref: '#/components/schemas/TeamHierarchyLinkTeam' + $ref: "#/components/schemas/TeamHierarchyLinkTeam" type: array links: - $ref: '#/components/schemas/TeamsHierarchyLinksResponseLinks' + $ref: "#/components/schemas/TeamsHierarchyLinksResponseLinks" meta: - $ref: '#/components/schemas/TeamsHierarchyLinksResponseMeta' + $ref: "#/components/schemas/TeamsHierarchyLinksResponseMeta" type: object TeamIncluded: description: Included resources related to the team oneOf: - - $ref: '#/components/schemas/User' - - $ref: '#/components/schemas/TeamLink' - - $ref: '#/components/schemas/UserTeamPermission' + - $ref: "#/components/schemas/User" + - $ref: "#/components/schemas/TeamLink" + - $ref: "#/components/schemas/UserTeamPermission" TeamLink: description: Team link properties: attributes: - $ref: '#/components/schemas/TeamLinkAttributes' + $ref: "#/components/schemas/TeamLinkAttributes" id: description: The team link's identifier example: b8626d7e-cedd-11eb-abf5-da7ad0900001 type: string type: - $ref: '#/components/schemas/TeamLinkType' + $ref: "#/components/schemas/TeamLinkType" required: - - attributes - - id - - type + - attributes + - id + - type type: object TeamLinkAttributes: description: Team link attributes @@ -67777,81 +64454,81 @@ components: type: string url: description: The URL for the link - example: https://example.com + example: "https://example.com" type: string required: - - label - - url + - label + - url type: object TeamLinkCreate: description: Team link create properties: attributes: - $ref: '#/components/schemas/TeamLinkAttributes' + $ref: "#/components/schemas/TeamLinkAttributes" type: - $ref: '#/components/schemas/TeamLinkType' + $ref: "#/components/schemas/TeamLinkType" required: - - attributes - - type + - attributes + - type type: object TeamLinkCreateRequest: description: Team link create request properties: data: - $ref: '#/components/schemas/TeamLinkCreate' + $ref: "#/components/schemas/TeamLinkCreate" required: - - data + - data type: object TeamLinkResponse: description: Team link response properties: data: - $ref: '#/components/schemas/TeamLink' + $ref: "#/components/schemas/TeamLink" type: object TeamLinkType: default: team_links description: Team link type enum: - - team_links + - team_links example: team_links type: string x-enum-varnames: - - TEAM_LINKS + - TEAM_LINKS TeamLinksResponse: description: Team links response properties: data: description: Team links response data items: - $ref: '#/components/schemas/TeamLink' + $ref: "#/components/schemas/TeamLink" type: array type: object TeamNotificationRule: description: Team notification rule properties: attributes: - $ref: '#/components/schemas/TeamNotificationRuleAttributes' + $ref: "#/components/schemas/TeamNotificationRuleAttributes" id: description: The identifier of the team notification rule example: b8626d7e-cedd-11eb-abf5-da7ad0900001 type: string type: - $ref: '#/components/schemas/TeamNotificationRuleType' + $ref: "#/components/schemas/TeamNotificationRuleType" required: - - attributes - - type + - attributes + - type type: object TeamNotificationRuleAttributes: description: Team notification rule attributes properties: email: - $ref: '#/components/schemas/TeamNotificationRuleAttributesEmail' + $ref: "#/components/schemas/TeamNotificationRuleAttributesEmail" ms_teams: - $ref: '#/components/schemas/TeamNotificationRuleAttributesMsTeams' + $ref: "#/components/schemas/TeamNotificationRuleAttributesMsTeams" pagerduty: - $ref: '#/components/schemas/TeamNotificationRuleAttributesPagerduty' + $ref: "#/components/schemas/TeamNotificationRuleAttributesPagerduty" slack: - $ref: '#/components/schemas/TeamNotificationRuleAttributesSlack' + $ref: "#/components/schemas/TeamNotificationRuleAttributesSlack" type: object TeamNotificationRuleAttributesEmail: description: Email notification settings for the team @@ -67888,46 +64565,45 @@ components: description: Request to create or update a team notification rule properties: data: - $ref: '#/components/schemas/TeamNotificationRule' + $ref: "#/components/schemas/TeamNotificationRule" required: - - data + - data type: object TeamNotificationRuleResponse: description: Team notification rule response properties: data: - $ref: '#/components/schemas/TeamNotificationRule' + $ref: "#/components/schemas/TeamNotificationRule" type: object TeamNotificationRuleType: default: team_notification_rules description: Team notification rule type enum: - - team_notification_rules + - team_notification_rules example: team_notification_rules type: string x-enum-varnames: - - TEAM_NOTIFICATION_RULES + - TEAM_NOTIFICATION_RULES TeamNotificationRulesResponse: description: Team notification rules response properties: data: description: Team notification rules response data items: - $ref: '#/components/schemas/TeamNotificationRule' + $ref: "#/components/schemas/TeamNotificationRule" type: array meta: - $ref: '#/components/schemas/TeamNotificationRulesResponseMeta' + $ref: "#/components/schemas/TeamNotificationRulesResponseMeta" type: object TeamNotificationRulesResponseMeta: - description: Metadata that is included in the response when querying the team - notification rules + description: Metadata that is included in the response when querying the team notification rules properties: page: - $ref: '#/components/schemas/TeamNotificationRulesResponseMetaPage' + $ref: "#/components/schemas/TeamNotificationRulesResponseMetaPage" type: object TeamNotificationRulesResponseMetaPage: - description: Metadata related to paging information that is included in the - response when querying the team notification rules + description: |- + Metadata related to paging information that is included in the response when querying the team notification rules properties: first_offset: description: The first offset. @@ -67967,105 +64643,99 @@ components: description: Root object representing a team's on-call responder configuration. example: data: - id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23 + id: "111ee23r-aaaaa-aaaa-aaww-1234wertsd23" relationships: escalations: data: - - id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23 - type: escalation_policy_steps + - id: "111ee23r-aaaaa-aaaa-aaww-1234wertsd23" + type: escalation_policy_steps responders: data: - - id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23 - type: users + - id: "111ee23r-aaaaa-aaaa-aaww-1234wertsd23" + type: users type: team_oncall_responders included: - - attributes: - email: test@test.com - name: Test User - status: active - id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23 - type: users - - id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23 - relationships: - responders: - data: - - id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23 - type: users - type: escalation_policy_steps + - attributes: + email: test@test.com + name: Test User + status: active + id: "111ee23r-aaaaa-aaaa-aaww-1234wertsd23" + type: users + - id: "111ee23r-aaaaa-aaaa-aaww-1234wertsd23" + relationships: + responders: + data: + - id: "111ee23r-aaaaa-aaaa-aaww-1234wertsd23" + type: users + type: escalation_policy_steps properties: data: - $ref: '#/components/schemas/TeamOnCallRespondersData' + $ref: "#/components/schemas/TeamOnCallRespondersData" included: description: The `TeamOnCallResponders` `included`. items: - $ref: '#/components/schemas/TeamOnCallRespondersIncluded' + $ref: "#/components/schemas/TeamOnCallRespondersIncluded" type: array type: object TeamOnCallRespondersData: - description: Defines the main on-call responder object for a team, including - relationships and metadata. + description: Defines the main on-call responder object for a team, including relationships and metadata. properties: id: description: Unique identifier of the on-call responder configuration. type: string relationships: - $ref: '#/components/schemas/TeamOnCallRespondersDataRelationships' + $ref: "#/components/schemas/TeamOnCallRespondersDataRelationships" type: - $ref: '#/components/schemas/TeamOnCallRespondersDataType' + $ref: "#/components/schemas/TeamOnCallRespondersDataType" required: - - type + - type type: object TeamOnCallRespondersDataRelationships: - description: Relationship objects linked to a team's on-call responder configuration, - including escalations and responders. + description: Relationship objects linked to a team's on-call responder configuration, including escalations and responders. properties: escalations: - $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalations' + $ref: "#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalations" responders: - $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsResponders' + $ref: "#/components/schemas/TeamOnCallRespondersDataRelationshipsResponders" type: object TeamOnCallRespondersDataRelationshipsEscalations: - description: Defines the escalation policy steps linked to the team's on-call - configuration. + description: Defines the escalation policy steps linked to the team's on-call configuration. properties: data: description: Array of escalation step references. items: - $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalationsDataItems' + $ref: "#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalationsDataItems" type: array type: object TeamOnCallRespondersDataRelationshipsEscalationsDataItems: - description: Represents a link to a specific escalation policy step associated - with the on-call team. + description: Represents a link to a specific escalation policy step associated with the on-call team. properties: id: description: Unique identifier of the escalation step. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType' + $ref: "#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType" required: - - type - - id + - type + - id type: object TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType: default: escalation_policy_steps - description: Identifies the resource type for escalation policy steps linked - to a team's on-call configuration. + description: Identifies the resource type for escalation policy steps linked to a team's on-call configuration. enum: - - escalation_policy_steps + - escalation_policy_steps example: escalation_policy_steps type: string x-enum-varnames: - - ESCALATION_POLICY_STEPS + - ESCALATION_POLICY_STEPS TeamOnCallRespondersDataRelationshipsResponders: - description: Defines the list of users assigned as on-call responders for the - team. + description: Defines the list of users assigned as on-call responders for the team. properties: data: description: Array of user references associated as responders. items: - $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsRespondersDataItems' + $ref: "#/components/schemas/TeamOnCallRespondersDataRelationshipsRespondersDataItems" type: array type: object TeamOnCallRespondersDataRelationshipsRespondersDataItems: @@ -68073,142 +64743,138 @@ components: properties: id: description: Unique identifier of the responder. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsRespondersDataItemsType' + $ref: "#/components/schemas/TeamOnCallRespondersDataRelationshipsRespondersDataItemsType" required: - - type - - id + - type + - id type: object TeamOnCallRespondersDataRelationshipsRespondersDataItemsType: default: users - description: Identifies the resource type for individual user entities associated - with on-call response. + description: Identifies the resource type for individual user entities associated with on-call response. enum: - - users + - users example: users type: string x-enum-varnames: - - USERS + - USERS TeamOnCallRespondersDataType: default: team_oncall_responders - description: Represents the resource type for a group of users assigned to handle - on-call duties within a team. + description: Represents the resource type for a group of users assigned to handle on-call duties within a team. enum: - - team_oncall_responders + - team_oncall_responders example: team_oncall_responders type: string x-enum-varnames: - - TEAM_ONCALL_RESPONDERS + - TEAM_ONCALL_RESPONDERS TeamOnCallRespondersIncluded: - description: Represents an union of related resources included in the response, - such as users and escalation steps. + description: Represents an union of related resources included in the response, such as users and escalation steps. oneOf: - - $ref: '#/components/schemas/User' - - $ref: '#/components/schemas/Escalation' + - $ref: "#/components/schemas/User" + - $ref: "#/components/schemas/Escalation" TeamPermissionSetting: description: Team permission setting properties: attributes: - $ref: '#/components/schemas/TeamPermissionSettingAttributes' + $ref: "#/components/schemas/TeamPermissionSettingAttributes" id: description: The team permission setting's identifier example: TeamPermission-aeadc05e-98a8-11ec-ac2c-da7ad0900001-edit type: string type: - $ref: '#/components/schemas/TeamPermissionSettingType' + $ref: "#/components/schemas/TeamPermissionSettingType" required: - - id - - type + - id + - type type: object TeamPermissionSettingAttributes: description: Team permission setting attributes properties: action: - $ref: '#/components/schemas/TeamPermissionSettingSerializerAction' + $ref: "#/components/schemas/TeamPermissionSettingSerializerAction" editable: - description: Whether or not the permission setting is editable by the current - user + description: Whether or not the permission setting is editable by the current user readOnly: true type: boolean options: - $ref: '#/components/schemas/TeamPermissionSettingValues' + $ref: "#/components/schemas/TeamPermissionSettingValues" title: description: The team permission name readOnly: true type: string value: - $ref: '#/components/schemas/TeamPermissionSettingValue' + $ref: "#/components/schemas/TeamPermissionSettingValue" type: object TeamPermissionSettingResponse: description: Team permission setting response properties: data: - $ref: '#/components/schemas/TeamPermissionSetting' + $ref: "#/components/schemas/TeamPermissionSetting" type: object TeamPermissionSettingSerializerAction: description: The identifier for the action enum: - - manage_membership - - edit + - manage_membership + - edit readOnly: true type: string x-enum-varnames: - - MANAGE_MEMBERSHIP - - EDIT + - MANAGE_MEMBERSHIP + - EDIT TeamPermissionSettingType: default: team_permission_settings description: Team permission setting type enum: - - team_permission_settings + - team_permission_settings example: team_permission_settings type: string x-enum-varnames: - - TEAM_PERMISSION_SETTINGS + - TEAM_PERMISSION_SETTINGS TeamPermissionSettingUpdate: description: Team permission setting update properties: attributes: - $ref: '#/components/schemas/TeamPermissionSettingUpdateAttributes' + $ref: "#/components/schemas/TeamPermissionSettingUpdateAttributes" type: - $ref: '#/components/schemas/TeamPermissionSettingType' + $ref: "#/components/schemas/TeamPermissionSettingType" required: - - type + - type type: object TeamPermissionSettingUpdateAttributes: description: Team permission setting update attributes properties: value: - $ref: '#/components/schemas/TeamPermissionSettingValue' + $ref: "#/components/schemas/TeamPermissionSettingValue" type: object TeamPermissionSettingUpdateRequest: description: Team permission setting update request properties: data: - $ref: '#/components/schemas/TeamPermissionSettingUpdate' + $ref: "#/components/schemas/TeamPermissionSettingUpdate" required: - - data + - data type: object TeamPermissionSettingValue: description: What type of user is allowed to perform the specified action enum: - - admins - - members - - organization - - user_access_manage - - teams_manage + - admins + - members + - organization + - user_access_manage + - teams_manage type: string x-enum-varnames: - - ADMINS - - MEMBERS - - ORGANIZATION - - USER_ACCESS_MANAGE - - TEAMS_MANAGE + - ADMINS + - MEMBERS + - ORGANIZATION + - USER_ACCESS_MANAGE + - TEAMS_MANAGE TeamPermissionSettingValues: description: Possible values for action items: - $ref: '#/components/schemas/TeamPermissionSettingValue' + $ref: "#/components/schemas/TeamPermissionSettingValue" readOnly: true type: array TeamPermissionSettingsResponse: @@ -68217,53 +64883,52 @@ components: data: description: Team permission settings response data items: - $ref: '#/components/schemas/TeamPermissionSetting' + $ref: "#/components/schemas/TeamPermissionSetting" type: array type: object TeamRef: description: Reference to a Datadog team. properties: data: - $ref: '#/components/schemas/TeamRefData' + $ref: "#/components/schemas/TeamRefData" type: object TeamRefData: description: Reference to a Datadog team. properties: id: description: The Datadog team ID. - example: 87654321-4321-8765-dcba-210987654321 + example: "87654321-4321-8765-dcba-210987654321" type: string type: - $ref: '#/components/schemas/TeamRefDataType' + $ref: "#/components/schemas/TeamRefDataType" required: - - id - - type + - id + - type type: object TeamRefDataType: - default: team + default: "team" description: Datadog team resource type. enum: - - team - example: team + - team + example: "team" type: string x-enum-varnames: - - TEAM + - TEAM TeamReference: description: Provides a reference to a team, including ID, type, and basic attributes/relationships. properties: attributes: - $ref: '#/components/schemas/TeamReferenceAttributes' + $ref: "#/components/schemas/TeamReferenceAttributes" id: description: The team's unique identifier. type: string type: - $ref: '#/components/schemas/TeamReferenceType' + $ref: "#/components/schemas/TeamReferenceType" required: - - type + - type type: object TeamReferenceAttributes: - description: Encapsulates the basic attributes of a Team reference, such as - name, handle, and an optional avatar or description. + description: Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description. properties: avatar: description: URL or reference for the team's avatar (if available). @@ -68280,317 +64945,298 @@ components: type: object TeamReferenceType: default: teams - description: Teams resource type. + description: |- + Teams resource type. enum: - - teams + - teams example: teams type: string x-enum-varnames: - - TEAMS + - TEAMS TeamRelationships: description: Resources related to a team properties: team_links: - $ref: '#/components/schemas/RelationshipToTeamLinks' + $ref: "#/components/schemas/RelationshipToTeamLinks" user_team_permissions: - $ref: '#/components/schemas/RelationshipToUserTeamPermission' + $ref: "#/components/schemas/RelationshipToUserTeamPermission" type: object TeamRelationshipsLinks: description: Links attributes. properties: related: description: Related link. - example: /api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links + example: "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links" type: string type: object TeamResponse: description: Response with a team properties: data: - $ref: '#/components/schemas/Team' + $ref: "#/components/schemas/Team" type: object TeamRoutingRules: - description: Represents a complete set of team routing rules, including data - and optionally included related resources. + description: Represents a complete set of team routing rules, including data and optionally included related resources. example: data: id: 27590dae-47be-4a7d-9abf-8f4e45124020 relationships: rules: data: - - id: 03aff2d6-6cbf-496c-997f-a857bbe9a94a - type: team_routing_rules - - id: 03aff2d6-6cbf-496c-997f-a857bbe9a94a - type: team_routing_rules + - id: 03aff2d6-6cbf-496c-997f-a857bbe9a94a + type: team_routing_rules + - id: 03aff2d6-6cbf-496c-997f-a857bbe9a94a + type: team_routing_rules type: team_routing_rules included: - - attributes: - actions: null - query: tags.service:test - time_restriction: - restrictions: - - end_day: monday - end_time: '17:00:00' - start_day: monday - start_time: 09:00:00 - - end_day: tuesday - end_time: '17:00:00' - start_day: tuesday - start_time: 09:00:00 - time_zone: '' - urgency: high - id: 03aff2d6-6cbf-496c-997f-a857bbe9a94a - relationships: - policy: - data: null - type: team_routing_rules + - attributes: + actions: + query: tags.service:test + time_restriction: + restrictions: + - end_day: monday + end_time: "17:00:00" + start_day: monday + start_time: "09:00:00" + - end_day: tuesday + end_time: "17:00:00" + start_day: tuesday + start_time: "09:00:00" + time_zone: "" + urgency: high + id: 03aff2d6-6cbf-496c-997f-a857bbe9a94a + relationships: + policy: + data: + type: team_routing_rules properties: data: - $ref: '#/components/schemas/TeamRoutingRulesData' + $ref: "#/components/schemas/TeamRoutingRulesData" included: description: Provides related routing rules or other included resources. items: - $ref: '#/components/schemas/TeamRoutingRulesIncluded' + $ref: "#/components/schemas/TeamRoutingRulesIncluded" type: array type: object TeamRoutingRulesData: - description: Represents the top-level data object for team routing rules, containing - the ID, relationships, and resource type. + description: Represents the top-level data object for team routing rules, containing the ID, relationships, and resource type. properties: id: - description: Specifies the unique identifier of this team routing rules - record. + description: Specifies the unique identifier of this team routing rules record. type: string relationships: - $ref: '#/components/schemas/TeamRoutingRulesDataRelationships' + $ref: "#/components/schemas/TeamRoutingRulesDataRelationships" type: - $ref: '#/components/schemas/TeamRoutingRulesDataType' + $ref: "#/components/schemas/TeamRoutingRulesDataType" required: - - type + - type type: object TeamRoutingRulesDataRelationships: - description: Specifies relationships for team routing rules, including rule - references. + description: Specifies relationships for team routing rules, including rule references. properties: rules: - $ref: '#/components/schemas/TeamRoutingRulesDataRelationshipsRules' + $ref: "#/components/schemas/TeamRoutingRulesDataRelationshipsRules" type: object TeamRoutingRulesDataRelationshipsRules: description: Holds references to a set of routing rules in a relationship. properties: data: - description: An array of references to the routing rules associated with - this team. + description: An array of references to the routing rules associated with this team. items: - $ref: '#/components/schemas/TeamRoutingRulesDataRelationshipsRulesDataItems' + $ref: "#/components/schemas/TeamRoutingRulesDataRelationshipsRulesDataItems" type: array type: object TeamRoutingRulesDataRelationshipsRulesDataItems: - description: Defines a relationship item to link a routing rule by its ID and - type. + description: "Defines a relationship item to link a routing rule by its ID and type." properties: id: description: Specifies the unique identifier for the related routing rule. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/TeamRoutingRulesDataRelationshipsRulesDataItemsType' + $ref: "#/components/schemas/TeamRoutingRulesDataRelationshipsRulesDataItemsType" required: - - type - - id + - type + - id type: object TeamRoutingRulesDataRelationshipsRulesDataItemsType: default: team_routing_rules - description: Indicates that the resource is of type 'team_routing_rules'. + description: "Indicates that the resource is of type 'team_routing_rules'." enum: - - team_routing_rules + - team_routing_rules example: team_routing_rules type: string x-enum-varnames: - - TEAM_ROUTING_RULES + - TEAM_ROUTING_RULES TeamRoutingRulesDataType: default: team_routing_rules description: Team routing rules resource type. enum: - - team_routing_rules + - team_routing_rules example: team_routing_rules type: string x-enum-varnames: - - TEAM_ROUTING_RULES + - TEAM_ROUTING_RULES TeamRoutingRulesIncluded: - description: Represents additional included resources for team routing rules, - such as associated routing rules. + description: Represents additional included resources for team routing rules, such as associated routing rules. oneOf: - - $ref: '#/components/schemas/RoutingRule' + - $ref: "#/components/schemas/RoutingRule" TeamRoutingRulesRequest: - description: Represents a request to create or update team routing rules, including - the data payload. + description: Represents a request to create or update team routing rules, including the data payload. example: data: attributes: rules: - - actions: null - policy_id: '' - query: tags.service:test - time_restriction: - restrictions: - - end_day: monday - end_time: '17:00:00' - start_day: monday - start_time: 09:00:00 - - end_day: tuesday - end_time: '17:00:00' - start_day: tuesday - start_time: 09:00:00 - time_zone: '' - urgency: high - - actions: - - channel: channel - type: send_slack_message - workspace: workspace - policy_id: fad4eee1-13f5-40d8-886b-4e56d8d5d1c6 - query: '' - time_restriction: null - urgency: low + - actions: + policy_id: "" + query: tags.service:test + time_restriction: + restrictions: + - end_day: monday + end_time: "17:00:00" + start_day: monday + start_time: "09:00:00" + - end_day: tuesday + end_time: "17:00:00" + start_day: tuesday + start_time: "09:00:00" + time_zone: "" + urgency: high + - actions: + - channel: channel + type: send_slack_message + workspace: workspace + policy_id: fad4eee1-13f5-40d8-886b-4e56d8d5d1c6 + query: "" + time_restriction: + urgency: low id: 27590dae-47be-4a7d-9abf-8f4e45124020 type: team_routing_rules properties: data: - $ref: '#/components/schemas/TeamRoutingRulesRequestData' + $ref: "#/components/schemas/TeamRoutingRulesRequestData" type: object TeamRoutingRulesRequestData: - description: Holds the data necessary to create or update team routing rules, - including attributes, ID, and resource type. + description: Holds the data necessary to create or update team routing rules, including attributes, ID, and resource type. properties: attributes: - $ref: '#/components/schemas/TeamRoutingRulesRequestDataAttributes' + $ref: "#/components/schemas/TeamRoutingRulesRequestDataAttributes" id: - description: Specifies the unique identifier for this set of team routing - rules. + description: Specifies the unique identifier for this set of team routing rules. type: string type: - $ref: '#/components/schemas/TeamRoutingRulesRequestDataType' + $ref: "#/components/schemas/TeamRoutingRulesRequestDataType" required: - - type + - type type: object TeamRoutingRulesRequestDataAttributes: - description: Represents the attributes of a request to update or create team - routing rules. + description: Represents the attributes of a request to update or create team routing rules. properties: rules: - description: A list of routing rule items that define how incoming pages - should be handled. + description: A list of routing rule items that define how incoming pages should be handled. items: - $ref: '#/components/schemas/TeamRoutingRulesRequestRule' + $ref: "#/components/schemas/TeamRoutingRulesRequestRule" type: array type: object TeamRoutingRulesRequestDataType: default: team_routing_rules description: Team routing rules resource type. enum: - - team_routing_rules + - team_routing_rules example: team_routing_rules type: string x-enum-varnames: - - TEAM_ROUTING_RULES + - TEAM_ROUTING_RULES TeamRoutingRulesRequestRule: - description: Defines an individual routing rule item that contains the rule - data for the request. + description: Defines an individual routing rule item that contains the rule data for the request. properties: actions: - description: Specifies the list of actions to perform when the routing rule - is matched. + description: Specifies the list of actions to perform when the routing rule is matched. items: - $ref: '#/components/schemas/RoutingRuleAction' + $ref: "#/components/schemas/RoutingRuleAction" type: array policy_id: - description: Identifies the policy to be applied when this routing rule - matches. + description: Identifies the policy to be applied when this routing rule matches. type: string query: description: Defines the query or condition that triggers this routing rule. type: string time_restriction: - $ref: '#/components/schemas/TimeRestrictions' + $ref: "#/components/schemas/TimeRestrictions" urgency: - $ref: '#/components/schemas/Urgency' + $ref: "#/components/schemas/Urgency" type: object TeamSyncAttributes: description: Team sync attributes. properties: frequency: - $ref: '#/components/schemas/TeamSyncAttributesFrequency' + $ref: "#/components/schemas/TeamSyncAttributesFrequency" source: - $ref: '#/components/schemas/TeamSyncAttributesSource' + $ref: "#/components/schemas/TeamSyncAttributesSource" sync_membership: - $ref: '#/components/schemas/TeamSyncAttributesSyncMembership' + $ref: "#/components/schemas/TeamSyncAttributesSyncMembership" type: - $ref: '#/components/schemas/TeamSyncAttributesType' + $ref: "#/components/schemas/TeamSyncAttributesType" required: - - source - - type + - source + - type type: object TeamSyncAttributesFrequency: - description: How often the sync process should be run. Defaults to `once` when - not provided. + description: How often the sync process should be run. Defaults to `once` when not provided. enum: - - once - - continuously - - paused + - once + - continuously + - paused example: once type: string x-enum-varnames: - - ONCE - - CONTINUOUSLY - - PAUSED + - ONCE + - CONTINUOUSLY + - PAUSED TeamSyncAttributesSource: - description: The external source platform for team synchronization. Only "github" - is supported. + description: The external source platform for team synchronization. Only "github" is supported. enum: - - github + - github example: github type: string x-enum-varnames: - - GITHUB + - GITHUB TeamSyncAttributesSyncMembership: - description: Whether to sync members from the external team to the Datadog team. - Defaults to `false` when not provided. + description: Whether to sync members from the external team to the Datadog team. Defaults to `false` when not provided. example: true type: boolean TeamSyncAttributesType: - description: The type of synchronization operation. "link" connects teams by - matching names. "provision" creates new teams when no match is found. + description: The type of synchronization operation. "link" connects teams by matching names. "provision" creates new teams when no match is found. enum: - - link - - provision + - link + - provision example: link type: string x-enum-varnames: - - LINK - - PROVISION + - LINK + - PROVISION TeamSyncBulkType: description: Team sync bulk type. enum: - - team_sync_bulk + - team_sync_bulk example: team_sync_bulk type: string x-enum-varnames: - - TEAM_SYNC_BULK + - TEAM_SYNC_BULK TeamSyncData: - description: A configuration governing syncing between Datadog teams and teams - from an external system. + description: A configuration governing syncing between Datadog teams and teams from an external system. properties: attributes: - $ref: '#/components/schemas/TeamSyncAttributes' + $ref: "#/components/schemas/TeamSyncAttributes" id: description: The sync's identifier example: aeadc05e-98a8-11ec-ac2c-da7ad0900001 type: string type: - $ref: '#/components/schemas/TeamSyncBulkType' + $ref: "#/components/schemas/TeamSyncBulkType" required: - - attributes - - type + - attributes + - type type: object TeamSyncRequest: description: Team sync request. @@ -68602,9 +65248,9 @@ components: type: team_sync_bulk properties: data: - $ref: '#/components/schemas/TeamSyncData' + $ref: "#/components/schemas/TeamSyncData" required: - - data + - data type: object TeamSyncResponse: description: Team sync configurations response. @@ -68612,61 +65258,59 @@ components: data: description: List of team sync configurations items: - $ref: '#/components/schemas/TeamSyncData' + $ref: "#/components/schemas/TeamSyncData" type: array type: object TeamTarget: - description: Represents a team target for an escalation policy step, including - the team's ID and resource type. + description: "Represents a team target for an escalation policy step, including the team's ID and resource type." properties: id: - description: Specifies the unique identifier of the team resource. - example: 00000000-aba1-0000-0000-000000000000 + description: "Specifies the unique identifier of the team resource." + example: "00000000-aba1-0000-0000-000000000000" type: string type: - $ref: '#/components/schemas/TeamTargetType' + $ref: "#/components/schemas/TeamTargetType" required: - - type - - id + - type + - id type: object TeamTargetType: default: teams - description: Indicates that the resource is of type `teams`. + description: "Indicates that the resource is of type `teams`." enum: - - teams + - teams example: teams type: string x-enum-varnames: - - TEAMS + - TEAMS TeamType: default: team description: Team type enum: - - team + - team example: team type: string x-enum-varnames: - - TEAM + - TEAM TeamUpdate: description: Team update request properties: attributes: - $ref: '#/components/schemas/TeamUpdateAttributes' + $ref: "#/components/schemas/TeamUpdateAttributes" relationships: - $ref: '#/components/schemas/TeamUpdateRelationships' + $ref: "#/components/schemas/TeamUpdateRelationships" type: - $ref: '#/components/schemas/TeamType' + $ref: "#/components/schemas/TeamType" required: - - attributes - - type + - attributes + - type type: object TeamUpdateAttributes: description: Team update attributes properties: avatar: - description: Unicode representation of the avatar for the team, limited - to a single grapheme - example: "\U0001F951" + description: Unicode representation of the avatar for the team, limited to a single grapheme + example: "🥑" nullable: true type: string banner: @@ -68700,61 +65344,60 @@ components: type: string type: array required: - - handle - - name + - handle + - name type: object TeamUpdateRelationships: description: Team update relationships properties: team_links: - $ref: '#/components/schemas/RelationshipToTeamLinks' + $ref: "#/components/schemas/RelationshipToTeamLinks" type: object TeamUpdateRequest: description: Team update request properties: data: - $ref: '#/components/schemas/TeamUpdate' + $ref: "#/components/schemas/TeamUpdate" required: - - data + - data type: object TeamsField: description: Supported teams field. enum: - - id - - name - - handle - - summary - - description - - avatar - - banner - - visible_modules - - hidden_modules - - created_at - - modified_at - - user_count - - link_count - - team_links - - user_team_permissions - type: string - x-enum-varnames: - - ID - - NAME - - HANDLE - - SUMMARY - - DESCRIPTION - - AVATAR - - BANNER - - VISIBLE_MODULES - - HIDDEN_MODULES - - CREATED_AT - - MODIFIED_AT - - USER_COUNT - - LINK_COUNT - - TEAM_LINKS - - USER_TEAM_PERMISSIONS + - id + - name + - handle + - summary + - description + - avatar + - banner + - visible_modules + - hidden_modules + - created_at + - modified_at + - user_count + - link_count + - team_links + - user_team_permissions + type: string + x-enum-varnames: + - ID + - NAME + - HANDLE + - SUMMARY + - DESCRIPTION + - AVATAR + - BANNER + - VISIBLE_MODULES + - HIDDEN_MODULES + - CREATED_AT + - MODIFIED_AT + - USER_COUNT + - LINK_COUNT + - TEAM_LINKS + - USER_TEAM_PERMISSIONS TeamsHierarchyLinksResponseLinks: - description: When querying team hierarchy links, a set of links for navigation - between different pages is included + description: When querying team hierarchy links, a set of links for navigation between different pages is included properties: first: description: Link to the first page. @@ -68777,15 +65420,13 @@ components: type: string type: object TeamsHierarchyLinksResponseMeta: - description: Metadata that is included in the response when querying the team - hierarchy links + description: Metadata that is included in the response when querying the team hierarchy links properties: page: - $ref: '#/components/schemas/TeamsHierarchyLinksResponseMetaPage' + $ref: "#/components/schemas/TeamsHierarchyLinksResponseMetaPage" type: object TeamsHierarchyLinksResponseMetaPage: - description: Metadata related to paging information that is included in the - response when querying the team hierarchy links + description: Metadata related to paging information that is included in the response when querying the team hierarchy links properties: first_number: description: First page number. @@ -68819,7 +65460,7 @@ components: type: integer type: description: Pagination type. - example: number_size + example: "number_size" type: string type: object TeamsResponse: @@ -68828,17 +65469,17 @@ components: data: description: Teams response data items: - $ref: '#/components/schemas/Team' + $ref: "#/components/schemas/Team" type: array included: description: Resources related to the team items: - $ref: '#/components/schemas/TeamIncluded' + $ref: "#/components/schemas/TeamIncluded" type: array links: - $ref: '#/components/schemas/TeamsResponseLinks' + $ref: "#/components/schemas/TeamsResponseLinks" meta: - $ref: '#/components/schemas/TeamsResponseMeta' + $ref: "#/components/schemas/TeamsResponseMeta" type: object TeamsResponseLinks: description: Teams response links. @@ -68865,7 +65506,7 @@ components: description: Teams response metadata. properties: pagination: - $ref: '#/components/schemas/TeamsResponseMetaPagination' + $ref: "#/components/schemas/TeamsResponseMetaPagination" type: object TeamsResponseMetaPagination: description: Teams response metadata. @@ -68913,42 +65554,42 @@ components: home_region: us-ashburn-1 logs_config: compartment_tag_filters: - - compartment.test + - compartment.test enabled: true enabled_services: - - compute + - compute metrics_config: compartment_tag_filters: - - compartment.test + - compartment.test enabled: true excluded_services: - - compute + - compute regions_config: available: - - us-ashburn-1 - - us-phoenix-1 + - us-ashburn-1 + - us-phoenix-1 disabled: - - us-phoenix-1 + - us-phoenix-1 enabled: - - us-ashburn-1 + - us-ashburn-1 resource_collection_enabled: true user_ocid: ocid.user.test id: ocid.tenancy.test type: oci_tenancy properties: data: - $ref: '#/components/schemas/TenancyConfigData' + $ref: "#/components/schemas/TenancyConfigData" type: object TenancyConfigData: properties: attributes: - $ref: '#/components/schemas/TenancyConfigDataAttributes' + $ref: "#/components/schemas/TenancyConfigDataAttributes" id: type: string type: - $ref: '#/components/schemas/UpdateTenancyConfigDataType' + $ref: "#/components/schemas/UpdateTenancyConfigDataType" required: - - type + - type type: object TenancyConfigDataAttributes: properties: @@ -68968,13 +65609,13 @@ components: home_region: type: string logs_config: - $ref: '#/components/schemas/TenancyConfigDataAttributesLogsConfig' + $ref: "#/components/schemas/TenancyConfigDataAttributesLogsConfig" metrics_config: - $ref: '#/components/schemas/TenancyConfigDataAttributesMetricsConfig' + $ref: "#/components/schemas/TenancyConfigDataAttributesMetricsConfig" parent_tenancy_name: type: string regions_config: - $ref: '#/components/schemas/TenancyConfigDataAttributesRegionsConfig' + $ref: "#/components/schemas/TenancyConfigDataAttributesRegionsConfig" resource_collection_enabled: type: boolean tenancy_name: @@ -69026,60 +65667,60 @@ components: TenancyConfigList: example: data: - - attributes: - config_version: 2 - cost_collection_enabled: true - dd_compartment_id: ocid.compartment.test - dd_stack_id: ocid.stack.test - home_region: us-ashburn-1 - logs_config: - compartment_tag_filters: - - compartment.test - enabled: true - enabled_services: - - compute - metrics_config: - compartment_tag_filters: - - compartment.test - enabled: true - excluded_services: - - compute - regions_config: - available: - - us-ashburn-1 - - us-phoenix-1 - disabled: - - us-phoenix-1 - enabled: - - us-ashburn-1 - resource_collection_enabled: true - user_ocid: ocid.user.test - id: ocid.tenancy.test - type: oci_tenancy - properties: - data: - items: - $ref: '#/components/schemas/TenancyConfigData' - type: array - required: - - data + - attributes: + config_version: 2 + cost_collection_enabled: true + dd_compartment_id: ocid.compartment.test + dd_stack_id: ocid.stack.test + home_region: us-ashburn-1 + logs_config: + compartment_tag_filters: + - compartment.test + enabled: true + enabled_services: + - compute + metrics_config: + compartment_tag_filters: + - compartment.test + enabled: true + excluded_services: + - compute + regions_config: + available: + - us-ashburn-1 + - us-phoenix-1 + disabled: + - us-phoenix-1 + enabled: + - us-ashburn-1 + resource_collection_enabled: true + user_ocid: ocid.user.test + id: ocid.tenancy.test + type: oci_tenancy + properties: + data: + items: + $ref: "#/components/schemas/TenancyConfigData" + type: array + required: + - data type: object TenancyProductsData: properties: attributes: - $ref: '#/components/schemas/TenancyProductsDataAttributes' + $ref: "#/components/schemas/TenancyProductsDataAttributes" id: type: string type: - $ref: '#/components/schemas/TenancyProductsDataType' + $ref: "#/components/schemas/TenancyProductsDataType" required: - - type + - type type: object TenancyProductsDataAttributes: properties: products: items: - $ref: '#/components/schemas/TenancyProductsDataAttributesProductsItems' + $ref: "#/components/schemas/TenancyProductsDataAttributesProductsItems" type: array type: object TenancyProductsDataAttributesProductsItems: @@ -69093,35 +65734,35 @@ components: default: oci_tenancy_product description: OCI tenancy product resource type. enum: - - oci_tenancy_product + - oci_tenancy_product example: oci_tenancy_product type: string x-enum-varnames: - - OCI_TENANCY_PRODUCT + - OCI_TENANCY_PRODUCT TenancyProductsList: example: data: - - attributes: - products: - - enabled: true - product_key: CLOUD_SECURITY_POSTURE_MANAGEMENT - id: ocid.tenancy.test - type: oci_tenancy_product + - attributes: + products: + - enabled: true + product_key: CLOUD_SECURITY_POSTURE_MANAGEMENT + id: ocid.tenancy.test + type: oci_tenancy_product properties: data: items: - $ref: '#/components/schemas/TenancyProductsData' + $ref: "#/components/schemas/TenancyProductsData" type: array required: - - data + - data type: object ThreatHuntingJobDataType: description: Type of payload. enum: - - historicalDetectionsJob + - historicalDetectionsJob type: string x-enum-varnames: - - HISTORICALDETECTIONSJOB + - HISTORICALDETECTIONSJOB ThreatHuntingJobListMeta: description: Metadata about the list of jobs. properties: @@ -69135,31 +65776,31 @@ components: description: Job options. properties: anomalyDetectionOptions: - $ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptions" detectionMethod: - $ref: '#/components/schemas/SecurityMonitoringRuleDetectionMethod' + $ref: "#/components/schemas/SecurityMonitoringRuleDetectionMethod" evaluationWindow: - $ref: '#/components/schemas/SecurityMonitoringRuleEvaluationWindow' + $ref: "#/components/schemas/SecurityMonitoringRuleEvaluationWindow" impossibleTravelOptions: - $ref: '#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptions" keepAlive: - $ref: '#/components/schemas/SecurityMonitoringRuleKeepAlive' + $ref: "#/components/schemas/SecurityMonitoringRuleKeepAlive" maxSignalDuration: - $ref: '#/components/schemas/SecurityMonitoringRuleMaxSignalDuration' + $ref: "#/components/schemas/SecurityMonitoringRuleMaxSignalDuration" newValueOptions: - $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleNewValueOptions" sequenceDetectionOptions: - $ref: '#/components/schemas/SecurityMonitoringRuleSequenceDetectionOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleSequenceDetectionOptions" thirdPartyRuleOptions: - $ref: '#/components/schemas/SecurityMonitoringRuleThirdPartyOptions' + $ref: "#/components/schemas/SecurityMonitoringRuleThirdPartyOptions" type: object ThreatHuntingJobQuery: description: Query for selecting logs analyzed by the threat hunting job. properties: aggregation: - $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation' + $ref: "#/components/schemas/SecurityMonitoringRuleQueryAggregation" dataSource: - $ref: '#/components/schemas/SecurityMonitoringStandardDataSource' + $ref: "#/components/schemas/SecurityMonitoringStandardDataSource" distinctFields: description: Field for which the cardinality is measured. Sent as an array. items: @@ -69174,16 +65815,11 @@ components: type: array hasOptionalGroupByFields: default: false - description: When false, events without a group-by value are ignored by - the query. When true, events with missing group-by fields are processed - with `N/A`, replacing the missing values. + description: When false, events without a group-by value are ignored by the query. When true, events with missing group-by fields are processed with `N/A`, replacing the missing values. example: false type: boolean metrics: - description: Group of target fields to aggregate over when using the sum, - max, geo data, or new value aggregations. The sum, max, and geo data aggregations - only accept one value in this list, whereas the new value aggregation - accepts up to five values. + description: Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values. items: description: Field. type: string @@ -69200,7 +65836,7 @@ components: description: Threat hunting job response. properties: data: - $ref: '#/components/schemas/ThreatHuntingJobResponseData' + $ref: "#/components/schemas/ThreatHuntingJobResponseData" type: object ThreatHuntingJobResponseAttributes: description: Threat hunting job attributes. @@ -69215,11 +65851,10 @@ components: description: The name of the user who created the job. type: string createdFromRuleId: - description: ID of the rule used to create the job (if it is created from - a rule). + description: ID of the rule used to create the job (if it is created from a rule). type: string jobDefinition: - $ref: '#/components/schemas/JobDefinition' + $ref: "#/components/schemas/JobDefinition" jobName: description: Job name. type: string @@ -69237,68 +65872,60 @@ components: description: Threat hunting job response data. properties: attributes: - $ref: '#/components/schemas/ThreatHuntingJobResponseAttributes' + $ref: "#/components/schemas/ThreatHuntingJobResponseAttributes" id: description: ID of the job. type: string type: - $ref: '#/components/schemas/ThreatHuntingJobDataType' + $ref: "#/components/schemas/ThreatHuntingJobDataType" type: object TimeAggregation: - description: 'Time aggregation period (in seconds) is used to aggregate the - results of the notification rule evaluation. - - Results are aggregated over a selected time frame using a rolling window, - which updates with each new evaluation. - + description: |- + Time aggregation period (in seconds) is used to aggregate the results of the notification rule evaluation. + Results are aggregated over a selected time frame using a rolling window, which updates with each new evaluation. Notifications are only sent for new issues discovered during the window. - - Time aggregation is only available for vulnerability-based notification rules. - When omitted or set to 0, no aggregation - - is done.' + Time aggregation is only available for vulnerability-based notification rules. When omitted or set to 0, no aggregation + is done. example: 86400 format: int64 type: integer TimeRestriction: - description: Defines a single time restriction rule with start and end times - and the applicable weekdays. + description: Defines a single time restriction rule with start and end times and the applicable weekdays. properties: end_day: - $ref: '#/components/schemas/Weekday' + $ref: "#/components/schemas/Weekday" end_time: description: Specifies the ending time for this restriction. type: string start_day: - $ref: '#/components/schemas/Weekday' + $ref: "#/components/schemas/Weekday" start_time: description: Specifies the starting time for this restriction. type: string type: object TimeRestrictions: - description: Holds time zone information and a list of time restrictions for - a routing rule. + description: Holds time zone information and a list of time restrictions for a routing rule. properties: restrictions: description: Defines the list of time-based restrictions. items: - $ref: '#/components/schemas/TimeRestriction' + $ref: "#/components/schemas/TimeRestriction" type: array time_zone: description: Specifies the time zone applicable to the restrictions. - example: '' + example: "" type: string required: - - time_zone - - restrictions + - time_zone + - restrictions type: object TimelineCell: description: timeline cell properties: author: - $ref: '#/components/schemas/TimelineCellAuthor' + $ref: "#/components/schemas/TimelineCellAuthor" cell_content: - $ref: '#/components/schemas/TimelineCellContent' + $ref: "#/components/schemas/TimelineCellContent" created_at: description: Timestamp of when the cell was created format: date-time @@ -69315,19 +65942,19 @@ components: readOnly: true type: string type: - $ref: '#/components/schemas/TimelineCellType' + $ref: "#/components/schemas/TimelineCellType" type: object TimelineCellAuthor: description: author of the timeline cell oneOf: - - $ref: '#/components/schemas/TimelineCellAuthorUser' + - $ref: "#/components/schemas/TimelineCellAuthorUser" TimelineCellAuthorUser: description: timeline cell user author properties: content: - $ref: '#/components/schemas/TimelineCellAuthorUserContent' + $ref: "#/components/schemas/TimelineCellAuthorUserContent" type: - $ref: '#/components/schemas/TimelineCellAuthorUserType' + $ref: "#/components/schemas/TimelineCellAuthorUserType" type: object TimelineCellAuthorUserContent: description: user author content. @@ -69348,15 +65975,15 @@ components: TimelineCellAuthorUserType: description: user author type. enum: - - USER + - USER example: USER type: string x-enum-varnames: - - USER + - USER TimelineCellContent: description: timeline cell content oneOf: - - $ref: '#/components/schemas/TimelineCellContentComment' + - $ref: "#/components/schemas/TimelineCellContentComment" TimelineCellContentComment: description: comment content properties: @@ -69368,58 +65995,57 @@ components: description: Timeline cell JSON:API resource properties: attributes: - $ref: '#/components/schemas/TimelineCell' + $ref: "#/components/schemas/TimelineCell" id: description: Timeline cell's identifier example: aeadc05e-98a8-11ec-ac2c-da7ad0900001 type: string type: - $ref: '#/components/schemas/TimelineCellResourceType' + $ref: "#/components/schemas/TimelineCellResourceType" required: - - id - - type - - attributes + - id + - type + - attributes type: object TimelineCellResourceType: default: timeline_cell description: Timeline cell JSON:API resource type enum: - - timeline_cell + - timeline_cell example: timeline_cell type: string x-enum-varnames: - - TIMELINE_CELL + - TIMELINE_CELL TimelineCellType: description: Timeline cell content type enum: - - COMMENT + - COMMENT example: COMMENT type: string x-enum-varnames: - - COMMENT + - COMMENT TimelineResponse: description: Timeline response properties: data: description: The `TimelineResponse` `data`. items: - $ref: '#/components/schemas/TimelineCellResource' + $ref: "#/components/schemas/TimelineCellResource" type: array type: object TimeseriesFormulaQueryRequest: description: A request wrapper around a single timeseries query to be executed. properties: data: - $ref: '#/components/schemas/TimeseriesFormulaRequest' + $ref: "#/components/schemas/TimeseriesFormulaRequest" required: - - data + - data type: object TimeseriesFormulaQueryResponse: - description: A message containing one response to a timeseries query made with - timeseries formula query request. + description: A message containing one response to a timeseries query made with timeseries formula query request. properties: data: - $ref: '#/components/schemas/TimeseriesResponse' + $ref: "#/components/schemas/TimeseriesResponse" errors: description: The error generated by the request. type: string @@ -69428,12 +66054,12 @@ components: description: A single timeseries query to be executed. properties: attributes: - $ref: '#/components/schemas/TimeseriesFormulaRequestAttributes' + $ref: "#/components/schemas/TimeseriesFormulaRequestAttributes" type: - $ref: '#/components/schemas/TimeseriesFormulaRequestType' + $ref: "#/components/schemas/TimeseriesFormulaRequestType" required: - - type - - attributes + - type + - attributes type: object TimeseriesFormulaRequestAttributes: description: The object describing a timeseries formula request. @@ -69441,138 +66067,120 @@ components: formulas: description: List of formulas to be calculated and returned as responses. items: - $ref: '#/components/schemas/QueryFormula' + $ref: "#/components/schemas/QueryFormula" type: array from: - description: Start date (inclusive) of the query in milliseconds since the - Unix epoch. + description: Start date (inclusive) of the query in milliseconds since the Unix epoch. example: 1568899800000 format: int64 type: integer interval: - description: 'A time interval in milliseconds. - + description: |- + A time interval in milliseconds. May be overridden by a larger interval if the query would result in - too many points for the specified timeframe. - - Defaults to a reasonable interval for the given timeframe.' + Defaults to a reasonable interval for the given timeframe. example: 5000 format: int64 type: integer queries: - $ref: '#/components/schemas/TimeseriesFormulaRequestQueries' + $ref: "#/components/schemas/TimeseriesFormulaRequestQueries" to: - description: End date (exclusive) of the query in milliseconds since the - Unix epoch. + description: End date (exclusive) of the query in milliseconds since the Unix epoch. example: 1568923200000 format: int64 type: integer required: - - to - - from - - queries + - to + - from + - queries type: object TimeseriesFormulaRequestQueries: description: List of queries to be run and used as inputs to the formulas. example: - - data_source: metrics - query: avg:system.cpu.user{*} by {env} + - data_source: metrics + query: "avg:system.cpu.user{*} by {env}" items: - $ref: '#/components/schemas/TimeseriesQuery' + $ref: "#/components/schemas/TimeseriesQuery" type: array TimeseriesFormulaRequestType: - default: timeseries_request + default: "timeseries_request" description: The type of the resource. The value should always be timeseries_request. - enum: - - timeseries_request - example: timeseries_request + enum: ["timeseries_request"] + example: "timeseries_request" type: string - x-enum-varnames: - - TIMESERIES_REQUEST + x-enum-varnames: ["TIMESERIES_REQUEST"] TimeseriesFormulaResponseType: - default: timeseries_response + default: "timeseries_response" description: The type of the resource. The value should always be timeseries_response. - enum: - - timeseries_response - example: timeseries_response + enum: ["timeseries_response"] + example: "timeseries_response" type: string - x-enum-varnames: - - TIMESERIES_RESPONSE + x-enum-varnames: ["TIMESERIES_RESPONSE"] TimeseriesQuery: - description: An individual timeseries query to one of the basic Datadog data - sources. + description: An individual timeseries query to one of the basic Datadog data sources. example: data_source: metrics - query: avg:system.cpu.user{*} by {env} + query: "avg:system.cpu.user{*} by {env}" oneOf: - - $ref: '#/components/schemas/MetricsTimeseriesQuery' - - $ref: '#/components/schemas/EventsTimeseriesQuery' + - $ref: "#/components/schemas/MetricsTimeseriesQuery" + - $ref: "#/components/schemas/EventsTimeseriesQuery" TimeseriesResponse: description: A message containing the response to a timeseries query. properties: attributes: - $ref: '#/components/schemas/TimeseriesResponseAttributes' + $ref: "#/components/schemas/TimeseriesResponseAttributes" type: - $ref: '#/components/schemas/TimeseriesFormulaResponseType' + $ref: "#/components/schemas/TimeseriesFormulaResponseType" type: object TimeseriesResponseAttributes: description: The object describing a timeseries response. properties: series: - $ref: '#/components/schemas/TimeseriesResponseSeriesList' + $ref: "#/components/schemas/TimeseriesResponseSeriesList" times: - $ref: '#/components/schemas/TimeseriesResponseTimes' + $ref: "#/components/schemas/TimeseriesResponseTimes" values: - $ref: '#/components/schemas/TimeseriesResponseValuesList' + $ref: "#/components/schemas/TimeseriesResponseValuesList" type: object TimeseriesResponseSeries: - description: '' + description: "" properties: group_tags: - $ref: '#/components/schemas/GroupTags' + $ref: "#/components/schemas/GroupTags" query_index: - description: The index of the query in the "formulas" array (or "queries" - array if no "formulas" was specified). + description: The index of the query in the "formulas" array (or "queries" array if no "formulas" was specified). example: 0 format: int32 maximum: 2147483647 type: integer unit: - description: 'Detailed information about the unit. - - The first element describes the "primary unit" (for example, `bytes` in - `bytes per second`). - - The second element describes the "per unit" (for example, `second` in - `bytes per second`). - - If the second element is not present, the API returns null.' + description: |- + Detailed information about the unit. + The first element describes the "primary unit" (for example, `bytes` in `bytes per second`). + The second element describes the "per unit" (for example, `second` in `bytes per second`). + If the second element is not present, the API returns null. items: - $ref: '#/components/schemas/Unit' + $ref: "#/components/schemas/Unit" nullable: true type: array type: object TimeseriesResponseSeriesList: - description: Array of response series. The index here corresponds to the index - in the `formulas` or `queries` array from the request. + description: Array of response series. The index here corresponds to the index in the `formulas` or `queries` array from the request. items: - $ref: '#/components/schemas/TimeseriesResponseSeries' + $ref: "#/components/schemas/TimeseriesResponseSeries" type: array TimeseriesResponseTimes: description: Array of times, 1-1 match with individual values arrays. items: - description: Start date (inclusive) of the query in seconds since the Unix - epoch. + description: Start date (inclusive) of the query in seconds since the Unix epoch. example: 1568899800000 format: int64 type: integer type: array TimeseriesResponseValues: description: Array of values for an individual formula or query. - example: - - 1575317847.0 - - 0.5 + example: [1575317847.0, 0.5] items: description: An individual value for a given time. format: double @@ -69580,10 +66188,9 @@ components: type: number type: array TimeseriesResponseValuesList: - description: Array of value-arrays. The index here corresponds to the index - in the `formulas` or `queries` array from the request. + description: Array of value-arrays. The index here corresponds to the index in the `formulas` or `queries` array from the request. items: - $ref: '#/components/schemas/TimeseriesResponseValues' + $ref: "#/components/schemas/TimeseriesResponseValues" type: array TokenName: description: Name for tokens. @@ -69593,33 +66200,33 @@ components: TokenType: description: The definition of `TokenType` object. enum: - - SECRET + - SECRET example: SECRET type: string x-enum-varnames: - - SECRET + - SECRET Trigger: - description: One of the triggers that can start the execution of a workflow. + description: "One of the triggers that can start the execution of a workflow." oneOf: - - $ref: '#/components/schemas/APITriggerWrapper' - - $ref: '#/components/schemas/AppTriggerWrapper' - - $ref: '#/components/schemas/CaseTriggerWrapper' - - $ref: '#/components/schemas/ChangeEventTriggerWrapper' - - $ref: '#/components/schemas/DatabaseMonitoringTriggerWrapper' - - $ref: '#/components/schemas/DatastoreTriggerWrapper' - - $ref: '#/components/schemas/DashboardTriggerWrapper' - - $ref: '#/components/schemas/FormTriggerWrapper' - - $ref: '#/components/schemas/GithubWebhookTriggerWrapper' - - $ref: '#/components/schemas/IncidentTriggerWrapper' - - $ref: '#/components/schemas/MonitorTriggerWrapper' - - $ref: '#/components/schemas/NotebookTriggerWrapper' - - $ref: '#/components/schemas/OnCallTriggerWrapper' - - $ref: '#/components/schemas/ScheduleTriggerWrapper' - - $ref: '#/components/schemas/SecurityTriggerWrapper' - - $ref: '#/components/schemas/SelfServiceTriggerWrapper' - - $ref: '#/components/schemas/SlackTriggerWrapper' - - $ref: '#/components/schemas/SoftwareCatalogTriggerWrapper' - - $ref: '#/components/schemas/WorkflowTriggerWrapper' + - $ref: "#/components/schemas/APITriggerWrapper" + - $ref: "#/components/schemas/AppTriggerWrapper" + - $ref: "#/components/schemas/CaseTriggerWrapper" + - $ref: "#/components/schemas/ChangeEventTriggerWrapper" + - $ref: "#/components/schemas/DatabaseMonitoringTriggerWrapper" + - $ref: "#/components/schemas/DatastoreTriggerWrapper" + - $ref: "#/components/schemas/DashboardTriggerWrapper" + - $ref: "#/components/schemas/FormTriggerWrapper" + - $ref: "#/components/schemas/GithubWebhookTriggerWrapper" + - $ref: "#/components/schemas/IncidentTriggerWrapper" + - $ref: "#/components/schemas/MonitorTriggerWrapper" + - $ref: "#/components/schemas/NotebookTriggerWrapper" + - $ref: "#/components/schemas/OnCallTriggerWrapper" + - $ref: "#/components/schemas/ScheduleTriggerWrapper" + - $ref: "#/components/schemas/SecurityTriggerWrapper" + - $ref: "#/components/schemas/SelfServiceTriggerWrapper" + - $ref: "#/components/schemas/SlackTriggerWrapper" + - $ref: "#/components/schemas/SoftwareCatalogTriggerWrapper" + - $ref: "#/components/schemas/WorkflowTriggerWrapper" TriggerRateLimit: description: Defines a rate limit for a trigger. properties: @@ -69628,63 +66235,60 @@ components: format: int64 type: integer interval: - description: The `TriggerRateLimit` `interval`. The expected format is the - number of seconds ending with an s. For example, 1 day is 86400s + description: The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s type: string type: object TriggerSource: - description: 'The type of security issues on which the rule applies. Notification - rules based on security signals need to use the trigger source "security_signals", - - while notification rules based on security vulnerabilities need to use the - trigger source "security_findings".' + description: |- + The type of security issues on which the rule applies. Notification rules based on security signals need to use the trigger source "security_signals", + while notification rules based on security vulnerabilities need to use the trigger source "security_findings". enum: - - security_findings - - security_signals + - security_findings + - security_signals example: security_findings type: string x-enum-varnames: - - SECURITY_FINDINGS - - SECURITY_SIGNALS + - SECURITY_FINDINGS + - SECURITY_SIGNALS UCConfigPair: description: The definition of `UCConfigPair` object. example: data: attributes: configs: - - account_id: 1234abcd-1234-abcd-1234-1234abcd1234 - client_id: 1234abcd-1234-abcd-1234-1234abcd1234 - created_at: 2023-01-01 12:00:00 - dataset_type: actual - error_messages: [] - export_name: dd-actual-export - export_path: dd-export-path - id: '123456789123' - months: 36 - scope: /subscriptions/1234abcd-1234-abcd-1234-1234abcd1234 - status: active - status_updated_at: 2023-01-01 12:00:00 - storage_account: dd-storage-account - storage_container: dd-storage-container - updated_at: 2023-01-01 12:00:00 - id: '123456789123' + - account_id: 1234abcd-1234-abcd-1234-1234abcd1234 + client_id: 1234abcd-1234-abcd-1234-1234abcd1234 + created_at: 2023-01-01 12:00:00 + dataset_type: actual + error_messages: [] + export_name: dd-actual-export + export_path: dd-export-path + id: "123456789123" + months: 36 + scope: /subscriptions/1234abcd-1234-abcd-1234-1234abcd1234 + status: active + status_updated_at: 2023-01-01 12:00:00 + storage_account: dd-storage-account + storage_container: dd-storage-container + updated_at: 2023-01-01 12:00:00 + id: "123456789123" type: azure_uc_configs properties: data: - $ref: '#/components/schemas/UCConfigPairData' + $ref: "#/components/schemas/UCConfigPairData" type: object UCConfigPairData: description: The definition of `UCConfigPairData` object. properties: attributes: - $ref: '#/components/schemas/UCConfigPairDataAttributes' + $ref: "#/components/schemas/UCConfigPairDataAttributes" id: description: The `UCConfigPairData` `id`. type: string type: - $ref: '#/components/schemas/UCConfigPairDataType' + $ref: "#/components/schemas/UCConfigPairDataType" required: - - type + - type type: object UCConfigPairDataAttributes: description: The definition of `UCConfigPairDataAttributes` object. @@ -69692,7 +66296,7 @@ components: configs: description: The `attributes` `configs`. items: - $ref: '#/components/schemas/UCConfigPairDataAttributesConfigsItems' + $ref: "#/components/schemas/UCConfigPairDataAttributesConfigsItems" type: array type: object UCConfigPairDataAttributesConfigsItems: @@ -69752,57 +66356,55 @@ components: default: azure_uc_configs description: Azure UC configs resource type. enum: - - azure_uc_configs + - azure_uc_configs example: azure_uc_configs type: string x-enum-varnames: - - AZURE_UC_CONFIGS + - AZURE_UC_CONFIGS UnassignSeatsUserRequest: properties: data: - $ref: '#/components/schemas/UnassignSeatsUserRequestData' + $ref: "#/components/schemas/UnassignSeatsUserRequestData" description: The data for the unassign seats user request. type: object UnassignSeatsUserRequestData: properties: attributes: - $ref: '#/components/schemas/UnassignSeatsUserRequestDataAttributes' + $ref: "#/components/schemas/UnassignSeatsUserRequestDataAttributes" description: The attributes of the unassign seats user request. id: description: The ID of the unassign seats user request. type: string type: - $ref: '#/components/schemas/SeatAssignmentsDataType' + $ref: "#/components/schemas/SeatAssignmentsDataType" description: The type of the unassign seats user request. required: - - type - - attributes + - type + - attributes type: object UnassignSeatsUserRequestDataAttributes: properties: product_code: description: The product code for which to unassign seats. - example: '' + example: "" type: string user_uuids: description: The list of user IDs to unassign seats from. example: - - '' + - "" items: type: string type: array required: - - product_code - - user_uuids + - product_code + - user_uuids type: object Unit: - description: Object containing the metric unit family, scale factor, name, and - short name. + description: Object containing the metric unit family, scale factor, name, and short name. nullable: true properties: family: - description: Unit family, allows for conversion between units of the same - family, for scaling. + description: Unit family, allows for conversion between units of the same family, for scaling. example: time type: string name: @@ -69827,21 +66429,21 @@ components: description: The response object after an app is successfully unpublished. properties: data: - $ref: '#/components/schemas/Deployment' + $ref: "#/components/schemas/Deployment" type: object UpdateActionConnectionRequest: description: Request used to update an action connection. properties: data: - $ref: '#/components/schemas/ActionConnectionDataUpdate' + $ref: "#/components/schemas/ActionConnectionDataUpdate" required: - - data + - data type: object UpdateActionConnectionResponse: description: The response for an updated connection. properties: data: - $ref: '#/components/schemas/ActionConnectionData' + $ref: "#/components/schemas/ActionConnectionData" type: object UpdateAppRequest: description: A request object for updating an existing app. @@ -69849,72 +66451,67 @@ components: data: attributes: components: - - events: [] - name: grid0 - properties: - children: - - events: [] - name: gridCell0 - properties: - children: + - events: [] + name: grid0 + properties: + children: - events: [] - name: calloutValue0 + name: gridCell0 properties: - isDisabled: false - isLoading: false - isVisible: true - label: CPU Usage - size: sm - style: vivid_yellow - unit: kB - value: '42' - type: calloutValue - isVisible: 'true' - layout: - default: - height: 8 - width: 2 - x: 0 - y: 0 - type: gridCell - type: grid - description: This is a simple example app - name: Example App + children: + - events: [] + name: calloutValue0 + properties: + isDisabled: false + isLoading: false + isVisible: true + label: CPU Usage + size: sm + style: vivid_yellow + unit: kB + value: "42" + type: calloutValue + isVisible: "true" + layout: + default: + height: 8 + width: 2 + x: 0 + "y": 0 + type: gridCell + type: grid + description: "This is a simple example app" + name: "Example App" queries: [] rootInstanceName: grid0 - id: 9e20cbaf-68da-45a6-9ccf-54193ac29fa5 + id: "9e20cbaf-68da-45a6-9ccf-54193ac29fa5" type: appDefinitions properties: data: - $ref: '#/components/schemas/UpdateAppRequestData' + $ref: "#/components/schemas/UpdateAppRequestData" type: object UpdateAppRequestData: - description: The data object containing the new app definition. Any fields not - included in the request remain unchanged. + description: The data object containing the new app definition. Any fields not included in the request remain unchanged. properties: attributes: - $ref: '#/components/schemas/UpdateAppRequestDataAttributes' + $ref: "#/components/schemas/UpdateAppRequestDataAttributes" id: - description: The ID of the app to update. The app ID must match the ID in - the URL path. + description: The ID of the app to update. The app ID must match the ID in the URL path. example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 format: uuid type: string type: - $ref: '#/components/schemas/AppDefinitionType' + $ref: "#/components/schemas/AppDefinitionType" required: - - type + - type type: object UpdateAppRequestDataAttributes: - description: App definition attributes to be updated, such as name, description, - and components. + description: App definition attributes to be updated, such as name, description, and components. properties: components: - description: The new UI components that make up the app. If this field is - set, all existing components are replaced with the new components under - this field. + description: The new UI components that make up the app. If this field is set, all existing components are replaced with the new components under this field. items: - $ref: '#/components/schemas/ComponentGrid' + $ref: "#/components/schemas/ComponentGrid" type: array description: description: The new human-readable description for the app. @@ -69923,23 +66520,18 @@ components: description: The new name of the app. type: string queries: - description: The new array of queries, such as external actions and state - variables, that the app uses. If this field is set, all existing queries - are replaced with the new queries under this field. + description: The new array of queries, such as external actions and state variables, that the app uses. If this field is set, all existing queries are replaced with the new queries under this field. items: - $ref: '#/components/schemas/Query' + $ref: "#/components/schemas/Query" type: array rootInstanceName: - description: The new name of the root component of the app. This must be - a `grid` component that contains all other components. + description: The new name of the root component of the app. This must be a `grid` component that contains all other components. type: string tags: - description: The new list of tags for the app, which can be used to filter - apps. If this field is set, any existing tags not included in the request - are removed. + description: The new list of tags for the app, which can be used to filter apps. If this field is set, any existing tags not included in the request are removed. example: - - service:webshop-backend - - team:webshop + - "service:webshop-backend" + - "team:webshop" items: description: An individual tag for the app. type: string @@ -69949,42 +66541,41 @@ components: description: The response object after an app is successfully updated. properties: data: - $ref: '#/components/schemas/UpdateAppResponseData' + $ref: "#/components/schemas/UpdateAppResponseData" included: description: Data on the version of the app that was published. items: - $ref: '#/components/schemas/Deployment' + $ref: "#/components/schemas/Deployment" type: array meta: - $ref: '#/components/schemas/AppMeta' + $ref: "#/components/schemas/AppMeta" relationship: - $ref: '#/components/schemas/AppRelationship' + $ref: "#/components/schemas/AppRelationship" type: object UpdateAppResponseData: description: The data object containing the updated app definition. properties: attributes: - $ref: '#/components/schemas/UpdateAppResponseDataAttributes' + $ref: "#/components/schemas/UpdateAppResponseDataAttributes" id: description: The ID of the updated app. example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 format: uuid type: string type: - $ref: '#/components/schemas/AppDefinitionType' + $ref: "#/components/schemas/AppDefinitionType" required: - - id - - type - - attributes + - id + - type + - attributes type: object UpdateAppResponseDataAttributes: - description: The updated app definition attributes, such as name, description, - and components. + description: The updated app definition attributes, such as name, description, and components. properties: components: description: The UI components that make up the app. items: - $ref: '#/components/schemas/ComponentGrid' + $ref: "#/components/schemas/ComponentGrid" type: array description: description: The human-readable description for the app. @@ -69996,20 +66587,18 @@ components: description: The name of the app. type: string queries: - description: An array of queries, such as external actions and state variables, - that the app uses. + description: An array of queries, such as external actions and state variables, that the app uses. items: - $ref: '#/components/schemas/Query' + $ref: "#/components/schemas/Query" type: array rootInstanceName: - description: The name of the root component of the app. This must be a `grid` - component that contains all other components. + description: The name of the root component of the app. This must be a `grid` component that contains all other components. type: string tags: description: A list of tags for the app, which can be used to filter apps. example: - - service:webshop-backend - - team:webshop + - "service:webshop-backend" + - "team:webshop" items: description: An individual tag for the app. type: string @@ -70019,79 +66608,73 @@ components: description: Request to update specific fields on an existing datastore item. properties: data: - $ref: '#/components/schemas/UpdateAppsDatastoreItemRequestData' + $ref: "#/components/schemas/UpdateAppsDatastoreItemRequestData" type: object UpdateAppsDatastoreItemRequestData: - description: Data wrapper containing the item identifier and the changes to - apply during the update operation. + description: Data wrapper containing the item identifier and the changes to apply during the update operation. properties: attributes: - $ref: '#/components/schemas/UpdateAppsDatastoreItemRequestDataAttributes' + $ref: "#/components/schemas/UpdateAppsDatastoreItemRequestDataAttributes" id: description: The unique identifier of the datastore item. type: string type: - $ref: '#/components/schemas/UpdateAppsDatastoreItemRequestDataType' + $ref: "#/components/schemas/UpdateAppsDatastoreItemRequestDataType" required: - - type + - type type: object UpdateAppsDatastoreItemRequestDataAttributes: - description: Attributes for updating a datastore item, including the item key - and changes to apply. + description: Attributes for updating a datastore item, including the item key and changes to apply. properties: id: description: The unique identifier of the item being updated. type: string item_changes: - $ref: '#/components/schemas/UpdateAppsDatastoreItemRequestDataAttributesItemChanges' + $ref: "#/components/schemas/UpdateAppsDatastoreItemRequestDataAttributesItemChanges" item_key: - description: The primary key that identifies the item to update. Cannot - exceed 256 characters. - example: '' + description: The primary key that identifies the item to update. Cannot exceed 256 characters. + example: "" maxLength: 256 type: string required: - - item_changes - - item_key + - item_changes + - item_key type: object UpdateAppsDatastoreItemRequestDataAttributesItemChanges: description: Changes to apply to a datastore item using set operations. properties: ops_set: additionalProperties: {} - description: Set operation that contains key-value pairs to set on the datastore - item. + description: Set operation that contains key-value pairs to set on the datastore item. type: object type: object UpdateAppsDatastoreItemRequestDataType: default: items description: The resource type for datastore items. enum: - - items + - items example: items type: string x-enum-varnames: - - ITEMS + - ITEMS UpdateAppsDatastoreRequest: - description: Request to update a datastore's configuration such as its name - or description. + description: Request to update a datastore's configuration such as its name or description. properties: data: - $ref: '#/components/schemas/UpdateAppsDatastoreRequestData' + $ref: "#/components/schemas/UpdateAppsDatastoreRequestData" type: object UpdateAppsDatastoreRequestData: - description: Data wrapper containing the datastore identifier and the attributes - to update. + description: Data wrapper containing the datastore identifier and the attributes to update. properties: attributes: - $ref: '#/components/schemas/UpdateAppsDatastoreRequestDataAttributes' + $ref: "#/components/schemas/UpdateAppsDatastoreRequestDataAttributes" id: description: The unique identifier of the datastore to update. type: string type: - $ref: '#/components/schemas/DatastoreDataType' + $ref: "#/components/schemas/DatastoreDataType" required: - - type + - type type: object UpdateAppsDatastoreRequestDataAttributes: description: Attributes that can be updated on a datastore. @@ -70108,46 +66691,46 @@ components: data: attributes: fields_to_add: - - description: Net Promoter Score from customer surveys - display_name: NPS Score - groups: - - Satisfaction - - Metrics - id: nps_score - source_name: net_promoter_score - type: number + - description: Net Promoter Score from customer surveys + display_name: NPS Score + groups: + - Satisfaction + - Metrics + id: nps_score + source_name: net_promoter_score + type: number fields_to_delete: - - old_revenue_field + - old_revenue_field fields_to_update: - - field_id: lifetime_value - updated_display_name: Customer Lifetime Value (`USD`) - updated_groups: - - Financial - - Metrics + - field_id: lifetime_value + updated_display_name: Customer Lifetime Value (`USD`) + updated_groups: + - Financial + - Metrics id: crm-integration type: connection_id properties: data: - $ref: '#/components/schemas/UpdateConnectionRequestData' + $ref: "#/components/schemas/UpdateConnectionRequestData" type: object UpdateConnectionRequestData: properties: attributes: - $ref: '#/components/schemas/UpdateConnectionRequestDataAttributes' + $ref: "#/components/schemas/UpdateConnectionRequestDataAttributes" id: - example: '' + example: "" type: string type: - $ref: '#/components/schemas/UpdateConnectionRequestDataType' + $ref: "#/components/schemas/UpdateConnectionRequestDataType" required: - - type - - id + - type + - id type: object UpdateConnectionRequestDataAttributes: properties: fields_to_add: items: - $ref: '#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems' + $ref: "#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems" type: array fields_to_delete: items: @@ -70155,13 +66738,13 @@ components: type: array fields_to_update: items: - $ref: '#/components/schemas/UpdateConnectionRequestDataAttributesFieldsToUpdateItems' + $ref: "#/components/schemas/UpdateConnectionRequestDataAttributesFieldsToUpdateItems" type: array type: object UpdateConnectionRequestDataAttributesFieldsToUpdateItems: properties: field_id: - example: '' + example: "" type: string updated_description: type: string @@ -70174,56 +66757,56 @@ components: type: string type: array required: - - field_id + - field_id type: object UpdateConnectionRequestDataType: default: connection_id description: Connection id resource type. enum: - - connection_id + - connection_id example: connection_id type: string x-enum-varnames: - - CONNECTION_ID + - CONNECTION_ID UpdateCustomFrameworkRequest: description: Request object to update a custom framework. properties: data: - $ref: '#/components/schemas/CustomFrameworkData' + $ref: "#/components/schemas/CustomFrameworkData" required: - - data + - data type: object UpdateCustomFrameworkResponse: description: Response object to update a custom framework. properties: data: - $ref: '#/components/schemas/FrameworkHandleAndVersionResponseData' + $ref: "#/components/schemas/FrameworkHandleAndVersionResponseData" required: - - data + - data type: object UpdateDeploymentGateParams: description: Parameters for updating a deployment gate. properties: data: - $ref: '#/components/schemas/UpdateDeploymentGateParamsData' + $ref: "#/components/schemas/UpdateDeploymentGateParamsData" required: - - data + - data type: object UpdateDeploymentGateParamsData: description: Parameters for updating a deployment gate. properties: attributes: - $ref: '#/components/schemas/UpdateDeploymentGateParamsDataAttributes' + $ref: "#/components/schemas/UpdateDeploymentGateParamsDataAttributes" id: description: Unique identifier of the deployment gate. - example: 12345678-1234-1234-1234-123456789012 + example: "12345678-1234-1234-1234-123456789012" type: string type: - $ref: '#/components/schemas/DeploymentGateDataType' + $ref: "#/components/schemas/DeploymentGateDataType" required: - - type - - id - - attributes + - type + - id + - attributes type: object UpdateDeploymentGateParamsDataAttributes: description: Attributes for updating a deployment gate. @@ -70233,26 +66816,26 @@ components: example: false type: boolean required: - - dry_run + - dry_run type: object UpdateDeploymentRuleParams: description: Parameters for updating a deployment rule. properties: data: - $ref: '#/components/schemas/UpdateDeploymentRuleParamsData' + $ref: "#/components/schemas/UpdateDeploymentRuleParamsData" required: - - data + - data type: object UpdateDeploymentRuleParamsData: description: Parameters for updating a deployment rule. properties: attributes: - $ref: '#/components/schemas/UpdateDeploymentRuleParamsDataAttributes' + $ref: "#/components/schemas/UpdateDeploymentRuleParamsDataAttributes" type: - $ref: '#/components/schemas/DeploymentRuleDataType' + $ref: "#/components/schemas/DeploymentRuleDataType" required: - - type - - attributes + - type + - attributes type: object UpdateDeploymentRuleParamsDataAttributes: description: Parameters for updating a deployment rule. @@ -70263,22 +66846,22 @@ components: type: boolean name: description: The name of the deployment rule. - example: Updated deployment rule + example: "Updated deployment rule" type: string options: - $ref: '#/components/schemas/DeploymentRulesOptions' + $ref: "#/components/schemas/DeploymentRulesOptions" required: - - dry_run - - name - - options + - dry_run + - name + - options type: object UpdateFlakyTestsRequest: description: Request to update the state of multiple flaky tests. properties: data: - $ref: '#/components/schemas/UpdateFlakyTestsRequestData' + $ref: "#/components/schemas/UpdateFlakyTestsRequestData" required: - - data + - data type: object UpdateFlakyTestsRequestAttributes: description: Attributes for updating flaky test states. @@ -70286,101 +66869,97 @@ components: tests: description: List of flaky tests to update. items: - $ref: '#/components/schemas/UpdateFlakyTestsRequestTest' + $ref: "#/components/schemas/UpdateFlakyTestsRequestTest" type: array required: - - tests + - tests type: object UpdateFlakyTestsRequestData: description: The JSON:API data for updating flaky test states. properties: attributes: - $ref: '#/components/schemas/UpdateFlakyTestsRequestAttributes' + $ref: "#/components/schemas/UpdateFlakyTestsRequestAttributes" type: - $ref: '#/components/schemas/UpdateFlakyTestsRequestDataType' + $ref: "#/components/schemas/UpdateFlakyTestsRequestDataType" required: - - type - - attributes + - type + - attributes type: object UpdateFlakyTestsRequestDataType: description: The definition of `UpdateFlakyTestsRequestDataType` object. enum: - - update_flaky_test_state_request + - update_flaky_test_state_request example: update_flaky_test_state_request type: string x-enum-varnames: - - UPDATE_FLAKY_TEST_STATE_REQUEST + - UPDATE_FLAKY_TEST_STATE_REQUEST UpdateFlakyTestsRequestTest: description: Details of what tests to update and their new attributes. properties: id: - description: The ID of the flaky test. This is the same ID returned by the - Search flaky tests endpoint and corresponds to the test_fingerprint_fqn - field in test run events. + description: The ID of the flaky test. This is the same ID returned by the Search flaky tests endpoint and corresponds to the test_fingerprint_fqn field in test run events. example: 4eb1887a8adb1847 type: string new_state: - $ref: '#/components/schemas/UpdateFlakyTestsRequestTestNewState' + $ref: "#/components/schemas/UpdateFlakyTestsRequestTestNewState" required: - - id - - new_state + - id + - new_state type: object UpdateFlakyTestsRequestTestNewState: description: The new state to set for the flaky test. enum: - - active - - quarantined - - disabled - - fixed + - active + - quarantined + - disabled + - fixed example: active type: string x-enum-varnames: - - ACTIVE - - QUARANTINED - - DISABLED - - FIXED + - ACTIVE + - QUARANTINED + - DISABLED + - FIXED UpdateFlakyTestsResponse: description: Response object for updating flaky test states. properties: data: - $ref: '#/components/schemas/UpdateFlakyTestsResponseData' + $ref: "#/components/schemas/UpdateFlakyTestsResponseData" type: object UpdateFlakyTestsResponseAttributes: description: Attributes for the update flaky test state response. properties: has_errors: - description: '`True` if any errors occurred during the update operations. - `False` if all tests succeeded to be updated.' + description: "`True` if any errors occurred during the update operations. `False` if all tests succeeded to be updated." example: true type: boolean results: description: Results of the update operation for each test. items: - $ref: '#/components/schemas/UpdateFlakyTestsResponseResult' + $ref: "#/components/schemas/UpdateFlakyTestsResponseResult" type: array required: - - has_errors - - results + - has_errors + - results type: object UpdateFlakyTestsResponseData: - description: Summary of the update operations. Tells whether a test succeeded - or failed to be updated. + description: Summary of the update operations. Tells whether a test succeeded or failed to be updated. properties: attributes: - $ref: '#/components/schemas/UpdateFlakyTestsResponseAttributes' + $ref: "#/components/schemas/UpdateFlakyTestsResponseAttributes" id: description: The ID of the response. type: string type: - $ref: '#/components/schemas/UpdateFlakyTestsResponseDataType' + $ref: "#/components/schemas/UpdateFlakyTestsResponseDataType" type: object UpdateFlakyTestsResponseDataType: description: The definition of `UpdateFlakyTestsResponseDataType` object. enum: - - update_flaky_test_state_response + - update_flaky_test_state_response type: string x-enum-varnames: - - UPDATE_FLAKY_TEST_STATE_RESPONSE + - UPDATE_FLAKY_TEST_STATE_RESPONSE UpdateFlakyTestsResponseResult: description: Result of updating a single flaky test state. properties: @@ -70388,30 +66967,27 @@ components: description: Error message if the update failed. type: string id: - description: The ID of the flaky test from the request. This is the same - ID returned by the Search flaky tests endpoint and corresponds to the - test_fingerprint_fqn field in test run events. + description: The ID of the flaky test from the request. This is the same ID returned by the Search flaky tests endpoint and corresponds to the test_fingerprint_fqn field in test run events. example: 4eb1887a8adb1847 type: string success: - description: '`True` if the update was successful, `False` if there were - any errors.' + description: "`True` if the update was successful, `False` if there were any errors." example: false type: boolean required: - - id - - success + - id + - success type: object UpdateOnCallNotificationRuleRequest: description: A top-level wrapper for updating a notification rule for a user example: data: attributes: - category: high_urgency + "category": "high_urgency" channel_settings: - method: sms - type: phone - delay_minutes: 1 + method: "sms" + type: "phone" + "delay_minutes": 1 id: 2462ace1-49e2-aab1-xc4f-29cc4ae1105n7 relationships: channel: @@ -70421,22 +66997,21 @@ components: type: notification_rules properties: data: - $ref: '#/components/schemas/UpdateOnCallNotificationRuleRequestData' + $ref: "#/components/schemas/UpdateOnCallNotificationRuleRequestData" required: - - data + - data type: object UpdateOnCallNotificationRuleRequestAttributes: description: Attributes for creating or modifying an on-call notification rule. properties: category: - $ref: '#/components/schemas/OnCallNotificationRuleCategory' + $ref: "#/components/schemas/OnCallNotificationRuleCategory" channel_settings: - $ref: '#/components/schemas/OnCallNotificationRuleChannelSettings' + $ref: "#/components/schemas/OnCallNotificationRuleChannelSettings" description: Configuration for the associated channel, if necessary nullable: true delay_minutes: - description: The number of minutes that will elapse before this rule is - evaluated. 0 indicates immediate evaluation + description: The number of minutes that will elapse before this rule is evaluated. 0 indicates immediate evaluation format: int64 type: integer type: object @@ -70444,22 +67019,22 @@ components: description: Data for updating an on-call notification rule properties: attributes: - $ref: '#/components/schemas/UpdateOnCallNotificationRuleRequestAttributes' + $ref: "#/components/schemas/UpdateOnCallNotificationRuleRequestAttributes" id: description: Unique identifier for the rule type: string relationships: - $ref: '#/components/schemas/OnCallNotificationRuleRelationships' + $ref: "#/components/schemas/OnCallNotificationRuleRelationships" type: - $ref: '#/components/schemas/OnCallNotificationRuleType' + $ref: "#/components/schemas/OnCallNotificationRuleType" required: - - type + - type type: object UpdateOpenAPIResponse: description: Response for `UpdateOpenAPI`. properties: data: - $ref: '#/components/schemas/UpdateOpenAPIResponseData' + $ref: "#/components/schemas/UpdateOpenAPIResponseData" type: object UpdateOpenAPIResponseAttributes: description: Attributes for `UpdateOpenAPI`. @@ -70467,16 +67042,16 @@ components: failed_endpoints: description: List of endpoints which couldn't be parsed. items: - $ref: '#/components/schemas/OpenAPIEndpoint' + $ref: "#/components/schemas/OpenAPIEndpoint" type: array type: object UpdateOpenAPIResponseData: description: Data envelope for `UpdateOpenAPIResponse`. properties: attributes: - $ref: '#/components/schemas/UpdateOpenAPIResponseAttributes' + $ref: "#/components/schemas/UpdateOpenAPIResponseAttributes" id: - $ref: '#/components/schemas/ApiID' + $ref: "#/components/schemas/ApiID" type: object UpdateOutcomesAsyncAttributes: description: The JSON:API attributes for a batched set of scorecard outcomes. @@ -70484,128 +67059,126 @@ components: results: description: Set of scorecard outcomes to update asynchronously. items: - $ref: '#/components/schemas/UpdateOutcomesAsyncRequestItem' + $ref: "#/components/schemas/UpdateOutcomesAsyncRequestItem" type: array type: object UpdateOutcomesAsyncRequest: description: Scorecard outcomes batch request. properties: data: - $ref: '#/components/schemas/UpdateOutcomesAsyncRequestData' + $ref: "#/components/schemas/UpdateOutcomesAsyncRequestData" type: object UpdateOutcomesAsyncRequestData: description: Scorecard outcomes batch request data. properties: attributes: - $ref: '#/components/schemas/UpdateOutcomesAsyncAttributes' + $ref: "#/components/schemas/UpdateOutcomesAsyncAttributes" type: - $ref: '#/components/schemas/UpdateOutcomesAsyncType' + $ref: "#/components/schemas/UpdateOutcomesAsyncType" type: object UpdateOutcomesAsyncRequestItem: description: Scorecard outcome for a single entity and rule. properties: entity_reference: - $ref: '#/components/schemas/EntityReference' + $ref: "#/components/schemas/EntityReference" remarks: - description: Any remarks regarding the scorecard rule's evaluation. Supports - HTML hyperlinks. + description: >- + Any remarks regarding the scorecard rule's evaluation. Supports HTML hyperlinks. example: 'See: Services' type: string rule_id: - $ref: '#/components/schemas/RuleId' + $ref: "#/components/schemas/RuleId" state: - $ref: '#/components/schemas/State' + $ref: "#/components/schemas/State" required: - - rule_id - - entity_reference - - state + - rule_id + - entity_reference + - state type: object UpdateOutcomesAsyncType: default: batched-outcome description: The JSON:API type for scorecard outcomes. - enum: - - batched-outcome + enum: [batched-outcome] example: batched-outcome type: string - x-enum-varnames: - - BATCHED_OUTCOME + x-enum-varnames: [BATCHED_OUTCOME] UpdateResourceEvaluationFiltersRequest: description: Request object to update a resource filter. properties: data: - $ref: '#/components/schemas/UpdateResourceEvaluationFiltersRequestData' + $ref: "#/components/schemas/UpdateResourceEvaluationFiltersRequestData" required: - - data + - data type: object UpdateResourceEvaluationFiltersRequestData: description: The definition of `UpdateResourceFilterRequestData` object. properties: attributes: - $ref: '#/components/schemas/ResourceFilterAttributes' + $ref: "#/components/schemas/ResourceFilterAttributes" id: description: The `UpdateResourceEvaluationFiltersRequestData` `id`. example: csm_resource_filter type: string type: - $ref: '#/components/schemas/ResourceFilterRequestType' + $ref: "#/components/schemas/ResourceFilterRequestType" required: - - attributes - - type + - attributes + - type type: object UpdateResourceEvaluationFiltersResponse: description: The definition of `UpdateResourceEvaluationFiltersResponse` object. properties: data: - $ref: '#/components/schemas/UpdateResourceEvaluationFiltersResponseData' + $ref: "#/components/schemas/UpdateResourceEvaluationFiltersResponseData" required: - - data + - data type: object UpdateResourceEvaluationFiltersResponseData: description: The definition of `UpdateResourceFilterResponseData` object. properties: attributes: - $ref: '#/components/schemas/ResourceFilterAttributes' + $ref: "#/components/schemas/ResourceFilterAttributes" id: description: The `data` `id`. example: csm_resource_filter type: string type: - $ref: '#/components/schemas/ResourceFilterRequestType' + $ref: "#/components/schemas/ResourceFilterRequestType" required: - - attributes - - type + - attributes + - type type: object UpdateRuleRequest: description: Request to update a scorecard rule. properties: data: - $ref: '#/components/schemas/UpdateRuleRequestData' + $ref: "#/components/schemas/UpdateRuleRequestData" type: object UpdateRuleRequestData: description: Data for the request to update a scorecard rule. properties: attributes: - $ref: '#/components/schemas/RuleAttributes' + $ref: "#/components/schemas/RuleAttributes" type: - $ref: '#/components/schemas/RuleType' + $ref: "#/components/schemas/RuleType" type: object UpdateRuleResponse: description: The response from a rule update request. properties: data: - $ref: '#/components/schemas/UpdateRuleResponseData' + $ref: "#/components/schemas/UpdateRuleResponseData" type: object UpdateRuleResponseData: description: The data for a rule update response. properties: attributes: - $ref: '#/components/schemas/RuleAttributes' + $ref: "#/components/schemas/RuleAttributes" id: - $ref: '#/components/schemas/RuleId' + $ref: "#/components/schemas/RuleId" relationships: - $ref: '#/components/schemas/RelationshipToRule' + $ref: "#/components/schemas/RelationshipToRule" type: - $ref: '#/components/schemas/RuleType' + $ref: "#/components/schemas/RuleType" type: object UpdateRulesetRequest: description: The definition of `UpdateRulesetRequest` object. @@ -70616,63 +67189,63 @@ components: last_version: 1 name: Updated Ruleset rules: - - enabled: true - mapping: null - metadata: null - name: Add Cost Center Tag - query: - addition: - key: cost_center - value: engineering - case_insensitivity: false - if_tag_exists: do_not_apply - query: account_id:"123456789" AND service:"web-api" - reference_table: null - - enabled: true - mapping: - destination_key: team_owner - if_tag_exists: do_not_apply - source_keys: - - account_name - - account_id - metadata: null - name: Account Name Mapping - query: null - reference_table: null - - enabled: true - mapping: null - metadata: null - name: New table rule with new UI - query: null - reference_table: - case_insensitivity: true - field_pairs: - - input_column: status_type - output_key: status - - input_column: status_description - output_key: dess - if_tag_exists: append - source_keys: - - http_status - - status_description - table_name: http_status_codes + - enabled: true + mapping: + metadata: + name: Add Cost Center Tag + query: + addition: + key: cost_center + value: engineering + case_insensitivity: false + if_tag_exists: do_not_apply + query: account_id:"123456789" AND service:"web-api" + reference_table: + - enabled: true + mapping: + destination_key: team_owner + if_tag_exists: do_not_apply + source_keys: + - account_name + - account_id + metadata: + name: Account Name Mapping + query: + reference_table: + - enabled: true + mapping: + metadata: + name: New table rule with new UI + query: + reference_table: + case_insensitivity: true + field_pairs: + - input_column: status_type + output_key: status + - input_column: status_description + output_key: dess + if_tag_exists: append + source_keys: + - http_status + - status_description + table_name: http_status_codes type: update_ruleset properties: data: - $ref: '#/components/schemas/UpdateRulesetRequestData' + $ref: "#/components/schemas/UpdateRulesetRequestData" type: object UpdateRulesetRequestData: description: The definition of `UpdateRulesetRequestData` object. properties: attributes: - $ref: '#/components/schemas/UpdateRulesetRequestDataAttributes' + $ref: "#/components/schemas/UpdateRulesetRequestDataAttributes" id: description: The `UpdateRulesetRequestData` `id`. type: string type: - $ref: '#/components/schemas/UpdateRulesetRequestDataType' + $ref: "#/components/schemas/UpdateRulesetRequestDataType" required: - - type + - type type: object UpdateRulesetRequestDataAttributes: description: The definition of `UpdateRulesetRequestDataAttributes` object. @@ -70688,43 +67261,41 @@ components: rules: description: The `attributes` `rules`. items: - $ref: '#/components/schemas/UpdateRulesetRequestDataAttributesRulesItems' + $ref: "#/components/schemas/UpdateRulesetRequestDataAttributesRulesItems" type: array required: - - enabled - - rules + - enabled + - rules type: object UpdateRulesetRequestDataAttributesRulesItems: - description: The definition of `UpdateRulesetRequestDataAttributesRulesItems` - object. + description: The definition of `UpdateRulesetRequestDataAttributesRulesItems` object. properties: enabled: description: The `items` `enabled`. example: false type: boolean mapping: - $ref: '#/components/schemas/DataAttributesRulesItemsMapping' + $ref: "#/components/schemas/DataAttributesRulesItemsMapping" metadata: - $ref: '#/components/schemas/RulesetItemMetadata' + $ref: "#/components/schemas/RulesetItemMetadata" name: description: The `items` `name`. - example: '' + example: "" type: string query: - $ref: '#/components/schemas/UpdateRulesetRequestDataAttributesRulesItemsQuery' + $ref: "#/components/schemas/UpdateRulesetRequestDataAttributesRulesItemsQuery" reference_table: - $ref: '#/components/schemas/UpdateRulesetRequestDataAttributesRulesItemsReferenceTable' + $ref: "#/components/schemas/UpdateRulesetRequestDataAttributesRulesItemsReferenceTable" required: - - enabled - - name + - enabled + - name type: object UpdateRulesetRequestDataAttributesRulesItemsQuery: - description: The definition of `UpdateRulesetRequestDataAttributesRulesItemsQuery` - object. + description: The definition of `UpdateRulesetRequestDataAttributesRulesItemsQuery` object. nullable: true properties: addition: - $ref: '#/components/schemas/UpdateRulesetRequestDataAttributesRulesItemsQueryAddition' + $ref: "#/components/schemas/UpdateRulesetRequestDataAttributesRulesItemsQueryAddition" case_insensitivity: description: The `query` `case_insensitivity`. type: boolean @@ -70733,35 +67304,33 @@ components: description: Deprecated. Use `if_tag_exists` instead. The `query` `if_not_exists`. type: boolean if_tag_exists: - $ref: '#/components/schemas/DataAttributesRulesItemsIfTagExists' + $ref: "#/components/schemas/DataAttributesRulesItemsIfTagExists" query: description: The `query` `query`. - example: '' + example: "" type: string required: - - addition - - query + - addition + - query type: object UpdateRulesetRequestDataAttributesRulesItemsQueryAddition: - description: The definition of `UpdateRulesetRequestDataAttributesRulesItemsQueryAddition` - object. + description: The definition of `UpdateRulesetRequestDataAttributesRulesItemsQueryAddition` object. nullable: true properties: key: description: The `addition` `key`. - example: '' + example: "" type: string value: description: The `addition` `value`. - example: '' + example: "" type: string required: - - key - - value + - key + - value type: object UpdateRulesetRequestDataAttributesRulesItemsReferenceTable: - description: The definition of `UpdateRulesetRequestDataAttributesRulesItemsReferenceTable` - object. + description: The definition of `UpdateRulesetRequestDataAttributesRulesItemsReferenceTable` object. nullable: true properties: case_insensitivity: @@ -70770,83 +67339,81 @@ components: field_pairs: description: The `reference_table` `field_pairs`. items: - $ref: '#/components/schemas/UpdateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems' + $ref: "#/components/schemas/UpdateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems" type: array if_not_exists: deprecated: true - description: Deprecated. Use `if_tag_exists` instead. The `reference_table` - `if_not_exists`. + description: Deprecated. Use `if_tag_exists` instead. The `reference_table` `if_not_exists`. type: boolean if_tag_exists: - $ref: '#/components/schemas/DataAttributesRulesItemsIfTagExists' + $ref: "#/components/schemas/DataAttributesRulesItemsIfTagExists" source_keys: description: The `reference_table` `source_keys`. example: - - '' + - "" items: type: string type: array table_name: description: The `reference_table` `table_name`. - example: '' + example: "" type: string required: - - field_pairs - - source_keys - - table_name + - field_pairs + - source_keys + - table_name type: object UpdateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems: - description: The definition of `UpdateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems` - object. + description: The definition of `UpdateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems` object. properties: input_column: description: The `items` `input_column`. - example: '' + example: "" type: string output_key: description: The `items` `output_key`. - example: '' + example: "" type: string required: - - input_column - - output_key + - input_column + - output_key type: object UpdateRulesetRequestDataType: default: update_ruleset description: Update ruleset resource type. enum: - - update_ruleset + - update_ruleset example: update_ruleset type: string x-enum-varnames: - - UPDATE_RULESET + - UPDATE_RULESET UpdateTenancyConfigData: properties: attributes: - $ref: '#/components/schemas/UpdateTenancyConfigDataAttributes' + $ref: "#/components/schemas/UpdateTenancyConfigDataAttributes" id: - example: '' + example: "" type: string type: - $ref: '#/components/schemas/UpdateTenancyConfigDataType' + $ref: "#/components/schemas/UpdateTenancyConfigDataType" required: - - type - - id + - type + - id type: object UpdateTenancyConfigDataAttributes: properties: auth_credentials: - $ref: '#/components/schemas/UpdateTenancyConfigDataAttributesAuthCredentials' + $ref: "#/components/schemas/UpdateTenancyConfigDataAttributesAuthCredentials" cost_collection_enabled: type: boolean home_region: type: string logs_config: - $ref: '#/components/schemas/UpdateTenancyConfigDataAttributesLogsConfig' + $ref: "#/components/schemas/UpdateTenancyConfigDataAttributesLogsConfig" metrics_config: - $ref: '#/components/schemas/UpdateTenancyConfigDataAttributesMetricsConfig' + $ref: "#/components/schemas/UpdateTenancyConfigDataAttributesMetricsConfig" regions_config: - $ref: '#/components/schemas/UpdateTenancyConfigDataAttributesRegionsConfig' + $ref: "#/components/schemas/UpdateTenancyConfigDataAttributesRegionsConfig" resource_collection_enabled: type: boolean user_ocid: @@ -70857,10 +67424,10 @@ components: fingerprint: type: string private_key: - example: '' + example: "" type: string required: - - private_key + - private_key type: object UpdateTenancyConfigDataAttributesLogsConfig: properties: @@ -70907,228 +67474,208 @@ components: default: oci_tenancy description: OCI tenancy resource type. enum: - - oci_tenancy + - oci_tenancy example: oci_tenancy type: string x-enum-varnames: - - OCI_TENANCY + - OCI_TENANCY UpdateTenancyConfigRequest: example: data: attributes: auth_credentials: - fingerprint: '' - private_key: '----BEGIN PRIVATE KEY----- - + fingerprint: "" + private_key: |- + ----BEGIN PRIVATE KEY----- MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCdvSMmlfLyeD4M - QsA3WlrWBqKdWa5eVV3/uODyqT3wWMEMIJHcG3/quNs8nh9xrK1/JkQT2qoKEHqR - C5k59jN6Vp8em8ARJthMgam9K37ELt+IQ/G8ySTSuqZG8T4cHp/cs3fAclNqttOl - YnGr4RbVAgMBAAECggEAGZNLGbyCUbIRTW6Kh4d8ZVC+eZtJMqGmGJ3KfVaW8Pjn - QGWfSuJCEe2o2Y8G3phlidFauICnZ44enXA17Rhi+I/whnr7FIyQk2bR7rv+1Uhc - mOJygWX5eFFMsledgVAdIAl9Luk2nykx7Un3g6rtbl/Vs+5k4m7ITLFMpCHzsJLU - nm8kBzDOqY2JUkMd08nL88KL6QywWtal05UESzQpNFXd0e5kxYfexeMCsLsWP0mc - quMLRbn7NuBjCbe9VU2kmIvcfDDaWjurT7d5m1OXx1cc8p6P4PFZTVyCjdhiWOr3 - LQXZ4/vdZNR3zgEHypRoM6D9Yq99LWUOUEMrdiSLQQKBgQDQkh7C1OtAXnpy7F6R - W+/I3zBHici2p7A57UT7VECQ1IVGg37/uus83DkuOtdZ33JmHLAVrwLFJvUlbyjx - l6dc/1ms40L5HFdLgaVtd4k0rSPFeOSDr6evz0lX4yBuzlP0fEh+o3XHW7mwe2G+ - rWCULF/Uqza66fjbCSKMNgLIXQKBgQDBm9nZg/s4S0THWCFNWcB1tXBG0p/sH5eY - PC1H/VmTEINIixStrS4ufczf31X8rcoSjSbO7+vZDTTATdk7OLn1I2uGFVYl8M59 - 86BYT2Hi7cwp7YVzOc/cJigVeBAqSRW/iYYyWBEUTiW1gbkV0sRWwhPp67m+c0sP - XpY/iEZA2QKBgB1w8tynt4l/jKNaUEMOijt9ndALWATIiOy0XG9pxi9rgGCiwTOS - DBCsOXoYHjv2eayGUijNaoOv6xzcoxfvQ1WySdNIxTRq1ru20kYwgHKqGgmO9hrM - mcwMY5r/WZ2qjFlPjeAqbL62aPDLidGjoaVo2iIoBPK/gjxQ/5f0MS4N/YQ0zWoYBueSQ0DGs - - -----END PRIVATE KEY-----' + -----END PRIVATE KEY----- cost_collection_enabled: true home_region: us-ashburn-1 logs_config: compartment_tag_filters: - - datadog:true - - env:prod + - datadog:true + - env:prod enabled: true enabled_services: - - service_1 - - service_1 + - service_1 + - service_1 metrics_config: compartment_tag_filters: - - datadog:true - - env:prod + - datadog:true + - env:prod enabled: true excluded_services: - - service_1 - - service_1 + - service_1 + - service_1 regions_config: available: - - us-ashburn-1 - - us-phoenix-1 + - us-ashburn-1 + - us-phoenix-1 disabled: - - us-phoenix-1 + - us-phoenix-1 enabled: - - us-ashburn-1 + - us-ashburn-1 resource_collection_enabled: true user_ocid: ocid.user.test id: ocid.tenancy.test type: oci_tenancy properties: data: - $ref: '#/components/schemas/UpdateTenancyConfigData' + $ref: "#/components/schemas/UpdateTenancyConfigData" required: - - data + - data type: object UpdateWorkflowRequest: description: A request object for updating an existing workflow. example: data: attributes: - description: A sample workflow. - name: Example Workflow + description: "A sample workflow." + name: "Example Workflow" published: true spec: annotations: - - display: - bounds: - height: 150 - width: 300 - x: -375 - y: -0.5 - id: 99999999-9999-9999-9999-999999999999 - markdownTextAnnotation: - text: Example annotation. + - display: + bounds: + height: 150 + width: 300 + x: -375 + y: -0.5 + id: 99999999-9999-9999-9999-999999999999 + markdownTextAnnotation: + text: "Example annotation." connectionEnvs: - - connections: - - connectionId: 11111111-1111-1111-1111-111111111111 - label: INTEGRATION_DATADOG - env: default - handle: my-handle + - connections: + - connectionId: "11111111-1111-1111-1111-111111111111" + label: "INTEGRATION_DATADOG" + env: "default" + handle: "my-handle" inputSchema: parameters: - - defaultValue: default - name: input - type: STRING + - defaultValue: "default" + name: "input" + type: "STRING" outputSchema: parameters: - - name: output - type: ARRAY_OBJECT - value: '{{ Steps.Step1 }}' + - name: "output" + type: "ARRAY_OBJECT" + value: "{{ Steps.Step1 }}" steps: - - actionId: com.datadoghq.dd.monitor.listMonitors - connectionLabel: INTEGRATION_DATADOG - name: Step1 - outboundEdges: - - branchName: main - nextStepName: Step2 - parameters: - - name: tags - value: service:monitoring - - actionId: com.datadoghq.core.noop - name: Step2 + - actionId: "com.datadoghq.dd.monitor.listMonitors" + connectionLabel: "INTEGRATION_DATADOG" + name: "Step1" + outboundEdges: + - branchName: "main" + nextStepName: "Step2" + parameters: + - name: "tags" + value: "service:monitoring" + - actionId: "com.datadoghq.core.noop" + name: "Step2" triggers: - - monitorTrigger: - rateLimit: - count: 1 - interval: 3600s - startStepNames: - - Step1 - - githubWebhookTrigger: {} - startStepNames: - - Step1 + - monitorTrigger: + rateLimit: + count: 1 + interval: "3600s" + startStepNames: ["Step1"] + - githubWebhookTrigger: {} + startStepNames: ["Step1"] tags: - - team:infra - - service:monitoring - - foo:bar - id: 22222222-2222-2222-2222-222222222222 - type: workflows + - "team:infra" + - "service:monitoring" + - "foo:bar" + id: "22222222-2222-2222-2222-222222222222" + type: "workflows" properties: data: - $ref: '#/components/schemas/WorkflowDataUpdate' + $ref: "#/components/schemas/WorkflowDataUpdate" required: - - data + - data type: object UpdateWorkflowResponse: description: The response object after updating a workflow. properties: data: - $ref: '#/components/schemas/WorkflowDataUpdate' + $ref: "#/components/schemas/WorkflowDataUpdate" type: object UpsertCatalogEntityRequest: description: Create or update entity request. oneOf: - - $ref: '#/components/schemas/EntityV3' - - $ref: '#/components/schemas/EntityRaw' + - $ref: "#/components/schemas/EntityV3" + - $ref: "#/components/schemas/EntityRaw" UpsertCatalogEntityResponse: description: Upsert entity response. properties: data: - $ref: '#/components/schemas/EntityResponseData' + $ref: "#/components/schemas/EntityResponseData" included: - $ref: '#/components/schemas/UpsertCatalogEntityResponseIncluded' + $ref: "#/components/schemas/UpsertCatalogEntityResponseIncluded" meta: - $ref: '#/components/schemas/EntityResponseMeta' + $ref: "#/components/schemas/EntityResponseMeta" type: object UpsertCatalogEntityResponseIncluded: description: Upsert entity response included. items: - $ref: '#/components/schemas/UpsertCatalogEntityResponseIncludedItem' + $ref: "#/components/schemas/UpsertCatalogEntityResponseIncludedItem" type: array UpsertCatalogEntityResponseIncludedItem: description: Upsert entity response included item. oneOf: - - $ref: '#/components/schemas/EntityResponseIncludedSchema' + - $ref: "#/components/schemas/EntityResponseIncludedSchema" UpsertCatalogKindRequest: description: Create or update kind request. oneOf: - - $ref: '#/components/schemas/KindObj' - - $ref: '#/components/schemas/KindRaw' + - $ref: "#/components/schemas/KindObj" + - $ref: "#/components/schemas/KindRaw" UpsertCatalogKindResponse: description: Upsert kind response. properties: data: - $ref: '#/components/schemas/KindResponseData' + $ref: "#/components/schemas/KindResponseData" meta: - $ref: '#/components/schemas/KindResponseMeta' + $ref: "#/components/schemas/KindResponseMeta" type: object Urgency: - description: Specifies the level of urgency for a routing rule (low, high, or - dynamic). + description: Specifies the level of urgency for a routing rule (low, high, or dynamic). enum: - - low - - high - - dynamic + - low + - high + - dynamic example: low type: string x-enum-varnames: - - LOW - - HIGH - - DYNAMIC + - LOW + - HIGH + - DYNAMIC UrlParam: description: The definition of `UrlParam` object. properties: name: - $ref: '#/components/schemas/TokenName' + $ref: "#/components/schemas/TokenName" example: MyUrlParameter value: description: The `UrlParam` `value`. example: Some Url Parameter value type: string required: - - name - - value + - name + - value type: object UrlParamUpdate: description: The definition of `UrlParamUpdate` object. @@ -71137,14 +67684,14 @@ components: description: Should the header be deleted. type: boolean name: - $ref: '#/components/schemas/TokenName' + $ref: "#/components/schemas/TokenName" example: MyUrlParameter value: description: The `UrlParamUpdate` `value`. example: Some Url Parameter value type: string required: - - name + - name type: object UsageApplicationSecurityMonitoringResponse: description: Application Security Monitoring usage response. @@ -71152,7 +67699,7 @@ components: data: description: Response containing Application Security Monitoring usage. items: - $ref: '#/components/schemas/UsageDataObject' + $ref: "#/components/schemas/UsageDataObject" type: array type: object UsageAttributesObject: @@ -71168,25 +67715,24 @@ components: description: The organization public ID. type: string region: - description: The region of the Datadog instance that the organization belongs - to. + description: The region of the Datadog instance that the organization belongs to. type: string timeseries: description: List of usage data reported for each requested hour. items: - $ref: '#/components/schemas/UsageTimeSeriesObject' + $ref: "#/components/schemas/UsageTimeSeriesObject" type: array usage_type: - $ref: '#/components/schemas/HourlyUsageType' + $ref: "#/components/schemas/HourlyUsageType" type: object UsageAttributionTypesAttributes: description: List of usage attribution types. properties: values: - description: List of usage attribution types. + description: "List of usage attribution types." items: description: A given usage type in a list. - example: infra_host + example: "infra_host" type: string type: array type: object @@ -71194,37 +67740,37 @@ components: description: Usage attribution types data. properties: attributes: - $ref: '#/components/schemas/UsageAttributionTypesAttributes' + $ref: "#/components/schemas/UsageAttributionTypesAttributes" id: description: Unique ID of the response. type: string type: - $ref: '#/components/schemas/UsageAttributionTypesType' + $ref: "#/components/schemas/UsageAttributionTypesType" type: object UsageAttributionTypesResponse: description: Usage attribution types response. properties: data: - $ref: '#/components/schemas/UsageAttributionTypesBody' + $ref: "#/components/schemas/UsageAttributionTypesBody" type: object UsageAttributionTypesType: default: usage_attribution_types description: Type of usage attribution types data. enum: - - usage_attribution_types + - usage_attribution_types type: string x-enum-varnames: - - USAGE_ATTRIBUTION_TYPES + - USAGE_ATTRIBUTION_TYPES UsageDataObject: description: Usage data. properties: attributes: - $ref: '#/components/schemas/UsageAttributesObject' + $ref: "#/components/schemas/UsageAttributesObject" id: description: Unique ID of the response. type: string type: - $ref: '#/components/schemas/UsageTimeSeriesType' + $ref: "#/components/schemas/UsageTimeSeriesType" type: object UsageLambdaTracedInvocationsResponse: description: Lambda Traced Invocations usage response. @@ -71232,7 +67778,7 @@ components: data: description: Response containing Lambda Traced Invocations usage. items: - $ref: '#/components/schemas/UsageDataObject' + $ref: "#/components/schemas/UsageDataObject" type: array type: object UsageObservabilityPipelinesResponse: @@ -71241,7 +67787,7 @@ components: data: description: Response containing Observability Pipelines usage. items: - $ref: '#/components/schemas/UsageDataObject' + $ref: "#/components/schemas/UsageDataObject" type: array type: object UsageTimeSeriesObject: @@ -71252,8 +67798,7 @@ components: format: date-time type: string value: - description: Contains the number measured for the given usage_type during - the hour. + description: Contains the number measured for the given usage_type during the hour. format: int64 nullable: true type: integer @@ -71262,23 +67807,23 @@ components: default: usage_timeseries description: Type of usage data. enum: - - usage_timeseries + - usage_timeseries example: usage_timeseries type: string x-enum-varnames: - - USAGE_TIMESERIES + - USAGE_TIMESERIES User: description: User object returned by the API. properties: attributes: - $ref: '#/components/schemas/UserAttributes' + $ref: "#/components/schemas/UserAttributes" id: description: ID of the user. type: string relationships: - $ref: '#/components/schemas/UserResponseRelationships' + $ref: "#/components/schemas/UserResponseRelationships" type: - $ref: '#/components/schemas/UsersType' + $ref: "#/components/schemas/UsersType" type: object UserAttributes: description: Attributes of user object returned by the API. @@ -71334,20 +67879,20 @@ components: UserAttributesStatus: description: The user's status. enum: - - active - - deactivated - - pending + - active + - deactivated + - pending type: string x-enum-varnames: - - ACTIVE - - DEACTIVATED - - PENDING + - ACTIVE + - DEACTIVATED + - PENDING UserCreateAttributes: description: Attributes of the created user. properties: email: description: The email of the user. - example: jane.doe@example.com + example: "jane.doe@example.com" type: string name: description: The name of the user. @@ -71356,39 +67901,39 @@ components: description: The title of the user. type: string required: - - email + - email type: object UserCreateData: description: Object to create a user. properties: attributes: - $ref: '#/components/schemas/UserCreateAttributes' + $ref: "#/components/schemas/UserCreateAttributes" relationships: - $ref: '#/components/schemas/UserRelationships' + $ref: "#/components/schemas/UserRelationships" type: - $ref: '#/components/schemas/UsersType' + $ref: "#/components/schemas/UsersType" required: - - attributes - - type + - attributes + - type type: object UserCreateRequest: description: Create a user. properties: data: - $ref: '#/components/schemas/UserCreateData' + $ref: "#/components/schemas/UserCreateData" required: - - data + - data type: object UserInvitationData: description: Object to create a user invitation. properties: relationships: - $ref: '#/components/schemas/UserInvitationRelationships' + $ref: "#/components/schemas/UserInvitationRelationships" type: - $ref: '#/components/schemas/UserInvitationsType' + $ref: "#/components/schemas/UserInvitationsType" required: - - type - - relationships + - type + - relationships type: object UserInvitationDataAttributes: description: Attributes of a user invitation. @@ -71412,40 +67957,40 @@ components: description: Relationships data for user invitation. properties: user: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" required: - - user + - user type: object UserInvitationResponse: description: User invitation as returned by the API. properties: data: - $ref: '#/components/schemas/UserInvitationResponseData' + $ref: "#/components/schemas/UserInvitationResponseData" type: object UserInvitationResponseData: description: Object of a user invitation returned by the API. properties: attributes: - $ref: '#/components/schemas/UserInvitationDataAttributes' + $ref: "#/components/schemas/UserInvitationDataAttributes" id: description: ID of the user invitation. type: string relationships: - $ref: '#/components/schemas/UserInvitationRelationships' + $ref: "#/components/schemas/UserInvitationRelationships" type: - $ref: '#/components/schemas/UserInvitationsType' + $ref: "#/components/schemas/UserInvitationsType" type: object UserInvitationsRequest: description: Object to invite users to join the organization. properties: data: - description: List of user invitations. + description: "List of user invitations." example: [] items: - $ref: '#/components/schemas/UserInvitationData' + $ref: "#/components/schemas/UserInvitationData" type: array required: - - data + - data type: object UserInvitationsResponse: description: User invitations as returned by the API. @@ -71453,173 +67998,169 @@ components: data: description: Array of user invitations. items: - $ref: '#/components/schemas/UserInvitationResponseData' + $ref: "#/components/schemas/UserInvitationResponseData" type: array type: object UserInvitationsType: default: user_invitations description: User invitations type. enum: - - user_invitations + - user_invitations example: user_invitations type: string x-enum-varnames: - - USER_INVITATIONS + - USER_INVITATIONS UserRelationshipData: description: Relationship to user object. properties: id: description: A unique identifier that represents the user. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string type: - $ref: '#/components/schemas/UserResourceType' + $ref: "#/components/schemas/UserResourceType" required: - - id - - type + - id + - type type: object UserRelationships: description: Relationships of the user object. properties: roles: - $ref: '#/components/schemas/RelationshipToRoles' + $ref: "#/components/schemas/RelationshipToRoles" type: object UserResourceType: default: user description: User resource type. enum: - - user + - user example: user type: string x-enum-varnames: - - USER + - USER UserResponse: description: Response containing information about a single user. properties: data: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" included: description: Array of objects related to the user. items: - $ref: '#/components/schemas/UserResponseIncludedItem' + $ref: "#/components/schemas/UserResponseIncludedItem" type: array type: object UserResponseIncludedItem: description: An object related to a user. oneOf: - - $ref: '#/components/schemas/Organization' - - $ref: '#/components/schemas/Permission' - - $ref: '#/components/schemas/Role' + - $ref: "#/components/schemas/Organization" + - $ref: "#/components/schemas/Permission" + - $ref: "#/components/schemas/Role" UserResponseRelationships: description: Relationships of the user object returned by the API. properties: org: - $ref: '#/components/schemas/RelationshipToOrganization' + $ref: "#/components/schemas/RelationshipToOrganization" other_orgs: - $ref: '#/components/schemas/RelationshipToOrganizations' + $ref: "#/components/schemas/RelationshipToOrganizations" other_users: - $ref: '#/components/schemas/RelationshipToUsers' + $ref: "#/components/schemas/RelationshipToUsers" roles: - $ref: '#/components/schemas/RelationshipToRoles' + $ref: "#/components/schemas/RelationshipToRoles" type: object UserTarget: - description: Represents a user target for an escalation policy step, including - the user's ID and resource type. + description: "Represents a user target for an escalation policy step, including the user's ID and resource type." properties: id: - description: Specifies the unique identifier of the user resource. - example: 00000000-aba1-0000-0000-000000000000 + description: "Specifies the unique identifier of the user resource." + example: "00000000-aba1-0000-0000-000000000000" type: string type: - $ref: '#/components/schemas/UserTargetType' + $ref: "#/components/schemas/UserTargetType" required: - - type - - id + - type + - id type: object UserTargetType: default: users - description: Indicates that the resource is of type `users`. + description: "Indicates that the resource is of type `users`." enum: - - users + - users example: users type: string x-enum-varnames: - - USERS + - USERS UserTeam: description: A user's relationship with a team properties: attributes: - $ref: '#/components/schemas/UserTeamAttributes' + $ref: "#/components/schemas/UserTeamAttributes" id: description: The ID of a user's relationship with a team example: TeamMembership-aeadc05e-98a8-11ec-ac2c-da7ad0900001-38835 type: string relationships: - $ref: '#/components/schemas/UserTeamRelationships' + $ref: "#/components/schemas/UserTeamRelationships" type: - $ref: '#/components/schemas/UserTeamType' + $ref: "#/components/schemas/UserTeamType" required: - - id - - type + - id + - type type: object UserTeamAttributes: description: Team membership attributes properties: provisioned_by: - description: 'The mechanism responsible for provisioning the team relationship. - - Possible values: null for added by a user, "service_account" if added - by a service account, and "saml_mapping" if provisioned via SAML mapping.' + description: |- + The mechanism responsible for provisioning the team relationship. + Possible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping. nullable: true readOnly: true type: string provisioned_by_id: - description: UUID of the User or Service Account who provisioned this team - membership, or null if provisioned via SAML mapping. + description: UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping. nullable: true readOnly: true type: string role: - $ref: '#/components/schemas/UserTeamRole' + $ref: "#/components/schemas/UserTeamRole" type: object UserTeamCreate: description: A user's relationship with a team properties: attributes: - $ref: '#/components/schemas/UserTeamAttributes' + $ref: "#/components/schemas/UserTeamAttributes" relationships: - $ref: '#/components/schemas/UserTeamRelationships' + $ref: "#/components/schemas/UserTeamRelationships" type: - $ref: '#/components/schemas/UserTeamType' + $ref: "#/components/schemas/UserTeamType" required: - - type + - type type: object UserTeamIncluded: description: Included resources related to the team membership oneOf: - - $ref: '#/components/schemas/User' - - $ref: '#/components/schemas/Team' + - $ref: "#/components/schemas/User" + - $ref: "#/components/schemas/Team" UserTeamPermission: description: A user's permissions for a given team properties: attributes: - $ref: '#/components/schemas/UserTeamPermissionAttributes' + $ref: "#/components/schemas/UserTeamPermissionAttributes" id: description: The user team permission's identifier example: UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595 type: string type: - $ref: '#/components/schemas/UserTeamPermissionType' + $ref: "#/components/schemas/UserTeamPermissionType" required: - - id - - type + - id + - type type: object UserTeamPermissionAttributes: description: User team permission attributes properties: permissions: - description: Object of team permission actions and boolean values that a - logged in user can perform on this team. + description: Object of team permission actions and boolean values that a logged in user can perform on this team. readOnly: true type: object type: object @@ -71627,108 +68168,108 @@ components: default: user_team_permissions description: User team permission type enum: - - user_team_permissions + - user_team_permissions example: user_team_permissions type: string x-enum-varnames: - - USER_TEAM_PERMISSIONS + - USER_TEAM_PERMISSIONS UserTeamRelationships: description: Relationship between membership and a user properties: team: - $ref: '#/components/schemas/RelationshipToUserTeamTeam' + $ref: "#/components/schemas/RelationshipToUserTeamTeam" user: - $ref: '#/components/schemas/RelationshipToUserTeamUser' + $ref: "#/components/schemas/RelationshipToUserTeamUser" type: object UserTeamRequest: description: Team membership request properties: data: - $ref: '#/components/schemas/UserTeamCreate' + $ref: "#/components/schemas/UserTeamCreate" required: - - data + - data type: object UserTeamResponse: description: Team membership response properties: data: - $ref: '#/components/schemas/UserTeam' + $ref: "#/components/schemas/UserTeam" included: description: Resources related to the team memberships items: - $ref: '#/components/schemas/UserTeamIncluded' + $ref: "#/components/schemas/UserTeamIncluded" type: array type: object UserTeamRole: description: The user's role within the team enum: - - admin + - admin nullable: true type: string x-enum-varnames: - - ADMIN + - ADMIN UserTeamTeamType: default: team description: User team team type enum: - - team + - team example: team type: string x-enum-varnames: - - TEAM + - TEAM UserTeamType: default: team_memberships description: Team membership type enum: - - team_memberships + - team_memberships example: team_memberships type: string x-enum-varnames: - - TEAM_MEMBERSHIPS + - TEAM_MEMBERSHIPS UserTeamUpdate: description: A user's relationship with a team properties: attributes: - $ref: '#/components/schemas/UserTeamAttributes' + $ref: "#/components/schemas/UserTeamAttributes" type: - $ref: '#/components/schemas/UserTeamType' + $ref: "#/components/schemas/UserTeamType" required: - - type + - type type: object UserTeamUpdateRequest: description: Team membership request properties: data: - $ref: '#/components/schemas/UserTeamUpdate' + $ref: "#/components/schemas/UserTeamUpdate" required: - - data + - data type: object UserTeamUserType: default: users description: User team user type enum: - - users + - users example: users type: string x-enum-varnames: - - USERS + - USERS UserTeamsResponse: description: Team memberships response properties: data: description: Team memberships response data items: - $ref: '#/components/schemas/UserTeam' + $ref: "#/components/schemas/UserTeam" type: array included: description: Resources related to the team memberships items: - $ref: '#/components/schemas/UserTeamIncluded' + $ref: "#/components/schemas/UserTeamIncluded" type: array links: - $ref: '#/components/schemas/TeamsResponseLinks' + $ref: "#/components/schemas/TeamsResponseLinks" meta: - $ref: '#/components/schemas/TeamsResponseMeta' + $ref: "#/components/schemas/TeamsResponseMeta" type: object UserUpdateAttributes: description: Attributes of the edited user. @@ -71747,25 +68288,25 @@ components: description: Object to update a user. properties: attributes: - $ref: '#/components/schemas/UserUpdateAttributes' + $ref: "#/components/schemas/UserUpdateAttributes" id: description: ID of the user. - example: 00000000-0000-feed-0000-000000000000 + example: "00000000-0000-feed-0000-000000000000" type: string type: - $ref: '#/components/schemas/UsersType' + $ref: "#/components/schemas/UsersType" required: - - attributes - - type - - id + - attributes + - type + - id type: object UserUpdateRequest: description: Update a user. properties: data: - $ref: '#/components/schemas/UserUpdateData' + $ref: "#/components/schemas/UserUpdateData" required: - - data + - data type: object UsersRelationship: description: Relationship to users. @@ -71774,10 +68315,10 @@ components: description: Relationships to user objects. example: [] items: - $ref: '#/components/schemas/UserRelationshipData' + $ref: "#/components/schemas/UserRelationshipData" type: array required: - - data + - data type: object UsersResponse: description: Response containing information about multiple users. @@ -71785,80 +68326,79 @@ components: data: description: Array of returned users. items: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" type: array included: description: Array of objects related to the users. items: - $ref: '#/components/schemas/UserResponseIncludedItem' + $ref: "#/components/schemas/UserResponseIncludedItem" type: array meta: - $ref: '#/components/schemas/ResponseMetaAttributes' + $ref: "#/components/schemas/ResponseMetaAttributes" readOnly: true type: object UsersType: default: users description: Users resource type. enum: - - users + - users example: users type: string x-enum-varnames: - - USERS + - USERS V2Event: description: An event object. properties: attributes: - $ref: '#/components/schemas/V2EventAttributes' + $ref: "#/components/schemas/V2EventAttributes" id: description: The event's ID. - example: '' + example: "" type: string type: description: Entity type. - example: event + example: "event" type: string type: object V2EventAggregationKey: description: Aggregation key of the event. - example: aggregation-key + example: "aggregation-key" type: string V2EventAttributes: description: Event attributes. properties: attributes: - $ref: '#/components/schemas/V2EventAttributesAttributes' + $ref: "#/components/schemas/V2EventAttributesAttributes" message: description: Free-form text associated with the event. - example: The event message + example: "The event message" type: string tags: description: A list of tags associated with the event. - example: - - env:api_client_test + example: ["env:api_client_test"] items: description: A tag. type: string type: array timestamp: description: Timestamp when the event occurred. - example: '2017-01-15T01:30:15.010000Z' + example: "2017-01-15T01:30:15.010000Z" type: string type: object V2EventAttributesAttributes: description: JSON object for category-specific attributes. oneOf: - - $ref: '#/components/schemas/ChangeEventAttributes' - - $ref: '#/components/schemas/AlertEventAttributes' + - $ref: "#/components/schemas/ChangeEventAttributes" + - $ref: "#/components/schemas/AlertEventAttributes" V2EventResponse: description: Get an event response. properties: data: - $ref: '#/components/schemas/V2Event' + $ref: "#/components/schemas/V2Event" type: object V2EventService: description: Service that triggered the event. - example: service-name + example: "service-name" type: string V2EventTimestamp: description: POSIX timestamp of the event. @@ -71867,25 +68407,23 @@ components: type: integer V2EventTitle: description: The title of the event. - example: The event title + example: "The event title" type: string ValidationError: - description: Represents a single validation error, including a human-readable - title and metadata. + description: Represents a single validation error, including a human-readable title and metadata. properties: meta: - $ref: '#/components/schemas/ValidationErrorMeta' + $ref: "#/components/schemas/ValidationErrorMeta" title: description: A short, human-readable summary of the error. example: Field 'region' is required type: string required: - - title - - meta + - title + - meta type: object ValidationErrorMeta: - description: Describes additional metadata for validation errors, including - field names and error messages. + description: Describes additional metadata for validation errors, including field names and error messages. properties: field: description: The field name that caused the error. @@ -71900,27 +68438,26 @@ components: example: Field 'region' is required type: string required: - - message + - message type: object ValidationResponse: description: Response containing validation errors. example: errors: - - meta: - field: region - id: datadog-agent-source - message: Field 'region' is required - title: Field 'region' is required + - meta: + field: "region" + id: "datadog-agent-source" + message: "Field 'region' is required" + title: "Field 'region' is required" properties: errors: description: The `ValidationResponse` `errors`. items: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" type: array type: object Version: - description: Version of the notification rule. It is updated when the rule is - modified. + description: Version of the notification rule. It is updated when the rule is modified. example: 1 format: int64 type: integer @@ -71936,45 +68473,45 @@ components: example: Tags type: string type: - $ref: '#/components/schemas/VersionHistoryUpdateType' + $ref: "#/components/schemas/VersionHistoryUpdateType" type: object VersionHistoryUpdateType: description: The type of change. enum: - - create - - update - - delete + - create + - update + - delete type: string x-enum-varnames: - - CREATE - - UPDATE - - DELETE + - CREATE + - UPDATE + - DELETE ViewershipHistorySessionArray: properties: data: items: - $ref: '#/components/schemas/ViewershipHistorySessionData' + $ref: "#/components/schemas/ViewershipHistorySessionData" type: array required: - - data + - data type: object ViewershipHistorySessionData: properties: attributes: - $ref: '#/components/schemas/ViewershipHistorySessionDataAttributes' + $ref: "#/components/schemas/ViewershipHistorySessionDataAttributes" id: type: string type: - $ref: '#/components/schemas/ViewershipHistorySessionDataType' + $ref: "#/components/schemas/ViewershipHistorySessionDataType" required: - - type + - type type: object ViewershipHistorySessionDataAttributes: properties: event_id: type: string last_watched_at: - example: '2026-01-13T17:15:53.208340Z' + example: "2026-01-13T17:15:53.208340Z" format: date-time type: string session_event: @@ -71983,38 +68520,38 @@ components: track: type: string required: - - last_watched_at + - last_watched_at type: object ViewershipHistorySessionDataType: default: rum_replay_session description: Rum replay session resource type. enum: - - rum_replay_session + - rum_replay_session example: rum_replay_session type: string x-enum-varnames: - - RUM_REPLAY_SESSION + - RUM_REPLAY_SESSION VirusTotalAPIKey: description: The definition of the `VirusTotalAPIKey` object. properties: api_key: description: The `VirusTotalAPIKey` `api_key`. - example: '' + example: "" type: string type: - $ref: '#/components/schemas/VirusTotalAPIKeyType' + $ref: "#/components/schemas/VirusTotalAPIKeyType" required: - - type - - api_key + - type + - api_key type: object VirusTotalAPIKeyType: description: The definition of the `VirusTotalAPIKey` object. enum: - - VirusTotalAPIKey + - VirusTotalAPIKey example: VirusTotalAPIKey type: string x-enum-varnames: - - VIRUSTOTALAPIKEY + - VIRUSTOTALAPIKEY VirusTotalAPIKeyUpdate: description: The definition of the `VirusTotalAPIKey` object. properties: @@ -72022,73 +68559,73 @@ components: description: The `VirusTotalAPIKeyUpdate` `api_key`. type: string type: - $ref: '#/components/schemas/VirusTotalAPIKeyType' + $ref: "#/components/schemas/VirusTotalAPIKeyType" required: - - type + - type type: object VirusTotalCredentials: description: The definition of the `VirusTotalCredentials` object. oneOf: - - $ref: '#/components/schemas/VirusTotalAPIKey' + - $ref: "#/components/schemas/VirusTotalAPIKey" VirusTotalCredentialsUpdate: description: The definition of the `VirusTotalCredentialsUpdate` object. oneOf: - - $ref: '#/components/schemas/VirusTotalAPIKeyUpdate' + - $ref: "#/components/schemas/VirusTotalAPIKeyUpdate" VirusTotalIntegration: description: The definition of the `VirusTotalIntegration` object. properties: credentials: - $ref: '#/components/schemas/VirusTotalCredentials' + $ref: "#/components/schemas/VirusTotalCredentials" type: - $ref: '#/components/schemas/VirusTotalIntegrationType' + $ref: "#/components/schemas/VirusTotalIntegrationType" required: - - type - - credentials + - type + - credentials type: object VirusTotalIntegrationType: description: The definition of the `VirusTotalIntegrationType` object. enum: - - VirusTotal + - VirusTotal example: VirusTotal type: string x-enum-varnames: - - VIRUSTOTAL + - VIRUSTOTAL VirusTotalIntegrationUpdate: description: The definition of the `VirusTotalIntegrationUpdate` object. properties: credentials: - $ref: '#/components/schemas/VirusTotalCredentialsUpdate' + $ref: "#/components/schemas/VirusTotalCredentialsUpdate" type: - $ref: '#/components/schemas/VirusTotalIntegrationType' + $ref: "#/components/schemas/VirusTotalIntegrationType" required: - - type + - type type: object VulnerabilitiesType: description: The JSON:API type. enum: - - vulnerabilities + - vulnerabilities example: vulnerabilities type: string x-enum-varnames: - - VULNERABILITIES + - VULNERABILITIES Vulnerability: description: A single vulnerability properties: attributes: - $ref: '#/components/schemas/VulnerabilityAttributes' + $ref: "#/components/schemas/VulnerabilityAttributes" id: description: The unique ID for this vulnerability. example: 3ecdfea798f2ce8f6e964805a344945f type: string relationships: - $ref: '#/components/schemas/VulnerabilityRelationships' + $ref: "#/components/schemas/VulnerabilityRelationships" type: - $ref: '#/components/schemas/VulnerabilitiesType' + $ref: "#/components/schemas/VulnerabilitiesType" required: - - id - - type - - attributes - - relationships + - id + - type + - attributes + - relationships type: object VulnerabilityAdvisory: description: Advisory associated with the vulnerability. @@ -72106,52 +68643,44 @@ components: example: 2024-09-19 21:23:08+00:00 type: string required: - - id + - id type: object VulnerabilityAttributes: description: The JSON:API attributes of the vulnerability. properties: advisory: - $ref: '#/components/schemas/VulnerabilityAdvisory' + $ref: "#/components/schemas/VulnerabilityAdvisory" advisory_id: description: Vulnerability advisory ID. example: TRIVY-CVE-2023-0615 type: string code_location: - $ref: '#/components/schemas/CodeLocation' + $ref: "#/components/schemas/CodeLocation" cve_list: description: Vulnerability CVE list. example: - - CVE-2023-0615 + - CVE-2023-0615 items: example: CVE-2023-0615 type: string type: array cvss: - $ref: '#/components/schemas/VulnerabilityCvss' + $ref: "#/components/schemas/VulnerabilityCvss" dependency_locations: - $ref: '#/components/schemas/VulnerabilityDependencyLocations' + $ref: "#/components/schemas/VulnerabilityDependencyLocations" description: description: Vulnerability description. - example: LDAP Injection is a security vulnerability that occurs when untrusted - user input is improperly handled and directly incorporated into LDAP queries - without appropriate sanitization or validation. This vulnerability enables - attackers to manipulate LDAP queries and potentially gain unauthorized - access, modify data, or extract sensitive information from the directory - server. By exploiting the LDAP injection vulnerability, attackers can - execute malicious commands, bypass authentication mechanisms, and perform - unauthorized actions within the directory service. + example: "LDAP Injection is a security vulnerability that occurs when untrusted user input is improperly handled and directly incorporated into LDAP queries without appropriate sanitization or validation. This vulnerability enables attackers to manipulate LDAP queries and potentially gain unauthorized access, modify data, or extract sensitive information from the directory server. By exploiting the LDAP injection vulnerability, attackers can execute malicious commands, bypass authentication mechanisms, and perform unauthorized actions within the directory service." type: string ecosystem: - $ref: '#/components/schemas/VulnerabilityEcosystem' + $ref: "#/components/schemas/VulnerabilityEcosystem" exposure_time: description: Vulnerability exposure time in seconds. example: 5618604 format: int64 type: integer first_detection: - description: First detection of the vulnerability in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) - format + description: "First detection of the vulnerability in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format" example: 2024-09-19 21:23:08+00:00 type: string fix_available: @@ -72163,16 +68692,15 @@ components: example: ubuntu type: string last_detection: - description: Last detection of the vulnerability in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) - format + description: "Last detection of the vulnerability in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format" example: 2024-09-01 21:23:08+00:00 type: string library: - $ref: '#/components/schemas/Library' + $ref: "#/components/schemas/Library" origin: description: Vulnerability origin. example: - - agentless-scanner + - agentless-scanner items: example: agentless-scanner type: string @@ -72180,125 +68708,122 @@ components: remediations: description: List of remediations. items: - $ref: '#/components/schemas/Remediation' + $ref: "#/components/schemas/Remediation" type: array repo_digests: - description: Vulnerability `repo_digest` list (when the vulnerability is - related to `Image` asset). + description: Vulnerability `repo_digest` list (when the vulnerability is related to `Image` asset). items: example: sha256:0ae7da091191787229d321e3638e39c319a97d6e20f927d465b519d699215bf7 type: string type: array risks: - $ref: '#/components/schemas/VulnerabilityRisks' + $ref: "#/components/schemas/VulnerabilityRisks" running_kernel: - description: "True if the vulnerability affects a package in the host\u2019s - running kernel, false if it affects a non-running kernel, and omit if - it is not kernel-related." + description: True if the vulnerability affects a package in the host’s running kernel, false if it affects a non-running kernel, and omit if it is not kernel-related. example: true type: boolean status: - $ref: '#/components/schemas/VulnerabilityStatus' + $ref: "#/components/schemas/VulnerabilityStatus" title: description: Vulnerability title. - example: LDAP Injection + example: "LDAP Injection" type: string tool: - $ref: '#/components/schemas/VulnerabilityTool' - type: - $ref: '#/components/schemas/VulnerabilityType' - required: - - type - - cvss - - status - - tool - - title - - description - - cve_list - - risks - - language - - first_detection - - last_detection - - exposure_time - - remediations - - fix_available - - origin + $ref: "#/components/schemas/VulnerabilityTool" + type: + $ref: "#/components/schemas/VulnerabilityType" + required: + - type + - cvss + - status + - tool + - title + - description + - cve_list + - risks + - language + - first_detection + - last_detection + - exposure_time + - remediations + - fix_available + - origin type: object VulnerabilityCvss: description: Vulnerability severities. properties: base: - $ref: '#/components/schemas/CVSS' + $ref: "#/components/schemas/CVSS" datadog: - $ref: '#/components/schemas/CVSS' + $ref: "#/components/schemas/CVSS" required: - - base - - datadog + - base + - datadog type: object VulnerabilityDependencyLocations: description: Static library vulnerability location. properties: block: - $ref: '#/components/schemas/DependencyLocation' + $ref: "#/components/schemas/DependencyLocation" name: - $ref: '#/components/schemas/DependencyLocation' + $ref: "#/components/schemas/DependencyLocation" version: - $ref: '#/components/schemas/DependencyLocation' + $ref: "#/components/schemas/DependencyLocation" required: - - block + - block type: object VulnerabilityEcosystem: description: The related vulnerability asset ecosystem. enum: - - PyPI - - Maven - - NuGet - - Npm - - RubyGems - - Go - - Packagist - - Deb - - Rpm - - Apk - - Windows - - Generic - - MacOs - - Oci - - BottleRocket - - None - type: string - x-enum-varnames: - - PYPI - - MAVEN - - NUGET - - NPM - - RUBY_GEMS - - GO - - PACKAGIST - - DEB - - RPM - - APK - - WINDOWS - - GENERIC - - MAC_OS - - OCI - - BOTTLE_ROCKET - - NONE + - PyPI + - Maven + - NuGet + - Npm + - RubyGems + - Go + - Packagist + - Deb + - Rpm + - Apk + - Windows + - Generic + - MacOs + - Oci + - BottleRocket + - None + type: string + x-enum-varnames: + - PYPI + - MAVEN + - NUGET + - NPM + - RUBY_GEMS + - GO + - PACKAGIST + - DEB + - RPM + - APK + - WINDOWS + - GENERIC + - MAC_OS + - OCI + - BOTTLE_ROCKET + - NONE VulnerabilityRelationships: description: Related entities object. properties: affects: - $ref: '#/components/schemas/VulnerabilityRelationshipsAffects' + $ref: "#/components/schemas/VulnerabilityRelationshipsAffects" required: - - affects + - affects type: object VulnerabilityRelationshipsAffects: description: Relationship type. properties: data: - $ref: '#/components/schemas/VulnerabilityRelationshipsAffectsData' + $ref: "#/components/schemas/VulnerabilityRelationshipsAffectsData" required: - - data + - data type: object VulnerabilityRelationshipsAffectsData: description: Asset affected by this vulnerability. @@ -72308,16 +68833,16 @@ components: example: Repository|github.com/DataDog/datadog-agent.git type: string type: - $ref: '#/components/schemas/AssetEntityType' + $ref: "#/components/schemas/AssetEntityType" required: - - id - - type + - id + - type type: object VulnerabilityRisks: description: Vulnerability risks. properties: epss: - $ref: '#/components/schemas/EPSS' + $ref: "#/components/schemas/EPSS" exploit_available: description: Vulnerability public exploit availability. example: false @@ -72325,7 +68850,7 @@ components: exploit_sources: description: Vulnerability exploit sources. example: - - NIST + - NIST items: example: NIST type: string @@ -72339,166 +68864,166 @@ components: example: false type: boolean required: - - exploitation_probability - - poc_exploit_available - - exploit_available - - exploit_sources + - exploitation_probability + - poc_exploit_available + - exploit_available + - exploit_sources type: object VulnerabilitySeverity: description: The vulnerability severity. enum: - - Unknown - - None - - Low - - Medium - - High - - Critical + - Unknown + - None + - Low + - Medium + - High + - Critical example: Medium type: string x-enum-varnames: - - UNKNOWN - - NONE - - LOW - - MEDIUM - - HIGH - - CRITICAL + - UNKNOWN + - NONE + - LOW + - MEDIUM + - HIGH + - CRITICAL VulnerabilityStatus: description: The vulnerability status. enum: - - Open - - Muted - - Remediated - - InProgress - - AutoClosed + - Open + - Muted + - Remediated + - InProgress + - AutoClosed example: Open type: string x-enum-varnames: - - OPEN - - MUTED - - REMEDIATED - - INPROGRESS - - AUTOCLOSED + - OPEN + - MUTED + - REMEDIATED + - INPROGRESS + - AUTOCLOSED VulnerabilityTool: description: The vulnerability tool. enum: - - IAST - - SCA - - Infra - - SAST + - IAST + - SCA + - Infra + - SAST example: SCA type: string x-enum-varnames: - - IAST - - SCA - - INFRA - - SAST + - IAST + - SCA + - INFRA + - SAST VulnerabilityType: description: The vulnerability type. enum: - - AdminConsoleActive - - CodeInjection - - CommandInjection - - ComponentWithKnownVulnerability - - DangerousWorkflows - - DefaultAppDeployed - - DefaultHtmlEscapeInvalid - - DirectoryListingLeak - - EmailHtmlInjection - - EndOfLife - - HardcodedPassword - - HardcodedSecret - - HeaderInjection - - HstsHeaderMissing - - InsecureAuthProtocol - - InsecureCookie - - InsecureJspLayout - - LdapInjection - - MaliciousPackage - - MandatoryRemediation - - NoHttpOnlyCookie - - NoSameSiteCookie - - NoSqlMongoDbInjection - - PathTraversal - - ReflectionInjection - - RiskyLicense - - SessionRewriting - - SessionTimeout - - SqlInjection - - Ssrf - - StackTraceLeak - - TrustBoundaryViolation - - Unmaintained - - UntrustedDeserialization - - UnvalidatedRedirect - - VerbTampering - - WeakCipher - - WeakHash - - WeakRandomness - - XContentTypeHeaderMissing - - XPathInjection - - Xss + - AdminConsoleActive + - CodeInjection + - CommandInjection + - ComponentWithKnownVulnerability + - DangerousWorkflows + - DefaultAppDeployed + - DefaultHtmlEscapeInvalid + - DirectoryListingLeak + - EmailHtmlInjection + - EndOfLife + - HardcodedPassword + - HardcodedSecret + - HeaderInjection + - HstsHeaderMissing + - InsecureAuthProtocol + - InsecureCookie + - InsecureJspLayout + - LdapInjection + - MaliciousPackage + - MandatoryRemediation + - NoHttpOnlyCookie + - NoSameSiteCookie + - NoSqlMongoDbInjection + - PathTraversal + - ReflectionInjection + - RiskyLicense + - SessionRewriting + - SessionTimeout + - SqlInjection + - Ssrf + - StackTraceLeak + - TrustBoundaryViolation + - Unmaintained + - UntrustedDeserialization + - UnvalidatedRedirect + - VerbTampering + - WeakCipher + - WeakHash + - WeakRandomness + - XContentTypeHeaderMissing + - XPathInjection + - Xss example: WeakCipher type: string x-enum-varnames: - - ADMIN_CONSOLE_ACTIVE - - CODE_INJECTION - - COMMAND_INJECTION - - COMPONENT_WITH_KNOWN_VULNERABILITY - - DANGEROUS_WORKFLOWS - - DEFAULT_APP_DEPLOYED - - DEFAULT_HTML_ESCAPE_INVALID - - DIRECTORY_LISTING_LEAK - - EMAIL_HTML_INJECTION - - END_OF_LIFE - - HARDCODED_PASSWORD - - HARDCODED_SECRET - - HEADER_INJECTION - - HSTS_HEADER_MISSING - - INSECURE_AUTH_PROTOCOL - - INSECURE_COOKIE - - INSECURE_JSP_LAYOUT - - LDAP_INJECTION - - MALICIOUS_PACKAGE - - MANDATORY_REMEDIATION - - NO_HTTP_ONLY_COOKIE - - NO_SAME_SITE_COOKIE - - NO_SQL_MONGO_DB_INJECTION - - PATH_TRAVERSAL - - REFLECTION_INJECTION - - RISKY_LICENSE - - SESSION_REWRITING - - SESSION_TIMEOUT - - SQL_INJECTION - - SSRF - - STACK_TRACE_LEAK - - TRUST_BOUNDARY_VIOLATION - - UNMAINTAINED - - UNTRUSTED_DESERIALIZATION - - UNVALIDATED_REDIRECT - - VERB_TAMPERING - - WEAK_CIPHER - - WEAK_HASH - - WEAK_RANDOMNESS - - X_CONTENT_TYPE_HEADER_MISSING - - X_PATH_INJECTION - - XSS + - ADMIN_CONSOLE_ACTIVE + - CODE_INJECTION + - COMMAND_INJECTION + - COMPONENT_WITH_KNOWN_VULNERABILITY + - DANGEROUS_WORKFLOWS + - DEFAULT_APP_DEPLOYED + - DEFAULT_HTML_ESCAPE_INVALID + - DIRECTORY_LISTING_LEAK + - EMAIL_HTML_INJECTION + - END_OF_LIFE + - HARDCODED_PASSWORD + - HARDCODED_SECRET + - HEADER_INJECTION + - HSTS_HEADER_MISSING + - INSECURE_AUTH_PROTOCOL + - INSECURE_COOKIE + - INSECURE_JSP_LAYOUT + - LDAP_INJECTION + - MALICIOUS_PACKAGE + - MANDATORY_REMEDIATION + - NO_HTTP_ONLY_COOKIE + - NO_SAME_SITE_COOKIE + - NO_SQL_MONGO_DB_INJECTION + - PATH_TRAVERSAL + - REFLECTION_INJECTION + - RISKY_LICENSE + - SESSION_REWRITING + - SESSION_TIMEOUT + - SQL_INJECTION + - SSRF + - STACK_TRACE_LEAK + - TRUST_BOUNDARY_VIOLATION + - UNMAINTAINED + - UNTRUSTED_DESERIALIZATION + - UNVALIDATED_REDIRECT + - VERB_TAMPERING + - WEAK_CIPHER + - WEAK_HASH + - WEAK_RANDOMNESS + - X_CONTENT_TYPE_HEADER_MISSING + - X_PATH_INJECTION + - XSS Watch: properties: data: - $ref: '#/components/schemas/WatchData' + $ref: "#/components/schemas/WatchData" required: - - data + - data type: object WatchData: properties: attributes: - $ref: '#/components/schemas/WatchDataAttributes' + $ref: "#/components/schemas/WatchDataAttributes" id: type: string type: - $ref: '#/components/schemas/WatchDataType' + $ref: "#/components/schemas/WatchDataType" required: - - type + - type type: object WatchDataAttributes: properties: @@ -72511,42 +69036,42 @@ components: example: 11111111-2222-3333-4444-555555555555 type: string timestamp: - example: '2026-01-13T17:15:53.208340Z' + example: "2026-01-13T17:15:53.208340Z" format: date-time type: string required: - - application_id - - event_id - - timestamp + - application_id + - event_id + - timestamp type: object WatchDataType: default: rum_replay_watch description: Rum replay watch resource type. enum: - - rum_replay_watch + - rum_replay_watch example: rum_replay_watch type: string x-enum-varnames: - - RUM_REPLAY_WATCH + - RUM_REPLAY_WATCH WatcherArray: properties: data: items: - $ref: '#/components/schemas/WatcherData' + $ref: "#/components/schemas/WatcherData" type: array required: - - data + - data type: object WatcherData: properties: attributes: - $ref: '#/components/schemas/WatcherDataAttributes' + $ref: "#/components/schemas/WatcherDataAttributes" id: type: string type: - $ref: '#/components/schemas/WatcherDataType' + $ref: "#/components/schemas/WatcherDataType" required: - - type + - type type: object WatcherDataAttributes: properties: @@ -72556,7 +69081,7 @@ components: icon: type: string last_watched_at: - example: '2026-01-13T17:15:53.208340Z' + example: "2026-01-13T17:15:53.208340Z" format: date-time type: string name: @@ -72567,90 +69092,90 @@ components: maximum: 2147483647 type: integer required: - - handle - - last_watched_at - - watch_count + - handle + - last_watched_at + - watch_count type: object WatcherDataType: default: rum_replay_watcher description: Rum replay watcher resource type. enum: - - rum_replay_watcher + - rum_replay_watcher example: rum_replay_watcher type: string x-enum-varnames: - - RUM_REPLAY_WATCHER + - RUM_REPLAY_WATCHER Weekday: description: A day of the week. enum: - - monday - - tuesday - - wednesday - - thursday - - friday - - saturday - - sunday - type: string - x-enum-varnames: - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - - SUNDAY + - monday + - tuesday + - wednesday + - thursday + - friday + - saturday + - sunday + type: string + x-enum-varnames: + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY WidgetLiveSpan: description: The available timeframes depend on the widget you are using. enum: - - 1m - - 5m - - 10m - - 15m - - 30m - - 1h - - 4h - - 1d - - 2d - - 1w - - 1mo - - 3mo - - 6mo - - 1y - - alert + - 1m + - 5m + - 10m + - 15m + - 30m + - 1h + - 4h + - 1d + - 2d + - 1w + - 1mo + - 3mo + - 6mo + - 1y + - alert example: 5m type: string x-enum-varnames: - - PAST_ONE_MINUTE - - PAST_FIVE_MINUTES - - PAST_TEN_MINUTES - - PAST_FIFTEEN_MINUTES - - PAST_THIRTY_MINUTES - - PAST_ONE_HOUR - - PAST_FOUR_HOURS - - PAST_ONE_DAY - - PAST_TWO_DAYS - - PAST_ONE_WEEK - - PAST_ONE_MONTH - - PAST_THREE_MONTHS - - PAST_SIX_MONTHS - - PAST_ONE_YEAR - - ALERT + - PAST_ONE_MINUTE + - PAST_FIVE_MINUTES + - PAST_TEN_MINUTES + - PAST_FIFTEEN_MINUTES + - PAST_THIRTY_MINUTES + - PAST_ONE_HOUR + - PAST_FOUR_HOURS + - PAST_ONE_DAY + - PAST_TWO_DAYS + - PAST_ONE_WEEK + - PAST_ONE_MONTH + - PAST_THREE_MONTHS + - PAST_SIX_MONTHS + - PAST_ONE_YEAR + - ALERT WorkflowData: description: Data related to the workflow. properties: attributes: - $ref: '#/components/schemas/WorkflowDataAttributes' + $ref: "#/components/schemas/WorkflowDataAttributes" id: description: The workflow identifier readOnly: true type: string relationships: - $ref: '#/components/schemas/WorkflowDataRelationships' + $ref: "#/components/schemas/WorkflowDataRelationships" type: - $ref: '#/components/schemas/WorkflowDataType' + $ref: "#/components/schemas/WorkflowDataType" required: - - type - - attributes + - type + - attributes type: object WorkflowDataAttributes: description: The definition of `WorkflowDataAttributes` object. @@ -72665,15 +69190,13 @@ components: type: string name: description: Name of the workflow. - example: '' + example: "" type: string published: - description: Set the workflow to published or unpublished. Workflows in - an unpublished state will only be executable via manual runs. Automatic - triggers such as Schedule will not execute the workflow until it is published. + description: Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published. type: boolean spec: - $ref: '#/components/schemas/Spec' + $ref: "#/components/schemas/Spec" tags: description: Tags of the workflow. items: @@ -72685,46 +69208,45 @@ components: readOnly: true type: string webhookSecret: - description: If a Webhook trigger is defined on this workflow, a webhookSecret - is required and should be provided here. + description: If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here. type: string writeOnly: true required: - - name - - spec + - name + - spec type: object WorkflowDataRelationships: description: The definition of `WorkflowDataRelationships` object. properties: creator: - $ref: '#/components/schemas/WorkflowUserRelationship' + $ref: "#/components/schemas/WorkflowUserRelationship" owner: - $ref: '#/components/schemas/WorkflowUserRelationship' + $ref: "#/components/schemas/WorkflowUserRelationship" readOnly: true type: object WorkflowDataType: description: The definition of `WorkflowDataType` object. enum: - - workflows + - workflows example: workflows type: string x-enum-varnames: - - WORKFLOWS + - WORKFLOWS WorkflowDataUpdate: description: Data related to the workflow being updated. properties: attributes: - $ref: '#/components/schemas/WorkflowDataUpdateAttributes' + $ref: "#/components/schemas/WorkflowDataUpdateAttributes" id: description: The workflow identifier type: string relationships: - $ref: '#/components/schemas/WorkflowDataRelationships' + $ref: "#/components/schemas/WorkflowDataRelationships" type: - $ref: '#/components/schemas/WorkflowDataType' + $ref: "#/components/schemas/WorkflowDataType" required: - - type - - attributes + - type + - attributes type: object WorkflowDataUpdateAttributes: description: The definition of `WorkflowDataUpdateAttributes` object. @@ -72741,12 +69263,10 @@ components: description: Name of the workflow. type: string published: - description: Set the workflow to published or unpublished. Workflows in - an unpublished state will only be executable via manual runs. Automatic - triggers such as Schedule will not execute the workflow until it is published. + description: Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published. type: boolean spec: - $ref: '#/components/schemas/Spec' + $ref: "#/components/schemas/Spec" tags: description: Tags of the workflow. items: @@ -72758,8 +69278,7 @@ components: readOnly: true type: string webhookSecret: - description: If a Webhook trigger is defined on this workflow, a webhookSecret - is required and should be provided here. + description: If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here. type: string writeOnly: true type: object @@ -72775,22 +69294,21 @@ components: description: Request used to create a workflow instance. properties: meta: - $ref: '#/components/schemas/WorkflowInstanceCreateMeta' + $ref: "#/components/schemas/WorkflowInstanceCreateMeta" type: object WorkflowInstanceCreateResponse: additionalProperties: {} description: Response returned upon successful workflow instance creation. properties: data: - $ref: '#/components/schemas/WorkflowInstanceCreateResponseData' + $ref: "#/components/schemas/WorkflowInstanceCreateResponseData" type: object WorkflowInstanceCreateResponseData: additionalProperties: {} description: Data about the created workflow instance. properties: id: - description: The ID of the workflow execution. It can be used to fetch the - execution status. + description: The ID of the workflow execution. It can be used to fetch the execution status. type: string type: object WorkflowInstanceListItem: @@ -72808,17 +69326,17 @@ components: data: description: A list of workflow instances. items: - $ref: '#/components/schemas/WorkflowInstanceListItem' + $ref: "#/components/schemas/WorkflowInstanceListItem" type: array meta: - $ref: '#/components/schemas/WorkflowListInstancesResponseMeta' + $ref: "#/components/schemas/WorkflowListInstancesResponseMeta" type: object WorkflowListInstancesResponseMeta: additionalProperties: {} description: Metadata about the instances list properties: page: - $ref: '#/components/schemas/WorkflowListInstancesResponseMetaPage' + $ref: "#/components/schemas/WorkflowListInstancesResponseMetaPage" type: object WorkflowListInstancesResponseMetaPage: additionalProperties: {} @@ -72830,49 +69348,48 @@ components: type: integer type: object WorkflowTriggerWrapper: - description: Schema for a Workflow-based trigger. + description: "Schema for a Workflow-based trigger." properties: startStepNames: - $ref: '#/components/schemas/StartStepNames' + $ref: "#/components/schemas/StartStepNames" workflowTrigger: - description: Trigger a workflow from the Datadog UI. Only required if no - other trigger exists. + description: "Trigger a workflow from the Datadog UI. Only required if no other trigger exists." type: object required: - - workflowTrigger + - workflowTrigger type: object WorkflowUserRelationship: description: The definition of `WorkflowUserRelationship` object. properties: data: - $ref: '#/components/schemas/WorkflowUserRelationshipData' + $ref: "#/components/schemas/WorkflowUserRelationshipData" type: object WorkflowUserRelationshipData: description: The definition of `WorkflowUserRelationshipData` object. properties: id: description: The user identifier - example: '' + example: "" type: string type: - $ref: '#/components/schemas/WorkflowUserRelationshipType' + $ref: "#/components/schemas/WorkflowUserRelationshipType" required: - - type - - id + - type + - id type: object WorkflowUserRelationshipType: description: The definition of `WorkflowUserRelationshipType` object. enum: - - users + - users example: users type: string x-enum-varnames: - - USERS + - USERS WorklflowCancelInstanceResponse: description: Information about the canceled instance. properties: data: - $ref: '#/components/schemas/WorklflowCancelInstanceResponseData' + $ref: "#/components/schemas/WorklflowCancelInstanceResponseData" type: object WorklflowCancelInstanceResponseData: description: Data about the canceled instance. @@ -72886,14 +69403,14 @@ components: description: The state of the given workflow instance. properties: data: - $ref: '#/components/schemas/WorklflowGetInstanceResponseData' + $ref: "#/components/schemas/WorklflowGetInstanceResponseData" type: object WorklflowGetInstanceResponseData: additionalProperties: {} description: The data of the instance response. properties: attributes: - $ref: '#/components/schemas/WorklflowGetInstanceResponseDataAttributes' + $ref: "#/components/schemas/WorklflowGetInstanceResponseDataAttributes" type: object WorklflowGetInstanceResponseDataAttributes: additionalProperties: {} @@ -72911,7 +69428,7 @@ components: example: false type: boolean required: - - include_all + - include_all type: object XRayServicesIncludeOnly: description: Include only these services. Defaults to `[]`. @@ -72920,27 +69437,27 @@ components: include_only: description: Include only these services. example: - - AWS/AppSync + - "AWS/AppSync" items: - example: AWS/AppSync + example: "AWS/AppSync" type: string type: array required: - - include_only + - include_only type: object XRayServicesList: description: AWS X-Ray services to collect traces from. Defaults to `include_only`. oneOf: - - $ref: '#/components/schemas/XRayServicesIncludeAll' - - $ref: '#/components/schemas/XRayServicesIncludeOnly' + - $ref: "#/components/schemas/XRayServicesIncludeAll" + - $ref: "#/components/schemas/XRayServicesIncludeOnly" ZoomConfigurationReference: description: A reference to a Zoom configuration resource. nullable: true properties: data: - $ref: '#/components/schemas/ZoomConfigurationReferenceData' + $ref: "#/components/schemas/ZoomConfigurationReferenceData" required: - - data + - data type: object ZoomConfigurationReferenceData: description: The Zoom configuration relationship data object. @@ -72948,15 +69465,15 @@ components: properties: id: description: The unique identifier of the Zoom configuration. - example: 00000000-0000-0000-0000-000000000000 + example: "00000000-0000-0000-0000-000000000000" type: string type: description: The type of the Zoom configuration. - example: zoom_configurations + example: "zoom_configurations" type: string required: - - id - - type + - id + - type type: object securitySchemes: AuthZ: @@ -72969,71 +69486,52 @@ components: apm_api_catalog_write: Add, modify, and delete API catalog definitions. apm_read: Read and query APM and Trace Analytics. apm_service_catalog_read: View service catalog and service definitions. - apm_service_catalog_write: Add, modify, and delete service catalog definitions - when those definitions are maintained by Datadog. - appsec_vm_read: View infrastructure, application code, and library vulnerability - findings. + apm_service_catalog_write: Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog. + appsec_vm_read: View infrastructure, application code, and library vulnerability findings. billing_read: View your organization's billing information. cases_read: View Cases. cases_write: Create and update cases. - ci_visibility_pipelines_write: Create CI Visibility pipeline spans using - the API. + ci_visibility_pipelines_write: Create CI Visibility pipeline spans using the API. ci_visibility_read: View CI Visibility. - cloud_cost_management_read: View Cloud Cost pages and the cloud cost data - source in dashboards and notebooks. For more details, see the Cloud - Cost Management docs. - cloud_cost_management_write: Configure cloud cost accounts and global - customizations. For more details, see the Cloud Cost Management docs. + cloud_cost_management_read: View Cloud Cost pages and the cloud cost data source in dashboards and notebooks. For more details, see the Cloud Cost Management docs. + cloud_cost_management_write: Configure cloud cost accounts and global customizations. For more details, see the Cloud Cost Management docs. code_analysis_read: View Code Analysis. code_coverage_read: View Code Coverage. - continuous_profiler_pgo_read: Read and query Continuous Profiler data - for Profile-Guided Optimization (PGO). + continuous_profiler_pgo_read: Read and query Continuous Profiler data for Profile-Guided Optimization (PGO). coterm_read: Read terminal recordings. coterm_write: Write terminal recordings. create_webhooks: Create webhooks integrations. - dashboards_embed_share: Create, modify, and delete shared dashboards with - share type 'embed'. - dashboards_invite_share: Create, modify, and delete shared dashboards - with share type 'invite'. - dashboards_public_share: Generate public and authenticated links to share - dashboards or embeddable graphs externally. + dashboards_embed_share: Create, modify, and delete shared dashboards with share type 'embed'. + dashboards_invite_share: Create, modify, and delete shared dashboards with share type 'invite'. + dashboards_public_share: Generate public and authenticated links to share dashboards or embeddable graphs externally. dashboards_read: View dashboards. dashboards_write: Create and change dashboards. data_scanner_read: View Data Scanner configurations. data_scanner_write: Edit Data Scanner configurations. - embeddable_graphs_share: Generate public links to share embeddable graphs - externally. + embeddable_graphs_share: Generate public links to share embeddable graphs externally. error_tracking_read: Read Error Tracking data. error_tracking_write: Edit Error Tracking issues. events_read: Read Events data. hosts_read: List hosts and their attributes. incident_notification_settings_read: View Incident Notification Rule Settings. - incident_notification_settings_write: Configure Incidents Notification - Rule settings. + incident_notification_settings_write: Configure Incidents Notification Rule settings. incident_read: View incidents in Datadog. incident_settings_read: View Incident Settings. incident_settings_write: Configure Incident Settings. incident_write: Create, view, and manage incidents in Datadog. metrics_read: View custom metrics. - monitors_downtime: Set downtimes to suppress alerts from any monitor in - an organization. Mute and unmute monitors. The ability to write monitors - is not required to set downtimes. + monitors_downtime: Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes. monitors_read: View monitors. monitors_write: Edit, delete, and resolve individual monitors. org_connections_read: Read cross organization connections. org_connections_write: Create, edit, and delete cross organization connections. - org_management: Edit org configurations, including authentication and - certain security preferences such as configuring SAML, renaming an org, - configuring allowed login methods, creating child orgs, subscribing - & unsubscribing from apps in the marketplace, and enabling & disabling - Remote Configuration for the entire organization. + org_management: Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization. security_comments_read: Read comments of vulnerabilities. security_monitoring_critical_assets_read: Read Critical Assets. security_monitoring_critical_assets_write: Write Critical Assets. security_monitoring_filters_read: Read Security Filters. security_monitoring_filters_write: Create, edit, and delete Security Filters. - security_monitoring_findings_read: View a list of findings that include - both misconfigurations and identity risks. + security_monitoring_findings_read: View a list of findings that include both misconfigurations and identity risks. security_monitoring_rules_read: Read Detection Rules. security_monitoring_rules_write: Create and edit Detection Rules. security_monitoring_signals_read: View Security Signals. @@ -73041,34 +69539,23 @@ components: security_monitoring_suppressions_write: Write Rule Suppressions. security_pipelines_read: View Security Pipelines. security_pipelines_write: Create, edit, and delete CSM Security Pipelines. - slos_corrections: Apply, edit, and delete SLO status corrections. A user - with this permission can make status corrections, even if they do not - have permission to edit those SLOs. + slos_corrections: Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs. slos_read: View SLOs and status corrections. slos_write: Create, edit, and delete SLOs. - synthetics_global_variable_read: View, search, and use Synthetics global - variables. - synthetics_global_variable_write: Create, edit, and delete global variables - for Synthetics. - synthetics_private_location_read: View, search, and use Synthetics private - locations. - synthetics_private_location_write: Create and delete private locations - in addition to having access to the associated installation guidelines. + synthetics_global_variable_read: View, search, and use Synthetics global variables. + synthetics_global_variable_write: Create, edit, and delete global variables for Synthetics. + synthetics_private_location_read: View, search, and use Synthetics private locations. + synthetics_private_location_write: Create and delete private locations in addition to having access to the associated installation guidelines. synthetics_read: List and view configured Synthetic tests and test results. synthetics_write: Create, edit, and delete Synthetic tests. - teams_manage: Manage Teams. Create, delete, rename, and edit metadata - of all Teams. To control Team membership across all Teams, use the User - Access Manage permission. - teams_read: Read Teams data. A User with this permission can view Team - names, metadata, and which Users are on each Team. + teams_manage: Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission. + teams_read: Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team. test_optimization_read: View Test Optimization. - test_optimization_write: Update flaky tests from Flaky Tests Management - of Test Optimization. + test_optimization_write: Update flaky tests from Flaky Tests Management of Test Optimization. timeseries_query: Query Timeseries data. usage_read: View your organization's usage and usage attribution. user_access_invite: Invite other users to your organization. - user_access_manage: Disable users, manage user roles, manage SAML-to-role - mappings, and configure logs restriction queries. + user_access_manage: Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries. user_access_read: View users and their roles and settings. workflows_read: View workflows. workflows_run: Run workflows. @@ -73098,253 +69585,243 @@ info: url: https://www.datadoghq.com/support/ description: Collection of all Datadog Public endpoints. title: Datadog API V2 Collection - version: '1.0' + version: "1.0" openapi: 3.0.0 paths: /api/unstable/fleet/agent_versions: get: - description: 'Retrieve a list of all available Datadog Agent versions. - - - This endpoint returns the available Agent versions that can be deployed to - your fleet. - - These versions are used when creating deployments or configuring schedules - for + description: |- + Retrieve a list of all available Datadog Agent versions. - automated Agent upgrades.' + This endpoint returns the available Agent versions that can be deployed to your fleet. + These versions are used when creating deployments or configuring schedules for + automated Agent upgrades. operationId: ListFleetAgentVersions responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FleetAgentVersionsResponse' + $ref: "#/components/schemas/FleetAgentVersionsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: List all available Agent versions tags: - - Fleet Automation - x-permission: + - Fleet Automation + "x-permission": operator: AND permissions: - - hosts_read - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - hosts_read + x-unstable: |- + This endpoint is in Preview and may introduce breaking changes. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/unstable/fleet/agents: get: - description: 'Retrieve a paginated list of all Datadog Agents. - - This endpoint returns a paginated list of all Datadog Agents with support - for pagination, sorting, and filtering. - - Use the `page_number` and `page_size` query parameters to paginate through - results.' + description: |- + Retrieve a paginated list of all Datadog Agents. + This endpoint returns a paginated list of all Datadog Agents with support for pagination, sorting, and filtering. + Use the `page_number` and `page_size` query parameters to paginate through results. operationId: ListFleetAgents parameters: - - description: Page number for pagination (starts at 0). - in: query - name: page_number - required: false - schema: - default: 0 - format: int64 - minimum: 0 - type: integer - - description: Number of results per page (must be greater than 0 and less than - or equal to 100). - in: query - name: page_size - required: false - schema: - default: 10 - format: int64 - maximum: 100 - minimum: 1 - type: integer - - description: Attribute to sort by. - in: query - name: sort_attribute - required: false - schema: - type: string - - description: Sort order (true for descending, false for ascending). - in: query - name: sort_descending - required: false - schema: - type: boolean - - description: Comma-separated list of tags to filter agents. - in: query - name: tags - required: false - schema: - type: string - - description: Filter string for narrowing down agent results. - example: hostname:my-hostname OR env:dev - in: query - name: filter - required: false - schema: - type: string + - description: Page number for pagination (starts at 0). + in: query + name: page_number + required: false + schema: + default: 0 + format: int64 + minimum: 0 + type: integer + - description: Number of results per page (must be greater than 0 and less than or equal to 100). + in: query + name: page_size + required: false + schema: + default: 10 + format: int64 + maximum: 100 + minimum: 1 + type: integer + - description: Attribute to sort by. + in: query + name: sort_attribute + required: false + schema: + type: string + - description: Sort order (true for descending, false for ascending). + in: query + name: sort_descending + required: false + schema: + type: boolean + - description: Comma-separated list of tags to filter agents. + in: query + name: tags + required: false + schema: + type: string + - description: Filter string for narrowing down agent results. + example: "hostname:my-hostname OR env:dev" + in: query + name: filter + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FleetAgentsResponse' + $ref: "#/components/schemas/FleetAgentsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: List all Datadog Agents tags: - - Fleet Automation - x-permission: + - Fleet Automation + "x-permission": operator: AND permissions: - - hosts_read - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - hosts_read + x-unstable: |- + This endpoint is in Preview and may introduce breaking changes. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/unstable/fleet/agents/{agent_key}: get: - description: 'Retrieve detailed information about a specific Datadog Agent. - + description: |- + Retrieve detailed information about a specific Datadog Agent. This endpoint returns comprehensive information about an agent including: - - Agent details and metadata - - Configured integrations organized by status (working, warning, error, missing) - - Detected integrations - - - Configuration files and layers' + - Configuration files and layers operationId: GetFleetAgentInfo parameters: - - description: The unique identifier (agent key) for the Datadog Agent. - in: path - name: agent_key - required: true - schema: - type: string + - description: The unique identifier (agent key) for the Datadog Agent. + in: path + name: agent_key + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FleetAgentInfoResponse' + $ref: "#/components/schemas/FleetAgentInfoResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get detailed information about an agent tags: - - Fleet Automation - x-permission: + - Fleet Automation + "x-permission": operator: AND permissions: - - hosts_read - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - hosts_read + x-unstable: |- + This endpoint is in Preview and may introduce breaking changes. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/unstable/fleet/deployments: get: - description: 'Retrieve a list of all deployments for fleet automation. - - Use the `page_size` and `page_offset` parameters to paginate results.' + description: |- + Retrieve a list of all deployments for fleet automation. + Use the `page_size` and `page_offset` parameters to paginate results. operationId: ListFleetDeployments parameters: - - description: Number of deployments to return per page. Maximum value is 100. - in: query - name: page_size - required: false - schema: - default: 10 - format: int64 - maximum: 100 - type: integer - - description: Index of the first deployment to return. Use this with `page_size` - to paginate through results. - in: query - name: page_offset - required: false - schema: - default: 0 - format: int64 - type: integer + - description: Number of deployments to return per page. Maximum value is 100. + in: query + name: page_size + required: false + schema: + default: 10 + format: int64 + maximum: 100 + type: integer + - description: Index of the first deployment to return. Use this with `page_size` to paginate through results. + in: query + name: page_offset + required: false + schema: + default: 0 + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FleetDeploymentsResponse' + $ref: "#/components/schemas/FleetDeploymentsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: List all deployments tags: - - Fleet Automation - x-permission: + - Fleet Automation + "x-permission": operator: AND permissions: - - hosts_read - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - hosts_read + x-unstable: |- + This endpoint is in Preview and may introduce breaking changes. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/unstable/fleet/deployments/configure: post: - description: "Create a new deployment to apply configuration changes\nto a fleet - of hosts matching the specified filter query.\n\nThis endpoint supports two - types of configuration operations:\n- `merge-patch`: Merges the provided patch - data with the existing configuration file,\n creating the file if it doesn't - exist\n- `delete`: Removes the specified configuration file from the target - hosts\n\nThe deployment is created and started automatically. You can specify - multiple configuration\noperations that will be executed in order on each - target host. Use the filter query to target\nspecific hosts using the Datadog - query syntax." + description: |- + Create a new deployment to apply configuration changes + to a fleet of hosts matching the specified filter query. + + This endpoint supports two types of configuration operations: + - `merge-patch`: Merges the provided patch data with the existing configuration file, + creating the file if it doesn't exist + - `delete`: Removes the specified configuration file from the target hosts + + The deployment is created and started automatically. You can specify multiple configuration + operations that will be executed in order on each target host. Use the filter query to target + specific hosts using the Datadog query syntax. operationId: CreateFleetDeploymentConfigure requestBody: content: @@ -73356,23 +69833,23 @@ paths: data: attributes: config_operations: - - file_op: merge-patch - file_path: /conf.d/postgres.d/logs.yaml - patch: - logs: - - path: /var/log/postgres.log - service: postgres1 - source: postgres - type: file - - file_op: merge-patch - file_path: /conf.d/kafka.d/logs.yaml - patch: - logs: - - path: /var/log/kafka.log - service: kafka1 - source: kafka - type: file - filter_query: env:prod + - file_op: "merge-patch" + file_path: "/conf.d/postgres.d/logs.yaml" + patch: + logs: + - path: "/var/log/postgres.log" + service: "postgres1" + source: "postgres" + type: file + - file_op: "merge-patch" + file_path: "/conf.d/kafka.d/logs.yaml" + patch: + logs: + - path: "/var/log/kafka.log" + service: "kafka1" + source: "kafka" + type: file + filter_query: "env:prod" type: deployment comprehensive_configuration: summary: Comprehensive example with multiple configuration file types @@ -73380,70 +69857,70 @@ paths: data: attributes: config_operations: - - file_op: merge-patch - file_path: /datadog.yaml - patch: - apm_config: - apm_dd_url: https://trace.agent.datadoghq.com + - file_op: "merge-patch" + file_path: "/datadog.yaml" + patch: + apm_config: + apm_dd_url: "https://trace.agent.datadoghq.com" + enabled: true + log_level: "info" + logs_enabled: true + process_config: + enabled: true + - file_op: "merge-patch" + file_path: "/security-agent.yaml" + patch: + runtime_security_config: + enabled: true + fim_enabled: true + - file_op: "merge-patch" + file_path: "/system-probe.yaml" + patch: + network_config: + enabled: true + service_monitoring_config: + enabled: true + - file_op: "merge-patch" + file_path: "/application_monitoring.yaml" + patch: enabled: true - log_level: info - logs_enabled: true - process_config: - enabled: true - - file_op: merge-patch - file_path: /security-agent.yaml - patch: - runtime_security_config: - enabled: true - fim_enabled: true - - file_op: merge-patch - file_path: /system-probe.yaml - patch: - network_config: - enabled: true - service_monitoring_config: - enabled: true - - file_op: merge-patch - file_path: /application_monitoring.yaml - patch: - enabled: true - server: - host: 0.0.0.0 - port: 8126 - - file_op: merge-patch - file_path: /conf.d/logs.d/custom-app.yaml - patch: - logs: - - path: /var/log/custom-app/*.log - service: custom-app - source: custom - type: file - - file_op: merge-patch - file_path: /conf.d/docker.d/docker-logs.yaml - patch: - logs: - - service: docker - source: docker - type: docker - - file_op: merge-patch - file_path: /conf.d/snmp.d/network-devices.yaml - patch: - init_config: - loader: core - instances: - - community_string: public - ip_address: 192.168.1.1 - - file_op: merge-patch - file_path: /conf.d/postgres.d/conf.yaml - patch: - instances: - - dbname: postgres - host: localhost - port: 5432 - username: datadog - - file_op: delete - file_path: /conf.d/deprecated-integration.yaml - filter_query: env:prod AND datacenter:us-east-1 + server: + host: "0.0.0.0" + port: 8126 + - file_op: "merge-patch" + file_path: "/conf.d/logs.d/custom-app.yaml" + patch: + logs: + - path: "/var/log/custom-app/*.log" + service: "custom-app" + source: "custom" + type: file + - file_op: "merge-patch" + file_path: "/conf.d/docker.d/docker-logs.yaml" + patch: + logs: + - service: "docker" + source: "docker" + type: docker + - file_op: "merge-patch" + file_path: "/conf.d/snmp.d/network-devices.yaml" + patch: + init_config: + loader: core + instances: + - community_string: "public" + ip_address: "192.168.1.1" + - file_op: "merge-patch" + file_path: "/conf.d/postgres.d/conf.yaml" + patch: + instances: + - dbname: "postgres" + host: "localhost" + port: 5432 + username: "datadog" + - file_op: "delete" + file_path: "/conf.d/deprecated-integration.yaml" + filter_query: "env:prod AND datacenter:us-east-1" type: deployment delete_config_file: summary: Delete a configuration file @@ -73451,9 +69928,9 @@ paths: data: attributes: config_operations: - - file_op: delete - file_path: /conf.d/old-integration.yaml - filter_query: env:dev + - file_op: "delete" + file_path: "/conf.d/old-integration.yaml" + filter_query: "env:dev" type: deployment enable_apm_and_logs: summary: Enable APM and Logs products @@ -73461,14 +69938,14 @@ paths: data: attributes: config_operations: - - file_op: merge-patch - file_path: /datadog.yaml - patch: - apm_config: - enabled: true - log_level: debug - logs_enabled: true - filter_query: env:prod AND service:web + - file_op: "merge-patch" + file_path: "/datadog.yaml" + patch: + apm_config: + enabled: true + log_level: "debug" + logs_enabled: true + filter_query: "env:prod AND service:web" type: deployment simple_log_level: summary: Set log level to info @@ -73476,64 +69953,58 @@ paths: data: attributes: config_operations: - - file_op: merge-patch - file_path: /datadog.yaml - patch: - log_level: info - filter_query: env:staging + - file_op: "merge-patch" + file_path: "/datadog.yaml" + patch: + log_level: "info" + filter_query: "env:staging" type: deployment schema: - $ref: '#/components/schemas/FleetDeploymentConfigureCreateRequest' + $ref: "#/components/schemas/FleetDeploymentConfigureCreateRequest" description: Request payload containing the deployment details. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/FleetDeploymentResponse' + $ref: "#/components/schemas/FleetDeploymentResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] summary: Create a configuration deployment tags: - - Fleet Automation - x-permission: + - Fleet Automation + "x-permission": operator: AND permissions: - - agent_upgrade_write - - fleet_policies_write - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - agent_upgrade_write + - fleet_policies_write + x-unstable: |- + This endpoint is in Preview and may introduce breaking changes. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/unstable/fleet/deployments/upgrade: post: - description: 'Create and immediately start a new package upgrade - + description: |- + Create and immediately start a new package upgrade on hosts matching the specified filter query. - This endpoint allows you to upgrade the Datadog Agent to a specific version - on hosts matching the specified filter query. - The deployment is created and started automatically. The system will: - 1. Identify all hosts matching the filter query - 2. Validate that the specified version is available - - 3. Begin rolling out the package upgrade to the target hosts' + 3. Begin rolling out the package upgrade to the target hosts operationId: CreateFleetDeploymentUpgrade requestBody: content: @@ -73544,250 +70015,233 @@ paths: value: data: attributes: - filter_query: env:prod AND service:web + filter_query: "env:prod AND service:web" target_packages: - - name: datadog-agent - version: 7.52.0 + - name: "datadog-agent" + version: "7.52.0" type: deployment upgrade_multiple_packages: summary: Upgrade multiple packages value: data: attributes: - filter_query: env:staging + filter_query: "env:staging" target_packages: - - name: datadog-agent - version: 7.52.0-1 - - name: datadog-apm-inject - version: 0.10.0 + - name: "datadog-agent" + version: "7.52.0-1" + - name: "datadog-apm-inject" + version: "0.10.0" type: deployment schema: - $ref: '#/components/schemas/FleetDeploymentPackageUpgradeCreateRequest' + $ref: "#/components/schemas/FleetDeploymentPackageUpgradeCreateRequest" description: Request payload containing the package upgrade details. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/FleetDeploymentResponse' + $ref: "#/components/schemas/FleetDeploymentResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] summary: Upgrade hosts tags: - - Fleet Automation - x-permission: + - Fleet Automation + "x-permission": operator: AND permissions: - - agent_upgrade_write - - fleet_policies_write - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - agent_upgrade_write + - fleet_policies_write + x-unstable: |- + This endpoint is in Preview and may introduce breaking changes. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/unstable/fleet/deployments/{deployment_id}: get: - description: "Retrieve detailed information about a specific deployment using - its unique identifier.\nThis endpoint returns comprehensive information about - a deployment, including:\n- Deployment metadata (ID, type, filter query)\n- - Total number of target hosts\n- Current high-level status (pending, running, - succeeded, failed)\n- Estimated completion time\n- Configuration operations - that were or are being applied\n- Detailed host list: A paginated array of - hosts included in this deployment with individual\n host status, current - package versions, and any errors\n\nThe host list provides visibility into - the per-host execution status, allowing you to:\n- Monitor which hosts have - completed successfully\n- Identify hosts that are still in progress\n- Investigate - failures on specific hosts\n- View current package versions installed on each - host (including initial, target, and current\n versions for each package)\n\nPagination: - Use the `limit` and `page` query parameters to paginate through hosts. The - response\nincludes pagination metadata in the `meta.hosts` field with information - about the current page,\ntotal pages, and total host count. The default page - size is 50 hosts, with a maximum of 100." + description: |- + Retrieve detailed information about a specific deployment using its unique identifier. + This endpoint returns comprehensive information about a deployment, including: + - Deployment metadata (ID, type, filter query) + - Total number of target hosts + - Current high-level status (pending, running, succeeded, failed) + - Estimated completion time + - Configuration operations that were or are being applied + - Detailed host list: A paginated array of hosts included in this deployment with individual + host status, current package versions, and any errors + + The host list provides visibility into the per-host execution status, allowing you to: + - Monitor which hosts have completed successfully + - Identify hosts that are still in progress + - Investigate failures on specific hosts + - View current package versions installed on each host (including initial, target, and current + versions for each package) + + Pagination: Use the `limit` and `page` query parameters to paginate through hosts. The response + includes pagination metadata in the `meta.hosts` field with information about the current page, + total pages, and total host count. The default page size is 50 hosts, with a maximum of 100. operationId: GetFleetDeployment parameters: - - description: The unique identifier of the deployment to retrieve. - example: abc-def-ghi - in: path - name: deployment_id - required: true - schema: - type: string - - description: Maximum number of hosts to return per page. Default is 50, maximum - is 100. - in: query - name: limit - required: false - schema: - default: 50 - format: int64 - maximum: 100 - type: integer - - description: Page index for pagination (zero-based). Use this to retrieve - subsequent pages of hosts. - in: query - name: page - required: false - schema: - default: 0 - format: int64 - type: integer + - description: The unique identifier of the deployment to retrieve. + example: "abc-def-ghi" + in: path + name: deployment_id + required: true + schema: + type: string + - description: Maximum number of hosts to return per page. Default is 50, maximum is 100. + in: query + name: limit + required: false + schema: + default: 50 + format: int64 + maximum: 100 + type: integer + - description: Page index for pagination (zero-based). Use this to retrieve subsequent pages of hosts. + in: query + name: page + required: false + schema: + default: 0 + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FleetDeploymentResponse' + $ref: "#/components/schemas/FleetDeploymentResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get a configuration deployment by ID tags: - - Fleet Automation - x-permission: + - Fleet Automation + "x-permission": operator: AND permissions: - - hosts_read - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - hosts_read + x-unstable: |- + This endpoint is in Preview and may introduce breaking changes. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/unstable/fleet/deployments/{deployment_id}/cancel: post: - description: 'Cancel an active deployment and stop all pending operations. - + description: |- + Cancel an active deployment and stop all pending operations. When you cancel a deployment: + - All pending operations on hosts that haven't started yet are stopped + - Operations currently in progress on hosts may complete or be interrupted, depending on their current state + - Configuration changes or package upgrades already applied to hosts are not rolled back - - All pending operations on hosts that haven''t started yet are stopped - - - Operations currently in progress on hosts may complete or be interrupted, - depending on their current state - - - Configuration changes or package upgrades already applied to hosts are not - rolled back - - - After cancellation, you can view the final state of the deployment using the - GET endpoint to see which hosts - - were successfully updated before the cancellation.' + After cancellation, you can view the final state of the deployment using the GET endpoint to see which hosts + were successfully updated before the cancellation. operationId: CancelFleetDeployment parameters: - - description: The unique identifier of the deployment to cancel. - example: abc-def-ghi - in: path - name: deployment_id - required: true - schema: - type: string + - description: The unique identifier of the deployment to cancel. + example: "abc-def-ghi" + in: path + name: deployment_id + required: true + schema: + type: string responses: - '204': + "204": description: Deployment successfully canceled. - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] summary: Cancel a deployment tags: - - Fleet Automation - x-permission: + - Fleet Automation + "x-permission": operator: AND permissions: - - agent_upgrade_write - - fleet_policies_write - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - agent_upgrade_write + - fleet_policies_write + x-unstable: |- + This endpoint is in Preview and may introduce breaking changes. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/unstable/fleet/schedules: get: - description: 'Retrieve a list of all schedules for automated fleet deployments. - + description: |- + Retrieve a list of all schedules for automated fleet deployments. Schedules allow you to automate package upgrades by defining maintenance windows - - and recurrence rules. Each schedule automatically creates deployments based - on its - - configuration.' + and recurrence rules. Each schedule automatically creates deployments based on its + configuration. operationId: ListFleetSchedules responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FleetSchedulesResponse' + $ref: "#/components/schemas/FleetSchedulesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: List all schedules tags: - - Fleet Automation - x-permission: + - Fleet Automation + "x-permission": operator: AND permissions: - - hosts_read - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - hosts_read + x-unstable: |- + This endpoint is in Preview and may introduce breaking changes. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: - description: 'Create a new schedule for automated package upgrades. - - - Schedules define when and how often to automatically deploy package upgrades - to a fleet + description: |- + Create a new schedule for automated package upgrades. + Schedules define when and how often to automatically deploy package upgrades to a fleet of hosts. Each schedule includes: - - A filter query to select target hosts - - A recurrence rule defining maintenance windows - - A version strategy (e.g., always latest, or N versions behind latest) - - When the schedule triggers during a maintenance window, it automatically creates - a - - deployment that upgrades the Datadog Agent to the specified version on all - matching hosts.' + When the schedule triggers during a maintenance window, it automatically creates a + deployment that upgrades the Datadog Agent to the specified version on all matching hosts. operationId: CreateFleetSchedule requestBody: content: @@ -73798,15 +70252,14 @@ paths: value: data: attributes: - name: Staging Environment - Conservative Updates - query: env:staging + name: "Staging Environment - Conservative Updates" + query: "env:staging" rule: - days_of_week: - - Fri + days_of_week: ["Fri"] maintenance_window_duration: 240 - start_maintenance_window: '22:00' - timezone: UTC - status: active + start_maintenance_window: "22:00" + timezone: "UTC" + status: "active" version_to_latest: 1 type: schedule weekly_production_update: @@ -73814,187 +70267,166 @@ paths: value: data: attributes: - name: Weekly Production Agent Updates - query: env:prod + name: "Weekly Production Agent Updates" + query: "env:prod" rule: - days_of_week: - - Mon - - Wed + days_of_week: ["Mon", "Wed"] maintenance_window_duration: 180 - start_maintenance_window: 02:00 - timezone: America/New_York - status: active + start_maintenance_window: "02:00" + timezone: "America/New_York" + status: "active" version_to_latest: 0 type: schedule schema: - $ref: '#/components/schemas/FleetScheduleCreateRequest' + $ref: "#/components/schemas/FleetScheduleCreateRequest" description: Request payload containing the schedule details. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/FleetScheduleResponse' + $ref: "#/components/schemas/FleetScheduleResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] summary: Create a schedule tags: - - Fleet Automation - x-permission: + - Fleet Automation + "x-permission": operator: AND permissions: - - agent_upgrade_write - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - agent_upgrade_write + x-unstable: |- + This endpoint is in Preview and may introduce breaking changes. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/unstable/fleet/schedules/{id}: delete: - description: 'Delete a schedule permanently. - + description: |- + Delete a schedule permanently. When you delete a schedule: - - The schedule is permanently removed and will no longer create deployments - - Any deployments already created by this schedule are not affected - - This action cannot be undone - If you want to temporarily stop a schedule from creating deployments, consider - - updating its status to "inactive" instead of deleting it.' + updating its status to "inactive" instead of deleting it. operationId: DeleteFleetSchedule parameters: - - description: The unique identifier of the schedule to delete. - example: abc-def-ghi-123 - in: path - name: id - required: true - schema: - type: string + - description: The unique identifier of the schedule to delete. + example: "abc-def-ghi-123" + in: path + name: id + required: true + schema: + type: string responses: - '204': + "204": description: Schedule successfully deleted. - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] summary: Delete a schedule tags: - - Fleet Automation - x-permission: + - Fleet Automation + "x-permission": operator: AND permissions: - - agent_upgrade_write - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - agent_upgrade_write + x-unstable: |- + This endpoint is in Preview and may introduce breaking changes. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: - description: 'Retrieve detailed information about a specific schedule using - its unique identifier. - + description: |- + Retrieve detailed information about a specific schedule using its unique identifier. This endpoint returns comprehensive information about a schedule, including: - - Schedule metadata (ID, name, creation/update timestamps) - - Filter query for selecting target hosts - - Recurrence rule defining when deployments are triggered - - Version strategy for package upgrades - - - Current status (active or inactive)' + - Current status (active or inactive) operationId: GetFleetSchedule parameters: - - description: The unique identifier of the schedule to retrieve. - example: abc-def-ghi-123 - in: path - name: id - required: true - schema: - type: string + - description: The unique identifier of the schedule to retrieve. + example: "abc-def-ghi-123" + in: path + name: id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FleetScheduleResponse' + $ref: "#/components/schemas/FleetScheduleResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get a schedule by ID tags: - - Fleet Automation - x-permission: + - Fleet Automation + "x-permission": operator: AND permissions: - - hosts_read - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - hosts_read + x-unstable: |- + This endpoint is in Preview and may introduce breaking changes. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: - description: 'Partially update a schedule by providing only the fields you want - to change. - + description: |- + Partially update a schedule by providing only the fields you want to change. This endpoint allows you to modify specific attributes of a schedule without - affecting other fields. Common use cases include: - - Changing the schedule status between active and inactive - - Updating the maintenance window times - - Modifying the filter query to target different hosts - - Adjusting the version strategy - Only include the fields you want to update in the request body. All fields - - are optional in a PATCH request.' + are optional in a PATCH request. operationId: UpdateFleetSchedule parameters: - - description: The unique identifier of the schedule to update. - example: abc-def-ghi-123 - in: path - name: id - required: true - schema: - type: string + - description: The unique identifier of the schedule to update. + example: "abc-def-ghi-123" + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -74005,154 +70437,137 @@ paths: data: attributes: rule: - days_of_week: - - Mon - - Wed - - Fri + days_of_week: ["Mon", "Wed", "Fri"] maintenance_window_duration: 240 - start_maintenance_window: 03:00 - timezone: America/New_York + start_maintenance_window: "03:00" + timezone: "America/New_York" type: schedule pause_schedule: summary: Pause a schedule value: data: attributes: - status: inactive + status: "inactive" type: schedule update_query: summary: Update target hosts query value: data: attributes: - query: env:prod AND service:api + query: "env:prod AND service:api" type: schedule schema: - $ref: '#/components/schemas/FleetSchedulePatchRequest' + $ref: "#/components/schemas/FleetSchedulePatchRequest" description: Request payload containing the fields to update. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FleetScheduleResponse' + $ref: "#/components/schemas/FleetScheduleResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Update a schedule tags: - - Fleet Automation - x-permission: + - Fleet Automation + "x-permission": operator: AND permissions: - - agent_upgrade_write - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - agent_upgrade_write + x-unstable: |- + This endpoint is in Preview and may introduce breaking changes. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/unstable/fleet/schedules/{id}/trigger: post: - description: 'Manually trigger a schedule to immediately create and start a - deployment. - - - This endpoint allows you to manually initiate a deployment using the schedule''s - - configuration, without waiting for the next scheduled maintenance window. - This is + description: |- + Manually trigger a schedule to immediately create and start a deployment. + This endpoint allows you to manually initiate a deployment using the schedule's + configuration, without waiting for the next scheduled maintenance window. This is useful for: - - Testing a schedule before it runs automatically - - Performing an emergency update outside the regular maintenance window - - Creating an ad-hoc deployment with the same settings as a schedule - The deployment is created immediately with: - - The same filter query as the schedule - - - The package version determined by the schedule''s version strategy - + - The package version determined by the schedule's version strategy - All matching hosts as targets - - The manually triggered deployment is independent of the schedule and does - not - - affect the schedule''s normal recurrence pattern.' + The manually triggered deployment is independent of the schedule and does not + affect the schedule's normal recurrence pattern. operationId: TriggerFleetSchedule parameters: - - description: The unique identifier of the schedule to trigger. - example: abc-def-ghi-123 - in: path - name: id - required: true - schema: - type: string + - description: The unique identifier of the schedule to trigger. + example: "abc-def-ghi-123" + in: path + name: id + required: true + schema: + type: string responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/FleetDeploymentResponse' + $ref: "#/components/schemas/FleetDeploymentResponse" description: CREATED - Deployment successfully created and started. - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] summary: Trigger a schedule deployment tags: - - Fleet Automation - x-permission: + - Fleet Automation + "x-permission": operator: AND permissions: - - agent_upgrade_write - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - agent_upgrade_write + x-unstable: |- + This endpoint is in Preview and may introduce breaking changes. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/actions-datastores: get: description: Lists all datastores for the organization. operationId: ListDatastores responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DatastoreArray' + $ref: "#/components/schemas/DatastoreArray" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List datastores tags: - - Actions Datastores + - Actions Datastores x-permission: operator: OR permissions: - - apps_datastore_read + - apps_datastore_read post: description: Creates a new datastore. operationId: CreateDatastore @@ -74160,762 +70575,750 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateAppsDatastoreRequest' + $ref: "#/components/schemas/CreateAppsDatastoreRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CreateAppsDatastoreResponse' + $ref: "#/components/schemas/CreateAppsDatastoreResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create datastore tags: - - Actions Datastores + - Actions Datastores x-permission: operator: OR permissions: - - apps_datastore_manage - /api/v2/actions-datastores/{datastore_id}: + - apps_datastore_manage + "/api/v2/actions-datastores/{datastore_id}": delete: description: Deletes a datastore by its unique identifier. operationId: DeleteDatastore parameters: - - description: The unique identifier of the datastore to retrieve. - in: path - name: datastore_id - required: true - schema: - type: string + - description: The unique identifier of the datastore to retrieve. + in: path + name: datastore_id + required: true + schema: + type: string responses: - '200': + "200": description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete datastore tags: - - Actions Datastores + - Actions Datastores x-permission: operator: OR permissions: - - apps_datastore_manage + - apps_datastore_manage get: description: Retrieves a specific datastore by its ID. operationId: GetDatastore parameters: - - description: The unique identifier of the datastore to retrieve. - in: path - name: datastore_id - required: true - schema: - type: string + - description: The unique identifier of the datastore to retrieve. + in: path + name: datastore_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Datastore' + $ref: "#/components/schemas/Datastore" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get datastore tags: - - Actions Datastores + - Actions Datastores x-permission: operator: OR permissions: - - apps_datastore_read + - apps_datastore_read patch: description: Updates an existing datastore's attributes. operationId: UpdateDatastore parameters: - - description: The unique identifier of the datastore to retrieve. - in: path - name: datastore_id - required: true - schema: - type: string + - description: The unique identifier of the datastore to retrieve. + in: path + name: datastore_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateAppsDatastoreRequest' + $ref: "#/components/schemas/UpdateAppsDatastoreRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Datastore' + $ref: "#/components/schemas/Datastore" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update datastore tags: - - Actions Datastores + - Actions Datastores x-permission: operator: OR permissions: - - apps_datastore_manage - /api/v2/actions-datastores/{datastore_id}/items: + - apps_datastore_manage + "/api/v2/actions-datastores/{datastore_id}/items": delete: description: Deletes an item from a datastore by its key. operationId: DeleteDatastoreItem parameters: - - description: The unique identifier of the datastore to retrieve. - in: path - name: datastore_id - required: true - schema: - type: string + - description: The unique identifier of the datastore to retrieve. + in: path + name: datastore_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteAppsDatastoreItemRequest' + $ref: "#/components/schemas/DeleteAppsDatastoreItemRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteAppsDatastoreItemResponse' + $ref: "#/components/schemas/DeleteAppsDatastoreItemResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete datastore item tags: - - Actions Datastores + - Actions Datastores x-permission: operator: OR permissions: - - apps_datastore_write + - apps_datastore_write get: - description: Lists items from a datastore. You can filter the results by specifying - either an item key or a filter query parameter, but not both at the same time. - Supports server-side pagination for large datasets. + description: >- + Lists items from a datastore. You can filter the results by specifying either an item key or a filter query parameter, but not both at the same time. Supports server-side pagination for large datasets. operationId: ListDatastoreItems parameters: - - description: The unique identifier of the datastore to retrieve. - in: path - name: datastore_id - required: true - schema: - type: string - - description: Optional query filter to search items using the [logs search - syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/). - in: query - name: filter - schema: - type: string - - description: Optional primary key value to retrieve a specific item. Cannot - be used together with the filter parameter. - in: query - name: item_key - schema: - maxLength: 256 - type: string - - description: Optional field to limit the number of items to return per page - for pagination. Up to 100 items can be returned per page. - in: query - name: page[limit] - schema: - format: int64 - maximum: 100 - minimum: 1 - type: integer - - description: Optional field to offset the number of items to skip from the - beginning of the result set for pagination. - in: query - name: page[offset] - schema: - format: int64 - type: integer - - description: Optional field to sort results by. Prefix with '-' for descending - order (e.g., '-created_at'). - in: query - name: sort - schema: - type: string + - description: The unique identifier of the datastore to retrieve. + in: path + name: datastore_id + required: true + schema: + type: string + - description: Optional query filter to search items using the [logs search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/). + in: query + name: filter + schema: + type: string + - description: Optional primary key value to retrieve a specific item. Cannot be used together with the filter parameter. + in: query + name: item_key + schema: + maxLength: 256 + type: string + - description: Optional field to limit the number of items to return per page for pagination. Up to 100 items can be returned per page. + in: query + name: "page[limit]" + schema: + format: int64 + maximum: 100 + minimum: 1 + type: integer + - description: Optional field to offset the number of items to skip from the beginning of the result set for pagination. + in: query + name: "page[offset]" + schema: + format: int64 + type: integer + - description: Optional field to sort results by. Prefix with '-' for descending order (e.g., '-created_at'). + in: query + name: sort + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ItemApiPayloadArray' + $ref: "#/components/schemas/ItemApiPayloadArray" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List datastore items tags: - - Actions Datastores + - Actions Datastores x-permission: operator: OR permissions: - - apps_datastore_read + - apps_datastore_read patch: description: Partially updates an item in a datastore by its key. operationId: UpdateDatastoreItem parameters: - - description: The unique identifier of the datastore to retrieve. - in: path - name: datastore_id - required: true - schema: - type: string + - description: The unique identifier of the datastore to retrieve. + in: path + name: datastore_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateAppsDatastoreItemRequest' + $ref: "#/components/schemas/UpdateAppsDatastoreItemRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ItemApiPayload' + $ref: "#/components/schemas/ItemApiPayload" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update datastore item tags: - - Actions Datastores + - Actions Datastores x-permission: operator: OR permissions: - - apps_datastore_write - /api/v2/actions-datastores/{datastore_id}/items/bulk: + - apps_datastore_write + "/api/v2/actions-datastores/{datastore_id}/items/bulk": delete: - description: Deletes multiple items from a datastore by their keys in a single - operation. + description: >- + Deletes multiple items from a datastore by their keys in a single operation. operationId: BulkDeleteDatastoreItems parameters: - - description: The ID of the datastore. - in: path - name: datastore_id - required: true - schema: - type: string + - description: The ID of the datastore. + in: path + name: datastore_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/BulkDeleteAppsDatastoreItemsRequest' + $ref: "#/components/schemas/BulkDeleteAppsDatastoreItemsRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteAppsDatastoreItemResponseArray' + $ref: "#/components/schemas/DeleteAppsDatastoreItemResponseArray" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Internal Server Error summary: Bulk delete datastore items tags: - - Actions Datastores + - Actions Datastores x-permission: operator: OR permissions: - - apps_datastore_write + - apps_datastore_write post: - description: Creates or replaces multiple items in a datastore by their keys - in a single operation. + description: >- + Creates or replaces multiple items in a datastore by their keys in a single operation. operationId: BulkWriteDatastoreItems parameters: - - description: The unique identifier of the datastore to retrieve. - in: path - name: datastore_id - required: true - schema: - type: string + - description: The unique identifier of the datastore to retrieve. + in: path + name: datastore_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/BulkPutAppsDatastoreItemsRequest' + $ref: "#/components/schemas/BulkPutAppsDatastoreItemsRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PutAppsDatastoreItemResponseArray' + $ref: "#/components/schemas/PutAppsDatastoreItemResponseArray" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Bulk write datastore items tags: - - Actions Datastores + - Actions Datastores x-permission: operator: OR permissions: - - apps_datastore_write + - apps_datastore_write /api/v2/actions/app_key_registrations: get: description: List App Key Registrations operationId: ListAppKeyRegistrations parameters: - - description: The number of App Key Registrations to return per page. - in: query - name: page[size] - required: false - schema: - format: int64 - type: integer - - description: The page number to return. - in: query - name: page[number] - required: false - schema: - format: int64 - type: integer + - description: The number of App Key Registrations to return per page. + in: query + name: page[size] + required: false + schema: + format: int64 + type: integer + - description: The page number to return. + in: query + name: page[number] + required: false + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListAppKeyRegistrationsResponse' + $ref: "#/components/schemas/ListAppKeyRegistrationsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Too many requests summary: List App Key Registrations tags: - - Action Connection + - Action Connection x-permission: operator: OR permissions: - - org_app_keys_read + - org_app_keys_read /api/v2/actions/app_key_registrations/{app_key_id}: delete: description: Unregister an App Key operationId: UnregisterAppKey parameters: - - $ref: '#/components/parameters/ApplicationKeyId' + - $ref: "#/components/parameters/ApplicationKeyId" responses: - '204': + "204": description: No Content - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Too many requests summary: Unregister an App Key tags: - - Action Connection + - Action Connection x-permission: operator: OR permissions: - - user_access_manage - - user_app_keys - - service_account_write + - user_access_manage + - user_app_keys + - service_account_write get: description: Get an existing App Key Registration operationId: GetAppKeyRegistration parameters: - - $ref: '#/components/parameters/ApplicationKeyId' + - $ref: "#/components/parameters/ApplicationKeyId" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GetAppKeyRegistrationResponse' + $ref: "#/components/schemas/GetAppKeyRegistrationResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Too many requests summary: Get an existing App Key Registration tags: - - Action Connection + - Action Connection x-permission: operator: OR permissions: - - org_app_keys_read + - org_app_keys_read put: description: Register a new App Key operationId: RegisterAppKey parameters: - - $ref: '#/components/parameters/ApplicationKeyId' + - $ref: "#/components/parameters/ApplicationKeyId" responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/RegisterAppKeyResponse' + $ref: "#/components/schemas/RegisterAppKeyResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Too many requests summary: Register a new App Key tags: - - Action Connection + - Action Connection x-permission: operator: OR permissions: - - user_access_manage - - user_app_keys - - service_account_write + - user_access_manage + - user_app_keys + - service_account_write /api/v2/actions/connections: post: - description: Create a new Action Connection. This API requires a [registered - application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). + description: Create a new Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). operationId: CreateActionConnection requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateActionConnectionRequest' + $ref: "#/components/schemas/CreateActionConnectionRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/CreateActionConnectionResponse' + $ref: "#/components/schemas/CreateActionConnectionResponse" description: Successfully created Action Connection - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Too Many Request summary: Create a new Action Connection tags: - - Action Connection + - Action Connection /api/v2/actions/connections/{connection_id}: delete: - description: Delete an existing Action Connection. This API requires a [registered - application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: Delete an existing Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: DeleteActionConnection parameters: - - $ref: '#/components/parameters/ConnectionId' + - $ref: "#/components/parameters/ConnectionId" responses: - '204': + "204": description: The resource was deleted successfully. - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Too Many Request summary: Delete an existing Action Connection tags: - - Action Connection + - Action Connection x-permission: operator: OR permissions: - - connection_write + - connection_write get: - description: Get an existing Action Connection. This API requires a [registered - application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). + description: Get an existing Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). operationId: GetActionConnection parameters: - - $ref: '#/components/parameters/ConnectionId' + - $ref: "#/components/parameters/ConnectionId" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GetActionConnectionResponse' + $ref: "#/components/schemas/GetActionConnectionResponse" description: Successfully get Action Connection - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Too Many Request summary: Get an existing Action Connection tags: - - Action Connection + - Action Connection patch: - description: Update an existing Action Connection. This API requires a [registered - application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). + description: Update an existing Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). operationId: UpdateActionConnection parameters: - - $ref: '#/components/parameters/ConnectionId' + - $ref: "#/components/parameters/ConnectionId" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateActionConnectionRequest' + $ref: "#/components/schemas/UpdateActionConnectionRequest" description: Update an existing Action Connection request body required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateActionConnectionResponse' + $ref: "#/components/schemas/UpdateActionConnectionResponse" description: Successfully updated Action Connection - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Too Many Request summary: Update an existing Action Connection tags: - - Action Connection + - Action Connection /api/v2/agentless_scanning/accounts/aws: get: description: Fetches the scan options configured for AWS accounts. operationId: ListAwsScanOptions responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AwsScanOptionsListResponse' + $ref: "#/components/schemas/AwsScanOptionsListResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_findings_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read summary: List AWS scan options - tags: - - Agentless Scanning + tags: ["Agentless Scanning"] post: description: Activate Agentless scan options for an AWS account. operationId: CreateAwsScanOptions @@ -74923,139 +71326,135 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AwsScanOptionsCreateRequest' + $ref: "#/components/schemas/AwsScanOptionsCreateRequest" description: The definition of the new scan options. required: true responses: - '201': + "201": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/AwsScanOptionsResponse' + $ref: "#/components/schemas/AwsScanOptionsResponse" description: Agentless scan options enabled successfully. - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management summary: Create AWS scan options - tags: - - Agentless Scanning + tags: ["Agentless Scanning"] x-codegen-request-body-name: body /api/v2/agentless_scanning/accounts/aws/{account_id}: delete: description: Delete Agentless scan options for an AWS account. operationId: DeleteAwsScanOptions parameters: - - $ref: '#/components/parameters/AwsAccountId' + - $ref: "#/components/parameters/AwsAccountId" responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management summary: Delete AWS scan options - tags: - - Agentless Scanning + tags: ["Agentless Scanning"] get: description: Fetches the Agentless scan options for an activated account. operationId: GetAwsScanOptions parameters: - - $ref: '#/components/parameters/AwsAccountId' + - $ref: "#/components/parameters/AwsAccountId" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AwsScanOptionsResponse' + $ref: "#/components/schemas/AwsScanOptionsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_findings_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read summary: Get AWS scan options - tags: - - Agentless Scanning + tags: ["Agentless Scanning"] patch: description: Update the Agentless scan options for an activated account. operationId: UpdateAwsScanOptions parameters: - - $ref: '#/components/parameters/AwsAccountId' + - $ref: "#/components/parameters/AwsAccountId" requestBody: content: application/json: schema: - $ref: '#/components/schemas/AwsScanOptionsUpdateRequest' + $ref: "#/components/schemas/AwsScanOptionsUpdateRequest" description: New definition of the scan options. required: true responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management summary: Update AWS scan options - tags: - - Agentless Scanning + tags: ["Agentless Scanning"] x-codegen-request-body-name: body /api/v2/agentless_scanning/accounts/azure: get: description: Fetches the scan options configured for Azure accounts. operationId: ListAzureScanOptions responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AzureScanOptionsArray' + $ref: "#/components/schemas/AzureScanOptionsArray" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_findings_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read summary: List Azure scan options tags: - - Agentless Scanning + - Agentless Scanning post: description: Activate Agentless scan options for an Azure subscription. operationId: CreateAzureScanOptions @@ -75063,141 +71462,140 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AzureScanOptions' + $ref: "#/components/schemas/AzureScanOptions" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/AzureScanOptions' + $ref: "#/components/schemas/AzureScanOptions" description: Created - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management summary: Create Azure scan options tags: - - Agentless Scanning + - Agentless Scanning /api/v2/agentless_scanning/accounts/azure/{subscription_id}: delete: description: Delete Agentless scan options for an Azure subscription. operationId: DeleteAzureScanOptions parameters: - - description: The Azure subscription ID. - in: path - name: subscription_id - required: true - schema: - example: 12345678-90ab-cdef-1234-567890abcdef - type: string + - description: The Azure subscription ID. + in: path + name: subscription_id + required: true + schema: + example: 12345678-90ab-cdef-1234-567890abcdef + type: string responses: - '204': + "204": description: No Content - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management summary: Delete Azure scan options tags: - - Agentless Scanning + - Agentless Scanning get: description: Fetches the Agentless scan options for an activated subscription. operationId: GetAzureScanOptions parameters: - - description: The Azure subscription ID. - in: path - name: subscription_id - required: true - schema: - example: 12345678-90ab-cdef-1234-567890abcdef - type: string + - description: The Azure subscription ID. + in: path + name: subscription_id + required: true + schema: + example: 12345678-90ab-cdef-1234-567890abcdef + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AzureScanOptions' + $ref: "#/components/schemas/AzureScanOptions" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_findings_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read summary: Get Azure scan options - tags: - - Agentless Scanning + tags: ["Agentless Scanning"] patch: description: Update the Agentless scan options for an activated subscription. operationId: UpdateAzureScanOptions parameters: - - description: The Azure subscription ID. - in: path - name: subscription_id - required: true - schema: - example: 12345678-90ab-cdef-1234-567890abcdef - type: string + - description: The Azure subscription ID. + in: path + name: subscription_id + required: true + schema: + example: 12345678-90ab-cdef-1234-567890abcdef + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/AzureScanOptionsInputUpdate' + $ref: "#/components/schemas/AzureScanOptionsInputUpdate" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AzureScanOptions' + $ref: "#/components/schemas/AzureScanOptions" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management summary: Update Azure scan options tags: - - Agentless Scanning + - Agentless Scanning /api/v2/agentless_scanning/accounts/gcp: get: description: Fetches the scan options configured for all GCP projects. operationId: ListGcpScanOptions responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GcpScanOptionsArray' + $ref: "#/components/schemas/GcpScanOptionsArray" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_findings_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read summary: List GCP scan options tags: - - Agentless Scanning + - Agentless Scanning post: description: Activate Agentless scan options for a GCP project. operationId: CreateGcpScanOptions @@ -75205,282 +71603,277 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GcpScanOptions' + $ref: "#/components/schemas/GcpScanOptions" description: The definition of the new scan options. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/GcpScanOptions' + $ref: "#/components/schemas/GcpScanOptions" description: Agentless scan options enabled successfully. - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management summary: Create GCP scan options tags: - - Agentless Scanning + - Agentless Scanning x-codegen-request-body-name: body /api/v2/agentless_scanning/accounts/gcp/{project_id}: delete: description: Delete Agentless scan options for a GCP project. operationId: DeleteGcpScanOptions parameters: - - description: The GCP project ID. - in: path - name: project_id - required: true - schema: - example: company-project-id - type: string + - description: The GCP project ID. + in: path + name: project_id + required: true + schema: + example: company-project-id + type: string responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management summary: Delete GCP scan options tags: - - Agentless Scanning + - Agentless Scanning get: description: Fetches the Agentless scan options for an activated GCP project. operationId: GetGcpScanOptions parameters: - - description: The GCP project ID. - in: path - name: project_id - required: true - schema: - example: company-project-id - type: string + - description: The GCP project ID. + in: path + name: project_id + required: true + schema: + example: company-project-id + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GcpScanOptions' + $ref: "#/components/schemas/GcpScanOptions" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_findings_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read summary: Get GCP scan options tags: - - Agentless Scanning + - Agentless Scanning patch: description: Update the Agentless scan options for an activated GCP project. operationId: UpdateGcpScanOptions parameters: - - description: The GCP project ID. - in: path - name: project_id - required: true - schema: - example: company-project-id - type: string + - description: The GCP project ID. + in: path + name: project_id + required: true + schema: + example: company-project-id + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/GcpScanOptionsInputUpdate' + $ref: "#/components/schemas/GcpScanOptionsInputUpdate" description: New definition of the scan options. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GcpScanOptions' + $ref: "#/components/schemas/GcpScanOptions" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management summary: Update GCP scan options tags: - - Agentless Scanning + - Agentless Scanning x-codegen-request-body-name: body /api/v2/agentless_scanning/ondemand/aws: get: description: Fetches the most recent 1000 AWS on demand tasks. operationId: ListAwsOnDemandTasks responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AwsOnDemandListResponse' + $ref: "#/components/schemas/AwsOnDemandListResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_findings_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read summary: List AWS on demand tasks - tags: - - Agentless Scanning - x-permission: + tags: ["Agentless Scanning"] + "x-permission": operator: OR permissions: - - security_monitoring_findings_read + - security_monitoring_findings_read post: - description: Trigger the scan of an AWS resource with a high priority. Agentless - scanning must be activated for the AWS account containing the resource to - scan. + description: Trigger the scan of an AWS resource with a high priority. Agentless scanning must be activated for the AWS account containing the resource to scan. operationId: CreateAwsOnDemandTask requestBody: content: application/json: schema: - $ref: '#/components/schemas/AwsOnDemandCreateRequest' + $ref: "#/components/schemas/AwsOnDemandCreateRequest" description: The definition of the on demand task. required: true responses: - '201': + "201": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/AwsOnDemandResponse' + $ref: "#/components/schemas/AwsOnDemandResponse" description: AWS on demand task created successfully. - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management summary: Create AWS on demand task - tags: - - Agentless Scanning + tags: ["Agentless Scanning"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_findings_write + - security_monitoring_findings_write /api/v2/agentless_scanning/ondemand/aws/{task_id}: get: description: Fetch the data of a specific on demand task. operationId: GetAwsOnDemandTask parameters: - - $ref: '#/components/parameters/OnDemandTaskId' + - $ref: "#/components/parameters/OnDemandTaskId" responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/AwsOnDemandResponse' + $ref: "#/components/schemas/AwsOnDemandResponse" description: OK. - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_findings_read + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read summary: Get AWS on demand task - tags: - - Agentless Scanning - x-permission: + tags: ["Agentless Scanning"] + "x-permission": operator: OR permissions: - - security_monitoring_findings_read + - security_monitoring_findings_read /api/v2/api_keys: get: description: List all API keys available for your account. operationId: ListAPIKeys parameters: - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' - - $ref: '#/components/parameters/APIKeysSortParameter' - - $ref: '#/components/parameters/APIKeyFilterParameter' - - $ref: '#/components/parameters/APIKeyFilterCreatedAtStartParameter' - - $ref: '#/components/parameters/APIKeyFilterCreatedAtEndParameter' - - $ref: '#/components/parameters/APIKeyFilterModifiedAtStartParameter' - - $ref: '#/components/parameters/APIKeyFilterModifiedAtEndParameter' - - $ref: '#/components/parameters/APIKeyIncludeParameter' - - $ref: '#/components/parameters/APIKeyReadConfigReadEnabledParameter' - - $ref: '#/components/parameters/APIKeyCategoryParameter' + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - $ref: "#/components/parameters/APIKeysSortParameter" + - $ref: "#/components/parameters/APIKeyFilterParameter" + - $ref: "#/components/parameters/APIKeyFilterCreatedAtStartParameter" + - $ref: "#/components/parameters/APIKeyFilterCreatedAtEndParameter" + - $ref: "#/components/parameters/APIKeyFilterModifiedAtStartParameter" + - $ref: "#/components/parameters/APIKeyFilterModifiedAtEndParameter" + - $ref: "#/components/parameters/APIKeyIncludeParameter" + - $ref: "#/components/parameters/APIKeyReadConfigReadEnabledParameter" + - $ref: "#/components/parameters/APIKeyCategoryParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/APIKeysResponse' + $ref: "#/components/schemas/APIKeysResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all API keys tags: - - Key Management - x-permission: + - Key Management + "x-permission": operator: OR permissions: - - api_keys_read + - api_keys_read post: description: Create an API key. operationId: CreateAPIKey @@ -75488,632 +71881,621 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/APIKeyCreateRequest' + $ref: "#/components/schemas/APIKeyCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/APIKeyResponse' + $ref: "#/components/schemas/APIKeyResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an API key tags: - - Key Management + - Key Management x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - api_keys_write + - api_keys_write /api/v2/api_keys/{api_key_id}: delete: description: Delete an API key. operationId: DeleteAPIKey parameters: - - $ref: '#/components/parameters/APIKeyId' + - $ref: "#/components/parameters/APIKeyId" responses: - '204': + "204": description: No Content - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an API key tags: - - Key Management - x-permission: + - Key Management + "x-permission": operator: OR permissions: - - api_keys_delete + - api_keys_delete get: description: Get an API key. operationId: GetAPIKey parameters: - - $ref: '#/components/parameters/APIKeyId' - - $ref: '#/components/parameters/APIKeyIncludeParameter' + - $ref: "#/components/parameters/APIKeyId" + - $ref: "#/components/parameters/APIKeyIncludeParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/APIKeyResponse' + $ref: "#/components/schemas/APIKeyResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get API key tags: - - Key Management - x-permission: + - Key Management + "x-permission": operator: OR permissions: - - api_keys_read + - api_keys_read patch: description: Update an API key. operationId: UpdateAPIKey parameters: - - $ref: '#/components/parameters/APIKeyId' + - $ref: "#/components/parameters/APIKeyId" requestBody: content: application/json: schema: - $ref: '#/components/schemas/APIKeyUpdateRequest' + $ref: "#/components/schemas/APIKeyUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/APIKeyResponse' + $ref: "#/components/schemas/APIKeyResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Edit an API key tags: - - Key Management + - Key Management x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - api_keys_write + - api_keys_write /api/v2/apicatalog/api: get: deprecated: true description: List APIs and their IDs. operationId: ListAPIs parameters: - - description: Filter APIs by name - in: query - name: query - required: false - schema: - example: payments - type: string - - description: Number of items per page. - in: query - name: page[limit] - required: false - schema: - default: 20 - format: int64 - minimum: 1 - type: integer - - description: Offset for pagination. - in: query - name: page[offset] - required: false - schema: - default: 0 - format: int64 - minimum: 0 - type: integer + - description: Filter APIs by name + in: query + name: query + required: false + schema: + example: "payments" + type: string + - description: Number of items per page. + in: query + name: page[limit] + required: false + schema: + default: 20 + format: int64 + minimum: 1 + type: integer + - description: Offset for pagination. + in: query + name: page[offset] + required: false + schema: + default: 0 + format: int64 + minimum: 0 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListAPIsResponse' + $ref: "#/components/schemas/ListAPIsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_api_catalog_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_api_catalog_read summary: List APIs - tags: - - API Management - x-permission: + tags: ["API Management"] + "x-permission": operator: OR permissions: - - apm_api_catalog_read - x-unstable: '**Note**: This endpoint is deprecated.' + - apm_api_catalog_read + x-unstable: |- + **Note**: This endpoint is deprecated. /api/v2/apicatalog/api/{id}: delete: deprecated: true description: Delete a specific API by ID. operationId: DeleteOpenAPI parameters: - - description: ID of the API to delete - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/ApiID' + - description: ID of the API to delete + in: path + name: id + required: true + schema: + $ref: "#/components/schemas/ApiID" responses: - '204': + "204": description: API deleted successfully - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: API not found error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_api_catalog_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_api_catalog_write summary: Delete an API - tags: - - API Management - x-permission: + tags: ["API Management"] + "x-permission": operator: OR permissions: - - apm_api_catalog_write - x-unstable: '**Note**: This endpoint is deprecated.' + - apm_api_catalog_write + x-unstable: |- + **Note**: This endpoint is deprecated. /api/v2/apicatalog/api/{id}/openapi: get: deprecated: true - description: Retrieve information about a specific API in [OpenAPI](https://spec.openapis.org/oas/latest.html) - format file. + description: Retrieve information about a specific API in [OpenAPI](https://spec.openapis.org/oas/latest.html) format file. operationId: GetOpenAPI parameters: - - description: ID of the API to retrieve - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/ApiID' + - description: ID of the API to retrieve + in: path + name: id + required: true + schema: + $ref: "#/components/schemas/ApiID" responses: - '200': + "200": content: multipart/form-data: schema: format: binary type: string description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: API not found error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_api_catalog_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_api_catalog_read summary: Get an API - tags: - - API Management - x-permission: + tags: ["API Management"] + "x-permission": operator: OR permissions: - - apm_api_catalog_read - x-unstable: '**Note**: This endpoint is deprecated.' + - apm_api_catalog_read + x-unstable: |- + **Note**: This endpoint is deprecated. put: deprecated: true - description: 'Update information about a specific API. The given content will - replace all API content of the given ID. - - The ID is returned by the create API, or can be found in the URL in the API - catalog UI.' + description: |- + Update information about a specific API. The given content will replace all API content of the given ID. + The ID is returned by the create API, or can be found in the URL in the API catalog UI. operationId: UpdateOpenAPI parameters: - - description: ID of the API to modify - in: path - name: id - required: true - schema: - $ref: '#/components/schemas/ApiID' + - description: ID of the API to modify + in: path + name: id + required: true + schema: + $ref: "#/components/schemas/ApiID" requestBody: content: multipart/form-data: schema: - $ref: '#/components/schemas/OpenAPIFile' + $ref: "#/components/schemas/OpenAPIFile" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateOpenAPIResponse' + $ref: "#/components/schemas/UpdateOpenAPIResponse" description: API updated successfully - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: API not found error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_api_catalog_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_api_catalog_write summary: Update an API - tags: - - API Management - x-permission: + tags: ["API Management"] + "x-permission": operator: OR permissions: - - apm_api_catalog_write - x-unstable: '**Note**: This endpoint is deprecated.' + - apm_api_catalog_write + x-unstable: |- + **Note**: This endpoint is deprecated. /api/v2/apicatalog/openapi: post: deprecated: true - description: 'Create a new API from the [OpenAPI](https://spec.openapis.org/oas/latest.html) - specification given. - - See the [API Catalog documentation](https://docs.datadoghq.com/api_catalog/add_metadata/) - for additional - + description: |- + Create a new API from the [OpenAPI](https://spec.openapis.org/oas/latest.html) specification given. + See the [API Catalog documentation](https://docs.datadoghq.com/api_catalog/add_metadata/) for additional information about the possible metadata. - - It returns the created API ID.' + It returns the created API ID. operationId: CreateOpenAPI requestBody: content: multipart/form-data: schema: - $ref: '#/components/schemas/OpenAPIFile' + $ref: "#/components/schemas/OpenAPIFile" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/CreateOpenAPIResponse' + $ref: "#/components/schemas/CreateOpenAPIResponse" description: API created successfully - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_api_catalog_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_api_catalog_write summary: Create a new API - tags: - - API Management - x-permission: + tags: ["API Management"] + "x-permission": operator: OR permissions: - - apm_api_catalog_write - x-unstable: '**Note**: This endpoint is deprecated.' + - apm_api_catalog_write + x-unstable: |- + **Note**: This endpoint is deprecated. /api/v2/apm/config/metrics: get: description: Get the list of configured span-based metrics with their definitions. operationId: ListSpansMetrics responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SpansMetricsResponse' + $ref: "#/components/schemas/SpansMetricsResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all span-based metrics tags: - - Spans Metrics - x-permission: + - Spans Metrics + "x-permission": operator: OR permissions: - - apm_read + - apm_read post: - description: 'Create a metric based on your ingested spans in your organization. - - Returns the span-based metric object from the request body when the request - is successful.' + description: |- + Create a metric based on your ingested spans in your organization. + Returns the span-based metric object from the request body when the request is successful. operationId: CreateSpansMetric requestBody: content: application/json: schema: - $ref: '#/components/schemas/SpansMetricCreateRequest' + $ref: "#/components/schemas/SpansMetricCreateRequest" description: The definition of the new span-based metric. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SpansMetricResponse' + $ref: "#/components/schemas/SpansMetricResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a span-based metric tags: - - Spans Metrics + - Spans Metrics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - apm_generate_metrics + - apm_generate_metrics /api/v2/apm/config/metrics/{metric_id}: delete: description: Delete a specific span-based metric from your organization. operationId: DeleteSpansMetric parameters: - - $ref: '#/components/parameters/SpansMetricIDParameter' + - $ref: "#/components/parameters/SpansMetricIDParameter" responses: - '204': + "204": description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a span-based metric tags: - - Spans Metrics - x-permission: + - Spans Metrics + "x-permission": operator: OR permissions: - - apm_generate_metrics + - apm_generate_metrics get: description: Get a specific span-based metric from your organization. operationId: GetSpansMetric parameters: - - $ref: '#/components/parameters/SpansMetricIDParameter' + - $ref: "#/components/parameters/SpansMetricIDParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SpansMetricResponse' + $ref: "#/components/schemas/SpansMetricResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a span-based metric tags: - - Spans Metrics - x-permission: + - Spans Metrics + "x-permission": operator: OR permissions: - - apm_read + - apm_read patch: - description: 'Update a specific span-based metric from your organization. - - Returns the span-based metric object from the request body when the request - is successful.' + description: |- + Update a specific span-based metric from your organization. + Returns the span-based metric object from the request body when the request is successful. operationId: UpdateSpansMetric parameters: - - $ref: '#/components/parameters/SpansMetricIDParameter' + - $ref: "#/components/parameters/SpansMetricIDParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SpansMetricUpdateRequest' + $ref: "#/components/schemas/SpansMetricUpdateRequest" description: New definition of the span-based metric. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SpansMetricResponse' + $ref: "#/components/schemas/SpansMetricResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a span-based metric tags: - - Spans Metrics + - Spans Metrics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - apm_generate_metrics + - apm_generate_metrics /api/v2/apm/config/retention-filters: get: description: Get the list of APM retention filters. operationId: ListApmRetentionFilters responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RetentionFiltersResponse' + $ref: "#/components/schemas/RetentionFiltersResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List all APM retention filters tags: - - APM Retention Filters - x-permission: + - APM Retention Filters + "x-permission": operator: OR permissions: - - apm_retention_filter_read + - apm_retention_filter_read post: - description: 'Create a retention filter to index spans in your organization. - + description: |- + Create a retention filter to index spans in your organization. Returns the retention filter definition when the request is successful. - - Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor - cannot be created.' + Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be created. operationId: CreateApmRetentionFilter requestBody: content: application/json: schema: - $ref: '#/components/schemas/RetentionFilterCreateRequest' + $ref: "#/components/schemas/RetentionFilterCreateRequest" description: The definition of the new retention filter. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RetentionFilterCreateResponse' + $ref: "#/components/schemas/RetentionFilterCreateResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a retention filter tags: - - APM Retention Filters + - APM Retention Filters x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - apm_retention_filter_write + - apm_retention_filter_write /api/v2/apm/config/retention-filters-execution-order: put: description: Re-order the execution order of retention filters. @@ -76122,951 +72504,915 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReorderRetentionFiltersRequest' + $ref: "#/components/schemas/ReorderRetentionFiltersRequest" description: The list of retention filters in the new order. required: true responses: - '200': + "200": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Re-order retention filters tags: - - APM Retention Filters + - APM Retention Filters x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - apm_retention_filter_write + - apm_retention_filter_write /api/v2/apm/config/retention-filters/{filter_id}: delete: - description: 'Delete a specific retention filter from your organization. + description: |- + Delete a specific retention filter from your organization. - - Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor - cannot be deleted.' + Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be deleted. operationId: DeleteApmRetentionFilter parameters: - - $ref: '#/components/parameters/RetentionFilterIdParam' + - $ref: "#/components/parameters/RetentionFilterIdParam" responses: - '200': + "200": description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a retention filter tags: - - APM Retention Filters - x-permission: + - APM Retention Filters + "x-permission": operator: OR permissions: - - apm_retention_filter_write + - apm_retention_filter_write get: description: Get an APM retention filter. operationId: GetApmRetentionFilter parameters: - - $ref: '#/components/parameters/RetentionFilterIdParam' + - $ref: "#/components/parameters/RetentionFilterIdParam" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RetentionFilterResponse' + $ref: "#/components/schemas/RetentionFilterResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a given APM retention filter tags: - - APM Retention Filters - x-permission: + - APM Retention Filters + "x-permission": operator: OR permissions: - - apm_retention_filter_read + - apm_retention_filter_read put: - description: 'Update a retention filter from your organization. - + description: |- + Update a retention filter from your organization. - Default filters (filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor) - cannot be renamed or removed.' + Default filters (filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor) cannot be renamed or removed. operationId: UpdateApmRetentionFilter parameters: - - $ref: '#/components/parameters/RetentionFilterIdParam' + - $ref: "#/components/parameters/RetentionFilterIdParam" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RetentionFilterUpdateRequest' + $ref: "#/components/schemas/RetentionFilterUpdateRequest" description: The updated definition of the retention filter. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RetentionFilterResponse' + $ref: "#/components/schemas/RetentionFilterResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a retention filter tags: - - APM Retention Filters + - APM Retention Filters x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - apm_retention_filter_write + - apm_retention_filter_write /api/v2/apm/services: get: operationId: GetServiceList parameters: - - description: Filter services by environment. Can be set to `*` to return all - services across all environments. - in: query - name: filter[env] - required: true - schema: - type: string + - description: Filter services by environment. Can be set to `*` to return all services across all environments. + in: query + name: filter[env] + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceList' + $ref: "#/components/schemas/ServiceList" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_read summary: Get service list tags: - - APM + - APM /api/v2/app-builder/apps: delete: - description: Delete multiple apps in a single request from a list of app IDs. - This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: Delete multiple apps in a single request from a list of app IDs. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: DeleteApps requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteAppsRequest' + $ref: "#/components/schemas/DeleteAppsRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteAppsResponse' + $ref: "#/components/schemas/DeleteAppsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete Multiple Apps tags: - - App Builder - x-permission: + - App Builder + "x-permission": operator: OR permissions: - - apps_write + - apps_write get: - description: List all apps, with optional filters and sorting. This endpoint - is paginated. Only basic app information such as the app ID, name, and description - is returned by this endpoint. This API requires a [registered application - key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: List all apps, with optional filters and sorting. This endpoint is paginated. Only basic app information such as the app ID, name, and description is returned by this endpoint. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: ListApps parameters: - - description: The number of apps to return per page. - in: query - name: limit - required: false - schema: - format: int64 - type: integer - - description: The page number to return. - in: query - name: page - required: false - schema: - format: int64 - type: integer - - description: Filter apps by the app creator. Usually the user's email. - in: query - name: filter[user_name] - required: false - schema: - type: string - - description: Filter apps by the app creator's UUID. - example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 - in: query - name: filter[user_uuid] - required: false - schema: - format: uuid - type: string - - description: Filter by app name. - in: query - name: filter[name] - required: false - schema: - type: string - - description: Filter apps by the app name or the app creator. - in: query - name: filter[query] - required: false - schema: - type: string - - description: Filter apps by whether they are published. - in: query - name: filter[deployed] - required: false - schema: - type: boolean - - description: Filter apps by tags. - in: query - name: filter[tags] - required: false - schema: - type: string - - description: Filter apps by whether you have added them to your favorites. - in: query - name: filter[favorite] - required: false - schema: - type: boolean - - description: Filter apps by whether they are enabled for self-service. - in: query - name: filter[self_service] - required: false - schema: - type: boolean - - description: The fields and direction to sort apps by. - explode: false - in: query - name: sort - required: false - schema: - items: - $ref: '#/components/schemas/AppsSortField' - type: array - style: form + - description: The number of apps to return per page. + in: query + name: limit + required: false + schema: + format: int64 + type: integer + - description: The page number to return. + in: query + name: page + required: false + schema: + format: int64 + type: integer + - description: Filter apps by the app creator. Usually the user's email. + in: query + name: filter[user_name] + required: false + schema: + type: string + - description: Filter apps by the app creator's UUID. + example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 + in: query + name: filter[user_uuid] + required: false + schema: + format: uuid + type: string + - description: Filter by app name. + in: query + name: filter[name] + required: false + schema: + type: string + - description: Filter apps by the app name or the app creator. + in: query + name: filter[query] + required: false + schema: + type: string + - description: Filter apps by whether they are published. + in: query + name: filter[deployed] + required: false + schema: + type: boolean + - description: Filter apps by tags. + in: query + name: filter[tags] + required: false + schema: + type: string + - description: Filter apps by whether you have added them to your favorites. + in: query + name: filter[favorite] + required: false + schema: + type: boolean + - description: Filter apps by whether they are enabled for self-service. + in: query + name: filter[self_service] + required: false + schema: + type: boolean + - description: The fields and direction to sort apps by. + explode: false + in: query + name: sort + required: false + schema: + items: + $ref: "#/components/schemas/AppsSortField" + type: array + style: form responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListAppsResponse' + $ref: "#/components/schemas/ListAppsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List Apps tags: - - App Builder - x-permission: + - App Builder + "x-permission": operator: OR permissions: - - apps_run + - apps_run post: - description: Create a new app, returning the app ID. This API requires a [registered - application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: Create a new app, returning the app ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: CreateApp requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateAppRequest' + $ref: "#/components/schemas/CreateAppRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/CreateAppResponse' + $ref: "#/components/schemas/CreateAppResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create App tags: - - App Builder - x-permission: + - App Builder + "x-permission": operator: AND permissions: - - apps_write - - connections_resolve - - workflows_run - /api/v2/app-builder/apps/{app_id}: + - apps_write + - connections_resolve + - workflows_run + "/api/v2/app-builder/apps/{app_id}": delete: - description: Delete a single app. This API requires a [registered application - key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: Delete a single app. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: DeleteApp parameters: - - description: The ID of the app to delete. - example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 - in: path - name: app_id - required: true - schema: - format: uuid - type: string + - description: The ID of the app to delete. + example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 + in: path + name: app_id + required: true + schema: + format: uuid + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteAppResponse' + $ref: "#/components/schemas/DeleteAppResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '410': + "410": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Gone - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete App tags: - - App Builder - x-permission: + - App Builder + "x-permission": operator: OR permissions: - - apps_write + - apps_write get: - description: Get the full definition of an app. This API requires a [registered - application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: Get the full definition of an app. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: GetApp parameters: - - description: The ID of the app to retrieve. - example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 - in: path - name: app_id - required: true - schema: - format: uuid - type: string - - 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. - in: query - name: version - required: false - schema: - type: string + - description: The ID of the app to retrieve. + example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 + in: path + name: app_id + required: true + schema: + format: uuid + type: string + - 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. + in: query + name: version + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GetAppResponse' + $ref: "#/components/schemas/GetAppResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '410': + "410": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Gone - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get App tags: - - App Builder - x-permission: + - App Builder + "x-permission": operator: AND permissions: - - apps_run - - connections_read + - apps_run + - connections_read patch: - description: Update an existing app. This creates a new version of the app. - This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: Update an existing app. This creates a new version of the app. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: UpdateApp parameters: - - description: The ID of the app to update. - example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 - in: path - name: app_id - required: true - schema: - format: uuid - type: string + - description: The ID of the app to update. + example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 + in: path + name: app_id + required: true + schema: + format: uuid + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateAppRequest' + $ref: "#/components/schemas/UpdateAppRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateAppResponse' + $ref: "#/components/schemas/UpdateAppResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update App tags: - - App Builder - x-permission: + - App Builder + "x-permission": operator: AND permissions: - - apps_write - - connections_resolve - - workflows_run - /api/v2/app-builder/apps/{app_id}/deployment: + - apps_write + - connections_resolve + - workflows_run + "/api/v2/app-builder/apps/{app_id}/deployment": delete: - description: Unpublish an app, removing the live version of the app. Unpublishing - creates a new instance of a `deployment` object on the app, with a nil `app_version_id` - (`00000000-0000-0000-0000-000000000000`). The app can still be updated and - published again in the future. This API requires a [registered application - key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: Unpublish an app, removing the live version of the app. Unpublishing creates a new instance of a `deployment` object on the app, with a nil `app_version_id` (`00000000-0000-0000-0000-000000000000`). The app can still be updated and published again in the future. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: UnpublishApp parameters: - - description: The ID of the app to unpublish. - example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 - in: path - name: app_id - required: true - schema: - format: uuid - type: string + - description: The ID of the app to unpublish. + example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 + in: path + name: app_id + required: true + schema: + format: uuid + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UnpublishAppResponse' + $ref: "#/components/schemas/UnpublishAppResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Unpublish App tags: - - App Builder - x-permission: + - App Builder + "x-permission": operator: OR permissions: - - apps_write + - apps_write post: - description: Publish an app for use by other users. To ensure the app is accessible - to the correct users, you also need to set a [Restriction Policy](https://docs.datadoghq.com/api/latest/restriction-policies/) - on the app if a policy does not yet exist. This API requires a [registered - application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: Publish an app for use by other users. To ensure the app is accessible to the correct users, you also need to set a [Restriction Policy](https://docs.datadoghq.com/api/latest/restriction-policies/) on the app if a policy does not yet exist. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: PublishApp parameters: - - description: The ID of the app to publish. - example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 - in: path - name: app_id - required: true - schema: - format: uuid - type: string + - description: The ID of the app to publish. + example: 65bb1f25-52e1-4510-9f8d-22d1516ed693 + in: path + name: app_id + required: true + schema: + format: uuid + type: string responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/PublishAppResponse' + $ref: "#/components/schemas/PublishAppResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Publish App tags: - - App Builder - x-permission: + - App Builder + "x-permission": operator: OR permissions: - - apps_write + - apps_write /api/v2/application_keys: get: description: List all application keys available for your org operationId: ListApplicationKeys parameters: - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' - - $ref: '#/components/parameters/ApplicationKeysSortParameter' - - $ref: '#/components/parameters/ApplicationKeyFilterParameter' - - $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter' - - $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter' - - $ref: '#/components/parameters/ApplicationKeyIncludeParameter' + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - $ref: "#/components/parameters/ApplicationKeysSortParameter" + - $ref: "#/components/parameters/ApplicationKeyFilterParameter" + - $ref: "#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter" + - $ref: "#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter" + - $ref: "#/components/parameters/ApplicationKeyIncludeParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListApplicationKeysResponse' + $ref: "#/components/schemas/ListApplicationKeysResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all application keys tags: - - Key Management - x-permission: + - Key Management + "x-permission": operator: OR permissions: - - org_app_keys_read + - org_app_keys_read /api/v2/application_keys/{app_key_id}: delete: description: Delete an application key operationId: DeleteApplicationKey parameters: - - $ref: '#/components/parameters/ApplicationKeyID' + - $ref: "#/components/parameters/ApplicationKeyID" responses: - '204': + "204": description: No Content - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an application key tags: - - Key Management + - Key Management x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - org_app_keys_write + - org_app_keys_write get: description: Get an application key for your org. operationId: GetApplicationKey parameters: - - $ref: '#/components/parameters/ApplicationKeyID' - - $ref: '#/components/parameters/ApplicationKeyIncludeParameter' + - $ref: "#/components/parameters/ApplicationKeyID" + - $ref: "#/components/parameters/ApplicationKeyIncludeParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationKeyResponse' + $ref: "#/components/schemas/ApplicationKeyResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get an application key tags: - - Key Management - x-permission: + - Key Management + "x-permission": operator: OR permissions: - - org_app_keys_read + - org_app_keys_read patch: description: Edit an application key operationId: UpdateApplicationKey parameters: - - $ref: '#/components/parameters/ApplicationKeyID' + - $ref: "#/components/parameters/ApplicationKeyID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApplicationKeyUpdateRequest' + $ref: "#/components/schemas/ApplicationKeyUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationKeyResponse' + $ref: "#/components/schemas/ApplicationKeyResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Edit an application key tags: - - Key Management + - Key Management x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - org_app_keys_write + - org_app_keys_write /api/v2/audit/events: get: - description: 'List endpoint returns events that match a Audit Logs search query. - + description: |- + List endpoint returns events that match a Audit Logs search query. [Results are paginated][1]. - Use this endpoint to see your latest Audit Logs events. - - [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination' + [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination operationId: ListAuditLogs parameters: - - description: Search query following Audit Logs syntax. - example: '@type:session @application_id:xxxx' - in: query - name: filter[query] - required: false - schema: - type: string - - description: Minimum timestamp for requested events. - example: '2019-01-02T09:42:36.320Z' - in: query - name: filter[from] - required: false - schema: - format: date-time - type: string - - description: Maximum timestamp for requested events. - example: '2019-01-03T09:42:36.320Z' - in: query - name: filter[to] - required: false - schema: - format: date-time - type: string - - description: Order of events in results. - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/AuditLogsSort' - - description: List following results with a cursor provided in the previous - query. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== - in: query - name: page[cursor] - required: false - schema: - type: string - - description: Maximum number of events in the response. - example: 25 - in: query - name: page[limit] - required: false - schema: - default: 10 - format: int32 - maximum: 1000 - type: integer + - description: Search query following Audit Logs syntax. + example: "@type:session @application_id:xxxx" + in: query + name: filter[query] + required: false + schema: + type: string + - description: Minimum timestamp for requested events. + example: "2019-01-02T09:42:36.320Z" + in: query + name: filter[from] + required: false + schema: + format: date-time + type: string + - description: Maximum timestamp for requested events. + example: "2019-01-03T09:42:36.320Z" + in: query + name: filter[to] + required: false + schema: + format: date-time + type: string + - description: Order of events in results. + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/AuditLogsSort" + - description: |- + List following results with a cursor provided in the previous query. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" + in: query + name: page[cursor] + required: false + schema: + type: string + - description: Maximum number of events in the response. + example: 25 + in: query + name: page[limit] + required: false + schema: + default: 10 + format: int32 + maximum: 1000 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AuditLogsEventsResponse' + $ref: "#/components/schemas/AuditLogsEventsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a list of Audit Logs events - tags: - - Audit + tags: ["Audit"] x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - audit_logs_read + - audit_logs_read /api/v2/audit/events/search: post: - description: 'List endpoint returns Audit Logs events that match an Audit search - query. - + description: |- + List endpoint returns Audit Logs events that match an Audit search query. [Results are paginated][1]. - Use this endpoint to build complex Audit Logs events filtering and search. - - [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination' + [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination operationId: SearchAuditLogs requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/AuditLogsSearchEventsRequest' + $ref: "#/components/schemas/AuditLogsSearchEventsRequest" required: false responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AuditLogsEventsResponse' + $ref: "#/components/schemas/AuditLogsEventsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Search Audit Logs events - tags: - - Audit + tags: ["Audit"] x-codegen-request-body-name: body x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - audit_logs_read + - audit_logs_read /api/v2/authn_mappings: get: description: List all AuthN Mappings in the org. operationId: ListAuthNMappings parameters: - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' - - description: Sort AuthN Mappings depending on the given field. - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/AuthNMappingsSort' - - description: Filter all mappings by the given string. - in: query - name: filter - required: false - schema: - type: string - - description: Filter by mapping resource type. Defaults to "role" if not specified. - in: query - name: resource_type - schema: - $ref: '#/components/schemas/AuthNMappingResourceType' + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - description: Sort AuthN Mappings depending on the given field. + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/AuthNMappingsSort" + - description: Filter all mappings by the given string. + in: query + name: filter + required: false + schema: + type: string + - description: Filter by mapping resource type. Defaults to "role" if not specified. + in: query + name: resource_type + schema: + $ref: "#/components/schemas/AuthNMappingResourceType" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AuthNMappingsResponse' + $ref: "#/components/schemas/AuthNMappingsResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List all AuthN Mappings tags: - - AuthN Mappings - x-permission: + - AuthN Mappings + "x-permission": operator: OR permissions: - - user_access_read + - user_access_read post: description: Create an AuthN Mapping. operationId: CreateAuthNMapping @@ -77074,211 +73420,212 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AuthNMappingCreateRequest' + $ref: "#/components/schemas/AuthNMappingCreateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AuthNMappingResponse' + $ref: "#/components/schemas/AuthNMappingResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an AuthN Mapping tags: - - AuthN Mappings + - AuthN Mappings x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage + - user_access_manage /api/v2/authn_mappings/{authn_mapping_id}: delete: description: Delete an AuthN Mapping specified by AuthN Mapping UUID. operationId: DeleteAuthNMapping parameters: - - $ref: '#/components/parameters/AuthNMappingID' + - $ref: "#/components/parameters/AuthNMappingID" responses: - '204': + "204": description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an AuthN Mapping tags: - - AuthN Mappings - x-permission: + - AuthN Mappings + "x-permission": operator: OR permissions: - - user_access_manage + - user_access_manage get: description: Get an AuthN Mapping specified by the AuthN Mapping UUID. operationId: GetAuthNMapping parameters: - - $ref: '#/components/parameters/AuthNMappingID' + - $ref: "#/components/parameters/AuthNMappingID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AuthNMappingResponse' + $ref: "#/components/schemas/AuthNMappingResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get an AuthN Mapping by UUID tags: - - AuthN Mappings - x-permission: + - AuthN Mappings + "x-permission": operator: OR permissions: - - user_access_read + - user_access_read patch: description: Edit an AuthN Mapping. operationId: UpdateAuthNMapping parameters: - - $ref: '#/components/parameters/AuthNMappingID' + - $ref: "#/components/parameters/AuthNMappingID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/AuthNMappingUpdateRequest' + $ref: "#/components/schemas/AuthNMappingUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AuthNMappingResponse' + $ref: "#/components/schemas/AuthNMappingResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Conflict - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Unprocessable Entity - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Edit an AuthN Mapping tags: - - AuthN Mappings + - AuthN Mappings x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage + - user_access_manage /api/v2/cases: get: - description: Search cases. + description: >- + Search cases. operationId: SearchCases parameters: - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' - - $ref: '#/components/parameters/CaseSortableFieldParameter' - - description: Search query - in: query - name: filter - required: false - schema: - example: status:open (team:case-management OR team:event-management) - type: string - - description: Specify if order is ascending or not - in: query - name: sort[asc] - required: false - schema: - default: false - type: boolean + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - $ref: "#/components/parameters/CaseSortableFieldParameter" + - description: Search query + in: query + name: filter + required: false + schema: + example: "status:open (team:case-management OR team:event-management)" + type: string + - description: Specify if order is ascending or not + in: query + name: sort[asc] + required: false + schema: + default: false + type: boolean responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CasesResponse' + $ref: "#/components/schemas/CasesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_read summary: Search cases tags: - - Case Management + - Case Management x-pagination: limitParam: page[size] pageParam: page[number] @@ -77290,63 +73637,64 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CaseCreateRequest' + $ref: "#/components/schemas/CaseCreateRequest" description: Case payload required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/CaseResponse' + $ref: "#/components/schemas/CaseResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Create a case tags: - - Case Management + - Case Management /api/v2/cases/projects: get: - description: Get all projects. + description: >- + Get all projects. operationId: GetProjects responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ProjectsResponse' + $ref: "#/components/schemas/ProjectsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_read summary: Get all projects tags: - - Case Management + - Case Management post: description: Create a project. operationId: CreateProject @@ -77354,302 +73702,306 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ProjectCreateRequest' + $ref: "#/components/schemas/ProjectCreateRequest" description: Project payload required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/ProjectResponse' + $ref: "#/components/schemas/ProjectResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Create a project tags: - - Case Management + - Case Management /api/v2/cases/projects/{project_id}: delete: description: Remove a project using the project's `id`. operationId: DeleteProject parameters: - - $ref: '#/components/parameters/ProjectIDPathParameter' + - $ref: "#/components/parameters/ProjectIDPathParameter" responses: - '204': + "204": description: No Content - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Remove a project tags: - - Case Management + - Case Management get: - description: Get the details of a project by `project_id`. + description: >- + Get the details of a project by `project_id`. operationId: GetProject parameters: - - $ref: '#/components/parameters/ProjectIDPathParameter' + - $ref: "#/components/parameters/ProjectIDPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ProjectResponse' + $ref: "#/components/schemas/ProjectResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_read summary: Get the details of a project tags: - - Case Management + - Case Management patch: - description: Update a project. + description: >- + Update a project. operationId: UpdateProject parameters: - - $ref: '#/components/parameters/ProjectIDPathParameter' + - $ref: "#/components/parameters/ProjectIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ProjectUpdateRequest' + $ref: "#/components/schemas/ProjectUpdateRequest" description: Project payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ProjectResponse' + $ref: "#/components/schemas/ProjectResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Update a project tags: - - Case Management + - Case Management /api/v2/cases/projects/{project_id}/notification_rules: get: - description: Get all notification rules for a project. + description: >- + Get all notification rules for a project. operationId: GetProjectNotificationRules parameters: - - description: Project UUID - example: e555e290-ed65-49bd-ae18-8acbfcf18db7 - in: path - name: project_id - required: true - schema: - type: string + - description: Project UUID + example: "e555e290-ed65-49bd-ae18-8acbfcf18db7" + in: path + name: project_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseNotificationRulesResponse' + $ref: "#/components/schemas/CaseNotificationRulesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_read summary: Get notification rules tags: - - Case Management + - Case Management post: description: Create a notification rule for a project. operationId: CreateProjectNotificationRule parameters: - - description: Project UUID - example: e555e290-ed65-49bd-ae18-8acbfcf18db7 - in: path - name: project_id - required: true - schema: - type: string + - description: Project UUID + example: "e555e290-ed65-49bd-ae18-8acbfcf18db7" + in: path + name: project_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseNotificationRuleCreateRequest' + $ref: "#/components/schemas/CaseNotificationRuleCreateRequest" description: Notification rule payload required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/CaseNotificationRuleResponse' + $ref: "#/components/schemas/CaseNotificationRuleResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Create a notification rule tags: - - Case Management + - Case Management /api/v2/cases/projects/{project_id}/notification_rules/{notification_rule_id}: delete: description: Delete a notification rule using the notification rule's `id`. operationId: DeleteProjectNotificationRule parameters: - - description: Project UUID - example: e555e290-ed65-49bd-ae18-8acbfcf18db7 - in: path - name: project_id - required: true - schema: - type: string - - $ref: '#/components/parameters/NotificationRuleIDPathParameter' + - description: Project UUID + example: "e555e290-ed65-49bd-ae18-8acbfcf18db7" + in: path + name: project_id + required: true + schema: + type: string + - $ref: "#/components/parameters/NotificationRuleIDPathParameter" responses: - '204': + "204": description: No Content - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Delete a notification rule tags: - - Case Management + - Case Management put: - description: Update a notification rule. + description: >- + Update a notification rule. operationId: UpdateProjectNotificationRule parameters: - - description: Project UUID - example: e555e290-ed65-49bd-ae18-8acbfcf18db7 - in: path - name: project_id - required: true - schema: - type: string - - $ref: '#/components/parameters/NotificationRuleIDPathParameter' + - description: Project UUID + example: "e555e290-ed65-49bd-ae18-8acbfcf18db7" + in: path + name: project_id + required: true + schema: + type: string + - $ref: "#/components/parameters/NotificationRuleIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseNotificationRuleUpdateRequest' + $ref: "#/components/schemas/CaseNotificationRuleUpdateRequest" description: Notification rule payload required: true responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Update a notification rule tags: - - Case Management + - Case Management /api/v2/cases/types: get: description: Get all case types operationId: GetAllCaseTypes responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseTypesResponse' + $ref: "#/components/schemas/CaseTypesResponse" description: OK - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all case types tags: - - Case Management Type + - Case Management Type post: description: Create a Case Type operationId: CreateCaseType @@ -77657,1065 +74009,1065 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CaseTypeCreateRequest' + $ref: "#/components/schemas/CaseTypeCreateRequest" description: Case type payload required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/CaseTypeResponse' + $ref: "#/components/schemas/CaseTypeResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a case type tags: - - Case Management Type + - Case Management Type /api/v2/cases/types/custom_attributes: get: description: Get all custom attributes operationId: GetAllCustomAttributes responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomAttributeConfigsResponse' + $ref: "#/components/schemas/CustomAttributeConfigsResponse" description: OK - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all custom attributes tags: - - Case Management Attribute + - Case Management Attribute /api/v2/cases/types/{case_type_id}: delete: description: Delete a case type operationId: DeleteCaseType parameters: - - $ref: '#/components/parameters/CaseTypeIDPathParameter' + - $ref: "#/components/parameters/CaseTypeIDPathParameter" responses: - '204': + "204": description: No Content - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a case type tags: - - Case Management Type + - Case Management Type /api/v2/cases/types/{case_type_id}/custom_attributes: get: description: Get all custom attribute config of case type operationId: GetAllCustomAttributeConfigsByCaseType parameters: - - $ref: '#/components/parameters/CaseTypeIDPathParameter' + - $ref: "#/components/parameters/CaseTypeIDPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomAttributeConfigsResponse' + $ref: "#/components/schemas/CustomAttributeConfigsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all custom attributes config of case type tags: - - Case Management Attribute + - Case Management Attribute post: description: Create custom attribute config for a case type operationId: CreateCustomAttributeConfig parameters: - - $ref: '#/components/parameters/CaseTypeIDPathParameter' + - $ref: "#/components/parameters/CaseTypeIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CustomAttributeConfigCreateRequest' + $ref: "#/components/schemas/CustomAttributeConfigCreateRequest" description: Custom attribute config payload required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/CustomAttributeConfigResponse' + $ref: "#/components/schemas/CustomAttributeConfigResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create custom attribute config for a case type tags: - - Case Management Attribute + - Case Management Attribute /api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}: delete: description: Delete custom attribute config operationId: DeleteCustomAttributeConfig parameters: - - $ref: '#/components/parameters/CaseTypeIDPathParameter' - - $ref: '#/components/parameters/CaseCustomAttributeIDPathParameter' + - $ref: "#/components/parameters/CaseTypeIDPathParameter" + - $ref: "#/components/parameters/CaseCustomAttributeIDPathParameter" responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete custom attributes config tags: - - Case Management Attribute + - Case Management Attribute /api/v2/cases/{case_id}: get: - description: Get the details of case by `case_id` + description: >- + Get the details of case by `case_id` operationId: GetCase parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseResponse' + $ref: "#/components/schemas/CaseResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_read summary: Get the details of a case tags: - - Case Management + - Case Management /api/v2/cases/{case_id}/archive: post: description: Archive case operationId: ArchiveCase parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseEmptyRequest' + $ref: "#/components/schemas/CaseEmptyRequest" description: Archive case payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseResponse' + $ref: "#/components/schemas/CaseResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Archive case tags: - - Case Management + - Case Management /api/v2/cases/{case_id}/assign: post: description: Assign case to a user operationId: AssignCase parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseAssignRequest' + $ref: "#/components/schemas/CaseAssignRequest" description: Assign case payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseResponse' + $ref: "#/components/schemas/CaseResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Assign case tags: - - Case Management + - Case Management /api/v2/cases/{case_id}/attributes: post: description: Update case attributes operationId: UpdateAttributes parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseUpdateAttributesRequest' + $ref: "#/components/schemas/CaseUpdateAttributesRequest" description: Case attributes update payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseResponse' + $ref: "#/components/schemas/CaseResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Update case attributes tags: - - Case Management + - Case Management /api/v2/cases/{case_id}/comment: post: description: Comment case operationId: CommentCase parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseCommentRequest' + $ref: "#/components/schemas/CaseCommentRequest" description: Case comment payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TimelineResponse' + $ref: "#/components/schemas/TimelineResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Comment case tags: - - Case Management + - Case Management /api/v2/cases/{case_id}/comment/{cell_id}: delete: description: Delete case comment operationId: DeleteCaseComment parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' - - $ref: '#/components/parameters/CellIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" + - $ref: "#/components/parameters/CellIDPathParameter" responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete case comment tags: - - Case Management + - Case Management /api/v2/cases/{case_id}/custom_attributes/{custom_attribute_key}: delete: description: Delete custom attribute from case operationId: DeleteCaseCustomAttribute parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' - - $ref: '#/components/parameters/CaseCustomAttributeKeyPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" + - $ref: "#/components/parameters/CaseCustomAttributeKeyPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseResponse' + $ref: "#/components/schemas/CaseResponse" description: OK - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Delete custom attribute from case tags: - - Case Management + - Case Management post: description: Update case custom attribute operationId: UpdateCaseCustomAttribute parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' - - $ref: '#/components/parameters/CaseCustomAttributeKeyPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" + - $ref: "#/components/parameters/CaseCustomAttributeKeyPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseUpdateCustomAttributeRequest' + $ref: "#/components/schemas/CaseUpdateCustomAttributeRequest" description: Update case custom attribute payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseResponse' + $ref: "#/components/schemas/CaseResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Update case custom attribute tags: - - Case Management + - Case Management /api/v2/cases/{case_id}/description: post: description: Update case description operationId: UpdateCaseDescription parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseUpdateDescriptionRequest' + $ref: "#/components/schemas/CaseUpdateDescriptionRequest" description: Case description update payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseResponse' + $ref: "#/components/schemas/CaseResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Update case description tags: - - Case Management + - Case Management /api/v2/cases/{case_id}/priority: post: description: Update case priority operationId: UpdatePriority parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseUpdatePriorityRequest' + $ref: "#/components/schemas/CaseUpdatePriorityRequest" description: Case priority update payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseResponse' + $ref: "#/components/schemas/CaseResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Update case priority tags: - - Case Management + - Case Management /api/v2/cases/{case_id}/relationships/incidents: post: description: Link an incident to a case operationId: LinkIncident parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RelationshipToIncidentRequest' + $ref: "#/components/schemas/RelationshipToIncidentRequest" description: Incident link request required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/CaseResponse' + $ref: "#/components/schemas/CaseResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Link incident to case tags: - - Case Management - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Case Management + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/cases/{case_id}/relationships/jira_issues: delete: description: Remove the link between a Jira issue and a case operationId: UnlinkJiraIssue parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" responses: - '204': + "204": description: No Content - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Remove Jira issue link from case tags: - - Case Management - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Case Management + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: description: Link an existing Jira issue to a case operationId: LinkJiraIssueToCase parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/JiraIssueLinkRequest' + $ref: "#/components/schemas/JiraIssueLinkRequest" description: Jira issue link request required: true responses: - '204': + "204": description: No Content - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Conflict - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Link existing Jira issue to case tags: - - Case Management - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Case Management + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Create a new Jira issue and link it to a case operationId: CreateCaseJiraIssue parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/JiraIssueCreateRequest' + $ref: "#/components/schemas/JiraIssueCreateRequest" description: Jira issue creation request required: true responses: - '202': + "202": description: Accepted - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Create Jira issue for case tags: - - Case Management - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Case Management + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/cases/{case_id}/relationships/notebook: post: description: Create a new investigation notebook and link it to a case operationId: CreateCaseNotebook parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/NotebookCreateRequest' + $ref: "#/components/schemas/NotebookCreateRequest" description: Notebook creation request required: true responses: - '204': + "204": description: No Content - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Create investigation notebook for case tags: - - Case Management - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Case Management + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/cases/{case_id}/relationships/project: patch: description: Update the project associated with a case operationId: MoveCaseToProject parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ProjectRelationship' + $ref: "#/components/schemas/ProjectRelationship" description: Project update request required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseResponse' + $ref: "#/components/schemas/CaseResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Update case project tags: - - Case Management - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Case Management + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/cases/{case_id}/relationships/servicenow_tickets: post: description: Create a new ServiceNow incident ticket and link it to a case operationId: CreateCaseServiceNowTicket parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ServiceNowTicketCreateRequest' + $ref: "#/components/schemas/ServiceNowTicketCreateRequest" description: ServiceNow ticket creation request required: true responses: - '202': + "202": description: Accepted - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Create ServiceNow ticket for case tags: - - Case Management - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Case Management + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/cases/{case_id}/status: post: description: Update case status operationId: UpdateStatus parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseUpdateStatusRequest' + $ref: "#/components/schemas/CaseUpdateStatusRequest" description: Case status update payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseResponse' + $ref: "#/components/schemas/CaseResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Update case status tags: - - Case Management + - Case Management /api/v2/cases/{case_id}/title: post: description: Update case title operationId: UpdateCaseTitle parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseUpdateTitleRequest' + $ref: "#/components/schemas/CaseUpdateTitleRequest" description: Case title update payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseResponse' + $ref: "#/components/schemas/CaseResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Update case title tags: - - Case Management + - Case Management /api/v2/cases/{case_id}/unarchive: post: description: Unarchive case operationId: UnarchiveCase parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseEmptyRequest' + $ref: "#/components/schemas/CaseEmptyRequest" description: Unarchive case payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseResponse' + $ref: "#/components/schemas/CaseResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Unarchive case tags: - - Case Management + - Case Management /api/v2/cases/{case_id}/unassign: post: description: Unassign case operationId: UnassignCase parameters: - - $ref: '#/components/parameters/CaseIDPathParameter' + - $ref: "#/components/parameters/CaseIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CaseEmptyRequest' + $ref: "#/components/schemas/CaseEmptyRequest" description: Unassign case payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CaseResponse' + $ref: "#/components/schemas/CaseResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Unassign case tags: - - Case Management + - Case Management /api/v2/catalog/entity: get: description: Get a list of entities from Software Catalog. operationId: ListCatalogEntity parameters: - - $ref: '#/components/parameters/PageOffset' - - description: Maximum number of entities in the response. - example: 100 - in: query - name: page[limit] - required: false - schema: - default: 100 - format: int64 - type: integer - - $ref: '#/components/parameters/FilterByID' - - $ref: '#/components/parameters/FilterByRef' - - $ref: '#/components/parameters/FilterByName' - - $ref: '#/components/parameters/FilterByKind' - - $ref: '#/components/parameters/FilterByOwner' - - $ref: '#/components/parameters/FilterByRelationType' - - $ref: '#/components/parameters/FilterByExcludeSnapshot' - - $ref: '#/components/parameters/Include' - - description: If true, includes discovered services from APM and USM that do - not have entity definitions. - in: query - name: includeDiscovered - required: false - schema: - default: false - type: boolean + - $ref: "#/components/parameters/PageOffset" + - description: Maximum number of entities in the response. + example: 100 + in: query + name: page[limit] + required: false + schema: + default: 100 + format: int64 + type: integer + - $ref: "#/components/parameters/FilterByID" + - $ref: "#/components/parameters/FilterByRef" + - $ref: "#/components/parameters/FilterByName" + - $ref: "#/components/parameters/FilterByKind" + - $ref: "#/components/parameters/FilterByOwner" + - $ref: "#/components/parameters/FilterByRelationType" + - $ref: "#/components/parameters/FilterByExcludeSnapshot" + - $ref: "#/components/parameters/Include" + - description: If true, includes discovered services from APM and USM that do not have entity definitions. + in: query + name: includeDiscovered + required: false + schema: + default: false + type: boolean responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListEntityCatalogResponse' + $ref: "#/components/schemas/ListEntityCatalogResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_read summary: Get a list of entities tags: - - Software Catalog + - Software Catalog x-pagination: limitParam: page[limit] pageOffsetParam: page[offset] @@ -78727,114 +75079,114 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpsertCatalogEntityRequest' + $ref: "#/components/schemas/UpsertCatalogEntityRequest" description: Entity YAML or JSON. required: true responses: - '202': + "202": content: application/json: schema: - $ref: '#/components/schemas/UpsertCatalogEntityResponse' + $ref: "#/components/schemas/UpsertCatalogEntityResponse" description: ACCEPTED - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_write summary: Create or update entities tags: - - Software Catalog + - Software Catalog x-codegen-request-body-name: body /api/v2/catalog/entity/preview: post: operationId: PreviewCatalogEntities responses: - '202': + "202": content: application/json: schema: - $ref: '#/components/schemas/EntityResponseArray' + $ref: "#/components/schemas/EntityResponseArray" description: Accepted - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_read summary: Preview catalog entities tags: - - Software Catalog + - Software Catalog /api/v2/catalog/entity/{entity_id}: delete: description: Delete a single entity in Software Catalog. operationId: DeleteCatalogEntity parameters: - - $ref: '#/components/parameters/EntityID' + - $ref: "#/components/parameters/EntityID" responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_write summary: Delete a single entity tags: - - Software Catalog + - Software Catalog /api/v2/catalog/kind: get: description: Get a list of entity kinds from Software Catalog. operationId: ListCatalogKind parameters: - - $ref: '#/components/parameters/PageOffset' - - description: Maximum number of kinds in the response. - example: 100 - in: query - name: page[limit] - required: false - schema: - default: 100 - format: int64 - type: integer - - $ref: '#/components/parameters/FilterByID' - - $ref: '#/components/parameters/FilterByName' + - $ref: "#/components/parameters/PageOffset" + - description: Maximum number of kinds in the response. + example: 100 + in: query + name: page[limit] + required: false + schema: + default: 100 + format: int64 + type: integer + - $ref: "#/components/parameters/FilterByID" + - $ref: "#/components/parameters/FilterByName" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListKindCatalogResponse' + $ref: "#/components/schemas/ListKindCatalogResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_read summary: Get a list of entity kinds tags: - - Software Catalog + - Software Catalog x-pagination: limitParam: page[limit] pageOffsetParam: page[offset] @@ -78846,101 +75198,101 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpsertCatalogKindRequest' + $ref: "#/components/schemas/UpsertCatalogKindRequest" description: Kind YAML or JSON. required: true responses: - '202': + "202": content: application/json: schema: - $ref: '#/components/schemas/UpsertCatalogKindResponse' + $ref: "#/components/schemas/UpsertCatalogKindResponse" description: ACCEPTED - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_write summary: Create or update kinds tags: - - Software Catalog + - Software Catalog x-codegen-request-body-name: body /api/v2/catalog/kind/{kind_id}: delete: description: Delete a single kind in Software Catalog. operationId: DeleteCatalogKind parameters: - - $ref: '#/components/parameters/KindID' + - $ref: "#/components/parameters/KindID" responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_write summary: Delete a single kind tags: - - Software Catalog + - Software Catalog /api/v2/catalog/relation: get: description: Get a list of entity relations from Software Catalog. operationId: ListCatalogRelation parameters: - - $ref: '#/components/parameters/PageOffset' - - description: Maximum number of relations in the response. - example: 100 - in: query - name: page[limit] - required: false - schema: - default: 100 - format: int64 - type: integer - - $ref: '#/components/parameters/FilterRelationByType' - - $ref: '#/components/parameters/FilterRelationByFromRef' - - $ref: '#/components/parameters/FilterRelationByToRef' - - $ref: '#/components/parameters/RelationInclude' - - description: If true, includes relationships discovered by APM and USM. - in: query - name: includeDiscovered - required: false - schema: - default: false - type: boolean + - $ref: "#/components/parameters/PageOffset" + - description: Maximum number of relations in the response. + example: 100 + in: query + name: page[limit] + required: false + schema: + default: 100 + format: int64 + type: integer + - $ref: "#/components/parameters/FilterRelationByType" + - $ref: "#/components/parameters/FilterRelationByFromRef" + - $ref: "#/components/parameters/FilterRelationByToRef" + - $ref: "#/components/parameters/RelationInclude" + - description: If true, includes relationships discovered by APM and USM. + in: query + name: includeDiscovered + required: false + schema: + default: false + type: boolean responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListRelationCatalogResponse' + $ref: "#/components/schemas/ListRelationCatalogResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_read summary: Get a list of entity relations tags: - - Software Catalog + - Software Catalog x-pagination: limitParam: page[limit] pageOffsetParam: page[offset] @@ -78953,1239 +75305,1197 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ChangeRequestCreateRequest' + $ref: "#/components/schemas/ChangeRequestCreateRequest" description: Change request payload. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/ChangeRequestResponse' + $ref: "#/components/schemas/ChangeRequestResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Create a change request tags: - - Change Management - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Change Management + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/change-management/change-request/{change_request_id}: get: description: Get the details of a change request by its ID. operationId: GetChangeRequest parameters: - - $ref: '#/components/parameters/ChangeRequestIDPathParameter' + - $ref: "#/components/parameters/ChangeRequestIDPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ChangeRequestResponse' + $ref: "#/components/schemas/ChangeRequestResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_read summary: Get a change request tags: - - Change Management - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Change Management + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: description: Update the properties of a change request. operationId: UpdateChangeRequest parameters: - - $ref: '#/components/parameters/ChangeRequestIDPathParameter' + - $ref: "#/components/parameters/ChangeRequestIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ChangeRequestUpdateRequest' + $ref: "#/components/schemas/ChangeRequestUpdateRequest" description: Change request update payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ChangeRequestResponse' + $ref: "#/components/schemas/ChangeRequestResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Update a change request tags: - - Change Management - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Change Management + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/change-management/change-request/{change_request_id}/branch: post: description: Create a new branch in a repository for a change request. operationId: CreateChangeRequestBranch parameters: - - $ref: '#/components/parameters/ChangeRequestIDPathParameter' + - $ref: "#/components/parameters/ChangeRequestIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ChangeRequestBranchCreateRequest' + $ref: "#/components/schemas/ChangeRequestBranchCreateRequest" description: Branch creation payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ChangeRequestResponse' + $ref: "#/components/schemas/ChangeRequestResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Create a change request branch tags: - - Change Management - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Change Management + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/change-management/change-request/{change_request_id}/decisions/{decision_id}: delete: description: Delete a decision from a change request. operationId: DeleteChangeRequestDecision parameters: - - $ref: '#/components/parameters/ChangeRequestIDPathParameter' - - $ref: '#/components/parameters/ChangeRequestDecisionIDPathParameter' + - $ref: "#/components/parameters/ChangeRequestIDPathParameter" + - $ref: "#/components/parameters/ChangeRequestDecisionIDPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ChangeRequestResponse' + $ref: "#/components/schemas/ChangeRequestResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Delete a change request decision tags: - - Change Management - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Change Management + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: - description: Update a decision on a change request, such as approving or declining - it. + description: Update a decision on a change request, such as approving or declining it. operationId: UpdateChangeRequestDecision parameters: - - $ref: '#/components/parameters/ChangeRequestIDPathParameter' - - $ref: '#/components/parameters/ChangeRequestDecisionIDPathParameter' + - $ref: "#/components/parameters/ChangeRequestIDPathParameter" + - $ref: "#/components/parameters/ChangeRequestDecisionIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ChangeRequestDecisionUpdateRequest' + $ref: "#/components/schemas/ChangeRequestDecisionUpdateRequest" description: Decision update payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ChangeRequestResponse' + $ref: "#/components/schemas/ChangeRequestResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Update a change request decision tags: - - Change Management - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Change Management + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/ci/pipeline: post: - description: 'Send your pipeline event to your Datadog platform over HTTP. For - details about how pipeline executions are modeled and what execution types - we support, see [Pipeline Data Model And Execution Types](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/). - + description: |- + Send your pipeline event to your Datadog platform over HTTP. For details about how pipeline executions are modeled and what execution types we support, see [Pipeline Data Model And Execution Types](https://docs.datadoghq.com/continuous_integration/guides/pipeline_data_model/). Multiple events can be sent in an array (up to 1000). - - Pipeline events can be submitted with a timestamp that is up to 18 hours in - the past. - - The duration between the event start and end times cannot exceed 1 year.' + Pipeline events can be submitted with a timestamp that is up to 18 hours in the past. + The duration between the event start and end times cannot exceed 1 year. operationId: CreateCIAppPipelineEvent requestBody: content: application/json: schema: - $ref: '#/components/schemas/CIAppCreatePipelineEventRequest' + $ref: "#/components/schemas/CIAppCreatePipelineEventRequest" required: true responses: - '202': + "202": content: application/json: schema: type: object description: Request accepted for processing - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Forbidden - '408': + "408": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Request Timeout - '413': + "413": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Payload Too Large - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Too Many Requests - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Internal Server Error - '503': + "503": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Service Unavailable security: - - apiKeyAuth: [] + - apiKeyAuth: [] summary: Send pipeline event - tags: - - CI Visibility Pipelines + tags: ["CI Visibility Pipelines"] x-codegen-request-body-name: body /api/v2/ci/pipelines/analytics/aggregate: post: - description: Use this API endpoint to aggregate CI Visibility pipeline events - into buckets of computed metrics and timeseries. + description: |- + Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries. operationId: AggregateCIAppPipelineEvents requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CIAppPipelinesAggregateRequest' + $ref: "#/components/schemas/CIAppPipelinesAggregateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CIAppPipelinesAnalyticsAggregateResponse' + $ref: "#/components/schemas/CIAppPipelinesAnalyticsAggregateResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - ci_visibility_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - ci_visibility_read summary: Aggregate pipelines events - tags: - - CI Visibility Pipelines + tags: ["CI Visibility Pipelines"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - ci_visibility_read + - ci_visibility_read /api/v2/ci/pipelines/events: get: - description: 'List endpoint returns CI Visibility pipeline events that match - a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/). - + description: |- + List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/). [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). - - Use this endpoint to see your latest pipeline events.' + Use this endpoint to see your latest pipeline events. operationId: ListCIAppPipelineEvents parameters: - - description: Search query following log syntax. - example: '@ci.provider.name:github @ci.pipeline.name:Pull Request Labeler' - in: query - name: filter[query] - required: false - schema: - type: string - - description: Minimum timestamp for requested events. - example: '2019-01-02T09:42:36.320Z' - in: query - name: filter[from] - required: false - schema: - format: date-time - type: string - - description: Maximum timestamp for requested events. - example: '2019-01-03T09:42:36.320Z' - in: query - name: filter[to] - required: false - schema: - format: date-time - type: string - - description: Order of events in results. - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/CIAppSort' - - description: List following results with a cursor provided in the previous - query. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== - in: query - name: page[cursor] - required: false - schema: - type: string - - description: Maximum number of events in the response. - example: 25 - in: query - name: page[limit] - required: false - schema: - default: 10 - format: int32 - maximum: 1000 - type: integer + - description: Search query following log syntax. + example: "@ci.provider.name:github @ci.pipeline.name:Pull Request Labeler" + in: query + name: filter[query] + required: false + schema: + type: string + - description: Minimum timestamp for requested events. + example: "2019-01-02T09:42:36.320Z" + in: query + name: filter[from] + required: false + schema: + format: date-time + type: string + - description: Maximum timestamp for requested events. + example: "2019-01-03T09:42:36.320Z" + in: query + name: filter[to] + required: false + schema: + format: date-time + type: string + - description: Order of events in results. + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/CIAppSort" + - description: |- + List following results with a cursor provided in the previous query. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" + in: query + name: page[cursor] + required: false + schema: + type: string + - description: Maximum number of events in the response. + example: 25 + in: query + name: page[limit] + required: false + schema: + default: 10 + format: int32 + maximum: 1000 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CIAppPipelineEventsResponse' + $ref: "#/components/schemas/CIAppPipelineEventsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - ci_visibility_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - ci_visibility_read summary: Get a list of pipelines events - tags: - - CI Visibility Pipelines + tags: ["CI Visibility Pipelines"] x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - ci_visibility_read + - ci_visibility_read /api/v2/ci/pipelines/events/search: post: - description: 'List endpoint returns CI Visibility pipeline events that match - a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/). - + description: |- + List endpoint returns CI Visibility pipeline events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/). [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). - - Use this endpoint to build complex events filtering and search.' + Use this endpoint to build complex events filtering and search. operationId: SearchCIAppPipelineEvents requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CIAppPipelineEventsRequest' + $ref: "#/components/schemas/CIAppPipelineEventsRequest" required: false responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CIAppPipelineEventsResponse' + $ref: "#/components/schemas/CIAppPipelineEventsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - ci_visibility_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - ci_visibility_read summary: Search pipelines events - tags: - - CI Visibility Pipelines + tags: ["CI Visibility Pipelines"] x-codegen-request-body-name: body x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - ci_visibility_read + - ci_visibility_read /api/v2/ci/tests/analytics/aggregate: post: - description: The API endpoint to aggregate CI Visibility test events into buckets - of computed metrics and timeseries. + description: |- + The API endpoint to aggregate CI Visibility test events into buckets of computed metrics and timeseries. operationId: AggregateCIAppTestEvents requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CIAppTestsAggregateRequest' + $ref: "#/components/schemas/CIAppTestsAggregateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CIAppTestsAnalyticsAggregateResponse' + $ref: "#/components/schemas/CIAppTestsAnalyticsAggregateResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - ci_visibility_read - - AuthZ: - - test_optimization_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - ci_visibility_read + - AuthZ: + - test_optimization_read summary: Aggregate tests events - tags: - - CI Visibility Tests + tags: ["CI Visibility Tests"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - ci_visibility_read - - test_optimization_read + - ci_visibility_read + - test_optimization_read /api/v2/ci/tests/events: get: - description: 'List endpoint returns CI Visibility test events that match a [search - query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/). - + description: |- + List endpoint returns CI Visibility test events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/). [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). - - Use this endpoint to see your latest test events.' + Use this endpoint to see your latest test events. operationId: ListCIAppTestEvents parameters: - - description: Search query following log syntax. - example: '@test.name:test_foo @test.suite:github.com/DataDog/dd-go/model' - in: query - name: filter[query] - required: false - schema: - type: string - - description: Minimum timestamp for requested events. - example: '2019-01-02T09:42:36.320Z' - in: query - name: filter[from] - required: false - schema: - format: date-time - type: string - - description: Maximum timestamp for requested events. - example: '2019-01-03T09:42:36.320Z' - in: query - name: filter[to] - required: false - schema: - format: date-time - type: string - - description: Order of events in results. - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/CIAppSort' - - description: List following results with a cursor provided in the previous - query. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== - in: query - name: page[cursor] - required: false - schema: - type: string - - description: Maximum number of events in the response. - example: 25 - in: query - name: page[limit] - required: false - schema: - default: 10 - format: int32 - maximum: 1000 - type: integer + - description: Search query following log syntax. + example: "@test.name:test_foo @test.suite:github.com/DataDog/dd-go/model" + in: query + name: filter[query] + required: false + schema: + type: string + - description: Minimum timestamp for requested events. + example: "2019-01-02T09:42:36.320Z" + in: query + name: filter[from] + required: false + schema: + format: date-time + type: string + - description: Maximum timestamp for requested events. + example: "2019-01-03T09:42:36.320Z" + in: query + name: filter[to] + required: false + schema: + format: date-time + type: string + - description: Order of events in results. + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/CIAppSort" + - description: |- + List following results with a cursor provided in the previous query. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" + in: query + name: page[cursor] + required: false + schema: + type: string + - description: Maximum number of events in the response. + example: 25 + in: query + name: page[limit] + required: false + schema: + default: 10 + format: int32 + maximum: 1000 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CIAppTestEventsResponse' + $ref: "#/components/schemas/CIAppTestEventsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - ci_visibility_read - - AuthZ: - - test_optimization_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - ci_visibility_read + - AuthZ: + - test_optimization_read summary: Get a list of tests events - tags: - - CI Visibility Tests + tags: ["CI Visibility Tests"] x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - ci_visibility_read - - test_optimization_read + - ci_visibility_read + - test_optimization_read /api/v2/ci/tests/events/search: post: - description: 'List endpoint returns CI Visibility test events that match a [search - query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/). - + description: |- + List endpoint returns CI Visibility test events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/). [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). - - Use this endpoint to build complex events filtering and search.' + Use this endpoint to build complex events filtering and search. operationId: SearchCIAppTestEvents requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CIAppTestEventsRequest' + $ref: "#/components/schemas/CIAppTestEventsRequest" required: false responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CIAppTestEventsResponse' + $ref: "#/components/schemas/CIAppTestEventsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - ci_visibility_read - - AuthZ: - - test_optimization_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - ci_visibility_read + - AuthZ: + - test_optimization_read summary: Search tests events - tags: - - CI Visibility Tests + tags: ["CI Visibility Tests"] x-codegen-request-body-name: body x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - ci_visibility_read - - test_optimization_read + - ci_visibility_read + - test_optimization_read /api/v2/cloud_auth/aws/persona_mapping: get: - description: List all AWS cloud authentication persona mappings. This endpoint - retrieves all configured persona mappings that associate AWS IAM principals - with Datadog users. + description: List all AWS cloud authentication persona mappings. This endpoint retrieves all configured persona mappings that associate AWS IAM principals with Datadog users. operationId: ListAWSCloudAuthPersonaMappings responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSCloudAuthPersonaMappingsResponse' + $ref: "#/components/schemas/AWSCloudAuthPersonaMappingsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List AWS cloud authentication persona mappings tags: - - Cloud Authentication - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Cloud Authentication + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: - description: Create an AWS cloud authentication persona mapping. This endpoint - associates an AWS IAM principal with a Datadog user. + description: Create an AWS cloud authentication persona mapping. This endpoint associates an AWS IAM principal with a Datadog user. operationId: CreateAWSCloudAuthPersonaMapping requestBody: content: application/json: schema: - $ref: '#/components/schemas/AWSCloudAuthPersonaMappingCreateRequest' + $ref: "#/components/schemas/AWSCloudAuthPersonaMappingCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/AWSCloudAuthPersonaMappingResponse' + $ref: "#/components/schemas/AWSCloudAuthPersonaMappingResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Conflict - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an AWS cloud authentication persona mapping tags: - - Cloud Authentication + - Cloud Authentication x-codegen-request-body-name: body - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/cloud_auth/aws/persona_mapping/{persona_mapping_id}: delete: - description: Delete an AWS cloud authentication persona mapping by ID. This - removes the association between an AWS IAM principal and a Datadog user. + description: Delete an AWS cloud authentication persona mapping by ID. This removes the association between an AWS IAM principal and a Datadog user. operationId: DeleteAWSCloudAuthPersonaMapping parameters: - - $ref: '#/components/parameters/PersonaMappingID' + - $ref: "#/components/parameters/PersonaMappingID" responses: - '204': + "204": description: No Content - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an AWS cloud authentication persona mapping tags: - - Cloud Authentication - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Cloud Authentication + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: - description: Get a specific AWS cloud authentication persona mapping by ID. - This endpoint retrieves a single configured persona mapping that associates - an AWS IAM principal with a Datadog user. + description: Get a specific AWS cloud authentication persona mapping by ID. This endpoint retrieves a single configured persona mapping that associates an AWS IAM principal with a Datadog user. operationId: GetAWSCloudAuthPersonaMapping parameters: - - $ref: '#/components/parameters/PersonaMappingID' + - $ref: "#/components/parameters/PersonaMappingID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSCloudAuthPersonaMappingResponse' + $ref: "#/components/schemas/AWSCloudAuthPersonaMappingResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get an AWS cloud authentication persona mapping tags: - - Cloud Authentication - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Cloud Authentication + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/cloud_security_management/custom_frameworks: post: description: Create a custom framework. operationId: CreateCustomFramework requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CreateCustomFrameworkRequest' + $ref: "#/components/schemas/CreateCustomFrameworkRequest" required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CreateCustomFrameworkResponse' + $ref: "#/components/schemas/CreateCustomFrameworkResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': - $ref: '#/components/responses/BadRequestResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": + $ref: "#/components/responses/BadRequestResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_read - - security_monitoring_rules_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_read + - security_monitoring_rules_write summary: Create a custom framework - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: AND permissions: - - security_monitoring_rules_read - - security_monitoring_rules_write + - security_monitoring_rules_read + - security_monitoring_rules_write /api/v2/cloud_security_management/custom_frameworks/{handle}/{version}: delete: description: Delete a custom framework. operationId: DeleteCustomFramework parameters: - - $ref: '#/components/parameters/CustomFrameworkHandle' - - $ref: '#/components/parameters/CustomFrameworkVersion' + - $ref: "#/components/parameters/CustomFrameworkHandle" + - $ref: "#/components/parameters/CustomFrameworkVersion" responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/DeleteCustomFrameworkResponse' + $ref: "#/components/schemas/DeleteCustomFrameworkResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': - $ref: '#/components/responses/BadRequestResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": + $ref: "#/components/responses/BadRequestResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_read - - security_monitoring_rules_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_read + - security_monitoring_rules_write summary: Delete a custom framework - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: AND permissions: - - security_monitoring_rules_read - - security_monitoring_rules_write + - security_monitoring_rules_read + - security_monitoring_rules_write get: description: Get a custom framework. operationId: GetCustomFramework parameters: - - $ref: '#/components/parameters/CustomFrameworkHandle' - - $ref: '#/components/parameters/CustomFrameworkVersion' + - $ref: "#/components/parameters/CustomFrameworkHandle" + - $ref: "#/components/parameters/CustomFrameworkVersion" responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/GetCustomFrameworkResponse' + $ref: "#/components/schemas/GetCustomFrameworkResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': - $ref: '#/components/responses/BadRequestResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": + $ref: "#/components/responses/BadRequestResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_read summary: Get a custom framework - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_rules_read + - security_monitoring_rules_read put: description: Update a custom framework. operationId: UpdateCustomFramework parameters: - - $ref: '#/components/parameters/CustomFrameworkHandle' - - $ref: '#/components/parameters/CustomFrameworkVersion' + - $ref: "#/components/parameters/CustomFrameworkHandle" + - $ref: "#/components/parameters/CustomFrameworkVersion" requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/UpdateCustomFrameworkRequest' + $ref: "#/components/schemas/UpdateCustomFrameworkRequest" required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/UpdateCustomFrameworkResponse' + $ref: "#/components/schemas/UpdateCustomFrameworkResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': - $ref: '#/components/responses/BadRequestResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": + $ref: "#/components/responses/BadRequestResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_read - - security_monitoring_rules_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_read + - security_monitoring_rules_write summary: Update a custom framework - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: AND permissions: - - security_monitoring_rules_read - - security_monitoring_rules_write + - security_monitoring_rules_read + - security_monitoring_rules_write /api/v2/cloud_security_management/resource_filters: get: description: List resource filters. operationId: GetResourceEvaluationFilters parameters: - - $ref: '#/components/parameters/ResourceFilterProvider' - - $ref: '#/components/parameters/ResourceFilterAccountID' - - $ref: '#/components/parameters/SkipCache' + - $ref: "#/components/parameters/ResourceFilterProvider" + - $ref: "#/components/parameters/ResourceFilterAccountID" + - $ref: "#/components/parameters/SkipCache" responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/GetResourceEvaluationFiltersResponse' + $ref: "#/components/schemas/GetResourceEvaluationFiltersResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_filters_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_filters_read summary: List resource filters - tags: - - Security Monitoring - x-permission: + tags: ["Security Monitoring"] + "x-permission": operator: OR permissions: - - security_monitoring_filters_read + - security_monitoring_filters_read put: description: Update resource filters. operationId: UpdateResourceEvaluationFilters requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/UpdateResourceEvaluationFiltersRequest' + $ref: "#/components/schemas/UpdateResourceEvaluationFiltersRequest" required: true responses: - '201': + "201": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/UpdateResourceEvaluationFiltersResponse' + $ref: "#/components/schemas/UpdateResourceEvaluationFiltersResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_filters_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_filters_write summary: Update resource filters - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_filters_write + - security_monitoring_filters_write /api/v2/code-coverage/branch/summary: post: - description: 'Retrieve aggregated code coverage statistics for a specific branch - in a repository. - + description: |- + Retrieve aggregated code coverage statistics for a specific branch in a repository. This endpoint provides overall coverage metrics as well as breakdowns by service - - and code owner.' + and code owner. operationId: GetCodeCoverageBranchSummary requestBody: content: application/json: schema: - $ref: '#/components/schemas/BranchCoverageSummaryRequest' + $ref: "#/components/schemas/BranchCoverageSummaryRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CoverageSummaryResponse' + $ref: "#/components/schemas/CoverageSummaryResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Internal server error security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - code_coverage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - code_coverage_read summary: Get code coverage summary for a branch - tags: - - Code Coverage + tags: ["Code Coverage"] x-codegen-request-body-name: body x-permission: operator: OR permissions: - - code_coverage_read - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - code_coverage_read + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/code-coverage/commit/summary: post: - description: 'Retrieve aggregated code coverage statistics for a specific commit - in a repository. - + description: |- + Retrieve aggregated code coverage statistics for a specific commit in a repository. This endpoint provides overall coverage metrics as well as breakdowns by service - and code owner. - - The commit SHA must be a 40-character hexadecimal string (SHA-1 hash).' + The commit SHA must be a 40-character hexadecimal string (SHA-1 hash). operationId: GetCodeCoverageCommitSummary requestBody: content: application/json: schema: - $ref: '#/components/schemas/CommitCoverageSummaryRequest' + $ref: "#/components/schemas/CommitCoverageSummaryRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CoverageSummaryResponse' + $ref: "#/components/schemas/CoverageSummaryResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Internal server error security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - code_coverage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - code_coverage_read summary: Get code coverage summary for a commit - tags: - - Code Coverage + tags: ["Code Coverage"] x-codegen-request-body-name: body x-permission: operator: OR permissions: - - code_coverage_read - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - code_coverage_read + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/container_images: get: - description: 'Get all Container Images for your organization. - - **Note**: To enrich the data returned by this endpoint with security scans, - see the new [api/v2/security/scanned-assets-metadata](https://docs.datadoghq.com/api/latest/security-monitoring/#list-scanned-assets-metadata) - endpoint.' + description: |- + Get all Container Images for your organization. + **Note**: To enrich the data returned by this endpoint with security scans, see the new [api/v2/security/scanned-assets-metadata](https://docs.datadoghq.com/api/latest/security-monitoring/#list-scanned-assets-metadata) endpoint. operationId: ListContainerImages parameters: - - description: Comma-separated list of tags to filter Container Images by. - example: short_image:redis,status:running - in: query - name: filter[tags] - required: false - schema: - type: string - - description: Comma-separated list of tags to group Container Images by. - example: registry,image_tags - in: query - name: group_by - required: false - schema: - type: string - - description: Attribute to sort Container Images by. - example: container_count - in: query - name: sort - required: false - schema: - type: string - - description: Maximum number of results returned. - in: query - name: page[size] - required: false - schema: - default: 1000 - format: int32 - maximum: 10000 - minimum: 1 - type: integer - - description: 'String to query the next page of results. - - This key is provided with each valid response from the API in `meta.pagination.next_cursor`.' - in: query - name: page[cursor] - required: false - schema: - type: string + - description: Comma-separated list of tags to filter Container Images by. + example: short_image:redis,status:running + in: query + name: filter[tags] + required: false + schema: + type: string + - description: Comma-separated list of tags to group Container Images by. + example: registry,image_tags + in: query + name: group_by + required: false + schema: + type: string + - description: Attribute to sort Container Images by. + example: container_count + in: query + name: sort + required: false + schema: + type: string + - description: Maximum number of results returned. + in: query + name: page[size] + required: false + schema: + default: 1000 + format: int32 + maximum: 10000 + minimum: 1 + type: integer + - description: |- + String to query the next page of results. + This key is provided with each valid response from the API in `meta.pagination.next_cursor`. + in: query + name: page[cursor] + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ContainerImagesResponse' + $ref: "#/components/schemas/ContainerImagesResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get all Container Images tags: - - Container Images + - Container Images x-pagination: cursorParam: page[cursor] cursorPath: meta.pagination.next_cursor limitParam: page[size] resultsPath: data - x-permission: + "x-permission": operator: OPEN permissions: [] /api/v2/containers: @@ -80193,337 +76503,303 @@ paths: description: Get all containers for your organization. operationId: ListContainers parameters: - - description: Comma-separated list of tags to filter containers by. - example: env:prod,short_image:cassandra - in: query - name: filter[tags] - required: false - schema: - type: string - - description: Comma-separated list of tags to group containers by. - example: datacenter,cluster - in: query - name: group_by - required: false - schema: - type: string - - description: Attribute to sort containers by. - example: started_at - in: query - name: sort - required: false - schema: - type: string - - description: Maximum number of results returned. - in: query - name: page[size] - required: false - schema: - default: 1000 - format: int32 - maximum: 10000 - minimum: 1 - type: integer - - description: 'String to query the next page of results. - - This key is provided with each valid response from the API in `meta.pagination.next_cursor`.' - in: query - name: page[cursor] - required: false - schema: - type: string + - description: Comma-separated list of tags to filter containers by. + example: env:prod,short_image:cassandra + in: query + name: filter[tags] + required: false + schema: + type: string + - description: Comma-separated list of tags to group containers by. + example: datacenter,cluster + in: query + name: group_by + required: false + schema: + type: string + - description: Attribute to sort containers by. + example: started_at + in: query + name: sort + required: false + schema: + type: string + - description: Maximum number of results returned. + in: query + name: page[size] + required: false + schema: + default: 1000 + format: int32 + maximum: 10000 + minimum: 1 + type: integer + - description: |- + String to query the next page of results. + This key is provided with each valid response from the API in `meta.pagination.next_cursor`. + in: query + name: page[cursor] + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ContainersResponse' + $ref: "#/components/schemas/ContainersResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get All Containers tags: - - Containers + - Containers x-pagination: cursorParam: page[cursor] cursorPath: meta.pagination.next_cursor limitParam: page[size] resultsPath: data - x-permission: + "x-permission": operator: OPEN permissions: [] /api/v2/cost/arbitrary_rule: get: - description: List all custom allocation rules - Retrieve a list of all custom - allocation rules for the organization + description: List all custom allocation rules - Retrieve a list of all custom allocation rules for the organization operationId: ListCustomAllocationRules responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ArbitraryRuleResponseArray' + $ref: "#/components/schemas/ArbitraryRuleResponseArray" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: List custom allocation rules tags: - - Cloud Cost Management + - Cloud Cost Management post: - description: 'Create a new custom allocation rule with the specified filters - and allocation strategy. - + description: |- + Create a new custom allocation rule with the specified filters and allocation strategy. **Strategy Methods:** - - - **PROPORTIONAL/EVEN**: Allocates costs proportionally/evenly based on existing - costs. Requires: granularity, allocated_by_tag_keys. Optional: based_on_costs, - allocated_by_filters, evaluate_grouped_by_tag_keys, evaluate_grouped_by_filters. - - - **PROPORTIONAL_TIMESERIES/EVEN_TIMESERIES**: Allocates based on timeseries - data. Requires: granularity, based_on_timeseries. Optional: evaluate_grouped_by_tag_keys. - - - **PERCENT**: Allocates fixed percentages to specific tags. Requires: allocated_by - (array of percentage allocations). - + - **PROPORTIONAL/EVEN**: Allocates costs proportionally/evenly based on existing costs. Requires: granularity, allocated_by_tag_keys. Optional: based_on_costs, allocated_by_filters, evaluate_grouped_by_tag_keys, evaluate_grouped_by_filters. + - **PROPORTIONAL_TIMESERIES/EVEN_TIMESERIES**: Allocates based on timeseries data. Requires: granularity, based_on_timeseries. Optional: evaluate_grouped_by_tag_keys. + - **PERCENT**: Allocates fixed percentages to specific tags. Requires: allocated_by (array of percentage allocations). **Filter Conditions:** - - - Use **value** for single-value conditions: "is", "is not", "contains", "does - not contain", "=", "!=", "like", "not like", "is all values", "is untagged" - + - Use **value** for single-value conditions: "is", "is not", "contains", "does not contain", "=", "!=", "like", "not like", "is all values", "is untagged" - Use **values** for multi-value conditions: "in", "not in" - - Cannot use both value and values simultaneously. - - **Supported operators**: is, is not, is all values, is untagged, contains, - does not contain, in, not in, =, !=, like, not like' + **Supported operators**: is, is not, is all values, is untagged, contains, does not contain, in, not in, =, !=, like, not like operationId: CreateCustomAllocationRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/ArbitraryCostUpsertRequest' + $ref: "#/components/schemas/ArbitraryCostUpsertRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ArbitraryRuleResponse' + $ref: "#/components/schemas/ArbitraryRuleResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Create custom allocation rule tags: - - Cloud Cost Management + - Cloud Cost Management /api/v2/cost/arbitrary_rule/reorder: post: - description: "Reorder custom allocation rules - Change the execution order of - custom allocation rules.\n\n**Important**: You must provide the **complete - list** of all rule IDs in the desired execution order. The API will reorder - ALL rules according to the provided sequence.\n\nRules are executed in the - order specified, with lower indices (earlier in the array) having higher priority.\n\n**Example**: - If you have rules with IDs [123, 456, 789] and want to change order from 123\u2192456\u2192789 - to 456\u2192123\u2192789, send: [{\"id\": \"456\"}, {\"id\": \"123\"}, {\"id\": - \"789\"}]" + description: |- + Reorder custom allocation rules - Change the execution order of custom allocation rules. + + **Important**: You must provide the **complete list** of all rule IDs in the desired execution order. The API will reorder ALL rules according to the provided sequence. + + Rules are executed in the order specified, with lower indices (earlier in the array) having higher priority. + + **Example**: If you have rules with IDs [123, 456, 789] and want to change order from 123→456→789 to 456→123→789, send: [{"id": "456"}, {"id": "123"}, {"id": "789"}] operationId: ReorderCustomAllocationRules requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReorderRuleResourceArray' + $ref: "#/components/schemas/ReorderRuleResourceArray" required: true responses: - '204': + "204": description: Successfully reordered rules - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Reorder custom allocation rules tags: - - Cloud Cost Management + - Cloud Cost Management /api/v2/cost/arbitrary_rule/{rule_id}: delete: - description: Delete a custom allocation rule - Delete an existing custom allocation - rule by its ID + description: Delete a custom allocation rule - Delete an existing custom allocation rule by its ID operationId: DeleteCustomAllocationRule parameters: - - description: The unique identifier of the custom allocation rule - in: path - name: rule_id - required: true - schema: - format: int64 - type: integer + - description: The unique identifier of the custom allocation rule + in: path + name: rule_id + required: true + schema: + format: int64 + type: integer responses: - '204': + "204": description: No Content - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Delete custom allocation rule tags: - - Cloud Cost Management + - Cloud Cost Management get: - description: Get a specific custom allocation rule - Retrieve a specific custom - allocation rule by its ID + description: Get a specific custom allocation rule - Retrieve a specific custom allocation rule by its ID operationId: GetCustomAllocationRule parameters: - - description: The unique identifier of the custom allocation rule - in: path - name: rule_id - required: true - schema: - format: int64 - type: integer + - description: The unique identifier of the custom allocation rule + in: path + name: rule_id + required: true + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ArbitraryRuleResponse' + $ref: "#/components/schemas/ArbitraryRuleResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: Get custom allocation rule tags: - - Cloud Cost Management + - Cloud Cost Management patch: - description: 'Update an existing custom allocation rule with new filters and - allocation strategy. - + description: |- + Update an existing custom allocation rule with new filters and allocation strategy. **Strategy Methods:** - - - **PROPORTIONAL/EVEN**: Allocates costs proportionally/evenly based on existing - costs. Requires: granularity, allocated_by_tag_keys. Optional: based_on_costs, - allocated_by_filters, evaluate_grouped_by_tag_keys, evaluate_grouped_by_filters. - - - **PROPORTIONAL_TIMESERIES/EVEN_TIMESERIES**: Allocates based on timeseries - data. Requires: granularity, based_on_timeseries. Optional: evaluate_grouped_by_tag_keys. - - - **PERCENT**: Allocates fixed percentages to specific tags. Requires: allocated_by - (array of percentage allocations). - + - **PROPORTIONAL/EVEN**: Allocates costs proportionally/evenly based on existing costs. Requires: granularity, allocated_by_tag_keys. Optional: based_on_costs, allocated_by_filters, evaluate_grouped_by_tag_keys, evaluate_grouped_by_filters. + - **PROPORTIONAL_TIMESERIES/EVEN_TIMESERIES**: Allocates based on timeseries data. Requires: granularity, based_on_timeseries. Optional: evaluate_grouped_by_tag_keys. + - **PERCENT**: Allocates fixed percentages to specific tags. Requires: allocated_by (array of percentage allocations). - **USAGE_METRIC**: Allocates based on usage metrics (implementation varies). - **Filter Conditions:** - - - Use **value** for single-value conditions: "is", "is not", "contains", "does - not contain", "=", "!=", "like", "not like", "is all values", "is untagged" - + - Use **value** for single-value conditions: "is", "is not", "contains", "does not contain", "=", "!=", "like", "not like", "is all values", "is untagged" - Use **values** for multi-value conditions: "in", "not in" - - Cannot use both value and values simultaneously. - - **Supported operators**: is, is not, is all values, is untagged, contains, - does not contain, in, not in, =, !=, like, not like' + **Supported operators**: is, is not, is all values, is untagged, contains, does not contain, in, not in, =, !=, like, not like operationId: UpdateCustomAllocationRule parameters: - - description: The unique identifier of the custom allocation rule - in: path - name: rule_id - required: true - schema: - format: int64 - type: integer + - description: The unique identifier of the custom allocation rule + in: path + name: rule_id + required: true + schema: + format: int64 + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/ArbitraryCostUpsertRequest' + $ref: "#/components/schemas/ArbitraryCostUpsertRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ArbitraryRuleResponse' + $ref: "#/components/schemas/ArbitraryRuleResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Update custom allocation rule tags: - - Cloud Cost Management + - Cloud Cost Management /api/v2/cost/aws_cur_config: get: description: List the AWS CUR configs. operationId: ListCostAWSCURConfigs responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AwsCURConfigsResponse' + $ref: "#/components/schemas/AwsCURConfigsResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: List Cloud Cost Management AWS CUR configs tags: - - Cloud Cost Management - x-permission: + - Cloud Cost Management + "x-permission": operator: OR permissions: - - cloud_cost_management_read + - cloud_cost_management_read post: description: Create a Cloud Cost Management account for an AWS CUR config. operationId: CreateCostAWSCURConfig @@ -80531,180 +76807,179 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AwsCURConfigPostRequest' + $ref: "#/components/schemas/AwsCURConfigPostRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AwsCurConfigResponse' + $ref: "#/components/schemas/AwsCurConfigResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Create Cloud Cost Management AWS CUR config tags: - - Cloud Cost Management - x-permission: + - Cloud Cost Management + "x-permission": operator: OR permissions: - - cloud_cost_management_write + - cloud_cost_management_write /api/v2/cost/aws_cur_config/{cloud_account_id}: delete: description: Archive a Cloud Cost Management Account. operationId: DeleteCostAWSCURConfig parameters: - - $ref: '#/components/parameters/CloudAccountID' + - $ref: "#/components/parameters/CloudAccountID" responses: - '204': + "204": description: No Content - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Delete Cloud Cost Management AWS CUR config tags: - - Cloud Cost Management - x-permission: + - Cloud Cost Management + "x-permission": operator: OR permissions: - - cloud_cost_management_write + - cloud_cost_management_write get: description: Get a specific AWS CUR config. operationId: GetCostAWSCURConfig parameters: - - description: The unique identifier of the cloud account - in: path - name: cloud_account_id - required: true - schema: - format: int64 - type: integer + - description: The unique identifier of the cloud account + in: path + name: cloud_account_id + required: true + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AwsCurConfigResponse' + $ref: "#/components/schemas/AwsCurConfigResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: Get cost AWS CUR config tags: - - Cloud Cost Management + - Cloud Cost Management patch: - description: Update the status (active/archived) and/or account filtering configuration - of an AWS CUR config. + description: Update the status (active/archived) and/or account filtering configuration of an AWS CUR config. operationId: UpdateCostAWSCURConfig parameters: - - $ref: '#/components/parameters/CloudAccountID' + - $ref: "#/components/parameters/CloudAccountID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/AwsCURConfigPatchRequest' + $ref: "#/components/schemas/AwsCURConfigPatchRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AwsCURConfigsResponse' + $ref: "#/components/schemas/AwsCURConfigsResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Update Cloud Cost Management AWS CUR config tags: - - Cloud Cost Management - x-permission: + - Cloud Cost Management + "x-permission": operator: OR permissions: - - cloud_cost_management_write + - cloud_cost_management_write /api/v2/cost/azure_uc_config: get: description: List the Azure configs. operationId: ListCostAzureUCConfigs responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AzureUCConfigsResponse' + $ref: "#/components/schemas/AzureUCConfigsResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: List Cloud Cost Management Azure configs tags: - - Cloud Cost Management - x-permission: + - Cloud Cost Management + "x-permission": operator: OR permissions: - - cloud_cost_management_read + - cloud_cost_management_read post: description: Create a Cloud Cost Management account for an Azure config. operationId: CreateCostAzureUCConfigs @@ -80712,154 +76987,154 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AzureUCConfigPostRequest' + $ref: "#/components/schemas/AzureUCConfigPostRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AzureUCConfigPairsResponse' + $ref: "#/components/schemas/AzureUCConfigPairsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Create Cloud Cost Management Azure configs tags: - - Cloud Cost Management - x-permission: + - Cloud Cost Management + "x-permission": operator: OR permissions: - - cloud_cost_management_write + - cloud_cost_management_write /api/v2/cost/azure_uc_config/{cloud_account_id}: delete: description: Archive a Cloud Cost Management Account. operationId: DeleteCostAzureUCConfig parameters: - - $ref: '#/components/parameters/CloudAccountID' + - $ref: "#/components/parameters/CloudAccountID" responses: - '204': + "204": description: No Content - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Delete Cloud Cost Management Azure config tags: - - Cloud Cost Management - x-permission: + - Cloud Cost Management + "x-permission": operator: OR permissions: - - cloud_cost_management_write + - cloud_cost_management_write get: description: Get a specific Azure config. operationId: GetCostAzureUCConfig parameters: - - description: The unique identifier of the cloud account - in: path - name: cloud_account_id - required: true - schema: - format: int64 - type: integer + - description: The unique identifier of the cloud account + in: path + name: cloud_account_id + required: true + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UCConfigPair' + $ref: "#/components/schemas/UCConfigPair" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: Get cost Azure UC config tags: - - Cloud Cost Management + - Cloud Cost Management patch: description: Update the status of an Azure config (active/archived). operationId: UpdateCostAzureUCConfigs parameters: - - $ref: '#/components/parameters/CloudAccountID' + - $ref: "#/components/parameters/CloudAccountID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/AzureUCConfigPatchRequest' + $ref: "#/components/schemas/AzureUCConfigPatchRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AzureUCConfigPairsResponse' + $ref: "#/components/schemas/AzureUCConfigPairsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Update Cloud Cost Management Azure config tags: - - Cloud Cost Management - x-permission: + - Cloud Cost Management + "x-permission": operator: OR permissions: - - cloud_cost_management_write + - cloud_cost_management_write /api/v2/cost/budget: put: description: Create a new budget or update an existing one. @@ -80868,43 +77143,43 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BudgetWithEntries' + $ref: "#/components/schemas/BudgetWithEntries" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/BudgetWithEntries' + $ref: "#/components/schemas/BudgetWithEntries" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Create or update a budget tags: - - Cloud Cost Management + - Cloud Cost Management /api/v2/cost/budget/csv/validate: post: operationId: ValidateCsvBudget responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ValidationResponse' + $ref: "#/components/schemas/ValidationResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: [] summary: Validate CSV budget tags: - - Cloud Cost Management + - Cloud Cost Management /api/v2/cost/budget/validate: post: description: Validate a budget configuration without creating or modifying it @@ -80913,141 +77188,141 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BudgetValidationRequest' + $ref: "#/components/schemas/BudgetValidationRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/BudgetValidationResponse' + $ref: "#/components/schemas/BudgetValidationResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Validate budget tags: - - Cloud Cost Management + - Cloud Cost Management /api/v2/cost/budget/{budget_id}: delete: description: Delete a budget operationId: DeleteBudget parameters: - - $ref: '#/components/parameters/BudgetID' + - $ref: "#/components/parameters/BudgetID" responses: - '204': + "204": description: No Content - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Delete budget tags: - - Cloud Cost Management + - Cloud Cost Management get: description: Get a budget operationId: GetBudget parameters: - - $ref: '#/components/parameters/BudgetID' + - $ref: "#/components/parameters/BudgetID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/BudgetWithEntries' + $ref: "#/components/schemas/BudgetWithEntries" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get budget tags: - - Cloud Cost Management + - Cloud Cost Management /api/v2/cost/budgets: get: description: List budgets. operationId: ListBudgets responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/BudgetArray' + $ref: "#/components/schemas/BudgetArray" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: List budgets tags: - - Cloud Cost Management + - Cloud Cost Management /api/v2/cost/custom_costs: get: description: List the Custom Costs files. operationId: ListCustomCostsFiles parameters: - - description: Page number for pagination - in: query - name: page[number] - schema: - format: int64 - type: integer - - description: Page size for pagination - in: query - name: page[size] - schema: - default: 100 - format: int64 - type: integer - - description: Filter by file status - in: query - name: filter[status] - schema: - type: string - - description: Sort key with optional descending prefix - in: query - name: sort - schema: - default: created_at - type: string + - description: Page number for pagination + in: query + name: page[number] + schema: + format: int64 + type: integer + - description: Page size for pagination + in: query + name: page[size] + schema: + default: 100 + format: int64 + type: integer + - description: Filter by file status + in: query + name: filter[status] + schema: + type: string + - description: Sort key with optional descending prefix + in: query + name: sort + schema: + default: created_at + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomCostsFileListResponse' + $ref: "#/components/schemas/CustomCostsFileListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: List Custom Costs files tags: - - Cloud Cost Management - x-permission: + - Cloud Cost Management + "x-permission": operator: OR permissions: - - cloud_cost_management_read + - cloud_cost_management_read put: description: Upload a Custom Costs file. operationId: UploadCustomCostsFile @@ -81055,681 +77330,661 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CustomCostsFileUploadRequest' + $ref: "#/components/schemas/CustomCostsFileUploadRequest" required: true responses: - '202': + "202": content: application/json: schema: - $ref: '#/components/schemas/CustomCostsFileUploadResponse' + $ref: "#/components/schemas/CustomCostsFileUploadResponse" description: Accepted - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Upload Custom Costs file tags: - - Cloud Cost Management - x-permission: + - Cloud Cost Management + "x-permission": operator: OR permissions: - - cloud_cost_management_write + - cloud_cost_management_write /api/v2/cost/custom_costs/{file_id}: delete: description: Delete the specified Custom Costs file. operationId: DeleteCustomCostsFile parameters: - - $ref: '#/components/parameters/FileID' + - $ref: "#/components/parameters/FileID" responses: - '204': + "204": description: No Content - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Delete Custom Costs file tags: - - Cloud Cost Management + - Cloud Cost Management get: description: Fetch the specified Custom Costs file. operationId: GetCustomCostsFile parameters: - - $ref: '#/components/parameters/FileID' + - $ref: "#/components/parameters/FileID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomCostsFileGetResponse' + $ref: "#/components/schemas/CustomCostsFileGetResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: Get Custom Costs file tags: - - Cloud Cost Management + - Cloud Cost Management /api/v2/cost/gcp_uc_config: get: description: List the Google Cloud Usage Cost configs. operationId: ListCostGCPUsageCostConfigs responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GCPUsageCostConfigsResponse' + $ref: "#/components/schemas/GCPUsageCostConfigsResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: List Google Cloud Usage Cost configs tags: - - Cloud Cost Management - x-permission: + - Cloud Cost Management + "x-permission": operator: OR permissions: - - cloud_cost_management_read + - cloud_cost_management_read post: - description: Create a Cloud Cost Management account for an Google Cloud Usage - Cost config. + description: Create a Cloud Cost Management account for an Google Cloud Usage Cost config. operationId: CreateCostGCPUsageCostConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/GCPUsageCostConfigPostRequest' + $ref: "#/components/schemas/GCPUsageCostConfigPostRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GCPUsageCostConfigResponse' + $ref: "#/components/schemas/GCPUsageCostConfigResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Create Google Cloud Usage Cost config tags: - - Cloud Cost Management - x-permission: + - Cloud Cost Management + "x-permission": operator: OR permissions: - - cloud_cost_management_write + - cloud_cost_management_write /api/v2/cost/gcp_uc_config/{cloud_account_id}: delete: description: Archive a Cloud Cost Management account. operationId: DeleteCostGCPUsageCostConfig parameters: - - $ref: '#/components/parameters/CloudAccountID' + - $ref: "#/components/parameters/CloudAccountID" responses: - '204': + "204": description: No Content - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Delete Google Cloud Usage Cost config tags: - - Cloud Cost Management - x-permission: + - Cloud Cost Management + "x-permission": operator: OR permissions: - - cloud_cost_management_write + - cloud_cost_management_write get: description: Get a specific Google Cloud Usage Cost config. operationId: GetCostGCPUsageCostConfig parameters: - - description: The unique identifier of the cloud account - in: path - name: cloud_account_id - required: true - schema: - format: int64 - type: integer + - description: The unique identifier of the cloud account + in: path + name: cloud_account_id + required: true + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GcpUcConfigResponse' + $ref: "#/components/schemas/GcpUcConfigResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: Get Google Cloud Usage Cost config tags: - - Cloud Cost Management + - Cloud Cost Management patch: description: Update the status of an Google Cloud Usage Cost config (active/archived). operationId: UpdateCostGCPUsageCostConfig parameters: - - $ref: '#/components/parameters/CloudAccountID' + - $ref: "#/components/parameters/CloudAccountID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/GCPUsageCostConfigPatchRequest' + $ref: "#/components/schemas/GCPUsageCostConfigPatchRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GCPUsageCostConfigResponse' + $ref: "#/components/schemas/GCPUsageCostConfigResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Update Google Cloud Usage Cost config tags: - - Cloud Cost Management - x-permission: + - Cloud Cost Management + "x-permission": operator: OR permissions: - - cloud_cost_management_write + - cloud_cost_management_write /api/v2/cost_by_tag/active_billing_dimensions: get: - description: Get active billing dimensions for cost attribution. Cost data for - a given month becomes available no later than the 19th of the following month. + description: |- + Get active billing dimensions for cost attribution. Cost data for a given month becomes available no later than the 19th of the following month. operationId: GetActiveBillingDimensions responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/ActiveBillingDimensionsResponse' + $ref: "#/components/schemas/ActiveBillingDimensionsResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get active billing dimensions for cost attribution tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v2/cost_by_tag/monthly_cost_attribution: get: - description: "Get monthly cost attribution by tag across multi-org and single - root-org accounts.\nCost Attribution data for a given month becomes available - no later than the 19th of the following month.\nThis API endpoint is paginated. - To make sure you receive all records, check if the value of `next_record_id` - is\nset in the response. If it is, make another request and pass `next_record_id` - as a parameter.\nPseudo code example:\n```\nresponse := GetMonthlyCostAttribution(start_month, - end_month)\ncursor := response.metadata.pagination.next_record_id\nWHILE cursor - != null BEGIN\n sleep(5 seconds) # Avoid running into rate limit\n response - := GetMonthlyCostAttribution(start_month, end_month, next_record_id=cursor)\n - \ cursor := response.metadata.pagination.next_record_id\nEND\n```\n\nThis - endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/). - This endpoint is not available in the Government (US1-FED) site." + description: |- + Get monthly cost attribution by tag across multi-org and single root-org accounts. + Cost Attribution data for a given month becomes available no later than the 19th of the following month. + This API endpoint is paginated. To make sure you receive all records, check if the value of `next_record_id` is + set in the response. If it is, make another request and pass `next_record_id` as a parameter. + Pseudo code example: + ``` + response := GetMonthlyCostAttribution(start_month, end_month) + cursor := response.metadata.pagination.next_record_id + WHILE cursor != null BEGIN + sleep(5 seconds) # Avoid running into rate limit + response := GetMonthlyCostAttribution(start_month, end_month, next_record_id=cursor) + cursor := response.metadata.pagination.next_record_id + END + ``` + + This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/). This endpoint is not available in the Government (US1-FED) site. operationId: GetMonthlyCostAttribution parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` - for cost beginning in this month.' - in: query - name: start_month - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` - for cost ending this month.' - in: query - name: end_month - required: false - schema: - format: date-time - type: string - - description: 'Comma-separated list specifying cost types (e.g., `_on_demand_cost`, - `_committed_cost`, `_total_cost`) - and the - - proportions (`_percentage_in_org`, `_percentage_in_account`). - Use `*` to retrieve all fields. - - Example: `infra_host_on_demand_cost,infra_host_percentage_in_account` - - To obtain the complete list of active billing dimensions that can be used - to replace - - `` 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).' - in: query - name: fields - required: true - schema: - type: string - - description: 'The direction to sort by: `[desc, asc]`.' - in: query - name: sort_direction - required: false - schema: - $ref: '#/components/schemas/SortDirection' - - description: 'The billing dimension to sort by. Always sorted by total cost. - Example: `infra_host`.' - in: query - name: sort_name - required: false - schema: - type: string - - 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. - - To see which tags are available, look for the value of `tag_config_source` - in the API response.' - in: query - name: tag_breakdown_keys - required: false - schema: - type: string - - description: List following results with a next_record_id provided in the - previous query. - in: query - name: next_record_id - required: false - schema: - type: string - - description: Include child org cost in the response. Defaults to `true`. - in: query - name: include_descendants - required: false - schema: - default: true - type: boolean + - description: |- + Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning in this month. + in: query + name: start_month + required: true + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month." + in: query + name: end_month + required: false + schema: + format: date-time + type: string + - description: |- + Comma-separated list specifying cost types (e.g., `_on_demand_cost`, `_committed_cost`, `_total_cost`) and the + proportions (`_percentage_in_org`, `_percentage_in_account`). Use `*` to retrieve all fields. + Example: `infra_host_on_demand_cost,infra_host_percentage_in_account` + To obtain the complete list of active billing dimensions that can be used to replace + `` 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). + in: query + name: fields + required: true + schema: + type: string + - description: "The direction to sort by: `[desc, asc]`." + in: query + name: sort_direction + required: false + schema: + $ref: "#/components/schemas/SortDirection" + - description: "The billing dimension to sort by. Always sorted by total cost. Example: `infra_host`." + in: query + name: sort_name + required: false + schema: + type: string + - 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. + To see which tags are available, look for the value of `tag_config_source` in the API response. + in: query + name: tag_breakdown_keys + required: false + schema: + type: string + - description: List following results with a next_record_id provided in the previous query. + in: query + name: next_record_id + required: false + schema: + type: string + - description: "Include child org cost in the response. Defaults to `true`." + in: query + name: include_descendants + required: false + schema: + default: true + type: boolean responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/MonthlyCostAttributionResponse' + $ref: "#/components/schemas/MonthlyCostAttributionResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read - - billing_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read + - billing_read summary: Get Monthly Cost Attribution tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: AND permissions: - - usage_read - - billing_read + - usage_read + - billing_read /api/v2/csm/onboarding/agents: get: description: Get the list of all CSM Agents running on your hosts and containers. operationId: ListAllCSMAgents parameters: - - description: The page index for pagination (zero-based). - in: query - name: page - required: false - schema: - example: 2 - format: int32 - maximum: 1000000 - minimum: 0 - type: integer - - description: The number of items to include in a single page. - in: query - name: size - required: false - schema: - example: 12 - format: int32 - maximum: 100 - minimum: 0 - type: integer - - description: A search query string to filter results (for example, `hostname:COMP-T2H4J27423`). - in: query - name: query - required: false - schema: - example: hostname:COMP-T2H4J27423 - type: string - - description: The sort direction for results. Use `asc` for ascending or `desc` - for descending. - in: query - name: order_direction - required: false - schema: - $ref: '#/components/schemas/OrderDirection' + - description: The page index for pagination (zero-based). + in: query + name: page + required: false + schema: + example: 2 + format: int32 + maximum: 1000000 + minimum: 0 + type: integer + - description: The number of items to include in a single page. + in: query + name: size + required: false + schema: + example: 12 + format: int32 + maximum: 100 + minimum: 0 + type: integer + - description: A search query string to filter results (for example, `hostname:COMP-T2H4J27423`). + in: query + name: query + required: false + schema: + example: "hostname:COMP-T2H4J27423" + type: string + - description: The sort direction for results. Use `asc` for ascending or `desc` for descending. + in: query + name: order_direction + required: false + schema: + $ref: "#/components/schemas/OrderDirection" responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CsmAgentsResponse' + $ref: "#/components/schemas/CsmAgentsResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all CSM Agents - tags: - - CSM Agents + tags: ["CSM Agents"] /api/v2/csm/onboarding/coverage_analysis/cloud_accounts: get: - description: 'Get the CSM Coverage Analysis of your Cloud Accounts. - + description: |- + Get the CSM Coverage Analysis of your Cloud Accounts. This is calculated based on the number of your Cloud Accounts that are - - scanned for security issues.' + scanned for security issues. operationId: GetCSMCloudAccountsCoverageAnalysis responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisResponse' + $ref: "#/components/schemas/CsmCloudAccountsCoverageAnalysisResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get the CSM Cloud Accounts Coverage Analysis - tags: - - CSM Coverage Analysis + tags: ["CSM Coverage Analysis"] /api/v2/csm/onboarding/coverage_analysis/hosts_and_containers: get: - description: 'Get the CSM Coverage Analysis of your Hosts and Containers. - + description: |- + Get the CSM Coverage Analysis of your Hosts and Containers. This is calculated based on the number of agents running on your Hosts - - and Containers with CSM feature(s) enabled.' + and Containers with CSM feature(s) enabled. operationId: GetCSMHostsAndContainersCoverageAnalysis responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CsmHostsAndContainersCoverageAnalysisResponse' + $ref: "#/components/schemas/CsmHostsAndContainersCoverageAnalysisResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get the CSM Hosts and Containers Coverage Analysis - tags: - - CSM Coverage Analysis + tags: ["CSM Coverage Analysis"] /api/v2/csm/onboarding/coverage_analysis/serverless: get: - description: 'Get the CSM Coverage Analysis of your Serverless Resources. - + description: |- + Get the CSM Coverage Analysis of your Serverless Resources. This is calculated based on the number of agents running on your Serverless - - Resources with CSM feature(s) enabled.' + Resources with CSM feature(s) enabled. operationId: GetCSMServerlessCoverageAnalysis responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CsmServerlessCoverageAnalysisResponse' + $ref: "#/components/schemas/CsmServerlessCoverageAnalysisResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get the CSM Serverless Coverage Analysis - tags: - - CSM Coverage Analysis + tags: ["CSM Coverage Analysis"] /api/v2/csm/onboarding/serverless/agents: get: - description: Get the list of all CSM Serverless Agents running on your hosts - and containers. + description: Get the list of all CSM Serverless Agents running on your hosts and containers. operationId: ListAllCSMServerlessAgents parameters: - - description: The page index for pagination (zero-based). - in: query - name: page - required: false - schema: - example: 2 - format: int32 - maximum: 1000000 - minimum: 0 - type: integer - - description: The number of items to include in a single page. - in: query - name: size - required: false - schema: - example: 12 - format: int32 - maximum: 100 - minimum: 0 - type: integer - - description: A search query string to filter results (for example, `hostname:COMP-T2H4J27423`). - in: query - name: query - required: false - schema: - example: hostname:COMP-T2H4J27423 - type: string - - description: The sort direction for results. Use `asc` for ascending or `desc` - for descending. - in: query - name: order_direction - required: false - schema: - $ref: '#/components/schemas/OrderDirection' + - description: The page index for pagination (zero-based). + in: query + name: page + required: false + schema: + example: 2 + format: int32 + maximum: 1000000 + minimum: 0 + type: integer + - description: The number of items to include in a single page. + in: query + name: size + required: false + schema: + example: 12 + format: int32 + maximum: 100 + minimum: 0 + type: integer + - description: A search query string to filter results (for example, `hostname:COMP-T2H4J27423`). + in: query + name: query + required: false + schema: + example: "hostname:COMP-T2H4J27423" + type: string + - description: The sort direction for results. Use `asc` for ascending or `desc` for descending. + in: query + name: order_direction + required: false + schema: + $ref: "#/components/schemas/OrderDirection" responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CsmAgentsResponse' + $ref: "#/components/schemas/CsmAgentsResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all CSM Serverless Agents - tags: - - CSM Agents + tags: ["CSM Agents"] /api/v2/current_user/application_keys: get: description: List all application keys available for current user operationId: ListCurrentUserApplicationKeys parameters: - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' - - $ref: '#/components/parameters/ApplicationKeysSortParameter' - - $ref: '#/components/parameters/ApplicationKeyFilterParameter' - - $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter' - - $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter' - - $ref: '#/components/parameters/ApplicationKeyIncludeParameter' + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - $ref: "#/components/parameters/ApplicationKeysSortParameter" + - $ref: "#/components/parameters/ApplicationKeyFilterParameter" + - $ref: "#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter" + - $ref: "#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter" + - $ref: "#/components/parameters/ApplicationKeyIncludeParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListApplicationKeysResponse' + $ref: "#/components/schemas/ListApplicationKeysResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all application keys owned by current user tags: - - Key Management - x-permission: + - Key Management + "x-permission": operator: OR permissions: - - user_app_keys + - user_app_keys post: description: Create an application key for current user operationId: CreateCurrentUserApplicationKey @@ -81737,374 +77992,375 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ApplicationKeyCreateRequest' + $ref: "#/components/schemas/ApplicationKeyCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/ApplicationKeyResponse' + $ref: "#/components/schemas/ApplicationKeyResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an application key for current user tags: - - Key Management + - Key Management x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_app_keys + - user_app_keys /api/v2/current_user/application_keys/{app_key_id}: delete: description: Delete an application key owned by current user operationId: DeleteCurrentUserApplicationKey parameters: - - $ref: '#/components/parameters/ApplicationKeyID' + - $ref: "#/components/parameters/ApplicationKeyID" responses: - '204': + "204": description: No Content - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an application key owned by current user tags: - - Key Management - x-permission: + - Key Management + "x-permission": operator: OR permissions: - - user_app_keys + - user_app_keys get: - description: 'Get an application key owned by current user. - - The `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).' + description: |- + Get an application key owned by current user. + The `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). operationId: GetCurrentUserApplicationKey parameters: - - $ref: '#/components/parameters/ApplicationKeyID' + - $ref: "#/components/parameters/ApplicationKeyID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationKeyResponse' + $ref: "#/components/schemas/ApplicationKeyResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get one application key owned by current user tags: - - Key Management - x-permission: + - Key Management + "x-permission": operator: OR permissions: - - user_app_keys + - user_app_keys patch: - description: 'Edit an application key owned by current user. - - The `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).' + description: |- + Edit an application key owned by current user. + The `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode). operationId: UpdateCurrentUserApplicationKey parameters: - - $ref: '#/components/parameters/ApplicationKeyID' + - $ref: "#/components/parameters/ApplicationKeyID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApplicationKeyUpdateRequest' + $ref: "#/components/schemas/ApplicationKeyUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationKeyResponse' + $ref: "#/components/schemas/ApplicationKeyResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Edit an application key owned by current user tags: - - Key Management + - Key Management x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_app_keys + - user_app_keys /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards: delete: description: Delete dashboards from an existing dashboard list. operationId: DeleteDashboardListItems parameters: - - description: ID of the dashboard list to delete items from. - in: path - name: dashboard_list_id - required: true - schema: - format: int64 - type: integer + - description: ID of the dashboard list to delete items from. + in: path + name: dashboard_list_id + required: true + schema: + format: int64 + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/DashboardListDeleteItemsRequest' + $ref: "#/components/schemas/DashboardListDeleteItemsRequest" description: Dashboards to delete from the dashboard list. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DashboardListDeleteItemsResponse' + $ref: "#/components/schemas/DashboardListDeleteItemsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete items from a dashboard list tags: - - Dashboard Lists + - Dashboard Lists x-codegen-request-body-name: body get: - description: "Fetch the dashboard list\u2019s dashboard definitions." + description: Fetch the dashboard list’s dashboard definitions. operationId: GetDashboardListItems parameters: - - description: ID of the dashboard list to get items from. - in: path - name: dashboard_list_id - required: true - schema: - format: int64 - type: integer + - description: ID of the dashboard list to get items from. + in: path + name: dashboard_list_id + required: true + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DashboardListItems' + $ref: "#/components/schemas/DashboardListItems" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_read summary: Get items of a Dashboard List tags: - - Dashboard Lists - x-permission: + - Dashboard Lists + "x-permission": operator: OR permissions: - - dashboards_read + - dashboards_read post: description: Add dashboards to an existing dashboard list. operationId: CreateDashboardListItems parameters: - - description: ID of the dashboard list to add items to. - in: path - name: dashboard_list_id - required: true - schema: - format: int64 - type: integer + - description: ID of the dashboard list to add items to. + in: path + name: dashboard_list_id + required: true + schema: + format: int64 + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/DashboardListAddItemsRequest' + $ref: "#/components/schemas/DashboardListAddItemsRequest" description: Dashboards to add to the dashboard list. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DashboardListAddItemsResponse' + $ref: "#/components/schemas/DashboardListAddItemsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Add Items to a Dashboard List tags: - - Dashboard Lists + - Dashboard Lists x-codegen-request-body-name: body put: description: Update dashboards of an existing dashboard list. operationId: UpdateDashboardListItems parameters: - - description: ID of the dashboard list to update items from. - in: path - name: dashboard_list_id - required: true - schema: - format: int64 - type: integer + - description: ID of the dashboard list to update items from. + in: path + name: dashboard_list_id + required: true + schema: + format: int64 + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/DashboardListUpdateItemsRequest' + $ref: "#/components/schemas/DashboardListUpdateItemsRequest" description: New dashboards of the dashboard list. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DashboardListUpdateItemsResponse' + $ref: "#/components/schemas/DashboardListUpdateItemsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update items of a dashboard list tags: - - Dashboard Lists + - Dashboard Lists x-codegen-request-body-name: body /api/v2/datasets: get: description: Get all datasets that have been configured for an organization. operationId: GetAllDatasets responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DatasetResponseMulti' + $ref: "#/components/schemas/DatasetResponseMulti" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_read summary: Get all datasets tags: - - Datasets - x-permission: + - Datasets + "x-permission": operator: OR permissions: - - user_access_read - x-unstable: '**Note: Data Access is in preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).**' + - user_access_read + x-unstable: |- + **Note: Data Access is in preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/).** post: - description: Create a dataset with the configurations in the request. + description: |- + Create a dataset with the configurations in the request. operationId: CreateDataset requestBody: content: @@ -82112,805 +78368,803 @@ paths: example: data: attributes: - name: Test RUM Dataset + name: "Test RUM Dataset" principals: - - role:94172442-be03-11e9-a77a-3b7612558ac1 + - "role:94172442-be03-11e9-a77a-3b7612558ac1" product_filters: - - filters: - - '@application.id:application_123' - product: rum + - filters: + - "@application.id:application_123" + product: "rum" type: dataset schema: - $ref: '#/components/schemas/DatasetCreateRequest' + $ref: "#/components/schemas/DatasetCreateRequest" description: Dataset payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DatasetResponseSingle' + $ref: "#/components/schemas/DatasetResponseSingle" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_manage + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_manage summary: Create a dataset tags: - - Datasets + - Datasets x-codegen-request-body-name: body x-permission: operator: OR permissions: - - user_access_manage - x-unstable: '**Note: Data Access is in preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).**' + - user_access_manage + x-unstable: |- + **Note: Data Access is in preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/).** /api/v2/datasets/{dataset_id}: delete: description: Deletes the dataset associated with the ID. operationId: DeleteDataset parameters: - - $ref: '#/components/parameters/DatasetID' + - $ref: "#/components/parameters/DatasetID" responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_manage + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_manage summary: Delete a dataset tags: - - Datasets - x-permission: + - Datasets + "x-permission": operator: OR permissions: - - user_access_manage - x-unstable: '**Note: Data Access is in preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).**' + - user_access_manage + x-unstable: |- + **Note: Data Access is in preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/).** get: description: Retrieves the dataset associated with the ID. operationId: GetDataset parameters: - - $ref: '#/components/parameters/DatasetID' + - $ref: "#/components/parameters/DatasetID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DatasetResponseSingle' + $ref: "#/components/schemas/DatasetResponseSingle" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_read summary: Get a single dataset by ID tags: - - Datasets - x-permission: + - Datasets + "x-permission": operator: OPEN permissions: [] - x-unstable: '**Note: Data Access is in preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).**' + x-unstable: |- + **Note: Data Access is in preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/).** put: - description: Edits the dataset associated with the ID. + description: |- + Edits the dataset associated with the ID. operationId: UpdateDataset parameters: - - $ref: '#/components/parameters/DatasetID' + - $ref: "#/components/parameters/DatasetID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/DatasetUpdateRequest' + $ref: "#/components/schemas/DatasetUpdateRequest" description: Dataset payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DatasetResponseSingle' + $ref: "#/components/schemas/DatasetResponseSingle" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_manage + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_manage summary: Edit a dataset tags: - - Datasets + - Datasets x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage - x-unstable: '**Note: Data Access is in preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).**' + - user_access_manage + x-unstable: |- + **Note: Data Access is in preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/).** /api/v2/deletion/data/{product}: post: - description: Creates a data deletion request by providing a query and a timeframe - targeting the proper data. + description: Creates a data deletion request by providing a query and a timeframe targeting the proper data. operationId: CreateDataDeletionRequest parameters: - - $ref: '#/components/parameters/ProductName' + - $ref: "#/components/parameters/ProductName" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateDataDeletionRequestBody' + $ref: "#/components/schemas/CreateDataDeletionRequestBody" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CreateDataDeletionResponseBody' + $ref: "#/components/schemas/CreateDataDeletionResponseBody" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '412': + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "412": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Precondition failed error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Internal server error security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Creates a data deletion request tags: - - Data Deletion + - Data Deletion x-permission: operator: OR permissions: - - rum_delete_data - - logs_delete_data - x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).' + - rum_delete_data + - logs_delete_data + x-unstable: |- + **Note**: This endpoint is in Preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/deletion/requests: get: description: Gets a list of data deletion requests based on several filter parameters. operationId: GetDataDeletionRequests parameters: - - description: The next page of the previous search. If the next_page parameter - is included, the rest of the query elements are ignored. - example: cGFnZTI= - in: query - name: next_page - required: false - schema: - type: string - - description: Retrieve only the requests related to the given product. - example: logs - in: query - name: product - required: false - schema: - type: string - - description: Retrieve only the requests that matches the given query. - example: service:xyz host:abc - in: query - name: query - required: false - schema: - type: string - - description: Retrieve only the requests with the given status. - example: pending - in: query - name: status - required: false - schema: - type: string - - description: Sets the page size of the search. - example: '50' - in: query - name: page_size - required: false - schema: - default: 50 - format: int64 - maximum: 50 - minimum: 1 - type: integer + - description: |- + The next page of the previous search. If the next_page parameter is included, the rest of the query elements are ignored. + example: "cGFnZTI=" + in: query + name: next_page + required: false + schema: + type: string + - description: Retrieve only the requests related to the given product. + example: "logs" + in: query + name: product + required: false + schema: + type: string + - description: Retrieve only the requests that matches the given query. + example: "service:xyz host:abc" + in: query + name: query + required: false + schema: + type: string + - description: Retrieve only the requests with the given status. + example: "pending" + in: query + name: status + required: false + schema: + type: string + - description: Sets the page size of the search. + example: "50" + in: query + name: page_size + required: false + schema: + default: 50 + format: int64 + maximum: 50 + minimum: 1 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GetDataDeletionsResponseBody' + $ref: "#/components/schemas/GetDataDeletionsResponseBody" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Internal server error security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Gets a list of data deletion requests tags: - - Data Deletion + - Data Deletion x-permission: operator: OR permissions: - - rum_delete_data - - logs_delete_data - x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).' + - rum_delete_data + - logs_delete_data + x-unstable: |- + **Note**: This endpoint is in Preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/deletion/requests/{id}/cancel: put: description: Cancels a data deletion request by providing its ID. operationId: CancelDataDeletionRequest parameters: - - $ref: '#/components/parameters/RequestId' + - $ref: "#/components/parameters/RequestId" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CancelDataDeletionResponseBody' + $ref: "#/components/schemas/CancelDataDeletionResponseBody" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '412': + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "412": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Precondition failed error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Internal server error security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Cancels a data deletion request tags: - - Data Deletion + - Data Deletion x-permission: operator: OR permissions: - - rum_delete_data - - logs_delete_data - x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).' + - rum_delete_data + - logs_delete_data + x-unstable: |- + **Note**: This endpoint is in Preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/deployment_gates: post: - description: Endpoint to create a deployment gate. + description: |- + Endpoint to create a deployment gate. operationId: CreateDeploymentGate requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateDeploymentGateParams' + $ref: "#/components/schemas/CreateDeploymentGateParams" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DeploymentGateResponse' + $ref: "#/components/schemas/DeploymentGateResponse" description: OK - '400': - $ref: '#/components/responses/HTTPCDGatesBadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "400": + $ref: "#/components/responses/HTTPCDGatesBadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Internal Server Error security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Create deployment gate - tags: - - Deployment Gates + tags: ["Deployment Gates"] x-permission: operator: OR permissions: - - deployment_gates_write - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - deployment_gates_write + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/deployment_gates/{gate_id}/rules: get: - description: Endpoint to get rules for a deployment gate. + description: |- + Endpoint to get rules for a deployment gate. operationId: GetDeploymentGateRules parameters: - - description: The ID of the deployment gate. - in: path - name: gate_id - required: true - schema: - type: string + - description: The ID of the deployment gate. + in: path + name: gate_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DeploymentGateRulesResponse' + $ref: "#/components/schemas/DeploymentGateRulesResponse" description: OK - '400': - $ref: '#/components/responses/HTTPCDGatesBadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "400": + $ref: "#/components/responses/HTTPCDGatesBadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Internal Server Error security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get rules for a deployment gate - tags: - - Deployment Gates + tags: ["Deployment Gates"] x-permission: operator: OR permissions: - - deployment_gates_read - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - deployment_gates_read + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: - description: Endpoint to create a deployment rule. A gate for the rule must - already exist. + description: |- + Endpoint to create a deployment rule. A gate for the rule must already exist. operationId: CreateDeploymentRule parameters: - - description: The ID of the deployment gate. - in: path - name: gate_id - required: true - schema: - type: string + - description: The ID of the deployment gate. + in: path + name: gate_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateDeploymentRuleParams' + $ref: "#/components/schemas/CreateDeploymentRuleParams" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DeploymentRuleResponse' + $ref: "#/components/schemas/DeploymentRuleResponse" description: OK - '400': - $ref: '#/components/responses/HTTPCDGatesBadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "400": + $ref: "#/components/responses/HTTPCDGatesBadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Internal Server Error security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Create deployment rule - tags: - - Deployment Gates + tags: ["Deployment Gates"] x-permission: operator: OR permissions: - - deployment_gates_write - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - deployment_gates_write + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/deployment_gates/{gate_id}/rules/{id}: delete: - description: Endpoint to delete a deployment rule. + description: |- + Endpoint to delete a deployment rule. operationId: DeleteDeploymentRule parameters: - - description: The ID of the deployment gate. - in: path - name: gate_id - required: true - schema: - type: string - - description: The ID of the deployment rule. - in: path - name: id - required: true - schema: - type: string + - description: The ID of the deployment gate. + in: path + name: gate_id + required: true + schema: + type: string + - description: The ID of the deployment rule. + in: path + name: id + required: true + schema: + type: string responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/HTTPCDGatesBadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/HTTPCDGatesNotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "400": + $ref: "#/components/responses/HTTPCDGatesBadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/HTTPCDGatesNotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Internal Server Error security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Delete deployment rule - tags: - - Deployment Gates + tags: ["Deployment Gates"] x-permission: operator: OR permissions: - - deployment_gates_write - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - deployment_gates_write + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: - description: Endpoint to get a deployment rule. + description: |- + Endpoint to get a deployment rule. operationId: GetDeploymentRule parameters: - - description: The ID of the deployment gate. - in: path - name: gate_id - required: true - schema: - type: string - - description: The ID of the deployment rule. - in: path - name: id - required: true - schema: - type: string + - description: The ID of the deployment gate. + in: path + name: gate_id + required: true + schema: + type: string + - description: The ID of the deployment rule. + in: path + name: id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DeploymentRuleResponse' + $ref: "#/components/schemas/DeploymentRuleResponse" description: OK - '400': - $ref: '#/components/responses/HTTPCDGatesBadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/HTTPCDRulesNotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "400": + $ref: "#/components/responses/HTTPCDGatesBadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/HTTPCDRulesNotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Internal Server Error security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get deployment rule - tags: - - Deployment Gates + tags: ["Deployment Gates"] x-permission: operator: OR permissions: - - deployment_gates_read - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - deployment_gates_read + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). put: - description: Endpoint to update a deployment rule. + description: |- + Endpoint to update a deployment rule. operationId: UpdateDeploymentRule parameters: - - description: The ID of the deployment gate. - in: path - name: gate_id - required: true - schema: - type: string - - description: The ID of the deployment rule. - in: path - name: id - required: true - schema: - type: string + - description: The ID of the deployment gate. + in: path + name: gate_id + required: true + schema: + type: string + - description: The ID of the deployment rule. + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateDeploymentRuleParams' + $ref: "#/components/schemas/UpdateDeploymentRuleParams" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DeploymentRuleResponse' + $ref: "#/components/schemas/DeploymentRuleResponse" description: OK - '400': - $ref: '#/components/responses/HTTPCDGatesBadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/HTTPCDRulesNotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "400": + $ref: "#/components/responses/HTTPCDGatesBadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/HTTPCDRulesNotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Internal Server Error security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Update deployment rule - tags: - - Deployment Gates + tags: ["Deployment Gates"] x-permission: operator: OR permissions: - - deployment_gates_write - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - deployment_gates_write + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/deployment_gates/{id}: delete: - description: Endpoint to delete a deployment gate. Rules associated with the - gate are also deleted. + description: |- + Endpoint to delete a deployment gate. Rules associated with the gate are also deleted. operationId: DeleteDeploymentGate parameters: - - description: The ID of the deployment gate. - in: path - name: id - required: true - schema: - type: string + - description: The ID of the deployment gate. + in: path + name: id + required: true + schema: + type: string responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/HTTPCDGatesBadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/HTTPCDGatesNotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "400": + $ref: "#/components/responses/HTTPCDGatesBadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/HTTPCDGatesNotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Internal Server Error security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Delete deployment gate - tags: - - Deployment Gates + tags: ["Deployment Gates"] x-permission: operator: OR permissions: - - deployment_gates_write - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - deployment_gates_write + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: - description: Endpoint to get a deployment gate. + description: |- + Endpoint to get a deployment gate. operationId: GetDeploymentGate parameters: - - description: The ID of the deployment gate. - in: path - name: id - required: true - schema: - type: string + - description: The ID of the deployment gate. + in: path + name: id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DeploymentGateResponse' + $ref: "#/components/schemas/DeploymentGateResponse" description: OK - '400': - $ref: '#/components/responses/HTTPCDGatesBadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/HTTPCDGatesNotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "400": + $ref: "#/components/responses/HTTPCDGatesBadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/HTTPCDGatesNotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Internal Server Error security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get deployment gate - tags: - - Deployment Gates + tags: ["Deployment Gates"] x-permission: operator: OR permissions: - - deployment_gates_read - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - deployment_gates_read + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). put: - description: Endpoint to update a deployment gate. + description: |- + Endpoint to update a deployment gate. operationId: UpdateDeploymentGate parameters: - - description: The ID of the deployment gate. - in: path - name: id - required: true - schema: - type: string + - description: The ID of the deployment gate. + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateDeploymentGateParams' + $ref: "#/components/schemas/UpdateDeploymentGateParams" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DeploymentGateResponse' + $ref: "#/components/schemas/DeploymentGateResponse" description: OK - '400': - $ref: '#/components/responses/HTTPCDGatesBadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/HTTPCDGatesNotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "400": + $ref: "#/components/responses/HTTPCDGatesBadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/HTTPCDGatesNotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/HTTPCIAppErrors' + $ref: "#/components/schemas/HTTPCIAppErrors" description: Internal Server Error security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Update deployment gate - tags: - - Deployment Gates + tags: ["Deployment Gates"] x-permission: operator: OR permissions: - - deployment_gates_write - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - deployment_gates_write + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/domain_allowlist: get: description: Get the domain allowlist for an organization. operationId: GetDomainAllowlist responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DomainAllowlistResponse' + $ref: "#/components/schemas/DomainAllowlistResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management - - AuthZ: - - monitors_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management + - AuthZ: + - monitors_write summary: Get Domain Allowlist tags: - - Domain Allowlist - x-permission: + - Domain Allowlist + "x-permission": operator: OR permissions: - - org_management - - monitors_write - - generate_dashboard_reports - - generate_log_reports - - manage_log_reports + - org_management + - monitors_write + - generate_dashboard_reports + - generate_log_reports + - manage_log_reports patch: description: Update the domain allowlist for an organization. operationId: PatchDomainAllowlist @@ -82918,504 +79172,487 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DomainAllowlistRequest' + $ref: "#/components/schemas/DomainAllowlistRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DomainAllowlistResponse' + $ref: "#/components/schemas/DomainAllowlistResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management - - AuthZ: - - monitors_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management + - AuthZ: + - monitors_write summary: Sets Domain Allowlist tags: - - Domain Allowlist - x-permission: + - Domain Allowlist + "x-permission": operator: OR permissions: - - org_management - - monitors_write - - generate_dashboard_reports - - generate_log_reports - - manage_log_reports + - org_management + - monitors_write + - generate_dashboard_reports + - generate_log_reports + - manage_log_reports /api/v2/dora/deployment: post: - description: 'Use this API endpoint to provide deployment data. - + description: |- + Use this API endpoint to provide deployment data. This is necessary for: - - Deployment Frequency - - Change Lead Time - - Change Failure Rate - - - Failed Deployment Recovery Time' + - Failed Deployment Recovery Time operationId: CreateDORADeployment requestBody: content: application/json: schema: - $ref: '#/components/schemas/DORADeploymentRequest' + $ref: "#/components/schemas/DORADeploymentRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DORADeploymentResponse' + $ref: "#/components/schemas/DORADeploymentResponse" description: OK - '202': + "202": content: application/json: schema: - $ref: '#/components/schemas/DORADeploymentResponse' + $ref: "#/components/schemas/DORADeploymentResponse" description: OK - but delayed due to incident - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] + - apiKeyAuth: [] summary: Send a deployment event - tags: - - DORA Metrics + tags: ["DORA Metrics"] x-codegen-request-body-name: body /api/v2/dora/deployment/{deployment_id}: delete: - description: Use this API endpoint to delete a deployment event. + description: |- + Use this API endpoint to delete a deployment event. operationId: DeleteDORADeployment parameters: - - description: The ID of the deployment event to delete. - in: path - name: deployment_id - required: true - schema: - type: string + - description: The ID of the deployment event to delete. + in: path + name: deployment_id + required: true + schema: + type: string responses: - '202': + "202": description: Accepted - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Delete a deployment event - tags: - - DORA Metrics + tags: ["DORA Metrics"] x-permission: operator: OR permissions: - - dora_metrics_write + - dora_metrics_write /api/v2/dora/deployments: post: - description: Use this API endpoint to get a list of deployment events. + description: |- + Use this API endpoint to get a list of deployment events. operationId: ListDORADeployments requestBody: content: application/json: schema: - $ref: '#/components/schemas/DORAListDeploymentsRequest' + $ref: "#/components/schemas/DORAListDeploymentsRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DORADeploymentsListResponse' + $ref: "#/components/schemas/DORADeploymentsListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get a list of deployment events - tags: - - DORA Metrics + tags: ["DORA Metrics"] x-codegen-request-body-name: body x-permission: operator: OR permissions: - - dora_metrics_read + - dora_metrics_read /api/v2/dora/deployments/{deployment_id}: get: - description: Use this API endpoint to get a deployment event. + description: |- + Use this API endpoint to get a deployment event. operationId: GetDORADeployment parameters: - - description: The ID of the deployment event. - in: path - name: deployment_id - required: true - schema: - type: string + - description: The ID of the deployment event. + in: path + name: deployment_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DORADeploymentFetchResponse' + $ref: "#/components/schemas/DORADeploymentFetchResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get a deployment event - tags: - - DORA Metrics + tags: ["DORA Metrics"] x-codegen-request-body-name: body x-permission: operator: OR permissions: - - dora_metrics_read + - dora_metrics_read patch: - description: Update a deployment's change failure status. Use this to mark a - deployment as a change failure or back to stable. You can optionally include - remediation details to enable failed deployment recovery time calculation. + description: |- + Update a deployment's change failure status. Use this to mark a deployment as a change failure or back to stable. You can optionally include remediation details to enable failed deployment recovery time calculation. operationId: PatchDORADeployment parameters: - - description: The ID of the deployment event. - in: path - name: deployment_id - required: true - schema: - type: string + - description: The ID of the deployment event. + in: path + name: deployment_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/DORADeploymentPatchRequest' + $ref: "#/components/schemas/DORADeploymentPatchRequest" required: true responses: - '202': + "202": description: Accepted - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Patch a deployment event - tags: - - DORA Metrics + tags: ["DORA Metrics"] x-codegen-request-body-name: body x-permission: operator: OR permissions: - - dora_metrics_write + - dora_metrics_write /api/v2/dora/failure: post: - description: 'Use this API endpoint to provide incident data for DORA Metrics. - - Note that change failure rate and failed deployment recovery time are computed - from change failures detected on deployments, not from incident events sent - through this endpoint. - - Tracking incidents gives a side-by-side view of how failed deployments translate - into real-world incidents, including their severity and frequency.' + description: |- + Use this API endpoint to provide incident data for DORA Metrics. + Note that change failure rate and failed deployment recovery time are computed from change failures detected on deployments, not from incident events sent through this endpoint. + Tracking incidents gives a side-by-side view of how failed deployments translate into real-world incidents, including their severity and frequency. operationId: CreateDORAFailure requestBody: content: application/json: schema: - $ref: '#/components/schemas/DORAFailureRequest' + $ref: "#/components/schemas/DORAFailureRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DORAFailureResponse' + $ref: "#/components/schemas/DORAFailureResponse" description: OK - '202': + "202": content: application/json: schema: - $ref: '#/components/schemas/DORAFailureResponse' + $ref: "#/components/schemas/DORAFailureResponse" description: OK - but delayed due to incident - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] + - apiKeyAuth: [] summary: Send an incident event - tags: - - DORA Metrics + tags: ["DORA Metrics"] x-codegen-request-body-name: body /api/v2/dora/failure/{failure_id}: delete: - description: Use this API endpoint to delete an incident event. + description: |- + Use this API endpoint to delete an incident event. operationId: DeleteDORAFailure parameters: - - description: The ID of the incident event to delete. - in: path - name: failure_id - required: true - schema: - type: string + - description: The ID of the incident event to delete. + in: path + name: failure_id + required: true + schema: + type: string responses: - '202': + "202": description: Accepted - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Delete an incident event - tags: - - DORA Metrics + tags: ["DORA Metrics"] x-permission: operator: OR permissions: - - dora_metrics_write + - dora_metrics_write /api/v2/dora/failures: post: - description: Use this API endpoint to get a list of incident events. + description: |- + Use this API endpoint to get a list of incident events. operationId: ListDORAFailures requestBody: content: application/json: schema: - $ref: '#/components/schemas/DORAListFailuresRequest' + $ref: "#/components/schemas/DORAListFailuresRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DORAFailuresListResponse' + $ref: "#/components/schemas/DORAFailuresListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get a list of incident events - tags: - - DORA Metrics + tags: ["DORA Metrics"] x-codegen-request-body-name: body x-permission: operator: OR permissions: - - dora_metrics_read + - dora_metrics_read /api/v2/dora/failures/{failure_id}: get: - description: Use this API endpoint to get an incident event. + description: |- + Use this API endpoint to get an incident event. operationId: GetDORAFailure parameters: - - description: The ID of the incident event. - in: path - name: failure_id - required: true - schema: - type: string + - description: The ID of the incident event. + in: path + name: failure_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DORAFailureFetchResponse' + $ref: "#/components/schemas/DORAFailureFetchResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get an incident event - tags: - - DORA Metrics + tags: ["DORA Metrics"] x-codegen-request-body-name: body x-permission: operator: OR permissions: - - dora_metrics_read + - dora_metrics_read /api/v2/dora/incident: post: deprecated: true - description: '**Note**: This endpoint is deprecated. Please use `/api/v2/dora/failure` - instead. - + description: |- + **Note**: This endpoint is deprecated. Please use `/api/v2/dora/failure` instead. Use this API endpoint to provide incident data. - - Tracking incidents gives a side-by-side view of how failed deployments translate - into real-world incidents.' + Tracking incidents gives a side-by-side view of how failed deployments translate into real-world incidents. operationId: CreateDORAIncident requestBody: content: application/json: schema: - $ref: '#/components/schemas/DORAFailureRequest' + $ref: "#/components/schemas/DORAFailureRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DORAFailureResponse' + $ref: "#/components/schemas/DORAFailureResponse" description: OK - '202': + "202": content: application/json: schema: - $ref: '#/components/schemas/DORAFailureResponse' + $ref: "#/components/schemas/DORAFailureResponse" description: OK - but delayed due to incident - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] + - apiKeyAuth: [] summary: Send an incident event (legacy) - tags: - - DORA Metrics + tags: ["DORA Metrics"] x-codegen-request-body-name: body /api/v2/downtime: get: description: Get all scheduled downtimes. operationId: ListDowntimes parameters: - - description: Only return downtimes that are active when the request is made. - in: query - name: current_only - required: false - schema: - type: boolean - - description: 'Comma-separated list of resource paths for related resources - to include in the response. Supported resource - - paths are `created_by` and `monitor`.' - in: query - name: include - required: false - schema: - example: created_by,monitor - type: string - - $ref: '#/components/parameters/PageOffset' - - description: Maximum number of downtimes in the response. - example: 100 - in: query - name: page[limit] - required: false - schema: - default: 30 - format: int64 - type: integer + - description: Only return downtimes that are active when the request is made. + in: query + name: current_only + required: false + schema: + type: boolean + - description: |- + Comma-separated list of resource paths for related resources to include in the response. Supported resource + paths are `created_by` and `monitor`. + in: query + name: include + required: false + schema: + example: "created_by,monitor" + type: string + - $ref: "#/components/parameters/PageOffset" + - description: Maximum number of downtimes in the response. + example: 100 + in: query + name: page[limit] + required: false + schema: + default: 30 + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListDowntimesResponse' + $ref: "#/components/schemas/ListDowntimesResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_downtime + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_downtime summary: Get all downtimes tags: - - Downtimes + - Downtimes x-pagination: limitParam: page[limit] pageOffsetParam: page[offset] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - monitors_downtime + - monitors_downtime post: description: Schedule a downtime. operationId: CreateDowntime @@ -83423,854 +79660,764 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DowntimeCreateRequest' + $ref: "#/components/schemas/DowntimeCreateRequest" description: Schedule a downtime request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DowntimeResponse' + $ref: "#/components/schemas/DowntimeResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_downtime + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_downtime summary: Schedule a downtime tags: - - Downtimes + - Downtimes x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - monitors_downtime + - monitors_downtime /api/v2/downtime/{downtime_id}: delete: - description: 'Cancel a downtime. - + description: |- + Cancel a downtime. - **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.' + **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. operationId: CancelDowntime parameters: - - description: ID of the downtime to cancel. - in: path - name: downtime_id - required: true - schema: - example: 00000000-0000-1234-0000-000000000000 - type: string + - description: ID of the downtime to cancel. + in: path + name: downtime_id + required: true + schema: + example: 00000000-0000-1234-0000-000000000000 + type: string responses: - '204': + "204": description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Downtime not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_downtime + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_downtime summary: Cancel a downtime tags: - - Downtimes - x-permission: + - Downtimes + "x-permission": operator: OR permissions: - - monitors_downtime + - monitors_downtime get: description: Get downtime detail by `downtime_id`. operationId: GetDowntime parameters: - - description: ID of the downtime to fetch. - in: path - name: downtime_id - required: true - schema: - example: 00000000-0000-1234-0000-000000000000 - type: string - - description: 'Comma-separated list of resource paths for related resources - to include in the response. Supported resource - - paths are `created_by` and `monitor`.' - in: query - name: include - required: false - schema: - example: created_by,monitor - type: string + - description: ID of the downtime to fetch. + in: path + name: downtime_id + required: true + schema: + example: "00000000-0000-1234-0000-000000000000" + type: string + - description: |- + Comma-separated list of resource paths for related resources to include in the response. Supported resource + paths are `created_by` and `monitor`. + in: query + name: include + required: false + schema: + example: "created_by,monitor" + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DowntimeResponse' + $ref: "#/components/schemas/DowntimeResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_downtime + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_downtime summary: Get a downtime tags: - - Downtimes - x-permission: + - Downtimes + "x-permission": operator: OR permissions: - - monitors_downtime + - monitors_downtime patch: description: Update a downtime by `downtime_id`. operationId: UpdateDowntime parameters: - - description: ID of the downtime to update. - in: path - name: downtime_id - required: true - schema: - example: 00e000000-0000-1234-0000-000000000000 - type: string + - description: ID of the downtime to update. + in: path + name: downtime_id + required: true + schema: + example: "00e000000-0000-1234-0000-000000000000" + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/DowntimeUpdateRequest' + $ref: "#/components/schemas/DowntimeUpdateRequest" description: Update a downtime request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DowntimeResponse' + $ref: "#/components/schemas/DowntimeResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Downtime not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_downtime + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_downtime summary: Update a downtime tags: - - Downtimes + - Downtimes x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - monitors_downtime + - monitors_downtime /api/v2/error-tracking/issues/search: post: - description: Search issues endpoint allows you to programmatically search for - issues within your organization. This endpoint returns a list of issues that - match a given search query, following the event search syntax. The search - results are limited to a maximum of 100 issues per request. + description: Search issues endpoint allows you to programmatically search for issues within your organization. This endpoint returns a list of issues that match a given search query, following the event search syntax. The search results are limited to a maximum of 100 issues per request. operationId: SearchIssues parameters: - - $ref: '#/components/parameters/SearchIssuesIncludeQueryParameter' + - $ref: "#/components/parameters/SearchIssuesIncludeQueryParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/IssuesSearchRequest' + $ref: "#/components/schemas/IssuesSearchRequest" description: Search issues request payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IssuesSearchResponse' + $ref: "#/components/schemas/IssuesSearchResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - error_tracking_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - error_tracking_read summary: Search error tracking issues tags: - - Error Tracking + - Error Tracking /api/v2/error-tracking/issues/{issue_id}: get: - description: Retrieve the full details for a specific error tracking issue, - including attributes and relationships. + description: Retrieve the full details for a specific error tracking issue, including attributes and relationships. operationId: GetIssue parameters: - - $ref: '#/components/parameters/IssueIDPathParameter' - - $ref: '#/components/parameters/GetIssueIncludeQueryParameter' + - $ref: "#/components/parameters/IssueIDPathParameter" + - $ref: "#/components/parameters/GetIssueIncludeQueryParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IssueResponse' + $ref: "#/components/schemas/IssueResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - error_tracking_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - error_tracking_read summary: Get the details of an error tracking issue tags: - - Error Tracking + - Error Tracking /api/v2/error-tracking/issues/{issue_id}/assignee: delete: description: Remove the assignee of an issue by `issue_id`. operationId: DeleteIssueAssignee parameters: - - $ref: '#/components/parameters/IssueIDPathParameter' + - $ref: "#/components/parameters/IssueIDPathParameter" responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - error_tracking_read - - error_tracking_write - - cases_read - - cases_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - error_tracking_read + - error_tracking_write + - cases_read + - cases_write summary: Remove the assignee of an issue tags: - - Error Tracking + - Error Tracking put: description: Update the assignee of an issue by `issue_id`. operationId: UpdateIssueAssignee parameters: - - $ref: '#/components/parameters/IssueIDPathParameter' + - $ref: "#/components/parameters/IssueIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/IssueUpdateAssigneeRequest' + $ref: "#/components/schemas/IssueUpdateAssigneeRequest" description: Update issue assignee request payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IssueResponse' + $ref: "#/components/schemas/IssueResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - error_tracking_read - - error_tracking_write - - cases_read - - cases_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - error_tracking_read + - error_tracking_write + - cases_read + - cases_write summary: Update the assignee of an issue tags: - - Error Tracking + - Error Tracking /api/v2/error-tracking/issues/{issue_id}/state: put: - description: Update the state of an issue by `issue_id`. Use this endpoint to - move an issue between states such as `OPEN`, `RESOLVED`, or `IGNORED`. + description: Update the state of an issue by `issue_id`. Use this endpoint to move an issue between states such as `OPEN`, `RESOLVED`, or `IGNORED`. operationId: UpdateIssueState parameters: - - $ref: '#/components/parameters/IssueIDPathParameter' + - $ref: "#/components/parameters/IssueIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/IssueUpdateStateRequest' + $ref: "#/components/schemas/IssueUpdateStateRequest" description: Update issue state request payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IssueResponse' + $ref: "#/components/schemas/IssueResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - error_tracking_read - - error_tracking_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - error_tracking_read + - error_tracking_write summary: Update the state of an issue tags: - - Error Tracking + - Error Tracking /api/v2/events: get: - description: 'List endpoint returns events that match an events search query. - + description: |- + List endpoint returns events that match an events search query. [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). - - Use this endpoint to see your latest events.' + Use this endpoint to see your latest events. operationId: ListEvents parameters: - - description: Search query following events syntax. - in: query - name: filter[query] - required: false - schema: - type: string - - description: Minimum timestamp for requested events, in milliseconds. - in: query - name: filter[from] - required: false - schema: - type: string - - description: Maximum timestamp for requested events, in milliseconds. - in: query - name: filter[to] - required: false - schema: - type: string - - description: Order of events in results. - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/EventsSort' - - description: List following results with a cursor provided in the previous - query. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== - in: query - name: page[cursor] - required: false - schema: - type: string - - description: Maximum number of events in the response. - example: 25 - in: query - name: page[limit] - required: false - schema: - default: 10 - format: int32 - maximum: 1000 - type: integer + - description: Search query following events syntax. + in: query + name: filter[query] + required: false + schema: + type: string + - description: Minimum timestamp for requested events, in milliseconds. + in: query + name: filter[from] + required: false + schema: + type: string + - description: Maximum timestamp for requested events, in milliseconds. + in: query + name: filter[to] + required: false + schema: + type: string + - description: Order of events in results. + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/EventsSort" + - description: |- + List following results with a cursor provided in the previous query. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" + in: query + name: page[cursor] + required: false + schema: + type: string + - description: Maximum number of events in the response. + example: 25 + in: query + name: page[limit] + required: false + schema: + default: 10 + format: int32 + maximum: 1000 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EventsListResponse' + $ref: "#/components/schemas/EventsListResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - events_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - events_read summary: Get a list of events - tags: - - Events + tags: ["Events"] x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - events_read + - events_read post: - description: "This endpoint allows you to publish events.\n\n**Note:** To utilize - this endpoint with our client libraries, please ensure you are using the latest - version released on or after July 1, 2025. Earlier versions do not support - this functionality.\n\n**Important:** Upgrade to the latest client library - version to use the updated endpoint at `https://event-management-intake.{site}/api/v2/events`. - Older client library versions of the Post an event (v2) API send requests - to a deprecated endpoint (`https://api.{site}/api/v2/events`).\n\n\u2705 **Only - events with the `change` or `alert` category** are in General Availability. - For change events, see [Change Tracking](https://docs.datadoghq.com/change_tracking) - for more details.\n\n\u274C For use cases involving other event categories, - use the V1 endpoint or reach out to [support](https://www.datadoghq.com/support/)." + description: |- + This endpoint allows you to publish events. + + **Note:** To utilize this endpoint with our client libraries, please ensure you are using the latest version released on or after July 1, 2025. Earlier versions do not support this functionality. + + **Important:** Upgrade to the latest client library version to use the updated endpoint at `https://event-management-intake.{site}/api/v2/events`. Older client library versions of the Post an event (v2) API send requests to a deprecated endpoint (`https://api.{site}/api/v2/events`). + + ✅ **Only events with the `change` or `alert` category** are in General Availability. For change events, see [Change Tracking](https://docs.datadoghq.com/change_tracking) for more details. + + ❌ For use cases involving other event categories, use the V1 endpoint or reach out to [support](https://www.datadoghq.com/support/). operationId: CreateEvent requestBody: content: application/json: examples: alert-event: - description: Example of an alert event for tracking alerts and monitoring - events. + description: Example of an alert event for tracking alerts and monitoring events. summary: Alert Event - value: - data: - attributes: - aggregation_key: deduplication_key_here - attributes: - custom: - my-object-attribute: - my-array-attribute: - - 1 - - 2 - - 3 - my-array-object-attribute: - - name: test-object-1 - - name: test-object-2 - my-integer-attribute: 1 - my-string-attribute: my-custom-value - links: - - category: runbook - title: Datadog website - url: https://datadoghq.com - priority: '1' - status: error - category: alert - message: Something is broken! - tags: - - service:my-test-service - - datacenter:primary - title: My Alerting Event - type: event + value: {"data": {"attributes": {"aggregation_key": "deduplication_key_here", "attributes": {"custom": {"my-object-attribute": {"my-array-attribute": [1, 2, 3], "my-array-object-attribute": ["name": "test-object-1", "name": "test-object-2"], "my-integer-attribute": 1}, "my-string-attribute": "my-custom-value"}, "links": [{"category": "runbook", "title": "Datadog website", "url": "https://datadoghq.com"}], "priority": "1", "status": "error"}, "category": "alert", "message": "Something is broken!", "tags": ["service:my-test-service", "datacenter:primary"], "title": "My Alerting Event"}, "type": "event"}} change-event: - description: Example of a change event for tracking configuration - or feature flag changes. + description: Example of a change event for tracking configuration or feature flag changes. summary: Change Event - value: - data: - attributes: - aggregation_key: aggregation_key_123 - attributes: - author: - name: example@datadog.com - type: user - change_metadata: - dd: - team: datadog_team - user_email: datadog@datadog.com - user_id: datadog_user_id - user_name: datadog_username - resource_link: datadog.com/feature/fallback_payments_test - changed_resource: - name: fallback_payments_test - type: feature_flag - impacted_resources: - - name: payments_api - type: service - new_value: - enabled: true - percentage: 50% - rule: - datacenter: devcycle.us1.prod - prev_value: - enabled: true - percentage: 10% - rule: - datacenter: devcycle.us1.prod - category: change - host: hostname - integration_id: custom-events - message: payment_processed feature flag has been enabled - tags: - - env:api_client_test - timestamp: '2020-01-01T01:30:15.010000Z' - title: payment_processed feature flag updated - type: event + value: {"data": {"attributes": {"aggregation_key": "aggregation_key_123", "attributes": {"author": {"name": "example@datadog.com", "type": "user"}, "change_metadata": {"dd": {"team": "datadog_team", "user_email": "datadog@datadog.com", "user_id": "datadog_user_id", "user_name": "datadog_username"}, "resource_link": "datadog.com/feature/fallback_payments_test"}, "changed_resource": {"name": "fallback_payments_test", "type": "feature_flag"}, "impacted_resources": [{"name": "payments_api", "type": "service"}], "new_value": {"enabled": true, "percentage": "50%", "rule": {"datacenter": "devcycle.us1.prod"}}, "prev_value": {"enabled": true, "percentage": "10%", "rule": {"datacenter": "devcycle.us1.prod"}}}, "category": "change", "host": "hostname", "integration_id": "custom-events", "message": "payment_processed feature flag has been enabled", "tags": ["env:api_client_test"], "timestamp": "2020-01-01T01:30:15.010000Z", "title": "payment_processed feature flag updated"}, "type": "event"}} schema: - $ref: '#/components/schemas/EventCreateRequestPayload' + $ref: "#/components/schemas/EventCreateRequestPayload" description: Event creation request payload. required: true responses: - '202': + "202": content: application/json: schema: - $ref: '#/components/schemas/EventCreateResponsePayload' + $ref: "#/components/schemas/EventCreateResponsePayload" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] servers: - - url: https://{subdomain}.{site} - variables: - site: - default: datadoghq.com - description: The regional site for customers. - enum: - - datadoghq.com - - us3.datadoghq.com - - us5.datadoghq.com - - ap1.datadoghq.com - - ap2.datadoghq.com - - datadoghq.eu - - ddog-gov.com - subdomain: - default: event-management-intake - description: The subdomain where the API is deployed. - - url: '{protocol}://{name}' - variables: - name: - default: event-management-intake.datadoghq.com - description: Full site DNS name. - protocol: - default: https - description: The protocol for accessing the API. - - url: https://{subdomain}.{site} - variables: - site: - default: datadoghq.com - description: Any Datadog deployment. - subdomain: - default: event-management-intake - description: The subdomain where the API is deployed. + - url: https://{subdomain}.{site} + variables: + site: + default: datadoghq.com + description: The regional site for customers. + enum: + - datadoghq.com + - us3.datadoghq.com + - us5.datadoghq.com + - ap1.datadoghq.com + - ap2.datadoghq.com + - datadoghq.eu + - ddog-gov.com + subdomain: + default: event-management-intake + description: The subdomain where the API is deployed. + - url: "{protocol}://{name}" + variables: + name: + default: event-management-intake.datadoghq.com + description: Full site DNS name. + protocol: + default: https + description: The protocol for accessing the API. + - url: https://{subdomain}.{site} + variables: + site: + default: datadoghq.com + description: Any Datadog deployment. + subdomain: + default: event-management-intake + description: The subdomain where the API is deployed. summary: Post an event - tags: - - Events + tags: ["Events"] x-codegen-request-body-name: body /api/v2/events/search: post: - description: 'List endpoint returns events that match an events search query. - + description: |- + List endpoint returns events that match an events search query. [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). - - Use this endpoint to build complex events filtering and search.' + Use this endpoint to build complex events filtering and search. operationId: SearchEvents requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/EventsListRequest' + $ref: "#/components/schemas/EventsListRequest" required: false responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EventsListResponse' + $ref: "#/components/schemas/EventsListResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Search events - tags: - - Events + tags: ["Events"] x-codegen-request-body-name: body x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - events_read + - events_read /api/v2/events/{event_id}: get: - description: Get the details of an event by `event_id`. + description: >- + Get the details of an event by `event_id`. operationId: GetEvent parameters: - - description: The UID of the event. - in: path - name: event_id - required: true - schema: - type: string + - description: The UID of the event. + in: path + name: event_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/V2EventResponse' + $ref: "#/components/schemas/V2EventResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - events_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - events_read summary: Get an event - tags: - - Events - x-permission: + tags: ["Events"] + "x-permission": operator: OR permissions: - - events_read + - events_read /api/v2/hamr: get: - description: 'Retrieve the High Availability Multi-Region (HAMR) organization - connection details for the authenticated organization. - - This endpoint returns information about the HAMR connection configuration, - including the target organization, - - datacenter, status, and whether this is the primary or secondary organization - in the HAMR relationship.' + description: |- + Retrieve the High Availability Multi-Region (HAMR) organization connection details for the authenticated organization. + This endpoint returns information about the HAMR connection configuration, including the target organization, + datacenter, status, and whether this is the primary or secondary organization in the HAMR relationship. operationId: GetHamrOrgConnection responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/HamrOrgConnectionResponse' + $ref: "#/components/schemas/HamrOrgConnectionResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get HAMR organization connection tags: - - High Availability MultiRegion - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - High Availability MultiRegion + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: - description: 'Create or update the High Availability Multi-Region (HAMR) organization - connection. - - This endpoint allows you to configure the HAMR connection between the authenticated - organization - - and a target organization, including setting the connection status (ONBOARDING, - PASSIVE, FAILOVER, ACTIVE, RECOVERY)' + description: |- + Create or update the High Availability Multi-Region (HAMR) organization connection. + This endpoint allows you to configure the HAMR connection between the authenticated organization + and a target organization, including setting the connection status (ONBOARDING, PASSIVE, FAILOVER, ACTIVE, RECOVERY) operationId: CreateHamrOrgConnection requestBody: content: application/json: schema: - $ref: '#/components/schemas/HamrOrgConnectionRequest' + $ref: "#/components/schemas/HamrOrgConnectionRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/HamrOrgConnectionResponse' + $ref: "#/components/schemas/HamrOrgConnectionResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Internal Server Error security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Create or update HAMR organization connection tags: - - High Availability MultiRegion - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - High Availability MultiRegion + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents: get: - description: Get all incidents for the user's organization. + description: >- + Get all incidents for the user's organization. operationId: ListIncidents parameters: - - $ref: '#/components/parameters/IncidentIncludeQueryParameter' - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageOffset' + - $ref: "#/components/parameters/IncidentIncludeQueryParameter" + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageOffset" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentsResponse' + $ref: "#/components/schemas/IncidentsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read summary: Get a list of incidents tags: - - Incidents + - Incidents x-pagination: limitParam: page[size] pageOffsetParam: page[offset] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - incident_read - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_read + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Create an incident. operationId: CreateIncident @@ -84278,196 +80425,196 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/IncidentCreateRequest' + $ref: "#/components/schemas/IncidentCreateRequest" description: Incident payload. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/IncidentResponse' + $ref: "#/components/schemas/IncidentResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write summary: Create an incident tags: - - Incidents + - Incidents x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - incident_write - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_write + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/config/global/incident-handles: delete: description: Delete a global incident handle. operationId: DeleteGlobalIncidentHandle responses: - '204': + "204": description: No Content - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete global incident handle tags: - - Incidents - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Incidents + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: description: Retrieve a list of global incident handles. operationId: ListGlobalIncidentHandles parameters: - - description: Comma-separated list of related resources to include in the response - in: query - name: include - required: false - schema: - example: created_by_user,last_modified_by_user,commander_user,incident_type - type: string + - description: Comma-separated list of related resources to include in the response + in: query + name: include + required: false + schema: + example: "created_by_user,last_modified_by_user,commander_user,incident_type" + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentHandlesResponse' + $ref: "#/components/schemas/IncidentHandlesResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List global incident handles tags: - - Incidents - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Incidents + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Create a new global incident handle. operationId: CreateGlobalIncidentHandle parameters: - - description: Comma-separated list of related resources to include in the response - in: query - name: include - required: false - schema: - example: created_by_user,last_modified_by_user,commander_user,incident_type - type: string + - description: Comma-separated list of related resources to include in the response + in: query + name: include + required: false + schema: + example: "created_by_user,last_modified_by_user,commander_user,incident_type" + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentHandleRequest' + $ref: "#/components/schemas/IncidentHandleRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/IncidentHandleResponse' + $ref: "#/components/schemas/IncidentHandleResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create global incident handle tags: - - Incidents - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Incidents + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). put: description: Update an existing global incident handle. operationId: UpdateGlobalIncidentHandle parameters: - - description: Comma-separated list of related resources to include in the response - in: query - name: include - required: false - schema: - example: created_by_user,last_modified_by_user,commander_user,incident_type - type: string + - description: Comma-separated list of related resources to include in the response + in: query + name: include + required: false + schema: + example: "created_by_user,last_modified_by_user,commander_user,incident_type" + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentHandleRequest' + $ref: "#/components/schemas/IncidentHandleRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentHandleResponse' + $ref: "#/components/schemas/IncidentHandleResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update global incident handle tags: - - Incidents - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Incidents + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/config/global/settings: get: description: Retrieve global incident settings for the organization. operationId: GetGlobalIncidentSettings responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GlobalIncidentSettingsResponse' + $ref: "#/components/schemas/GlobalIncidentSettingsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get global incident settings tags: - - Incidents - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Incidents + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: description: Update global incident settings for the organization. operationId: UpdateGlobalIncidentSettings @@ -84475,67 +80622,66 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GlobalIncidentSettingsRequest' + $ref: "#/components/schemas/GlobalIncidentSettingsRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GlobalIncidentSettingsResponse' + $ref: "#/components/schemas/GlobalIncidentSettingsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update global incident settings tags: - - Incidents - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Incidents + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/config/notification-rules: get: - description: Lists all notification rules for the organization. Optionally filter - by incident type. + description: Lists all notification rules for the organization. Optionally filter by incident type. operationId: ListIncidentNotificationRules parameters: - - $ref: '#/components/parameters/IncidentNotificationRuleIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentNotificationRuleIncludeQueryParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentNotificationRuleArray' + $ref: "#/components/schemas/IncidentNotificationRuleArray" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: List incident notification rules tags: - - Incidents + - Incidents x-permission: operator: AND permissions: - - incident_notification_settings_read - x-unstable: '**Note**: This endpoint is in Preview. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_notification_settings_read + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Creates a new notification rule. operationId: CreateIncidentNotificationRule @@ -84543,198 +80689,197 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateIncidentNotificationRuleRequest' + $ref: "#/components/schemas/CreateIncidentNotificationRuleRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/IncidentNotificationRule' + $ref: "#/components/schemas/IncidentNotificationRule" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_notification_settings_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_notification_settings_write summary: Create an incident notification rule tags: - - Incidents + - Incidents x-codegen-request-body-name: body x-permission: operator: AND permissions: - - incident_notification_settings_write - x-unstable: '**Note**: This endpoint is in Preview. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_notification_settings_write + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/config/notification-rules/{id}: delete: description: Deletes a notification rule by its ID. operationId: DeleteIncidentNotificationRule parameters: - - $ref: '#/components/parameters/IncidentNotificationRuleIDPathParameter' - - $ref: '#/components/parameters/IncidentNotificationRuleIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentNotificationRuleIDPathParameter" + - $ref: "#/components/parameters/IncidentNotificationRuleIncludeQueryParameter" responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_notification_settings_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_notification_settings_write summary: Delete an incident notification rule tags: - - Incidents + - Incidents x-permission: operator: AND permissions: - - incident_notification_settings_write - x-unstable: '**Note**: This endpoint is in Preview. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_notification_settings_write + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: description: Retrieves a specific notification rule by its ID. operationId: GetIncidentNotificationRule parameters: - - $ref: '#/components/parameters/IncidentNotificationRuleIDPathParameter' - - $ref: '#/components/parameters/IncidentNotificationRuleIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentNotificationRuleIDPathParameter" + - $ref: "#/components/parameters/IncidentNotificationRuleIncludeQueryParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentNotificationRule' + $ref: "#/components/schemas/IncidentNotificationRule" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_notification_settings_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_notification_settings_read summary: Get an incident notification rule tags: - - Incidents + - Incidents x-permission: operator: AND permissions: - - incident_notification_settings_read - x-unstable: '**Note**: This endpoint is in Preview. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_notification_settings_read + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). put: description: Updates an existing notification rule with a complete replacement. operationId: UpdateIncidentNotificationRule parameters: - - $ref: '#/components/parameters/IncidentNotificationRuleIDPathParameter' - - $ref: '#/components/parameters/IncidentNotificationRuleIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentNotificationRuleIDPathParameter" + - $ref: "#/components/parameters/IncidentNotificationRuleIncludeQueryParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/PutIncidentNotificationRuleRequest' + $ref: "#/components/schemas/PutIncidentNotificationRuleRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentNotificationRule' + $ref: "#/components/schemas/IncidentNotificationRule" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_notification_settings_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_notification_settings_write summary: Update an incident notification rule tags: - - Incidents + - Incidents x-codegen-request-body-name: body x-permission: operator: AND permissions: - - incident_notification_settings_write - x-unstable: '**Note**: This endpoint is in Preview. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_notification_settings_write + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/config/notification-templates: get: - description: Lists all notification templates. Optionally filter by incident - type. + description: Lists all notification templates. Optionally filter by incident type. operationId: ListIncidentNotificationTemplates parameters: - - $ref: '#/components/parameters/IncidentNotificationTemplateIncidentTypeFilterQueryParameter' - - $ref: '#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentNotificationTemplateIncidentTypeFilterQueryParameter" + - $ref: "#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentNotificationTemplateArray' + $ref: "#/components/schemas/IncidentNotificationTemplateArray" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: List incident notification templates tags: - - Incidents + - Incidents x-permission: operator: AND permissions: - - incident_notification_settings_read - x-unstable: '**Note**: This endpoint is in Preview. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_notification_settings_read + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Creates a new notification template. operationId: CreateIncidentNotificationTemplate @@ -84742,187 +80887,187 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateIncidentNotificationTemplateRequest' + $ref: "#/components/schemas/CreateIncidentNotificationTemplateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/IncidentNotificationTemplate' + $ref: "#/components/schemas/IncidentNotificationTemplate" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_notification_settings_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_notification_settings_write summary: Create incident notification template tags: - - Incidents + - Incidents x-codegen-request-body-name: body x-permission: operator: AND permissions: - - incident_notification_settings_write - x-unstable: '**Note**: This endpoint is in Preview. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_notification_settings_write + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/config/notification-templates/{id}: delete: description: Deletes a notification template by its ID. operationId: DeleteIncidentNotificationTemplate parameters: - - $ref: '#/components/parameters/IncidentNotificationTemplateIDPathParameter' - - $ref: '#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentNotificationTemplateIDPathParameter" + - $ref: "#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter" responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_notification_settings_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_notification_settings_write summary: Delete a notification template tags: - - Incidents + - Incidents x-permission: operator: AND permissions: - - incident_notification_settings_write - x-unstable: '**Note**: This endpoint is in Preview. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_notification_settings_write + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: description: Retrieves a specific notification template by its ID. operationId: GetIncidentNotificationTemplate parameters: - - $ref: '#/components/parameters/IncidentNotificationTemplateIDPathParameter' - - $ref: '#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentNotificationTemplateIDPathParameter" + - $ref: "#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentNotificationTemplate' + $ref: "#/components/schemas/IncidentNotificationTemplate" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_read - - incident_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read + - incident_write summary: Get incident notification template tags: - - Incidents + - Incidents x-permission: operator: OR permissions: - - incident_settings_read - - incident_write - - incident_read - x-unstable: '**Note**: This endpoint is in Preview. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_settings_read + - incident_write + - incident_read + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: description: Updates an existing notification template's attributes. operationId: UpdateIncidentNotificationTemplate parameters: - - $ref: '#/components/parameters/IncidentNotificationTemplateIDPathParameter' - - $ref: '#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentNotificationTemplateIDPathParameter" + - $ref: "#/components/parameters/IncidentNotificationTemplateIncludeQueryParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchIncidentNotificationTemplateRequest' + $ref: "#/components/schemas/PatchIncidentNotificationTemplateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentNotificationTemplate' + $ref: "#/components/schemas/IncidentNotificationTemplate" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_notification_settings_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_notification_settings_write summary: Update incident notification template tags: - - Incidents + - Incidents x-codegen-request-body-name: body x-permission: operator: AND permissions: - - incident_notification_settings_write - x-unstable: '**Note**: This endpoint is in Preview. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_notification_settings_write + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/config/postmortem-templates: get: description: Retrieve a list of all postmortem templates for incidents. operationId: ListIncidentPostmortemTemplates responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PostmortemTemplatesResponse' + $ref: "#/components/schemas/PostmortemTemplatesResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List postmortem templates tags: - - Incidents - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Incidents + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Create a new postmortem template for incidents. operationId: CreateIncidentPostmortemTemplate @@ -84930,189 +81075,189 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PostmortemTemplateRequest' + $ref: "#/components/schemas/PostmortemTemplateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/PostmortemTemplateResponse' + $ref: "#/components/schemas/PostmortemTemplateResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create postmortem template tags: - - Incidents - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Incidents + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/config/postmortem-templates/{template_id}: delete: description: Delete a postmortem template. operationId: DeleteIncidentPostmortemTemplate parameters: - - description: The ID of the postmortem template - in: path - name: template_id - required: true - schema: - example: template-456 - type: string + - description: The ID of the postmortem template + in: path + name: template_id + required: true + schema: + example: "template-456" + type: string responses: - '204': + "204": description: No Content - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete postmortem template tags: - - Incidents - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Incidents + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: description: Retrieve details of a specific postmortem template. operationId: GetIncidentPostmortemTemplate parameters: - - description: The ID of the postmortem template - in: path - name: template_id - required: true - schema: - example: template-456 - type: string + - description: The ID of the postmortem template + in: path + name: template_id + required: true + schema: + example: "template-456" + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PostmortemTemplateResponse' + $ref: "#/components/schemas/PostmortemTemplateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get postmortem template tags: - - Incidents - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Incidents + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: description: Update an existing postmortem template. operationId: UpdateIncidentPostmortemTemplate parameters: - - description: The ID of the postmortem template - in: path - name: template_id - required: true - schema: - example: template-456 - type: string + - description: The ID of the postmortem template + in: path + name: template_id + required: true + schema: + example: "template-456" + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/PostmortemTemplateRequest' + $ref: "#/components/schemas/PostmortemTemplateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PostmortemTemplateResponse' + $ref: "#/components/schemas/PostmortemTemplateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update postmortem template tags: - - Incidents - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Incidents + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/config/types: get: description: Get all incident types. operationId: ListIncidentTypes parameters: - - $ref: '#/components/parameters/IncidentTypeIncludeDeletedParameter' + - $ref: "#/components/parameters/IncidentTypeIncludeDeletedParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentTypeListResponse' + $ref: "#/components/schemas/IncidentTypeListResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read summary: Get a list of incident types tags: - - Incidents - x-permission: + - Incidents + "x-permission": operator: OR permissions: - - incident_settings_read - - incident_read - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_settings_read + - incident_read + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Create an incident type. operationId: CreateIncidentType @@ -85120,1111 +81265,1104 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/IncidentTypeCreateRequest' + $ref: "#/components/schemas/IncidentTypeCreateRequest" description: Incident type payload. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/IncidentTypeResponse' + $ref: "#/components/schemas/IncidentTypeResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_settings_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_write summary: Create an incident type tags: - - Incidents + - Incidents x-codegen-request-body-name: body - x-permission: + "x-permission": operator: AND permissions: - - incident_settings_write - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_settings_write + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/config/types/{incident_type_id}: delete: description: Delete an incident type. operationId: DeleteIncidentType parameters: - - $ref: '#/components/parameters/IncidentTypeIDPathParameter' - responses: - '204': - description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_settings_write + - $ref: "#/components/parameters/IncidentTypeIDPathParameter" + responses: + "204": + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_write summary: Delete an incident type tags: - - Incidents + - Incidents x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - incident_settings_write - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_settings_write + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: description: Get incident type details. operationId: GetIncidentType parameters: - - $ref: '#/components/parameters/IncidentTypeIDPathParameter' + - $ref: "#/components/parameters/IncidentTypeIDPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentTypeResponse' + $ref: "#/components/schemas/IncidentTypeResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read summary: Get incident type details tags: - - Incidents - x-permission: + - Incidents + "x-permission": operator: OR permissions: - - incident_read - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_read + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: description: Update an incident type. operationId: UpdateIncidentType parameters: - - $ref: '#/components/parameters/IncidentTypeIDPathParameter' + - $ref: "#/components/parameters/IncidentTypeIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentTypePatchRequest' + $ref: "#/components/schemas/IncidentTypePatchRequest" description: Incident type payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentTypeResponse' + $ref: "#/components/schemas/IncidentTypeResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_settings_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_write summary: Update an incident type tags: - - Incidents + - Incidents x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - incident_settings_write - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_settings_write + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/import: post: - description: 'Import an incident from an external system. This endpoint allows - you to create incidents with - - historical data such as custom timestamps for detection, declaration, and - resolution. - - Imported incidents do not execute integrations or notification rules.' + description: |- + Import an incident from an external system. This endpoint allows you to create incidents with + historical data such as custom timestamps for detection, declaration, and resolution. + Imported incidents do not execute integrations or notification rules. operationId: ImportIncident parameters: - - $ref: '#/components/parameters/IncidentImportIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentImportIncludeQueryParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentImportRequest' + $ref: "#/components/schemas/IncidentImportRequest" description: Incident import payload. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/IncidentImportResponse' + $ref: "#/components/schemas/IncidentImportResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write summary: Import an incident tags: - - Incidents + - Incidents x-codegen-request-body-name: body - x-permission: + "x-permission": operator: AND permissions: - - incident_write - x-unstable: '**Note**: This endpoint is in Preview. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_write + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/search: get: - description: Search for incidents matching a certain query. + description: >- + Search for incidents matching a certain query. operationId: SearchIncidents parameters: - - $ref: '#/components/parameters/IncidentSearchIncludeQueryParameter' - - $ref: '#/components/parameters/IncidentSearchQueryQueryParameter' - - $ref: '#/components/parameters/IncidentSearchSortQueryParameter' - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageOffset' + - $ref: "#/components/parameters/IncidentSearchIncludeQueryParameter" + - $ref: "#/components/parameters/IncidentSearchQueryQueryParameter" + - $ref: "#/components/parameters/IncidentSearchSortQueryParameter" + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageOffset" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentSearchResponse' + $ref: "#/components/schemas/IncidentSearchResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read summary: Search for incidents tags: - - Incidents + - Incidents x-pagination: limitParam: page[size] pageOffsetParam: page[offset] resultsPath: data.attributes.incidents - x-permission: + "x-permission": operator: OR permissions: - - incident_read - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_read + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/{incident_id}: delete: description: Deletes an existing incident from the users organization. operationId: DeleteIncident parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' - responses: - '204': - description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_write + - $ref: "#/components/parameters/IncidentIDPathParameter" + responses: + "204": + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write summary: Delete an existing incident tags: - - Incidents - x-permission: + - Incidents + "x-permission": operator: OR permissions: - - incident_write - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_write + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: - description: Get the details of an incident by `incident_id`. + description: >- + Get the details of an incident by `incident_id`. operationId: GetIncident parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' - - $ref: '#/components/parameters/IncidentIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentIncludeQueryParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentResponse' + $ref: "#/components/schemas/IncidentResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read summary: Get the details of an incident tags: - - Incidents - x-permission: + - Incidents + "x-permission": operator: OR permissions: - - incident_read - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_read + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: - description: Updates an incident. Provide only the attributes that should be - updated as this request is a partial update. + description: >- + Updates an incident. Provide only the attributes that should be updated as this request is a partial update. operationId: UpdateIncident parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' - - $ref: '#/components/parameters/IncidentIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentIncludeQueryParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentUpdateRequest' + $ref: "#/components/schemas/IncidentUpdateRequest" description: Incident Payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentResponse' + $ref: "#/components/schemas/IncidentResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write summary: Update an existing incident tags: - - Incidents + - Incidents x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - incident_write - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_write + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/{incident_id}/attachments: get: description: List incident attachments. operationId: ListIncidentAttachments parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' - - description: Filter attachments by type. Supported values are `1` (`postmortem`) - and `2` (`link`). - in: query - name: filter[attachment_type] - schema: - example: '1' - type: string - - $ref: '#/components/parameters/AttachmentIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" + - description: Filter attachments by type. Supported values are `1` (`postmortem`) and `2` (`link`). + in: query + name: filter[attachment_type] + schema: + example: "1" + type: string + - $ref: "#/components/parameters/AttachmentIncludeQueryParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AttachmentArray' + $ref: "#/components/schemas/AttachmentArray" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: List incident attachments tags: - - Incidents - x-permission: + - Incidents + "x-permission": operator: OR permissions: - - incident_read - x-unstable: '**Note**: This endpoint is in Preview. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_read + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Create an incident attachment. operationId: CreateIncidentAttachment parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' - - $ref: '#/components/parameters/AttachmentIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/AttachmentIncludeQueryParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateAttachmentRequest' + $ref: "#/components/schemas/CreateAttachmentRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/Attachment' + $ref: "#/components/schemas/Attachment" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write summary: Create incident attachment tags: - - Incidents - x-permission: + - Incidents + "x-permission": operator: AND permissions: - - incident_write - x-unstable: '**Note**: This endpoint is in Preview. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_write + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/{incident_id}/attachments/postmortems: post: - description: 'Create a postmortem attachment for an incident. + description: |- + Create a postmortem attachment for an incident. - - The endpoint accepts markdown for notebooks created in Confluence or Google - Docs. - - Postmortems created from notebooks need to be formatted using frontend notebook - cells, - - in addition to markdown format.' + The endpoint accepts markdown for notebooks created in Confluence or Google Docs. + Postmortems created from notebooks need to be formatted using frontend notebook cells, + in addition to markdown format. operationId: CreateIncidentPostmortemAttachment parameters: - - description: The ID of the incident - in: path - name: incident_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000000 - type: string + - description: The ID of the incident + in: path + name: incident_id + required: true + schema: + example: "00000000-0000-0000-0000-000000000000" + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/PostmortemAttachmentRequest' + $ref: "#/components/schemas/PostmortemAttachmentRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/Attachment' + $ref: "#/components/schemas/Attachment" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create postmortem attachment tags: - - Incidents - x-unstable: '**Note**: This endpoint is in public beta and it''s subject to - change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Incidents + x-unstable: |- + **Note**: This endpoint is in public beta and it's subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/{incident_id}/attachments/{attachment_id}: delete: operationId: DeleteIncidentAttachment parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' - - $ref: '#/components/parameters/AttachmentIDPathParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/AttachmentIDPathParameter" responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write summary: Delete incident attachment tags: - - Incidents - x-permission: + - Incidents + "x-permission": operator: AND permissions: - - incident_write - x-unstable: '**Note**: This endpoint is in Preview. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_write + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: operationId: UpdateIncidentAttachment parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' - - $ref: '#/components/parameters/AttachmentIDPathParameter' - - $ref: '#/components/parameters/AttachmentIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/AttachmentIDPathParameter" + - $ref: "#/components/parameters/AttachmentIncludeQueryParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchAttachmentRequest' + $ref: "#/components/schemas/PatchAttachmentRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Attachment' + $ref: "#/components/schemas/Attachment" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write summary: Update incident attachment tags: - - Incidents - x-permission: + - Incidents + "x-permission": operator: AND permissions: - - incident_write - x-unstable: '**Note**: This endpoint is in Preview. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_write + x-unstable: |- + **Note**: This endpoint is in Preview. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/{incident_id}/impacts: get: description: Get all impacts for an incident. operationId: ListIncidentImpacts parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' - - $ref: '#/components/parameters/IncidentImpactIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentImpactIncludeQueryParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentImpactsResponse' + $ref: "#/components/schemas/IncidentImpactsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read summary: List an incident's impacts tags: - - Incidents - x-permission: + - Incidents + "x-permission": operator: OR permissions: - - incident_read + - incident_read post: description: Create an impact for an incident. operationId: CreateIncidentImpact parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' - - $ref: '#/components/parameters/IncidentImpactIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentImpactIncludeQueryParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentImpactCreateRequest' + $ref: "#/components/schemas/IncidentImpactCreateRequest" description: Incident impact payload. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/IncidentImpactResponse' + $ref: "#/components/schemas/IncidentImpactResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write summary: Create an incident impact tags: - - Incidents + - Incidents x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - incident_write + - incident_write /api/v2/incidents/{incident_id}/impacts/{impact_id}: delete: description: Delete an incident impact. operationId: DeleteIncidentImpact parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' - - $ref: '#/components/parameters/IncidentImpactIDPathParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentImpactIDPathParameter" responses: - '204': + "204": description: No Content - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_write + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write summary: Delete an incident impact tags: - - Incidents - x-permission: + - Incidents + "x-permission": operator: OR permissions: - - incident_write + - incident_write /api/v2/incidents/{incident_id}/relationships/integrations: get: description: Get all integration metadata for an incident. operationId: ListIncidentIntegrations parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentIntegrationMetadataListResponse' + $ref: "#/components/schemas/IncidentIntegrationMetadataListResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read summary: Get a list of an incident's integration metadata tags: - - Incidents - x-permission: + - Incidents + "x-permission": operator: OR permissions: - - incident_read - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_read + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Create an incident integration metadata. operationId: CreateIncidentIntegration parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentIntegrationMetadataCreateRequest' + $ref: "#/components/schemas/IncidentIntegrationMetadataCreateRequest" description: Incident integration metadata payload. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/IncidentIntegrationMetadataResponse' + $ref: "#/components/schemas/IncidentIntegrationMetadataResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write summary: Create an incident integration metadata tags: - - Incidents + - Incidents x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - incident_write - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_write + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/{incident_id}/relationships/integrations/{integration_metadata_id}: delete: description: Delete an incident integration metadata. operationId: DeleteIncidentIntegration parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' - - $ref: '#/components/parameters/IncidentIntegrationMetadataIDPathParameter' - responses: - '204': - description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_write + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentIntegrationMetadataIDPathParameter" + responses: + "204": + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write summary: Delete an incident integration metadata tags: - - Incidents + - Incidents x-codegen-request-body-name: body - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: description: Get incident integration metadata details. operationId: GetIncidentIntegration parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' - - $ref: '#/components/parameters/IncidentIntegrationMetadataIDPathParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentIntegrationMetadataIDPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentIntegrationMetadataResponse' + $ref: "#/components/schemas/IncidentIntegrationMetadataResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read summary: Get incident integration metadata details tags: - - Incidents - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Incidents + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: description: Update an existing incident integration metadata. operationId: UpdateIncidentIntegration parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' - - $ref: '#/components/parameters/IncidentIntegrationMetadataIDPathParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentIntegrationMetadataIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentIntegrationMetadataPatchRequest' + $ref: "#/components/schemas/IncidentIntegrationMetadataPatchRequest" description: Incident integration metadata payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentIntegrationMetadataResponse' + $ref: "#/components/schemas/IncidentIntegrationMetadataResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write summary: Update an existing incident integration metadata tags: - - Incidents + - Incidents x-codegen-request-body-name: body - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/{incident_id}/relationships/todos: get: description: Get all todos for an incident. operationId: ListIncidentTodos parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentTodoListResponse' + $ref: "#/components/schemas/IncidentTodoListResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read summary: Get a list of an incident's todos tags: - - Incidents - x-permission: + - Incidents + "x-permission": operator: OR permissions: - - incident_read - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_read + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Create an incident todo. operationId: CreateIncidentTodo parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentTodoCreateRequest' + $ref: "#/components/schemas/IncidentTodoCreateRequest" description: Incident todo payload. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/IncidentTodoResponse' + $ref: "#/components/schemas/IncidentTodoResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write summary: Create an incident todo tags: - - Incidents + - Incidents x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - incident_write - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_write + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/incidents/{incident_id}/relationships/todos/{todo_id}: delete: description: Delete an incident todo. operationId: DeleteIncidentTodo parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' - - $ref: '#/components/parameters/IncidentTodoIDPathParameter' - responses: - '204': - description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_write + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentTodoIDPathParameter" + responses: + "204": + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write summary: Delete an incident todo tags: - - Incidents - x-permission: + - Incidents + "x-permission": operator: OR permissions: - - incident_write - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_write + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: description: Get incident todo details. operationId: GetIncidentTodo parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' - - $ref: '#/components/parameters/IncidentTodoIDPathParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentTodoIDPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentTodoResponse' + $ref: "#/components/schemas/IncidentTodoResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read summary: Get incident todo details tags: - - Incidents - x-permission: + - Incidents + "x-permission": operator: OR permissions: - - incident_read - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_read + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: description: Update an incident todo. operationId: UpdateIncidentTodo parameters: - - $ref: '#/components/parameters/IncidentIDPathParameter' - - $ref: '#/components/parameters/IncidentTodoIDPathParameter' + - $ref: "#/components/parameters/IncidentIDPathParameter" + - $ref: "#/components/parameters/IncidentTodoIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentTodoPatchRequest' + $ref: "#/components/schemas/IncidentTodoPatchRequest" description: Incident todo payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentTodoResponse' + $ref: "#/components/schemas/IncidentTodoResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_write summary: Update an incident todo tags: - - Incidents + - Incidents x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - incident_write - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - incident_write + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/integration/aws/accounts: get: description: Get a list of AWS Account Integration Configs. operationId: ListAWSAccounts parameters: - - description: 'Optional query parameter to filter accounts by AWS Account ID. - - If not provided, all accounts are returned.' - example: '123456789012' - in: query - name: aws_account_id - required: false - schema: - type: string + - description: |- + Optional query parameter to filter accounts by AWS Account ID. + If not provided, all accounts are returned. + example: "123456789012" + in: query + name: aws_account_id + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSAccountsResponse' + $ref: "#/components/schemas/AWSAccountsResponse" description: AWS Accounts List object - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List all AWS integrations tags: - - AWS Integration - x-permission: + - AWS Integration + "x-permission": operator: OR permissions: - - aws_configuration_read + - aws_configuration_read post: description: Create a new AWS Account Integration Config. operationId: CreateAWSAccount @@ -86232,280 +82370,273 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AWSAccountCreateRequest' + $ref: "#/components/schemas/AWSAccountCreateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSAccountResponse' + $ref: "#/components/schemas/AWSAccountResponse" description: AWS Account object - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an AWS integration tags: - - AWS Integration + - AWS Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - aws_configurations_manage + - aws_configurations_manage /api/v2/integration/aws/accounts/{aws_account_config_id}: delete: description: Delete an AWS Account Integration Config by config ID. operationId: DeleteAWSAccount parameters: - - $ref: '#/components/parameters/AWSAccountConfigIDPathParameter' + - $ref: "#/components/parameters/AWSAccountConfigIDPathParameter" responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an AWS integration tags: - - AWS Integration - x-permission: + - AWS Integration + "x-permission": operator: OR permissions: - - aws_configurations_manage + - aws_configurations_manage get: description: Get an AWS Account Integration Config by config ID. operationId: GetAWSAccount parameters: - - $ref: '#/components/parameters/AWSAccountConfigIDPathParameter' + - $ref: "#/components/parameters/AWSAccountConfigIDPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSAccountResponse' + $ref: "#/components/schemas/AWSAccountResponse" description: AWS Account object - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get an AWS integration by config ID tags: - - AWS Integration - x-permission: + - AWS Integration + "x-permission": operator: OR permissions: - - aws_configuration_read + - aws_configuration_read patch: description: Update an AWS Account Integration Config by config ID. operationId: UpdateAWSAccount parameters: - - $ref: '#/components/parameters/AWSAccountConfigIDPathParameter' + - $ref: "#/components/parameters/AWSAccountConfigIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/AWSAccountUpdateRequest' + $ref: "#/components/schemas/AWSAccountUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSAccountResponse' + $ref: "#/components/schemas/AWSAccountResponse" description: AWS Account object - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update an AWS integration tags: - - AWS Integration + - AWS Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - aws_configuration_edit + - aws_configuration_edit /api/v2/integration/aws/accounts/{aws_account_config_id}/ccm_config: delete: - description: 'Delete the Cloud Cost Management config for an AWS Account Integration - Config using Cost and Usage Report - - (CUR) 2.0 by config ID.' + description: |- + Delete the Cloud Cost Management config for an AWS Account Integration Config using Cost and Usage Report + (CUR) 2.0 by config ID. operationId: DeleteAWSAccountCCMConfig parameters: - - $ref: '#/components/parameters/AWSAccountConfigIDPathParameter' + - $ref: "#/components/parameters/AWSAccountConfigIDPathParameter" responses: - '204': + "204": description: No Content - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete AWS CCM config tags: - - AWS Integration - x-permission: + - AWS Integration + "x-permission": operator: OR permissions: - - aws_configuration_edit - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - aws_configuration_edit + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: - description: 'Get the Cloud Cost Management config for an AWS Account Integration - Config using Cost and Usage Report - - (CUR) 2.0 by config ID.' + description: |- + Get the Cloud Cost Management config for an AWS Account Integration Config using Cost and Usage Report + (CUR) 2.0 by config ID. operationId: GetAWSAccountCCMConfig parameters: - - $ref: '#/components/parameters/AWSAccountConfigIDPathParameter' + - $ref: "#/components/parameters/AWSAccountConfigIDPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSCcmConfigResponse' + $ref: "#/components/schemas/AWSCcmConfigResponse" description: AWS CCM Config object - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get AWS CCM config tags: - - AWS Integration - x-permission: + - AWS Integration + "x-permission": operator: OR permissions: - - aws_configuration_read - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - aws_configuration_read + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: - description: 'Update the Cloud Cost Management config for an AWS Account Integration - Config using Cost and Usage Report - - (CUR) 2.0 by config ID.' + description: |- + Update the Cloud Cost Management config for an AWS Account Integration Config using Cost and Usage Report + (CUR) 2.0 by config ID. operationId: UpdateAWSAccountCCMConfig parameters: - - $ref: '#/components/parameters/AWSAccountConfigIDPathParameter' + - $ref: "#/components/parameters/AWSAccountConfigIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/AWSCcmConfigRequest' - description: Update a Cloud Cost Management config for an AWS Account Integration - Config. + $ref: "#/components/schemas/AWSCcmConfigRequest" + description: Update a Cloud Cost Management config for an AWS Account Integration Config. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSCcmConfigResponse' + $ref: "#/components/schemas/AWSCcmConfigResponse" description: AWS CCM Config object - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update AWS CCM config tags: - - AWS Integration + - AWS Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - aws_configuration_edit - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - aws_configuration_edit + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: - description: 'Create the Cloud Cost Management config for an AWS Account Integration - Config using Cost and Usage Report - - (CUR) 2.0 by config ID.' + description: |- + Create the Cloud Cost Management config for an AWS Account Integration Config using Cost and Usage Report + (CUR) 2.0 by config ID. operationId: CreateAWSAccountCCMConfig parameters: - - $ref: '#/components/parameters/AWSAccountConfigIDPathParameter' + - $ref: "#/components/parameters/AWSAccountConfigIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/AWSCcmConfigRequest' - description: Create a Cloud Cost Management config for an AWS Account Integration - Config. + $ref: "#/components/schemas/AWSCcmConfigRequest" + description: Create a Cloud Cost Management config for an AWS Account Integration Config. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSCcmConfigResponse' + $ref: "#/components/schemas/AWSCcmConfigResponse" description: AWS CCM Config object - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create AWS CCM config tags: - - AWS Integration + - AWS Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - aws_configuration_edit - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - aws_configuration_edit + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/integration/aws/available_namespaces: get: - description: Get a list of available AWS CloudWatch namespaces that can send - metrics to Datadog. + description: Get a list of available AWS CloudWatch namespaces that can send metrics to Datadog. operationId: ListAWSNamespaces responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSNamespacesResponse' + $ref: "#/components/schemas/AWSNamespacesResponse" description: AWS Namespaces List object - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List available namespaces tags: - - AWS Integration - x-permission: + - AWS Integration + "x-permission": operator: OR permissions: - - aws_configuration_read + - aws_configuration_read /api/v2/integration/aws/event_bridge: delete: description: Delete an Amazon EventBridge source. @@ -86514,54 +82645,53 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AWSEventBridgeDeleteRequest' - description: Delete the Amazon EventBridge source with the given name, region, - and associated AWS account. + $ref: "#/components/schemas/AWSEventBridgeDeleteRequest" + description: Delete the Amazon EventBridge source with the given name, region, and associated AWS account. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSEventBridgeDeleteResponse' + $ref: "#/components/schemas/AWSEventBridgeDeleteResponse" description: Amazon EventBridge source deleted. - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an Amazon EventBridge source tags: - - AWS Integration + - AWS Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations get: description: Get all Amazon EventBridge sources. operationId: ListAWSEventBridgeSources responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSEventBridgeListResponse' + $ref: "#/components/schemas/AWSEventBridgeListResponse" description: Amazon EventBridge sources list. - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all Amazon EventBridge sources tags: - - AWS Integration - x-permission: + - AWS Integration + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read post: description: Create an Amazon EventBridge source. operationId: CreateAWSEventBridgeSource @@ -86569,266 +82699,262 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AWSEventBridgeCreateRequest' - description: Create an Amazon EventBridge source for an AWS account with a - given name and region. + $ref: "#/components/schemas/AWSEventBridgeCreateRequest" + description: Create an Amazon EventBridge source for an AWS account with a given name and region. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSEventBridgeCreateResponse' + $ref: "#/components/schemas/AWSEventBridgeCreateResponse" description: Amazon EventBridge source created. - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an Amazon EventBridge source tags: - - AWS Integration + - AWS Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v2/integration/aws/generate_new_external_id: post: description: Generate a new external ID for AWS role-based authentication. operationId: CreateNewAWSExternalID responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSNewExternalIDResponse' + $ref: "#/components/schemas/AWSNewExternalIDResponse" description: AWS External ID object - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Generate a new external ID tags: - - AWS Integration - x-permission: + - AWS Integration + "x-permission": operator: OR permissions: - - aws_configuration_edit + - aws_configuration_edit /api/v2/integration/aws/iam_permissions: get: description: Get all AWS IAM permissions required for the AWS integration. operationId: GetAWSIntegrationIAMPermissions responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSIntegrationIamPermissionsResponse' + $ref: "#/components/schemas/AWSIntegrationIamPermissionsResponse" description: AWS IAM Permissions object - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get AWS integration IAM permissions tags: - - AWS Integration + - AWS Integration /api/v2/integration/aws/iam_permissions/resource_collection: get: - description: Get all resource collection AWS IAM permissions required for the - AWS integration. + description: Get all resource collection AWS IAM permissions required for the AWS integration. operationId: GetAWSIntegrationIAMPermissionsResourceCollection responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSIntegrationIamPermissionsResponse' + $ref: "#/components/schemas/AWSIntegrationIamPermissionsResponse" description: AWS integration resource collection IAM permissions. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get resource collection IAM permissions tags: - - AWS Integration + - AWS Integration /api/v2/integration/aws/iam_permissions/standard: get: description: Get all standard AWS IAM permissions required for the AWS integration. operationId: GetAWSIntegrationIAMPermissionsStandard responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSIntegrationIamPermissionsResponse' + $ref: "#/components/schemas/AWSIntegrationIamPermissionsResponse" description: AWS integration standard IAM permissions. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get AWS integration standard IAM permissions tags: - - AWS Integration + - AWS Integration /api/v2/integration/aws/logs/services: get: description: Get a list of AWS services that can send logs to Datadog. operationId: ListAWSLogsServices responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/AWSLogsServicesResponse' + $ref: "#/components/schemas/AWSLogsServicesResponse" description: AWS Logs Services List object - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get list of AWS log ready services tags: - - AWS Logs Integration - x-permission: + - AWS Logs Integration + "x-permission": operator: OR permissions: - - aws_configuration_read + - aws_configuration_read /api/v2/integration/gcp/accounts: get: - description: List all GCP STS-enabled service accounts configured in your Datadog - account. + description: List all GCP STS-enabled service accounts configured in your Datadog account. operationId: ListGCPSTSAccounts responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GCPSTSServiceAccountsResponse' + $ref: "#/components/schemas/GCPSTSServiceAccountsResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List all GCP STS-enabled service accounts tags: - - GCP Integration - x-permission: + - GCP Integration + "x-permission": operator: OR permissions: - - gcp_configuration_read + - gcp_configuration_read post: - description: Create a new entry within Datadog for your STS enabled service - account. + description: |- + Create a new entry within Datadog for your STS enabled service account. operationId: CreateGCPSTSAccount requestBody: content: application/json: schema: - $ref: '#/components/schemas/GCPSTSServiceAccountCreateRequest' + $ref: "#/components/schemas/GCPSTSServiceAccountCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/GCPSTSServiceAccountResponse' + $ref: "#/components/schemas/GCPSTSServiceAccountResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a new entry for your service account tags: - - GCP Integration + - GCP Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - gcp_configurations_manage + - gcp_configurations_manage /api/v2/integration/gcp/accounts/{account_id}: delete: description: Delete an STS enabled GCP account from within Datadog. operationId: DeleteGCPSTSAccount parameters: - - $ref: '#/components/parameters/GCPSTSServiceAccountID' + - $ref: "#/components/parameters/GCPSTSServiceAccountID" responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an STS enabled GCP Account tags: - - GCP Integration - x-permission: + - GCP Integration + "x-permission": operator: OR permissions: - - gcp_configurations_manage + - gcp_configurations_manage patch: description: Update an STS enabled service account. operationId: UpdateGCPSTSAccount parameters: - - $ref: '#/components/parameters/GCPSTSServiceAccountID' + - $ref: "#/components/parameters/GCPSTSServiceAccountID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/GCPSTSServiceAccountUpdateRequest' + $ref: "#/components/schemas/GCPSTSServiceAccountUpdateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/GCPSTSServiceAccountResponse' + $ref: "#/components/schemas/GCPSTSServiceAccountResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update STS Service Account tags: - - GCP Integration + - GCP Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - gcp_configuration_edit + - gcp_configuration_edit /api/v2/integration/gcp/sts_delegate: get: - description: List your Datadog-GCP STS delegate account configured in your Datadog - account. + description: List your Datadog-GCP STS delegate account configured in your Datadog account. operationId: GetGCPSTSDelegate responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GCPSTSDelegateAccountResponse' + $ref: "#/components/schemas/GCPSTSDelegateAccountResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List delegate account tags: - - GCP Integration + - GCP Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - gcp_configuration_read + - gcp_configuration_read post: description: Create a Datadog GCP principal. operationId: MakeGCPSTSDelegate @@ -86841,459 +82967,455 @@ paths: description: Create a delegate service account within Datadog. required: false responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GCPSTSDelegateAccountResponse' + $ref: "#/components/schemas/GCPSTSDelegateAccountResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a Datadog GCP principal tags: - - GCP Integration + - GCP Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - gcp_configuration_edit + - gcp_configuration_edit /api/v2/integration/google-chat/organizations/app/named-spaces/{domain_name}/{space_display_name}: get: - description: Get the resource name and organization binding ID of a space in - the Datadog Google Chat integration. + description: Get the resource name and organization binding ID of a space in the Datadog Google Chat integration. operationId: GetSpaceByDisplayName parameters: - - $ref: '#/components/parameters/GoogleChatOrganizationDomainNamePathParameter' - - $ref: '#/components/parameters/GoogleChatOrganizationSpaceDisplayNamePathParameter' + - $ref: "#/components/parameters/GoogleChatOrganizationDomainNamePathParameter" + - $ref: "#/components/parameters/GoogleChatOrganizationSpaceDisplayNamePathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GoogleChatAppNamedSpaceResponse' + $ref: "#/components/schemas/GoogleChatAppNamedSpaceResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get space information by display name tags: - - Google Chat Integration + - Google Chat Integration /api/v2/integration/google-chat/organizations/{organization_binding_id}/organization-handles: get: - description: Get a list of all organization handles from the Datadog Google - Chat integration. + description: Get a list of all organization handles from the Datadog Google Chat integration. operationId: ListOrganizationHandles parameters: - - $ref: '#/components/parameters/GoogleChatOrganizationBindingIdPathParameter' + - $ref: "#/components/parameters/GoogleChatOrganizationBindingIdPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GoogleChatOrganizationHandlesResponse' + $ref: "#/components/schemas/GoogleChatOrganizationHandlesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all organization handles tags: - - Google Chat Integration + - Google Chat Integration post: description: Create an organization handle in the Datadog Google Chat integration. operationId: CreateOrganizationHandle parameters: - - $ref: '#/components/parameters/GoogleChatOrganizationBindingIdPathParameter' + - $ref: "#/components/parameters/GoogleChatOrganizationBindingIdPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleChatCreateOrganizationHandleRequest' + $ref: "#/components/schemas/GoogleChatCreateOrganizationHandleRequest" description: Organization handle payload. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/GoogleChatOrganizationHandleResponse' + $ref: "#/components/schemas/GoogleChatOrganizationHandleResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create organization handle tags: - - Google Chat Integration + - Google Chat Integration x-codegen-request-body-name: body /api/v2/integration/google-chat/organizations/{organization_binding_id}/organization-handles/{handle_id}: delete: description: Delete an organization handle from the Datadog Google Chat integration. operationId: DeleteOrganizationHandle parameters: - - description: Your organization binding ID. - in: path - name: organization_binding_id - required: true - schema: - type: string - - description: Your organization handle ID. - in: path - name: handle_id - required: true - schema: - type: string + - description: Your organization binding ID. + in: path + name: organization_binding_id + required: true + schema: + type: string + - description: Your organization handle ID. + in: path + name: handle_id + required: true + schema: + type: string responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete organization handle tags: - - Google Chat Integration + - Google Chat Integration get: description: Get an organization handle from the Datadog Google Chat integration. operationId: GetOrganizationHandle parameters: - - $ref: '#/components/parameters/GoogleChatOrganizationBindingIdPathParameter' - - $ref: '#/components/parameters/GoogleChatHandleIdPathParameter' + - $ref: "#/components/parameters/GoogleChatOrganizationBindingIdPathParameter" + - $ref: "#/components/parameters/GoogleChatHandleIdPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GoogleChatOrganizationHandleResponse' + $ref: "#/components/schemas/GoogleChatOrganizationHandleResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get organization handle tags: - - Google Chat Integration + - Google Chat Integration patch: description: Update an organization handle from the Datadog Google Chat integration. operationId: UpdateOrganizationHandle parameters: - - $ref: '#/components/parameters/GoogleChatOrganizationBindingIdPathParameter' - - $ref: '#/components/parameters/GoogleChatHandleIdPathParameter' + - $ref: "#/components/parameters/GoogleChatOrganizationBindingIdPathParameter" + - $ref: "#/components/parameters/GoogleChatHandleIdPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/GoogleChatUpdateOrganizationHandleRequest' + $ref: "#/components/schemas/GoogleChatUpdateOrganizationHandleRequest" description: Organization handle payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GoogleChatOrganizationHandleResponse' + $ref: "#/components/schemas/GoogleChatOrganizationHandleResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update organization handle tags: - - Google Chat Integration + - Google Chat Integration x-codegen-request-body-name: body /api/v2/integration/jira/accounts: get: - description: Get all Jira accounts for the organization. + description: |- + Get all Jira accounts for the organization. operationId: ListJiraAccounts responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/JiraAccountsResponse' + $ref: "#/components/schemas/JiraAccountsResponse" description: OK - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List Jira accounts tags: - - Jira Integration - x-unstable: '**Note**: This endpoint is in public beta and it''s subject to - change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Jira Integration + x-unstable: |- + **Note**: This endpoint is in public beta and it's subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/integration/jira/accounts/{account_id}: delete: - description: Delete a Jira account by ID. + description: |- + Delete a Jira account by ID. operationId: DeleteJiraAccount parameters: - - description: The ID of the Jira account to delete - example: 65b3341b-0680-47f9-a6d4-134db45c603e - in: path - name: account_id - required: true - schema: - format: uuid - type: string + - description: The ID of the Jira account to delete + example: "65b3341b-0680-47f9-a6d4-134db45c603e" + in: path + name: account_id + required: true + schema: + format: uuid + type: string responses: - '204': + "204": description: No Content - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete Jira account tags: - - Jira Integration - x-unstable: '**Note**: This endpoint is in public beta and it''s subject to - change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Jira Integration + x-unstable: |- + **Note**: This endpoint is in public beta and it's subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/integration/jira/issue-templates: get: - description: Get all Jira issue templates for the organization. + description: |- + Get all Jira issue templates for the organization. operationId: ListJiraIssueTemplates responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/JiraIssueTemplatesResponse' + $ref: "#/components/schemas/JiraIssueTemplatesResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List Jira issue templates tags: - - Jira Integration - x-unstable: '**Note**: This endpoint is in public beta and it''s subject to - change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Jira Integration + x-unstable: |- + **Note**: This endpoint is in public beta and it's subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: - description: Create a new Jira issue template. + description: |- + Create a new Jira issue template. operationId: CreateJiraIssueTemplate requestBody: content: application/json: schema: - $ref: '#/components/schemas/JiraIssueTemplateCreateRequest' + $ref: "#/components/schemas/JiraIssueTemplateCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/JiraIssueTemplateResponse' + $ref: "#/components/schemas/JiraIssueTemplateResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create Jira issue template tags: - - Jira Integration - x-unstable: '**Note**: This endpoint is in public beta and it''s subject to - change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Jira Integration + x-unstable: |- + **Note**: This endpoint is in public beta and it's subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/integration/jira/issue-templates/{issue_template_id}: delete: - description: Delete a Jira issue template by ID. + description: |- + Delete a Jira issue template by ID. operationId: DeleteJiraIssueTemplate parameters: - - description: The ID of the Jira issue template to delete - example: 65b3341b-0680-47f9-a6d4-134db45c603e - in: path - name: issue_template_id - required: true - schema: - format: uuid - type: string + - description: The ID of the Jira issue template to delete + example: "65b3341b-0680-47f9-a6d4-134db45c603e" + in: path + name: issue_template_id + required: true + schema: + format: uuid + type: string responses: - '204': + "204": description: No Content - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete Jira issue template tags: - - Jira Integration - x-unstable: '**Note**: This endpoint is in public beta and it''s subject to - change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Jira Integration + x-unstable: |- + **Note**: This endpoint is in public beta and it's subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: - description: Get a Jira issue template by ID. + description: |- + Get a Jira issue template by ID. operationId: GetJiraIssueTemplate parameters: - - description: The ID of the Jira issue template to retrieve - example: 65b3341b-0680-47f9-a6d4-134db45c603e - in: path - name: issue_template_id - required: true - schema: - format: uuid - type: string + - description: The ID of the Jira issue template to retrieve + example: "65b3341b-0680-47f9-a6d4-134db45c603e" + in: path + name: issue_template_id + required: true + schema: + format: uuid + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/JiraIssueTemplateResponse' + $ref: "#/components/schemas/JiraIssueTemplateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get Jira issue template tags: - - Jira Integration - x-unstable: '**Note**: This endpoint is in public beta and it''s subject to - change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Jira Integration + x-unstable: |- + **Note**: This endpoint is in public beta and it's subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: - description: Update a Jira issue template by ID. + description: |- + Update a Jira issue template by ID. operationId: UpdateJiraIssueTemplate parameters: - - description: The ID of the Jira issue template to update - example: 65b3341b-0680-47f9-a6d4-134db45c603e - in: path - name: issue_template_id - required: true - schema: - format: uuid - type: string + - description: The ID of the Jira issue template to update + example: "65b3341b-0680-47f9-a6d4-134db45c603e" + in: path + name: issue_template_id + required: true + schema: + format: uuid + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/JiraIssueTemplateUpdateRequest' + $ref: "#/components/schemas/JiraIssueTemplateUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/JiraIssueTemplateResponse' + $ref: "#/components/schemas/JiraIssueTemplateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update Jira issue template tags: - - Jira Integration - x-unstable: '**Note**: This endpoint is in public beta and it''s subject to - change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Jira Integration + x-unstable: |- + **Note**: This endpoint is in public beta and it's subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/integration/ms-teams/configuration/channel/{tenant_name}/{team_name}/{channel_name}: get: - description: Get the tenant, team, and channel ID of a channel in the Datadog - Microsoft Teams integration. + description: Get the tenant, team, and channel ID of a channel in the Datadog Microsoft Teams integration. operationId: GetChannelByName parameters: - - $ref: '#/components/parameters/MicrosoftTeamsTenantNamePathParameter' - - $ref: '#/components/parameters/MicrosoftTeamsTeamNamePathParameter' - - $ref: '#/components/parameters/MicrosoftTeamsChannelNamePathParameter' + - $ref: "#/components/parameters/MicrosoftTeamsTenantNamePathParameter" + - $ref: "#/components/parameters/MicrosoftTeamsTeamNamePathParameter" + - $ref: "#/components/parameters/MicrosoftTeamsChannelNamePathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsGetChannelByNameResponse' + $ref: "#/components/schemas/MicrosoftTeamsGetChannelByNameResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get channel information by name tags: - - Microsoft Teams Integration + - Microsoft Teams Integration /api/v2/integration/ms-teams/configuration/tenant-based-handles: get: - description: Get a list of all tenant-based handles from the Datadog Microsoft - Teams integration. + description: Get a list of all tenant-based handles from the Datadog Microsoft Teams integration. operationId: ListTenantBasedHandles parameters: - - $ref: '#/components/parameters/MicrosoftTeamsTenantIDQueryParameter' - - $ref: '#/components/parameters/MicrosoftTeamsHandleNameQueryParameter' + - $ref: "#/components/parameters/MicrosoftTeamsTenantIDQueryParameter" + - $ref: "#/components/parameters/MicrosoftTeamsHandleNameQueryParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandlesResponse' + $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandlesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '412': - $ref: '#/components/responses/PreconditionFailedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "412": + $ref: "#/components/responses/PreconditionFailedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all tenant-based handles tags: - - Microsoft Teams Integration + - Microsoft Teams Integration post: description: Create a tenant-based handle in the Datadog Microsoft Teams integration. operationId: CreateTenantBasedHandle @@ -87301,443 +83423,428 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsCreateTenantBasedHandleRequest' + $ref: "#/components/schemas/MicrosoftTeamsCreateTenantBasedHandleRequest" description: Tenant-based handle payload. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse' + $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '412': - $ref: '#/components/responses/PreconditionFailedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "412": + $ref: "#/components/responses/PreconditionFailedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create tenant-based handle tags: - - Microsoft Teams Integration + - Microsoft Teams Integration x-codegen-request-body-name: body /api/v2/integration/ms-teams/configuration/tenant-based-handles/{handle_id}: delete: description: Delete a tenant-based handle from the Datadog Microsoft Teams integration. operationId: DeleteTenantBasedHandle parameters: - - $ref: '#/components/parameters/MicrosoftTeamsTenantBasedHandleIDPathParameter' + - $ref: "#/components/parameters/MicrosoftTeamsTenantBasedHandleIDPathParameter" responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '412': - $ref: '#/components/responses/PreconditionFailedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "412": + $ref: "#/components/responses/PreconditionFailedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete tenant-based handle tags: - - Microsoft Teams Integration + - Microsoft Teams Integration get: - description: Get the tenant, team, and channel information of a tenant-based - handle from the Datadog Microsoft Teams integration. + description: Get the tenant, team, and channel information of a tenant-based handle from the Datadog Microsoft Teams integration. operationId: GetTenantBasedHandle parameters: - - $ref: '#/components/parameters/MicrosoftTeamsTenantBasedHandleIDPathParameter' + - $ref: "#/components/parameters/MicrosoftTeamsTenantBasedHandleIDPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse' + $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '412': - $ref: '#/components/responses/PreconditionFailedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "412": + $ref: "#/components/responses/PreconditionFailedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get tenant-based handle information tags: - - Microsoft Teams Integration + - Microsoft Teams Integration patch: description: Update a tenant-based handle from the Datadog Microsoft Teams integration. operationId: UpdateTenantBasedHandle parameters: - - $ref: '#/components/parameters/MicrosoftTeamsTenantBasedHandleIDPathParameter' + - $ref: "#/components/parameters/MicrosoftTeamsTenantBasedHandleIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsUpdateTenantBasedHandleRequest' + $ref: "#/components/schemas/MicrosoftTeamsUpdateTenantBasedHandleRequest" description: Tenant-based handle payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse' + $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '412': - $ref: '#/components/responses/PreconditionFailedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "412": + $ref: "#/components/responses/PreconditionFailedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update tenant-based handle tags: - - Microsoft Teams Integration + - Microsoft Teams Integration x-codegen-request-body-name: body /api/v2/integration/ms-teams/configuration/workflows-webhook-handles: get: - description: Get a list of all Workflows webhook handles from the Datadog Microsoft - Teams integration. + description: Get a list of all Workflows webhook handles from the Datadog Microsoft Teams integration. operationId: ListWorkflowsWebhookHandles parameters: - - $ref: '#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleNameQueryParameter' + - $ref: "#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleNameQueryParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandlesResponse' + $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandlesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '412': - $ref: '#/components/responses/PreconditionFailedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "412": + $ref: "#/components/responses/PreconditionFailedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all Workflows webhook handles tags: - - Microsoft Teams Integration + - Microsoft Teams Integration post: - description: Create a Workflows webhook handle in the Datadog Microsoft Teams - integration. + description: Create a Workflows webhook handle in the Datadog Microsoft Teams integration. operationId: CreateWorkflowsWebhookHandle requestBody: content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsCreateWorkflowsWebhookHandleRequest' + $ref: "#/components/schemas/MicrosoftTeamsCreateWorkflowsWebhookHandleRequest" description: Workflows Webhook handle payload. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse' + $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '412': - $ref: '#/components/responses/PreconditionFailedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "412": + $ref: "#/components/responses/PreconditionFailedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create Workflows webhook handle tags: - - Microsoft Teams Integration + - Microsoft Teams Integration x-codegen-request-body-name: body /api/v2/integration/ms-teams/configuration/workflows-webhook-handles/{handle_id}: delete: - description: Delete a Workflows webhook handle from the Datadog Microsoft Teams - integration. + description: Delete a Workflows webhook handle from the Datadog Microsoft Teams integration. operationId: DeleteWorkflowsWebhookHandle parameters: - - $ref: '#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleIDPathParameter' + - $ref: "#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleIDPathParameter" responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '412': - $ref: '#/components/responses/PreconditionFailedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "412": + $ref: "#/components/responses/PreconditionFailedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete Workflows webhook handle tags: - - Microsoft Teams Integration + - Microsoft Teams Integration get: - description: Get the name of a Workflows webhook handle from the Datadog Microsoft - Teams integration. + description: Get the name of a Workflows webhook handle from the Datadog Microsoft Teams integration. operationId: GetWorkflowsWebhookHandle parameters: - - $ref: '#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleIDPathParameter' + - $ref: "#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleIDPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse' + $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '412': - $ref: '#/components/responses/PreconditionFailedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "412": + $ref: "#/components/responses/PreconditionFailedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get Workflows webhook handle information tags: - - Microsoft Teams Integration + - Microsoft Teams Integration patch: - description: Update a Workflows webhook handle from the Datadog Microsoft Teams - integration. + description: Update a Workflows webhook handle from the Datadog Microsoft Teams integration. operationId: UpdateWorkflowsWebhookHandle parameters: - - $ref: '#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleIDPathParameter' + - $ref: "#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest' + $ref: "#/components/schemas/MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest" description: Workflows Webhook handle payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse' + $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '412': - $ref: '#/components/responses/PreconditionFailedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "412": + $ref: "#/components/responses/PreconditionFailedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update Workflows webhook handle tags: - - Microsoft Teams Integration + - Microsoft Teams Integration x-codegen-request-body-name: body /api/v2/integration/oci/products: get: - description: Lists the products for a given tenancy. Returns the enabled/disabled - status of Datadog products (such as Cloud Security Posture Management) for - specific OCI tenancies. + description: >- + Lists the products for a given tenancy. Returns the enabled/disabled status of Datadog products (such as Cloud Security Posture Management) for specific OCI tenancies. operationId: ListTenancyProducts parameters: - - description: Comma-separated list of product keys to filter by. - in: query - name: productKeys - required: true - schema: - type: string + - description: Comma-separated list of product keys to filter by. + in: query + name: productKeys + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TenancyProductsList' + $ref: "#/components/schemas/TenancyProductsList" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: List tenancy products tags: - - OCI Integration + - OCI Integration /api/v2/integration/oci/tenancies: get: - description: Get a list of all configured OCI tenancy integrations. Returns - basic information about each tenancy including authentication credentials, - region settings, and collection preferences for metrics, logs, and resources. + description: >- + Get a list of all configured OCI tenancy integrations. Returns basic information about each tenancy including authentication credentials, region settings, and collection preferences for metrics, logs, and resources. operationId: GetTenancyConfigs responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TenancyConfigList' + $ref: "#/components/schemas/TenancyConfigList" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get tenancy configs tags: - - OCI Integration - x-unstable: '**Note**: This endpoint may be subject to changes.' + - OCI Integration + x-unstable: "**Note**: This endpoint may be subject to changes." post: - description: 'Create a new tenancy config to establish monitoring and data collection - from your OCI environment. Requires OCI authentication credentials and tenancy - details. Warning: Datadog recommends interacting with this endpoint only through - the Datadog web UI to ensure all necessary OCI resources have been created - and configured properly.' + description: >- + Create a new tenancy config to establish monitoring and data collection from your OCI environment. Requires OCI authentication credentials and tenancy details. Warning: Datadog recommends interacting with this endpoint only through the Datadog web UI to ensure all necessary OCI resources have been created and configured properly. operationId: CreateTenancyConfig requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateTenancyConfigRequest' + $ref: "#/components/schemas/CreateTenancyConfigRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/TenancyConfig' + $ref: "#/components/schemas/TenancyConfig" description: Created - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Create tenancy config tags: - - OCI Integration - x-unstable: '**Note**: This endpoint may be subject to changes.' + - OCI Integration + x-unstable: "**Note**: This endpoint may be subject to changes." /api/v2/integration/oci/tenancies/{tenancy_ocid}: delete: - description: Delete an existing tenancy config. This will stop all data collection - from the specified OCI tenancy and remove the stored configuration. This operation - cannot be undone. + description: >- + Delete an existing tenancy config. This will stop all data collection from the specified OCI tenancy and remove the stored configuration. This operation cannot be undone. operationId: DeleteTenancyConfig parameters: - - description: The OCID of the tenancy config to delete. - in: path - name: tenancy_ocid - required: true - schema: - type: string + - description: The OCID of the tenancy config to delete. + in: path + name: tenancy_ocid + required: true + schema: + type: string responses: - '204': + "204": description: No Content - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Delete tenancy config tags: - - OCI Integration + - OCI Integration get: - description: Get a single tenancy config object by its OCID. Returns detailed - configuration including authentication credentials, enabled services, region - settings, and collection preferences. + description: >- + Get a single tenancy config object by its OCID. Returns detailed configuration including authentication credentials, enabled services, region settings, and collection preferences. operationId: GetTenancyConfig parameters: - - description: The OCID of the tenancy config to retrieve. - in: path - name: tenancy_ocid - required: true - schema: - type: string + - description: The OCID of the tenancy config to retrieve. + in: path + name: tenancy_ocid + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TenancyConfig' + $ref: "#/components/schemas/TenancyConfig" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get tenancy config tags: - - OCI Integration + - OCI Integration patch: - description: 'Update an existing tenancy config. You can modify authentication - credentials, enable/disable collection types, update service filters, and - change region settings. Warning: We recommend using the Datadog web UI to - avoid unintended update effects.' + description: >- + Update an existing tenancy config. You can modify authentication credentials, enable/disable collection types, update service filters, and change region settings. Warning: We recommend using the Datadog web UI to avoid unintended update effects. operationId: UpdateTenancyConfig parameters: - - description: The OCID of the tenancy config to update. - in: path - name: tenancy_ocid - required: true - schema: - type: string + - description: The OCID of the tenancy config to update. + in: path + name: tenancy_ocid + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateTenancyConfigRequest' + $ref: "#/components/schemas/UpdateTenancyConfigRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TenancyConfig' + $ref: "#/components/schemas/TenancyConfig" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Update tenancy config tags: - - OCI Integration + - OCI Integration /api/v2/integration/opsgenie/services: get: description: Get a list of all services from the Datadog Opsgenie integration. operationId: ListOpsgenieServices responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OpsgenieServicesResponse' + $ref: "#/components/schemas/OpsgenieServicesResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all service objects tags: - - Opsgenie Integration - x-permission: + - Opsgenie Integration + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read post: description: Create a new service object in the Opsgenie integration. operationId: CreateOpsgenieService @@ -87745,480 +83852,489 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OpsgenieServiceCreateRequest' + $ref: "#/components/schemas/OpsgenieServiceCreateRequest" description: Opsgenie service payload required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/OpsgenieServiceResponse' + $ref: "#/components/schemas/OpsgenieServiceResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a new service object tags: - - Opsgenie Integration + - Opsgenie Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v2/integration/opsgenie/services/{integration_service_id}: delete: description: Delete a single service object in the Datadog Opsgenie integration. operationId: DeleteOpsgenieService parameters: - - $ref: '#/components/parameters/OpsgenieServiceIDPathParameter' + - $ref: "#/components/parameters/OpsgenieServiceIDPathParameter" responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a single service object tags: - - Opsgenie Integration - x-permission: + - Opsgenie Integration + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations get: description: Get a single service from the Datadog Opsgenie integration. operationId: GetOpsgenieService parameters: - - $ref: '#/components/parameters/OpsgenieServiceIDPathParameter' + - $ref: "#/components/parameters/OpsgenieServiceIDPathParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OpsgenieServiceResponse' + $ref: "#/components/schemas/OpsgenieServiceResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a single service object tags: - - Opsgenie Integration - x-permission: + - Opsgenie Integration + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read patch: description: Update a single service object in the Datadog Opsgenie integration. operationId: UpdateOpsgenieService parameters: - - $ref: '#/components/parameters/OpsgenieServiceIDPathParameter' + - $ref: "#/components/parameters/OpsgenieServiceIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/OpsgenieServiceUpdateRequest' + $ref: "#/components/schemas/OpsgenieServiceUpdateRequest" description: Opsgenie service payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OpsgenieServiceResponse' + $ref: "#/components/schemas/OpsgenieServiceResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a single service object tags: - - Opsgenie Integration + - Opsgenie Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v2/integration/servicenow/assignment_groups/{instance_id}: get: - description: Get all assignment groups for a ServiceNow instance. + description: |- + Get all assignment groups for a ServiceNow instance. operationId: ListServiceNowAssignmentGroups parameters: - - description: The ID of the ServiceNow instance - example: 65b3341b-0680-47f9-a6d4-134db45c603e - in: path - name: instance_id - required: true - schema: - format: uuid - type: string + - description: The ID of the ServiceNow instance + example: "65b3341b-0680-47f9-a6d4-134db45c603e" + in: path + name: instance_id + required: true + schema: + format: uuid + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceNowAssignmentGroupsResponse' + $ref: "#/components/schemas/ServiceNowAssignmentGroupsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List ServiceNow assignment groups tags: - - ServiceNow Integration - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - ServiceNow Integration + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/integration/servicenow/business_services/{instance_id}: get: - description: Get all business services for a ServiceNow instance. + description: |- + Get all business services for a ServiceNow instance. operationId: ListServiceNowBusinessServices parameters: - - description: The ID of the ServiceNow instance - example: 65b3341b-0680-47f9-a6d4-134db45c603e - in: path - name: instance_id - required: true - schema: - format: uuid - type: string + - description: The ID of the ServiceNow instance + example: "65b3341b-0680-47f9-a6d4-134db45c603e" + in: path + name: instance_id + required: true + schema: + format: uuid + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceNowBusinessServicesResponse' + $ref: "#/components/schemas/ServiceNowBusinessServicesResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List ServiceNow business services tags: - - ServiceNow Integration - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - ServiceNow Integration + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/integration/servicenow/handles: get: - description: Get all ServiceNow templates for the organization. + description: |- + Get all ServiceNow templates for the organization. operationId: ListServiceNowTemplates responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceNowTemplatesResponse' + $ref: "#/components/schemas/ServiceNowTemplatesResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List ServiceNow templates tags: - - ServiceNow Integration - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - ServiceNow Integration + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: - description: Create a new ServiceNow template. + description: |- + Create a new ServiceNow template. operationId: CreateServiceNowTemplate requestBody: content: application/json: schema: - $ref: '#/components/schemas/ServiceNowTemplateCreateRequest' + $ref: "#/components/schemas/ServiceNowTemplateCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/ServiceNowTemplateResponse' + $ref: "#/components/schemas/ServiceNowTemplateResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create ServiceNow template tags: - - ServiceNow Integration - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - ServiceNow Integration + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/integration/servicenow/handles/{template_id}: delete: - description: Delete a ServiceNow template by ID. + description: |- + Delete a ServiceNow template by ID. operationId: DeleteServiceNowTemplate parameters: - - description: The ID of the ServiceNow template to delete - example: 65b3341b-0680-47f9-a6d4-134db45c603e - in: path - name: template_id - required: true - schema: - format: uuid - type: string + - description: The ID of the ServiceNow template to delete + example: "65b3341b-0680-47f9-a6d4-134db45c603e" + in: path + name: template_id + required: true + schema: + format: uuid + type: string responses: - '200': + "200": description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete ServiceNow template tags: - - ServiceNow Integration - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - ServiceNow Integration + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: - description: Get a ServiceNow template by ID. + description: |- + Get a ServiceNow template by ID. operationId: GetServiceNowTemplate parameters: - - description: The ID of the ServiceNow template to retrieve - example: 65b3341b-0680-47f9-a6d4-134db45c603e - in: path - name: template_id - required: true - schema: - format: uuid - type: string + - description: The ID of the ServiceNow template to retrieve + example: "65b3341b-0680-47f9-a6d4-134db45c603e" + in: path + name: template_id + required: true + schema: + format: uuid + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceNowTemplateResponse' + $ref: "#/components/schemas/ServiceNowTemplateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get ServiceNow template tags: - - ServiceNow Integration - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - ServiceNow Integration + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). put: - description: Update a ServiceNow template by ID. + description: |- + Update a ServiceNow template by ID. operationId: UpdateServiceNowTemplate parameters: - - description: The ID of the ServiceNow template to update - example: 65b3341b-0680-47f9-a6d4-134db45c603e - in: path - name: template_id - required: true - schema: - format: uuid - type: string + - description: The ID of the ServiceNow template to update + example: "65b3341b-0680-47f9-a6d4-134db45c603e" + in: path + name: template_id + required: true + schema: + format: uuid + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ServiceNowTemplateUpdateRequest' + $ref: "#/components/schemas/ServiceNowTemplateUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceNowTemplateResponse' + $ref: "#/components/schemas/ServiceNowTemplateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update ServiceNow template tags: - - ServiceNow Integration - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - ServiceNow Integration + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/integration/servicenow/instances: get: - description: Get all ServiceNow instances for the organization. + description: |- + Get all ServiceNow instances for the organization. operationId: ListServiceNowInstances responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceNowInstancesResponse' + $ref: "#/components/schemas/ServiceNowInstancesResponse" description: OK - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List ServiceNow instances tags: - - ServiceNow Integration - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - ServiceNow Integration + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/integration/servicenow/users/{instance_id}: get: - description: Get all users for a ServiceNow instance. + description: |- + Get all users for a ServiceNow instance. operationId: ListServiceNowUsers parameters: - - description: The ID of the ServiceNow instance - example: 65b3341b-0680-47f9-a6d4-134db45c603e - in: path - name: instance_id - required: true - schema: - format: uuid - type: string + - description: The ID of the ServiceNow instance + example: "65b3341b-0680-47f9-a6d4-134db45c603e" + in: path + name: instance_id + required: true + schema: + format: uuid + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceNowUsersResponse' + $ref: "#/components/schemas/ServiceNowUsersResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List ServiceNow users tags: - - ServiceNow Integration - x-unstable: '**Note**: This endpoint is in public beta and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - ServiceNow Integration + x-unstable: |- + **Note**: This endpoint is in public beta and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/integrations: get: operationId: ListIntegrations responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListIntegrationsResponse' + $ref: "#/components/schemas/ListIntegrationsResponse" description: Successful Response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: List Integrations tags: - - Integrations + - Integrations /api/v2/integrations/cloudflare/accounts: get: description: List Cloudflare accounts. operationId: ListCloudflareAccounts responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CloudflareAccountsResponse' + $ref: "#/components/schemas/CloudflareAccountsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List Cloudflare accounts tags: - - Cloudflare Integration - x-permission: + - Cloudflare Integration + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read post: description: Create a Cloudflare account. operationId: CreateCloudflareAccount @@ -88226,157 +84342,157 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CloudflareAccountCreateRequest' + $ref: "#/components/schemas/CloudflareAccountCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/CloudflareAccountResponse' + $ref: "#/components/schemas/CloudflareAccountResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Add Cloudflare account tags: - - Cloudflare Integration + - Cloudflare Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v2/integrations/cloudflare/accounts/{account_id}: delete: description: Delete a Cloudflare account. operationId: DeleteCloudflareAccount parameters: - - description: None - in: path - name: account_id - required: true - schema: - type: string + - description: None + in: path + name: account_id + required: true + schema: + type: string responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete Cloudflare account tags: - - Cloudflare Integration - x-permission: + - Cloudflare Integration + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations get: description: Get a Cloudflare account. operationId: GetCloudflareAccount parameters: - - description: None - in: path - name: account_id - required: true - schema: - type: string + - description: None + in: path + name: account_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CloudflareAccountResponse' + $ref: "#/components/schemas/CloudflareAccountResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get Cloudflare account tags: - - Cloudflare Integration - x-permission: + - Cloudflare Integration + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read patch: description: Update a Cloudflare account. operationId: UpdateCloudflareAccount parameters: - - description: None - in: path - name: account_id - required: true - schema: - type: string + - description: None + in: path + name: account_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CloudflareAccountUpdateRequest' + $ref: "#/components/schemas/CloudflareAccountUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CloudflareAccountResponse' + $ref: "#/components/schemas/CloudflareAccountResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update Cloudflare account tags: - - Cloudflare Integration + - Cloudflare Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v2/integrations/confluent-cloud/accounts: get: description: List Confluent accounts. operationId: ListConfluentAccount responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ConfluentAccountsResponse' + $ref: "#/components/schemas/ConfluentAccountsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List Confluent accounts tags: - - Confluent Cloud - x-permission: + - Confluent Cloud + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read post: description: Create a Confluent account. operationId: CreateConfluentAccount @@ -88384,301 +84500,296 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ConfluentAccountCreateRequest' + $ref: "#/components/schemas/ConfluentAccountCreateRequest" description: Confluent payload required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/ConfluentAccountResponse' + $ref: "#/components/schemas/ConfluentAccountResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Add Confluent account tags: - - Confluent Cloud + - Confluent Cloud x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v2/integrations/confluent-cloud/accounts/{account_id}: delete: description: Delete a Confluent account with the provided account ID. operationId: DeleteConfluentAccount parameters: - - $ref: '#/components/parameters/ConfluentAccountID' + - $ref: "#/components/parameters/ConfluentAccountID" responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete Confluent account tags: - - Confluent Cloud - x-permission: + - Confluent Cloud + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations get: description: Get the Confluent account with the provided account ID. operationId: GetConfluentAccount parameters: - - $ref: '#/components/parameters/ConfluentAccountID' + - $ref: "#/components/parameters/ConfluentAccountID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ConfluentAccountResponse' + $ref: "#/components/schemas/ConfluentAccountResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get Confluent account tags: - - Confluent Cloud - x-permission: + - Confluent Cloud + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read patch: description: Update the Confluent account with the provided account ID. operationId: UpdateConfluentAccount parameters: - - $ref: '#/components/parameters/ConfluentAccountID' + - $ref: "#/components/parameters/ConfluentAccountID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ConfluentAccountUpdateRequest' + $ref: "#/components/schemas/ConfluentAccountUpdateRequest" description: Confluent payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ConfluentAccountResponse' + $ref: "#/components/schemas/ConfluentAccountResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update Confluent account tags: - - Confluent Cloud + - Confluent Cloud x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v2/integrations/confluent-cloud/accounts/{account_id}/resources: get: - description: Get a Confluent resource for the account associated with the provided - ID. + description: Get a Confluent resource for the account associated with the provided ID. operationId: ListConfluentResource parameters: - - $ref: '#/components/parameters/ConfluentAccountID' + - $ref: "#/components/parameters/ConfluentAccountID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ConfluentResourcesResponse' + $ref: "#/components/schemas/ConfluentResourcesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List Confluent Account resources tags: - - Confluent Cloud - x-permission: + - Confluent Cloud + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read post: - description: Create a Confluent resource for the account associated with the - provided ID. + description: Create a Confluent resource for the account associated with the provided ID. operationId: CreateConfluentResource parameters: - - $ref: '#/components/parameters/ConfluentAccountID' + - $ref: "#/components/parameters/ConfluentAccountID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ConfluentResourceRequest' + $ref: "#/components/schemas/ConfluentResourceRequest" description: Confluent payload required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/ConfluentResourceResponse' + $ref: "#/components/schemas/ConfluentResourceResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Add resource to Confluent account tags: - - Confluent Cloud + - Confluent Cloud x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}: delete: - description: Delete a Confluent resource with the provided resource id for the - account associated with the provided account ID. + description: Delete a Confluent resource with the provided resource id for the account associated with the provided account ID. operationId: DeleteConfluentResource parameters: - - $ref: '#/components/parameters/ConfluentAccountID' - - $ref: '#/components/parameters/ConfluentResourceID' + - $ref: "#/components/parameters/ConfluentAccountID" + - $ref: "#/components/parameters/ConfluentResourceID" responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete resource from Confluent account tags: - - Confluent Cloud - x-permission: + - Confluent Cloud + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations get: - description: Get a Confluent resource with the provided resource id for the - account associated with the provided account ID. + description: Get a Confluent resource with the provided resource id for the account associated with the provided account ID. operationId: GetConfluentResource parameters: - - $ref: '#/components/parameters/ConfluentAccountID' - - $ref: '#/components/parameters/ConfluentResourceID' + - $ref: "#/components/parameters/ConfluentAccountID" + - $ref: "#/components/parameters/ConfluentResourceID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ConfluentResourceResponse' + $ref: "#/components/schemas/ConfluentResourceResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get resource from Confluent account tags: - - Confluent Cloud - x-permission: + - Confluent Cloud + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read patch: - description: Update a Confluent resource with the provided resource id for the - account associated with the provided account ID. + description: Update a Confluent resource with the provided resource id for the account associated with the provided account ID. operationId: UpdateConfluentResource parameters: - - $ref: '#/components/parameters/ConfluentAccountID' - - $ref: '#/components/parameters/ConfluentResourceID' + - $ref: "#/components/parameters/ConfluentAccountID" + - $ref: "#/components/parameters/ConfluentResourceID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ConfluentResourceRequest' + $ref: "#/components/schemas/ConfluentResourceRequest" description: Confluent payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ConfluentResourceResponse' + $ref: "#/components/schemas/ConfluentResourceResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update resource in Confluent account tags: - - Confluent Cloud + - Confluent Cloud x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v2/integrations/fastly/accounts: get: description: List Fastly accounts. operationId: ListFastlyAccounts responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FastlyAccountsResponse' + $ref: "#/components/schemas/FastlyAccountsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List Fastly accounts tags: - - Fastly Integration - x-permission: + - Fastly Integration + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read post: description: Create a Fastly account. operationId: CreateFastlyAccount @@ -88686,292 +84797,292 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FastlyAccountCreateRequest' + $ref: "#/components/schemas/FastlyAccountCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/FastlyAccountResponse' + $ref: "#/components/schemas/FastlyAccountResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Add Fastly account tags: - - Fastly Integration + - Fastly Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v2/integrations/fastly/accounts/{account_id}: delete: description: Delete a Fastly account. operationId: DeleteFastlyAccount parameters: - - $ref: '#/components/parameters/FastlyAccountID' + - $ref: "#/components/parameters/FastlyAccountID" responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete Fastly account tags: - - Fastly Integration - x-permission: + - Fastly Integration + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations get: description: Get a Fastly account. operationId: GetFastlyAccount parameters: - - $ref: '#/components/parameters/FastlyAccountID' + - $ref: "#/components/parameters/FastlyAccountID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FastlyAccountResponse' + $ref: "#/components/schemas/FastlyAccountResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get Fastly account tags: - - Fastly Integration - x-permission: + - Fastly Integration + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read patch: description: Update a Fastly account. operationId: UpdateFastlyAccount parameters: - - $ref: '#/components/parameters/FastlyAccountID' + - $ref: "#/components/parameters/FastlyAccountID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/FastlyAccountUpdateRequest' + $ref: "#/components/schemas/FastlyAccountUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FastlyAccountResponse' + $ref: "#/components/schemas/FastlyAccountResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update Fastly account tags: - - Fastly Integration + - Fastly Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v2/integrations/fastly/accounts/{account_id}/services: get: description: List Fastly services for an account. operationId: ListFastlyServices parameters: - - $ref: '#/components/parameters/FastlyAccountID' + - $ref: "#/components/parameters/FastlyAccountID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FastlyServicesResponse' + $ref: "#/components/schemas/FastlyServicesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List Fastly services tags: - - Fastly Integration - x-permission: + - Fastly Integration + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read post: description: Create a Fastly service for an account. operationId: CreateFastlyService parameters: - - $ref: '#/components/parameters/FastlyAccountID' + - $ref: "#/components/parameters/FastlyAccountID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/FastlyServiceRequest' + $ref: "#/components/schemas/FastlyServiceRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/FastlyServiceResponse' + $ref: "#/components/schemas/FastlyServiceResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Add Fastly service tags: - - Fastly Integration + - Fastly Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v2/integrations/fastly/accounts/{account_id}/services/{service_id}: delete: description: Delete a Fastly service for an account. operationId: DeleteFastlyService parameters: - - $ref: '#/components/parameters/FastlyAccountID' - - $ref: '#/components/parameters/FastlyServiceID' + - $ref: "#/components/parameters/FastlyAccountID" + - $ref: "#/components/parameters/FastlyServiceID" responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete Fastly service tags: - - Fastly Integration - x-permission: + - Fastly Integration + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations get: description: Get a Fastly service for an account. operationId: GetFastlyService parameters: - - $ref: '#/components/parameters/FastlyAccountID' - - $ref: '#/components/parameters/FastlyServiceID' + - $ref: "#/components/parameters/FastlyAccountID" + - $ref: "#/components/parameters/FastlyServiceID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FastlyServiceResponse' + $ref: "#/components/schemas/FastlyServiceResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get Fastly service tags: - - Fastly Integration - x-permission: + - Fastly Integration + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read patch: description: Update a Fastly service for an account. operationId: UpdateFastlyService parameters: - - $ref: '#/components/parameters/FastlyAccountID' - - $ref: '#/components/parameters/FastlyServiceID' + - $ref: "#/components/parameters/FastlyAccountID" + - $ref: "#/components/parameters/FastlyServiceID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/FastlyServiceRequest' + $ref: "#/components/schemas/FastlyServiceRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FastlyServiceResponse' + $ref: "#/components/schemas/FastlyServiceResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update Fastly service tags: - - Fastly Integration + - Fastly Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v2/integrations/okta/accounts: get: description: List Okta accounts. operationId: ListOktaAccounts responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OktaAccountsResponse' + $ref: "#/components/schemas/OktaAccountsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List Okta accounts tags: - - Okta Integration - x-permission: + - Okta Integration + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read post: description: Create an Okta account. operationId: CreateOktaAccount @@ -88979,160 +85090,160 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OktaAccountRequest' + $ref: "#/components/schemas/OktaAccountRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/OktaAccountResponse' + $ref: "#/components/schemas/OktaAccountResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Add Okta account tags: - - Okta Integration + - Okta Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v2/integrations/okta/accounts/{account_id}: delete: description: Delete an Okta account. operationId: DeleteOktaAccount parameters: - - description: None - in: path - name: account_id - required: true - schema: - type: string + - description: None + in: path + name: account_id + required: true + schema: + type: string responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete Okta account tags: - - Okta Integration - x-permission: + - Okta Integration + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations get: description: Get an Okta account. operationId: GetOktaAccount parameters: - - description: None - in: path - name: account_id - required: true - schema: - type: string + - description: None + in: path + name: account_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OktaAccountResponse' + $ref: "#/components/schemas/OktaAccountResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get Okta account tags: - - Okta Integration - x-permission: + - Okta Integration + "x-permission": operator: OR permissions: - - integrations_read + - integrations_read patch: description: Update an Okta account. operationId: UpdateOktaAccount parameters: - - description: None - in: path - name: account_id - required: true - schema: - type: string + - description: None + in: path + name: account_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/OktaAccountUpdateRequest' + $ref: "#/components/schemas/OktaAccountUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OktaAccountResponse' + $ref: "#/components/schemas/OktaAccountResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update Okta account tags: - - Okta Integration + - Okta Integration x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - manage_integrations + - manage_integrations /api/v2/ip_allowlist: get: description: Returns the IP allowlist and its enabled or disabled state. operationId: GetIPAllowlist responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IPAllowlistResponse' + $ref: "#/components/schemas/IPAllowlistResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management summary: Get IP Allowlist tags: - - IP Allowlist - x-permission: + - IP Allowlist + "x-permission": operator: OR permissions: - - org_management + - org_management patch: description: Edit the entries in the IP allowlist, and enable or disable it. operationId: UpdateIPAllowlist @@ -89140,106 +85251,103 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/IPAllowlistUpdateRequest' + $ref: "#/components/schemas/IPAllowlistUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IPAllowlistResponse' + $ref: "#/components/schemas/IPAllowlistResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management summary: Update IP Allowlist tags: - - IP Allowlist + - IP Allowlist x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - org_management + - org_management /api/v2/llm-obs/v1/experiments: get: - description: List all LLM Observability experiments sorted by creation date, - newest first. + description: List all LLM Observability experiments sorted by creation date, newest first. operationId: ListLLMObsExperiments parameters: - - description: Filter experiments by project ID. Required if `filter[dataset_id]` - is not provided. - in: query - name: filter[project_id] - schema: - type: string - - description: Filter experiments by dataset ID. - in: query - name: filter[dataset_id] - schema: - type: string - - description: Filter experiments by experiment ID. Can be specified multiple - times. - in: query - name: filter[id] - schema: - type: string - - description: Use the Pagination cursor to retrieve the next page of results. - in: query - name: page[cursor] - schema: - type: string - - description: Maximum number of results to return per page. - in: query - name: page[limit] - schema: - format: int64 - type: integer + - description: Filter experiments by project ID. Required if `filter[dataset_id]` is not provided. + in: query + name: filter[project_id] + schema: + type: string + - description: Filter experiments by dataset ID. + in: query + name: filter[dataset_id] + schema: + type: string + - description: Filter experiments by experiment ID. Can be specified multiple times. + in: query + name: filter[id] + schema: + type: string + - description: Use the Pagination cursor to retrieve the next page of results. + in: query + name: page[cursor] + schema: + type: string + - description: Maximum number of results to return per page. + in: query + name: page[limit] + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LLMObsExperimentsResponse' + $ref: "#/components/schemas/LLMObsExperimentsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: List LLM Observability experiments tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Create a new LLM Observability experiment. operationId: CreateLLMObsExperiment @@ -89247,51 +85355,51 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LLMObsExperimentRequest' + $ref: "#/components/schemas/LLMObsExperimentRequest" description: Create experiment payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LLMObsExperimentResponse' + $ref: "#/components/schemas/LLMObsExperimentResponse" description: OK - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/LLMObsExperimentResponse' + $ref: "#/components/schemas/LLMObsExperimentResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Create an LLM Observability experiment tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/llm-obs/v1/experiments/delete: post: description: Delete one or more LLM Observability experiments. @@ -89300,263 +85408,261 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LLMObsDeleteExperimentsRequest' + $ref: "#/components/schemas/LLMObsDeleteExperimentsRequest" description: Delete experiments payload. required: true responses: - '204': + "204": description: No Content - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Delete LLM Observability experiments tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/llm-obs/v1/experiments/{experiment_id}: patch: description: Partially update an existing LLM Observability experiment. operationId: UpdateLLMObsExperiment parameters: - - $ref: '#/components/parameters/LLMObsExperimentIDPathParameter' + - $ref: "#/components/parameters/LLMObsExperimentIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/LLMObsExperimentUpdateRequest' + $ref: "#/components/schemas/LLMObsExperimentUpdateRequest" description: Update experiment payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LLMObsExperimentResponse' + $ref: "#/components/schemas/LLMObsExperimentResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Update an LLM Observability experiment tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/llm-obs/v1/experiments/{experiment_id}/events: post: description: Push spans and metrics for an LLM Observability experiment. operationId: CreateLLMObsExperimentEvents parameters: - - $ref: '#/components/parameters/LLMObsExperimentIDPathParameter' + - $ref: "#/components/parameters/LLMObsExperimentIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/LLMObsExperimentEventsRequest' + $ref: "#/components/schemas/LLMObsExperimentEventsRequest" description: Experiment events payload. required: true responses: - '202': + "202": description: Accepted - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Push events for an LLM Observability experiment tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/llm-obs/v1/projects: get: - description: List all LLM Observability projects sorted by creation date, newest - first. + description: List all LLM Observability projects sorted by creation date, newest first. operationId: ListLLMObsProjects parameters: - - description: Filter projects by project ID. - in: query - name: filter[id] - schema: - type: string - - description: Filter projects by name. - in: query - name: filter[name] - schema: - type: string - - description: Use the Pagination cursor to retrieve the next page of results. - in: query - name: page[cursor] - schema: - type: string - - description: Maximum number of results to return per page. - in: query - name: page[limit] - schema: - format: int64 - type: integer + - description: Filter projects by project ID. + in: query + name: filter[id] + schema: + type: string + - description: Filter projects by name. + in: query + name: filter[name] + schema: + type: string + - description: Use the Pagination cursor to retrieve the next page of results. + in: query + name: page[cursor] + schema: + type: string + - description: Maximum number of results to return per page. + in: query + name: page[limit] + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LLMObsProjectsResponse' + $ref: "#/components/schemas/LLMObsProjectsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: List LLM Observability projects tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: - description: Create a new LLM Observability project. Returns the existing project - if a name conflict occurs. + description: Create a new LLM Observability project. Returns the existing project if a name conflict occurs. operationId: CreateLLMObsProject requestBody: content: application/json: schema: - $ref: '#/components/schemas/LLMObsProjectRequest' + $ref: "#/components/schemas/LLMObsProjectRequest" description: Create project payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LLMObsProjectResponse' + $ref: "#/components/schemas/LLMObsProjectResponse" description: OK - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/LLMObsProjectResponse' + $ref: "#/components/schemas/LLMObsProjectResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Create an LLM Observability project tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/llm-obs/v1/projects/delete: post: description: Delete one or more LLM Observability projects. @@ -89565,640 +85671,608 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LLMObsDeleteProjectsRequest' + $ref: "#/components/schemas/LLMObsDeleteProjectsRequest" description: Delete projects payload. required: true responses: - '204': + "204": description: No Content - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Delete LLM Observability projects tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/llm-obs/v1/projects/{project_id}: patch: description: Partially update an existing LLM Observability project. operationId: UpdateLLMObsProject parameters: - - $ref: '#/components/parameters/LLMObsProjectIDPathParameter' + - $ref: "#/components/parameters/LLMObsProjectIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/LLMObsProjectUpdateRequest' + $ref: "#/components/schemas/LLMObsProjectUpdateRequest" description: Update project payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LLMObsProjectResponse' + $ref: "#/components/schemas/LLMObsProjectResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Update an LLM Observability project tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/llm-obs/v1/{project_id}/datasets: get: - description: List all LLM Observability datasets for a project, sorted by creation - date, newest first. + description: List all LLM Observability datasets for a project, sorted by creation date, newest first. operationId: ListLLMObsDatasets parameters: - - $ref: '#/components/parameters/LLMObsProjectIDPathParameter' - - description: Filter datasets by name. - in: query - name: filter[name] - schema: - type: string - - description: Filter datasets by dataset ID. - in: query - name: filter[id] - schema: - type: string - - description: Use the Pagination cursor to retrieve the next page of results. - in: query - name: page[cursor] - schema: - type: string - - description: Maximum number of results to return per page. - in: query - name: page[limit] - schema: - format: int64 - type: integer + - $ref: "#/components/parameters/LLMObsProjectIDPathParameter" + - description: Filter datasets by name. + in: query + name: filter[name] + schema: + type: string + - description: Filter datasets by dataset ID. + in: query + name: filter[id] + schema: + type: string + - description: Use the Pagination cursor to retrieve the next page of results. + in: query + name: page[cursor] + schema: + type: string + - description: Maximum number of results to return per page. + in: query + name: page[limit] + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LLMObsDatasetsResponse' + $ref: "#/components/schemas/LLMObsDatasetsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: List LLM Observability datasets tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Create a new LLM Observability dataset within the specified project. operationId: CreateLLMObsDataset parameters: - - $ref: '#/components/parameters/LLMObsProjectIDPathParameter' + - $ref: "#/components/parameters/LLMObsProjectIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/LLMObsDatasetRequest' + $ref: "#/components/schemas/LLMObsDatasetRequest" description: Create dataset payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LLMObsDatasetResponse' + $ref: "#/components/schemas/LLMObsDatasetResponse" description: OK - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/LLMObsDatasetResponse' + $ref: "#/components/schemas/LLMObsDatasetResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Create an LLM Observability dataset tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/llm-obs/v1/{project_id}/datasets/delete: post: - description: Delete one or more LLM Observability datasets within the specified - project. + description: Delete one or more LLM Observability datasets within the specified project. operationId: DeleteLLMObsDatasets parameters: - - $ref: '#/components/parameters/LLMObsProjectIDPathParameter' + - $ref: "#/components/parameters/LLMObsProjectIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/LLMObsDeleteDatasetsRequest' + $ref: "#/components/schemas/LLMObsDeleteDatasetsRequest" description: Delete datasets payload. required: true responses: - '204': + "204": description: No Content - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Delete LLM Observability datasets tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}: patch: - description: Partially update an existing LLM Observability dataset within the - specified project. + description: Partially update an existing LLM Observability dataset within the specified project. operationId: UpdateLLMObsDataset parameters: - - $ref: '#/components/parameters/LLMObsProjectIDPathParameter' - - $ref: '#/components/parameters/LLMObsDatasetIDPathParameter' + - $ref: "#/components/parameters/LLMObsProjectIDPathParameter" + - $ref: "#/components/parameters/LLMObsDatasetIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/LLMObsDatasetUpdateRequest' + $ref: "#/components/schemas/LLMObsDatasetUpdateRequest" description: Update dataset payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LLMObsDatasetResponse' + $ref: "#/components/schemas/LLMObsDatasetResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Update an LLM Observability dataset tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records: get: - description: List all records in an LLM Observability dataset, sorted by creation - date, newest first. + description: List all records in an LLM Observability dataset, sorted by creation date, newest first. operationId: ListLLMObsDatasetRecords parameters: - - $ref: '#/components/parameters/LLMObsProjectIDPathParameter' - - $ref: '#/components/parameters/LLMObsDatasetIDPathParameter' - - description: Retrieve records from a specific dataset version. Defaults to - the current version. - in: query - name: filter[version] - schema: - format: int64 - type: integer - - description: Use the Pagination cursor to retrieve the next page of results. - in: query - name: page[cursor] - schema: - type: string - - description: Maximum number of results to return per page. - in: query - name: page[limit] - schema: - format: int64 - type: integer + - $ref: "#/components/parameters/LLMObsProjectIDPathParameter" + - $ref: "#/components/parameters/LLMObsDatasetIDPathParameter" + - description: Retrieve records from a specific dataset version. Defaults to the current version. + in: query + name: filter[version] + schema: + format: int64 + type: integer + - description: Use the Pagination cursor to retrieve the next page of results. + in: query + name: page[cursor] + schema: + type: string + - description: Maximum number of results to return per page. + in: query + name: page[limit] + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LLMObsDatasetRecordsListResponse' + $ref: "#/components/schemas/LLMObsDatasetRecordsListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: List LLM Observability dataset records tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: description: Update one or more existing records in an LLM Observability dataset. operationId: UpdateLLMObsDatasetRecords parameters: - - $ref: '#/components/parameters/LLMObsProjectIDPathParameter' - - $ref: '#/components/parameters/LLMObsDatasetIDPathParameter' + - $ref: "#/components/parameters/LLMObsProjectIDPathParameter" + - $ref: "#/components/parameters/LLMObsDatasetIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/LLMObsDatasetRecordsUpdateRequest' + $ref: "#/components/schemas/LLMObsDatasetRecordsUpdateRequest" description: Update records payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LLMObsDatasetRecordsMutationResponse' + $ref: "#/components/schemas/LLMObsDatasetRecordsMutationResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Update LLM Observability dataset records tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Append one or more records to an LLM Observability dataset. operationId: CreateLLMObsDatasetRecords parameters: - - $ref: '#/components/parameters/LLMObsProjectIDPathParameter' - - $ref: '#/components/parameters/LLMObsDatasetIDPathParameter' + - $ref: "#/components/parameters/LLMObsProjectIDPathParameter" + - $ref: "#/components/parameters/LLMObsDatasetIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/LLMObsDatasetRecordsRequest' + $ref: "#/components/schemas/LLMObsDatasetRecordsRequest" description: Append records payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LLMObsDatasetRecordsMutationResponse' + $ref: "#/components/schemas/LLMObsDatasetRecordsMutationResponse" description: OK - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/LLMObsDatasetRecordsMutationResponse' + $ref: "#/components/schemas/LLMObsDatasetRecordsMutationResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Append records to an LLM Observability dataset tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records/delete: post: description: Delete one or more records from an LLM Observability dataset. operationId: DeleteLLMObsDatasetRecords parameters: - - $ref: '#/components/parameters/LLMObsProjectIDPathParameter' - - $ref: '#/components/parameters/LLMObsDatasetIDPathParameter' + - $ref: "#/components/parameters/LLMObsProjectIDPathParameter" + - $ref: "#/components/parameters/LLMObsDatasetIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/LLMObsDeleteDatasetRecordsRequest' + $ref: "#/components/schemas/LLMObsDeleteDatasetRecordsRequest" description: Delete records payload. required: true responses: - '204': + "204": description: No Content - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Delete LLM Observability dataset records tags: - - LLM Observability - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - LLM Observability + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/logs: post: - description: 'Send your logs to your Datadog platform over HTTP. Limits per - HTTP request are: - + description: |- + Send your logs to your Datadog platform over HTTP. Limits per HTTP request are: - Maximum content size per payload (uncompressed): 5MB - - Maximum size for a single log: 1MB - - Maximum array size if sending multiple logs in an array: 1000 entries - Any log exceeding 1MB is accepted and truncated by Datadog: - - - For a single log request, the API truncates the log at 1MB and returns a - 2xx. - - - For a multi-logs request, the API processes all logs, truncates only logs - larger than 1MB, and returns a 2xx. - + - For a single log request, the API truncates the log at 1MB and returns a 2xx. + - For a multi-logs request, the API processes all logs, truncates only logs larger than 1MB, and returns a 2xx. Datadog recommends sending your logs compressed. - - Add the `Content-Encoding: gzip` header to the request when sending compressed - logs. - - Log events can be submitted with a timestamp that is up to 18 hours in the - past. - + Add the `Content-Encoding: gzip` header to the request when sending compressed logs. + Log events can be submitted with a timestamp that is up to 18 hours in the past. The status codes answered by the HTTP API are: - - 202: Accepted: the request has been accepted for processing - - 400: Bad request (likely an issue in the payload formatting) - - 401: Unauthorized (likely a missing API Key) - - 403: Permission issue (likely using an invalid API Key) - - 408: Request Timeout, request should be retried after some time - - 413: Payload too large (batch is above 5MB uncompressed) - - 429: Too Many Requests, request should be retried after some time - - - 500: Internal Server Error, the server encountered an unexpected condition - that prevented it from fulfilling the request, request should be retried after - some time - - - 503: Service Unavailable, the server is not ready to handle the request - probably because it is overloaded, request should be retried after some time' + - 500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time + - 503: Service Unavailable, the server is not ready to handle the request probably because it is overloaded, request should be retried after some time operationId: SubmitLog parameters: - - description: HTTP header used to compress the media-type. - in: header - name: Content-Encoding - required: false - schema: - $ref: '#/components/schemas/ContentEncoding' - - description: Log tags can be passed as query parameters with `text/plain` - content type. - example: env:prod,user:my-user - in: query - name: ddtags - required: false - schema: - type: string + - description: HTTP header used to compress the media-type. + in: header + name: Content-Encoding + required: false + schema: + $ref: "#/components/schemas/ContentEncoding" + - description: Log tags can be passed as query parameters with `text/plain` content type. + example: "env:prod,user:my-user" + in: query + name: ddtags + required: false + schema: + type: string requestBody: content: application/json: @@ -90207,37 +86281,35 @@ paths: description: Pass multiple log objects at once. summary: Multi JSON Messages value: - - ddsource: nginx - ddtags: env:staging,version:5.1 - hostname: i-012345678 - message: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello - service: payment - - ddsource: nginx - ddtags: env:staging,version:5.1 - hostname: i-012345679 - message: 2019-11-19T14:37:58,995 INFO [process.name][20081] World - service: payment + - ddsource: "nginx" + ddtags: "env:staging,version:5.1" + hostname: "i-012345678" + message: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello + service: "payment" + - ddsource: "nginx" + ddtags: "env:staging,version:5.1" + hostname: "i-012345679" + message: 2019-11-19T14:37:58,995 INFO [process.name][20081] World + service: "payment" simple-json-message: - description: Log attributes can be passed as `key:value` pairs in - valid JSON messages. + description: Log attributes can be passed as `key:value` pairs in valid JSON messages. summary: Simple JSON Message value: - ddsource: nginx - ddtags: env:staging,version:5.1 - hostname: i-012345678 - message: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello - World - service: payment + ddsource: "nginx" + ddtags: "env:staging,version:5.1" + hostname: "i-012345678" + message: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World + service: "payment" schema: - $ref: '#/components/schemas/HTTPLog' + $ref: "#/components/schemas/HTTPLog" application/logplex-1: examples: multi-raw-message: description: Submit log messages. summary: Multi Logplex Messages - value: '2019-11-19T14:37:58,995 INFO [process.name][20081] Hello - - 2019-11-19T14:37:58,995 INFO [process.name][20081] World' + value: |- + 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello + 2019-11-19T14:37:58,995 INFO [process.name][20081] World simple-logplex-message: description: Submit log string. summary: Simple Logplex Message @@ -90249,13 +86321,12 @@ paths: multi-raw-message: description: Submit log string. summary: Multi Raw Messages - value: '2019-11-19T14:37:58,995 INFO [process.name][20081] Hello - - 2019-11-19T14:37:58,995 INFO [process.name][20081] World' + value: |- + 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello + 2019-11-19T14:37:58,995 INFO [process.name][20081] World simple-raw-message: - description: 'Submit log string. Log attributes can be passed as query - parameters in the URL. This enables the addition of tags or the - source by using the `ddtags` and `ddsource` parameters: `?host=my-hostname&service=my-service&ddsource=my-source&ddtags=env:prod,user:my-user`.' + description: >- + Submit log string. Log attributes can be passed as query parameters in the URL. This enables the addition of tags or the source by using the `ddtags` and `ddsource` parameters: `?host=my-hostname&service=my-service&ddsource=my-source&ddtags=env:prod,user:my-user`. summary: Simple Raw Message value: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World schema: @@ -90263,239 +86334,235 @@ paths: description: Log to send (JSON format). required: true responses: - '202': + "202": content: application/json: schema: type: object description: Request accepted for processing (always 202 empty JSON). - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/HTTPLogErrors' + $ref: "#/components/schemas/HTTPLogErrors" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/HTTPLogErrors' + $ref: "#/components/schemas/HTTPLogErrors" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/HTTPLogErrors' + $ref: "#/components/schemas/HTTPLogErrors" description: Forbidden - '408': + "408": content: application/json: schema: - $ref: '#/components/schemas/HTTPLogErrors' + $ref: "#/components/schemas/HTTPLogErrors" description: Request Timeout - '413': + "413": content: application/json: schema: - $ref: '#/components/schemas/HTTPLogErrors' + $ref: "#/components/schemas/HTTPLogErrors" description: Payload Too Large - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/HTTPLogErrors' + $ref: "#/components/schemas/HTTPLogErrors" description: Too Many Requests - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/HTTPLogErrors' + $ref: "#/components/schemas/HTTPLogErrors" description: Internal Server Error - '503': + "503": content: application/json: schema: - $ref: '#/components/schemas/HTTPLogErrors' + $ref: "#/components/schemas/HTTPLogErrors" description: Service Unavailable security: - - apiKeyAuth: [] + - apiKeyAuth: [] servers: - - url: https://{subdomain}.{site} - variables: - site: - default: datadoghq.com - description: The regional site for customers. - enum: - - datadoghq.com - - us3.datadoghq.com - - us5.datadoghq.com - - ap1.datadoghq.com - - ap2.datadoghq.com - - datadoghq.eu - - ddog-gov.com - subdomain: - default: http-intake.logs - description: The subdomain where the API is deployed. - - url: '{protocol}://{name}' - variables: - name: - default: http-intake.logs.datadoghq.com - description: Full site DNS name. - protocol: - default: https - description: The protocol for accessing the API. - - url: https://{subdomain}.{site} - variables: - site: - default: datadoghq.com - description: Any Datadog deployment. - subdomain: - default: http-intake.logs - description: The subdomain where the API is deployed. + - url: https://{subdomain}.{site} + variables: + site: + default: datadoghq.com + description: The regional site for customers. + enum: + - datadoghq.com + - us3.datadoghq.com + - us5.datadoghq.com + - ap1.datadoghq.com + - ap2.datadoghq.com + - datadoghq.eu + - ddog-gov.com + subdomain: + default: http-intake.logs + description: The subdomain where the API is deployed. + - url: "{protocol}://{name}" + variables: + name: + default: http-intake.logs.datadoghq.com + description: Full site DNS name. + protocol: + default: https + description: The protocol for accessing the API. + - url: https://{subdomain}.{site} + variables: + site: + default: datadoghq.com + description: Any Datadog deployment. + subdomain: + default: http-intake.logs + description: The subdomain where the API is deployed. summary: Send logs tags: - - Logs + - Logs x-codegen-request-body-name: body /api/v2/logs/analytics/aggregate: post: - description: The API endpoint to aggregate events into buckets and compute metrics - and timeseries. + description: |- + The API endpoint to aggregate events into buckets and compute metrics and timeseries. operationId: AggregateLogs requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/LogsAggregateRequest' + $ref: "#/components/schemas/LogsAggregateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsAggregateResponse' + $ref: "#/components/schemas/LogsAggregateResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Aggregate events - tags: - - Logs + tags: ["Logs"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_read_data + - logs_read_data /api/v2/logs/config/archive-order: get: - description: 'Get the current order of your archives. - - This endpoint takes no JSON arguments.' + description: |- + Get the current order of your archives. + This endpoint takes no JSON arguments. operationId: GetLogsArchiveOrder responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsArchiveOrder' + $ref: "#/components/schemas/LogsArchiveOrder" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get archive order tags: - - Logs Archives - x-permission: + - Logs Archives + "x-permission": operator: OR permissions: - - logs_read_config + - logs_read_config put: - description: 'Update the order of your archives. Since logs are processed sequentially, - reordering an archive may change - + description: |- + Update the order of your archives. Since logs are processed sequentially, reordering an archive may change the structure and content of the data processed by other archives. - - **Note**: Using the `PUT` method updates your archive''s order by replacing - the current order - - with the new one.' + **Note**: Using the `PUT` method updates your archive's order by replacing the current order + with the new one. operationId: UpdateLogsArchiveOrder requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogsArchiveOrder' + $ref: "#/components/schemas/LogsArchiveOrder" description: An object containing the new ordered list of archive IDs. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsArchiveOrder' + $ref: "#/components/schemas/LogsArchiveOrder" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Unprocessable Entity - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update archive order tags: - - Logs Archives + - Logs Archives x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_write_archives + - logs_write_archives /api/v2/logs/config/archives: get: - description: Get the list of configured logs archives with their definitions. + description: |- + Get the list of configured logs archives with their definitions. operationId: ListLogsArchives responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsArchives' + $ref: "#/components/schemas/LogsArchives" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all archives tags: - - Logs Archives - x-permission: + - Logs Archives + "x-permission": operator: OR permissions: - - logs_read_archives + - logs_read_archives post: description: Create an archive in your organization. operationId: CreateLogsArchive @@ -90503,318 +86570,318 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LogsArchiveCreateRequest' + $ref: "#/components/schemas/LogsArchiveCreateRequest" description: The definition of the new archive. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsArchive' + $ref: "#/components/schemas/LogsArchive" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an archive tags: - - Logs Archives + - Logs Archives x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_write_archives + - logs_write_archives /api/v2/logs/config/archives/{archive_id}: delete: - description: Delete a given archive from your organization. + description: |- + Delete a given archive from your organization. operationId: DeleteLogsArchive parameters: - - $ref: '#/components/parameters/ArchiveID' + - $ref: "#/components/parameters/ArchiveID" responses: - '204': + "204": description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an archive tags: - - Logs Archives - x-permission: + - Logs Archives + "x-permission": operator: OR permissions: - - logs_write_archives + - logs_write_archives get: - description: Get a specific archive from your organization. + description: |- + Get a specific archive from your organization. operationId: GetLogsArchive parameters: - - $ref: '#/components/parameters/ArchiveID' + - $ref: "#/components/parameters/ArchiveID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsArchive' + $ref: "#/components/schemas/LogsArchive" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get an archive tags: - - Logs Archives - x-permission: + - Logs Archives + "x-permission": operator: OR permissions: - - logs_read_archives + - logs_read_archives put: - description: 'Update a given archive configuration. - + description: |- + Update a given archive configuration. **Note**: Using this method updates your archive configuration by **replacing** - - your current configuration with the new one sent to your Datadog organization.' + your current configuration with the new one sent to your Datadog organization. operationId: UpdateLogsArchive parameters: - - $ref: '#/components/parameters/ArchiveID' + - $ref: "#/components/parameters/ArchiveID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogsArchiveCreateRequest' + $ref: "#/components/schemas/LogsArchiveCreateRequest" description: New definition of the archive. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsArchive' + $ref: "#/components/schemas/LogsArchive" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update an archive tags: - - Logs Archives + - Logs Archives x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_write_archives + - logs_write_archives /api/v2/logs/config/archives/{archive_id}/readers: delete: description: Removes a role from an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/)) operationId: RemoveRoleFromArchive parameters: - - $ref: '#/components/parameters/ArchiveID' + - $ref: "#/components/parameters/ArchiveID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RelationshipToRole' + $ref: "#/components/schemas/RelationshipToRole" required: true responses: - '204': + "204": description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Revoke role from an archive tags: - - Logs Archives + - Logs Archives x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_write_archives + - logs_write_archives get: description: Returns all read roles a given archive is restricted to. operationId: ListArchiveReadRoles parameters: - - $ref: '#/components/parameters/ArchiveID' + - $ref: "#/components/parameters/ArchiveID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RolesResponse' + $ref: "#/components/schemas/RolesResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List read roles for an archive tags: - - Logs Archives + - Logs Archives x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_read_config + - logs_read_config post: description: Adds a read role to an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/)) operationId: AddReadRoleToArchive parameters: - - $ref: '#/components/parameters/ArchiveID' + - $ref: "#/components/parameters/ArchiveID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RelationshipToRole' + $ref: "#/components/schemas/RelationshipToRole" required: true responses: - '204': + "204": description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Grant role to an archive tags: - - Logs Archives + - Logs Archives x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_write_archives + - logs_write_archives /api/v2/logs/config/custom-destinations: get: - description: Get the list of configured custom destinations in your organization - with their definitions. + description: Get the list of configured custom destinations in your organization with their definitions. operationId: ListLogsCustomDestinations responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomDestinationsResponse' + $ref: "#/components/schemas/CustomDestinationsResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all custom destinations tags: - - Logs Custom Destinations - x-permission: + - Logs Custom Destinations + "x-permission": operator: OR permissions: - - logs_read_config - - logs_read_data + - logs_read_config + - logs_read_data post: description: Create a custom destination in your organization. operationId: CreateLogsCustomDestination @@ -90822,297 +86889,294 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CustomDestinationCreateRequest' + $ref: "#/components/schemas/CustomDestinationCreateRequest" description: The definition of the new custom destination. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomDestinationResponse' + $ref: "#/components/schemas/CustomDestinationResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a custom destination tags: - - Logs Custom Destinations + - Logs Custom Destinations x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_write_forwarding_rules + - logs_write_forwarding_rules /api/v2/logs/config/custom-destinations/{custom_destination_id}: delete: description: Delete a specific custom destination in your organization. operationId: DeleteLogsCustomDestination parameters: - - $ref: '#/components/parameters/CustomDestinationId' + - $ref: "#/components/parameters/CustomDestinationId" responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a custom destination tags: - - Logs Custom Destinations - x-permission: + - Logs Custom Destinations + "x-permission": operator: OR permissions: - - logs_write_forwarding_rules + - logs_write_forwarding_rules get: description: Get a specific custom destination in your organization. operationId: GetLogsCustomDestination parameters: - - $ref: '#/components/parameters/CustomDestinationId' + - $ref: "#/components/parameters/CustomDestinationId" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomDestinationResponse' + $ref: "#/components/schemas/CustomDestinationResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a custom destination tags: - - Logs Custom Destinations - x-permission: + - Logs Custom Destinations + "x-permission": operator: OR permissions: - - logs_read_config - - logs_read_data + - logs_read_config + - logs_read_data patch: - description: Update the given fields of a specific custom destination in your - organization. + description: Update the given fields of a specific custom destination in your organization. operationId: UpdateLogsCustomDestination parameters: - - $ref: '#/components/parameters/CustomDestinationId' + - $ref: "#/components/parameters/CustomDestinationId" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CustomDestinationUpdateRequest' + $ref: "#/components/schemas/CustomDestinationUpdateRequest" description: New definition of the custom destination's fields. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomDestinationResponse' + $ref: "#/components/schemas/CustomDestinationResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a custom destination tags: - - Logs Custom Destinations + - Logs Custom Destinations x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_write_forwarding_rules + - logs_write_forwarding_rules /api/v2/logs/config/metrics: get: description: Get the list of configured log-based metrics with their definitions. operationId: ListLogsMetrics responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsMetricsResponse' + $ref: "#/components/schemas/LogsMetricsResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all log-based metrics tags: - - Logs Metrics - x-permission: + - Logs Metrics + "x-permission": operator: OR permissions: - - logs_read_config + - logs_read_config post: - description: 'Create a metric based on your ingested logs in your organization. - - Returns the log-based metric object from the request body when the request - is successful.' + description: |- + Create a metric based on your ingested logs in your organization. + Returns the log-based metric object from the request body when the request is successful. operationId: CreateLogsMetric requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogsMetricCreateRequest' + $ref: "#/components/schemas/LogsMetricCreateRequest" description: The definition of the new log-based metric. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsMetricResponse' + $ref: "#/components/schemas/LogsMetricResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a log-based metric tags: - - Logs Metrics + - Logs Metrics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_generate_metrics + - logs_generate_metrics /api/v2/logs/config/metrics/{metric_id}: delete: description: Delete a specific log-based metric from your organization. operationId: DeleteLogsMetric parameters: - - $ref: '#/components/parameters/MetricID' + - $ref: "#/components/parameters/MetricID" responses: - '204': + "204": description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a log-based metric tags: - - Logs Metrics - x-permission: + - Logs Metrics + "x-permission": operator: OR permissions: - - logs_generate_metrics + - logs_generate_metrics get: description: Get a specific log-based metric from your organization. operationId: GetLogsMetric parameters: - - $ref: '#/components/parameters/MetricID' + - $ref: "#/components/parameters/MetricID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsMetricResponse' + $ref: "#/components/schemas/LogsMetricResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a log-based metric tags: - - Logs Metrics - x-permission: + - Logs Metrics + "x-permission": operator: OR permissions: - - logs_read_config + - logs_read_config patch: - description: 'Update a specific log-based metric from your organization. - - Returns the log-based metric object from the request body when the request - is successful.' + description: |- + Update a specific log-based metric from your organization. + Returns the log-based metric object from the request body when the request is successful. operationId: UpdateLogsMetric parameters: - - $ref: '#/components/parameters/MetricID' + - $ref: "#/components/parameters/MetricID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/LogsMetricUpdateRequest' + $ref: "#/components/schemas/LogsMetricUpdateRequest" description: New definition of the log-based metric. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsMetricResponse' + $ref: "#/components/schemas/LogsMetricResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a log-based metric tags: - - Logs Metrics + - Logs Metrics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_generate_metrics + - logs_generate_metrics /api/v2/logs/config/restriction_queries: get: description: Returns all restriction queries, including their names and IDs. operationId: ListRestrictionQueries parameters: - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RestrictionQueryListResponse' + $ref: "#/components/schemas/RestrictionQueryListResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List restriction queries tags: - - Logs Restriction Queries - x-permission: + - Logs Restriction Queries + "x-permission": operator: OR permissions: - - logs_read_config - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - logs_read_config + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Create a new restriction query for your organization. operationId: CreateRestrictionQuery @@ -91120,1192 +87184,1150 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RestrictionQueryCreatePayload' + $ref: "#/components/schemas/RestrictionQueryCreatePayload" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RestrictionQueryWithoutRelationshipsResponse' + $ref: "#/components/schemas/RestrictionQueryWithoutRelationshipsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a restriction query tags: - - Logs Restriction Queries + - Logs Restriction Queries x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - user_access_manage + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/logs/config/restriction_queries/role/{role_id}: get: description: Get restriction query for a given role. operationId: GetRoleRestrictionQuery parameters: - - $ref: '#/components/parameters/RestrictionQueryRoleID' + - $ref: "#/components/parameters/RestrictionQueryRoleID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RestrictionQueryListResponse' + $ref: "#/components/schemas/RestrictionQueryListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get restriction query for a given role tags: - - Logs Restriction Queries - x-permission: + - Logs Restriction Queries + "x-permission": operator: OR permissions: - - logs_read_config - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - logs_read_config + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/logs/config/restriction_queries/user/{user_id}: get: description: Get all restriction queries for a given user. operationId: ListUserRestrictionQueries parameters: - - $ref: '#/components/parameters/RestrictionQueryUserID' + - $ref: "#/components/parameters/RestrictionQueryUserID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RestrictionQueryListResponse' + $ref: "#/components/schemas/RestrictionQueryListResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all restriction queries for a given user tags: - - Logs Restriction Queries - x-permission: + - Logs Restriction Queries + "x-permission": operator: OR permissions: - - logs_read_config - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - logs_read_config + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/logs/config/restriction_queries/{restriction_query_id}: delete: description: Deletes a restriction query. operationId: DeleteRestrictionQuery parameters: - - $ref: '#/components/parameters/RestrictionQueryID' + - $ref: "#/components/parameters/RestrictionQueryID" responses: - '204': + "204": description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a restriction query tags: - - Logs Restriction Queries + - Logs Restriction Queries x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - user_access_manage + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: - description: Get a restriction query in the organization specified by the restriction - query's `restriction_query_id`. + description: Get a restriction query in the organization specified by the restriction query's `restriction_query_id`. operationId: GetRestrictionQuery parameters: - - $ref: '#/components/parameters/RestrictionQueryID' + - $ref: "#/components/parameters/RestrictionQueryID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RestrictionQueryWithRelationshipsResponse' + $ref: "#/components/schemas/RestrictionQueryWithRelationshipsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a restriction query tags: - - Logs Restriction Queries + - Logs Restriction Queries x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_read_config - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - logs_read_config + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: - description: Edit a restriction query. + description: |- + Edit a restriction query. operationId: UpdateRestrictionQuery parameters: - - $ref: '#/components/parameters/RestrictionQueryID' + - $ref: "#/components/parameters/RestrictionQueryID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RestrictionQueryUpdatePayload' + $ref: "#/components/schemas/RestrictionQueryUpdatePayload" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RestrictionQueryWithoutRelationshipsResponse' + $ref: "#/components/schemas/RestrictionQueryWithoutRelationshipsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a restriction query tags: - - Logs Restriction Queries + - Logs Restriction Queries x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - user_access_manage + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). put: - description: Replace a restriction query. + description: |- + Replace a restriction query. operationId: ReplaceRestrictionQuery parameters: - - $ref: '#/components/parameters/RestrictionQueryID' + - $ref: "#/components/parameters/RestrictionQueryID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RestrictionQueryUpdatePayload' + $ref: "#/components/schemas/RestrictionQueryUpdatePayload" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RestrictionQueryWithoutRelationshipsResponse' + $ref: "#/components/schemas/RestrictionQueryWithoutRelationshipsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Replace a restriction query tags: - - Logs Restriction Queries + - Logs Restriction Queries x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - user_access_manage + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/logs/config/restriction_queries/{restriction_query_id}/roles: delete: description: Removes a role from a restriction query. operationId: RemoveRoleFromRestrictionQuery parameters: - - $ref: '#/components/parameters/RestrictionQueryID' + - $ref: "#/components/parameters/RestrictionQueryID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RelationshipToRole' + $ref: "#/components/schemas/RelationshipToRole" required: true responses: - '204': + "204": description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Revoke role from a restriction query tags: - - Logs Restriction Queries + - Logs Restriction Queries x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - user_access_manage + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). get: description: Returns all roles that have a given restriction query. operationId: ListRestrictionQueryRoles parameters: - - $ref: '#/components/parameters/RestrictionQueryID' - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' + - $ref: "#/components/parameters/RestrictionQueryID" + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RestrictionQueryRolesResponse' + $ref: "#/components/schemas/RestrictionQueryRolesResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List roles for a restriction query tags: - - Logs Restriction Queries + - Logs Restriction Queries x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - logs_read_config - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - logs_read_config + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: - description: 'Adds a role to a restriction query. - + description: |- + Adds a role to a restriction query. - **Note**: This operation automatically grants the `logs_read_data` permission - to the role if it doesn''t already have it.' + **Note**: This operation automatically grants the `logs_read_data` permission to the role if it doesn't already have it. operationId: AddRoleToRestrictionQuery parameters: - - $ref: '#/components/parameters/RestrictionQueryID' + - $ref: "#/components/parameters/RestrictionQueryID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RelationshipToRole' + $ref: "#/components/schemas/RelationshipToRole" required: true responses: - '204': + "204": description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Grant role to a restriction query tags: - - Logs Restriction Queries + - Logs Restriction Queries x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - user_access_manage + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/logs/events: get: - description: 'List endpoint returns logs that match a log search query. - + description: |- + List endpoint returns logs that match a log search query. [Results are paginated][1]. - Use this endpoint to search and filter your logs. - **If you are considering archiving logs for your organization, - consider use of the Datadog archive capabilities instead of the log list API. - See [Datadog Logs Archive documentation][2].** - [1]: /logs/guide/collect-multiple-logs-with-pagination - - [2]: https://docs.datadoghq.com/logs/archives' + [2]: https://docs.datadoghq.com/logs/archives operationId: ListLogsGet parameters: - - description: Search query following logs syntax. - example: '@datacenter:us @role:db' - in: query - name: filter[query] - required: false - schema: - type: string - - description: 'For customers with multiple indexes, the indexes to search. - - Defaults to ''*'' which means all indexes' - example: - - main - - web - explode: false - in: query - name: filter[indexes] - required: false - schema: - items: - description: The name of a log index. + - description: Search query following logs syntax. + example: "@datacenter:us @role:db" + in: query + name: filter[query] + required: false + schema: type: string - type: array - - description: Minimum timestamp for requested logs. - example: '2019-01-02T09:42:36.320Z' - in: query - name: filter[from] - required: false - schema: - format: date-time - type: string - - description: Maximum timestamp for requested logs. - example: '2019-01-03T09:42:36.320Z' - in: query - name: filter[to] - required: false - schema: - format: date-time - type: string - - description: Specifies the storage type to be used - example: indexes - in: query - name: filter[storage_tier] - required: false - schema: - $ref: '#/components/schemas/LogsStorageTier' - - description: Order of logs in results. - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/LogsSort' - - description: List following results with a cursor provided in the previous - query. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== - in: query - name: page[cursor] - required: false - schema: - type: string - - description: Maximum number of logs in the response. - example: 25 - in: query - name: page[limit] - required: false - schema: - default: 10 - format: int32 - maximum: 1000 - type: integer + - description: |- + For customers with multiple indexes, the indexes to search. + Defaults to '*' which means all indexes + example: ["main", "web"] + explode: false + in: query + name: filter[indexes] + required: false + schema: + items: + description: The name of a log index. + type: string + type: array + - description: Minimum timestamp for requested logs. + example: "2019-01-02T09:42:36.320Z" + in: query + name: filter[from] + required: false + schema: + format: date-time + type: string + - description: Maximum timestamp for requested logs. + example: "2019-01-03T09:42:36.320Z" + in: query + name: filter[to] + required: false + schema: + format: date-time + type: string + - description: Specifies the storage type to be used + example: "indexes" + in: query + name: filter[storage_tier] + required: false + schema: + $ref: "#/components/schemas/LogsStorageTier" + - description: Order of logs in results. + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/LogsSort" + - description: |- + List following results with a cursor provided in the previous query. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" + in: query + name: page[cursor] + required: false + schema: + type: string + - description: Maximum number of logs in the response. + example: 25 + in: query + name: page[limit] + required: false + schema: + default: 10 + format: int32 + maximum: 1000 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsListResponse' + $ref: "#/components/schemas/LogsListResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Search logs (GET) - tags: - - Logs + tags: ["Logs"] x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - logs_read_data + - logs_read_data /api/v2/logs/events/search: post: - description: 'List endpoint returns logs that match a log search query. - + description: |- + List endpoint returns logs that match a log search query. [Results are paginated][1]. - Use this endpoint to search and filter your logs. - **If you are considering archiving logs for your organization, - consider use of the Datadog archive capabilities instead of the log list API. - See [Datadog Logs Archive documentation][2].** - [1]: /logs/guide/collect-multiple-logs-with-pagination - - [2]: https://docs.datadoghq.com/logs/archives' + [2]: https://docs.datadoghq.com/logs/archives operationId: ListLogs requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/LogsListRequest' + $ref: "#/components/schemas/LogsListRequest" required: false responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/LogsListResponse' + $ref: "#/components/schemas/LogsListResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Search logs (POST) - tags: - - Logs + tags: ["Logs"] x-codegen-request-body-name: body x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - logs_read_data + - logs_read_data /api/v2/metrics: get: - description: Get a list of actively reporting metrics for your organization. - Pagination is optional using the `page[cursor]` and `page[size]` query parameters. + description: |- + Returns all metrics for your organization that match the given filter parameters. + Optionally, paginate by using the `page[cursor]` and/or `page[size]` query parameters. + To 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. + Once the `meta.pagination.next_cursor` value is null, all pages have been retrieved. operationId: ListTagConfigurations parameters: - - description: Only return custom metrics that have been configured with Metrics - Without Limits. - example: true - in: query - name: filter[configured] - required: false - schema: - type: boolean - - description: Only return metrics that have the given tag key(s) in their Metrics - Without Limits configuration (included or excluded). - example: app,env - in: query - name: filter[tags_configured] - required: false - schema: - description: Tag keys to filter by. - type: string - - description: Only return metrics of the given metric type. - in: query - name: filter[metric_type] - required: false - schema: - $ref: '#/components/schemas/MetricTagConfigurationMetricTypeCategory' - - description: Only return distribution metrics that have percentile aggregations - enabled (true) or disabled (false). - example: true - in: query - name: filter[include_percentiles] - required: false - schema: - type: boolean - - description: Only return metrics that have been queried (true) or not queried - (false) in the look back window. Set the window with `filter[queried][window][seconds]`; - if omitted, a default window is used. - example: true - in: query - name: filter[queried] - required: false - schema: - type: boolean - - description: Only return metrics that have been queried or not queried in - the specified window. Dependent on being sent with `filter[queried]`. - example: 15552000 - in: query - name: filter[queried][window][seconds] - required: false - schema: - default: 2592000 - format: int64 - maximum: 15552000 - minimum: 1 - type: integer - - description: Only return metrics that were submitted with tags matching this - expression. You can use AND, OR, IN, and wildcards (for example, service:web*). - example: env IN (staging,test) AND service:web* - in: query - name: filter[tags] - required: false - schema: - type: string - - description: Only return metrics that are used in at least one dashboard, - monitor, notebook, or SLO. - example: true - in: query - name: filter[related_assets] - required: false - schema: - type: boolean - - description: Only return metrics that have been actively reporting in the - specified window. - example: 3600 - in: query - name: window[seconds] - required: false - schema: - default: 3600 - format: int64 - maximum: 2592000 - minimum: 1 - type: integer - - description: Maximum number of results per page. Use with `page[cursor]` for - pagination. - in: query - name: page[size] - required: false - schema: - default: 10000 - format: int32 - maximum: 10000 - minimum: 1 - type: integer - - description: Cursor for pagination. Use `page[size]` to opt-in to pagination - and get the first page; for subsequent pages, use the value from `meta.pagination.next_cursor` - in the response. Pagination is complete when `next_cursor` is null. - in: query - name: page[cursor] - required: false - schema: - type: string + - description: Filter custom metrics that have configured tags. + example: true + in: query + name: filter[configured] + required: false + schema: + type: boolean + - description: Filter tag configurations by configured tags. + example: "app" + in: query + name: filter[tags_configured] + required: false + schema: + description: Tag keys to filter by. + type: string + - description: Filter metrics by metric type. + in: query + name: filter[metric_type] + required: false + schema: + $ref: "#/components/schemas/MetricTagConfigurationMetricTypeCategory" + - description: |- + Filter distributions with additional percentile + aggregations enabled or disabled. + example: true + in: query + name: filter[include_percentiles] + required: false + schema: + type: boolean + - description: |- + (Preview) Filter custom metrics that have or have not been queried in the specified window[seconds]. + If no window is provided or the window is less than 2 hours, a default of 2 hours will be applied. + example: true + in: query + name: filter[queried] + required: false + schema: + type: boolean + - description: |- + The number of seconds of look back (from now) used by the `filter[queried]` filter logic. + Must be sent with `filter[queried]` and is only applied when `filter[queried]=true`. + If `filter[queried]=false`, this parameter is ignored and default queried-window behavior applies. + If `filter[queried]` is not provided, sending this parameter returns a 400. + For example: `GET /api/v2/metrics?filter[queried]=true&filter[queried][window][seconds]=15552000`. + example: 15552000 + in: query + name: filter[queried][window][seconds] + required: false + schema: + format: int64 + maximum: 15552000 + minimum: 0 + type: integer + - description: |- + Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. + Can only be combined with the filter[queried] filter. + example: "env IN (staging,test) AND service:web" + in: query + name: filter[tags] + required: false + schema: + type: string + - description: |- + (Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs. + example: true + in: query + name: filter[related_assets] + required: false + schema: + type: boolean + - description: |- + The number of seconds of look back (from now) to apply to a filter[tag] query. + Default value is 3600 (1 hour), maximum value is 5,184,000 (60 days). + example: 3600 + in: query + name: window[seconds] + required: false + schema: + format: int64 + type: integer + - description: Maximum number of results returned. + in: query + name: page[size] + required: false + schema: + default: 10000 + format: int32 + maximum: 10000 + minimum: 1 + type: integer + - description: |- + String to query the next page of results. + This key is provided with each valid response from the API in `meta.pagination.next_cursor`. + Once the `meta.pagination.next_cursor` key is null, all pages have been retrieved. + in: query + name: page[cursor] + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MetricsAndMetricTagConfigurationsResponse' + $ref: "#/components/schemas/MetricsAndMetricTagConfigurationsResponse" description: Success - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too Many Requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - metrics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - metrics_read summary: Get a list of metrics tags: - - Metrics + - Metrics x-pagination: cursorParam: page[cursor] cursorPath: meta.pagination.next_cursor limitParam: page[size] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - metrics_read + - metrics_read /api/v2/metrics/config/bulk-tags: delete: - description: 'Delete all custom lists of queryable tag keys for a set of existing - count, gauge, rate, and distribution metrics. - + description: |- + Delete all custom lists of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics. Metrics are selected by passing a metric name prefix. - - Results can be sent to a set of account email addresses, just like the same - operation in the Datadog web app. - - Can only be used with application keys of users with the `Manage Tags for - Metrics` permission.' + Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app. + Can only be used with application keys of users with the `Manage Tags for Metrics` permission. operationId: DeleteBulkTagsMetricsConfiguration requestBody: content: application/json: schema: - $ref: '#/components/schemas/MetricBulkTagConfigDeleteRequest' + $ref: "#/components/schemas/MetricBulkTagConfigDeleteRequest" required: true responses: - '202': + "202": content: application/json: schema: - $ref: '#/components/schemas/MetricBulkTagConfigResponse' + $ref: "#/components/schemas/MetricBulkTagConfigResponse" description: Accepted - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too Many Requests summary: Delete tags for multiple metrics tags: - - Metrics + - Metrics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - metric_tags_write + - metric_tags_write post: - description: 'Create and define a list of queryable tag keys for a set of existing - count, gauge, rate, and distribution metrics. - - Metrics are selected by passing a metric name prefix. Use the Delete method - of this API path to remove tag configurations. - - Results can be sent to a set of account email addresses, just like the same - operation in the Datadog web app. - - If multiple calls include the same metric, the last configuration applied - (not by submit order) is used, do not - - expect deterministic ordering of concurrent calls. The `exclude_tags_mode` - value will set all metrics that match the prefix to - - the same exclusion state, metric tag configurations do not support mixed inclusion - and exclusion for tags on the same metric. - - Can only be used with application keys of users with the `Manage Tags for - Metrics` permission.' + description: |- + Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics. + Metrics are selected by passing a metric name prefix. Use the Delete method of this API path to remove tag configurations. + Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app. + If multiple calls include the same metric, the last configuration applied (not by submit order) is used, do not + expect deterministic ordering of concurrent calls. The `exclude_tags_mode` value will set all metrics that match the prefix to + the same exclusion state, metric tag configurations do not support mixed inclusion and exclusion for tags on the same metric. + Can only be used with application keys of users with the `Manage Tags for Metrics` permission. operationId: CreateBulkTagsMetricsConfiguration requestBody: content: application/json: schema: - $ref: '#/components/schemas/MetricBulkTagConfigCreateRequest' + $ref: "#/components/schemas/MetricBulkTagConfigCreateRequest" required: true responses: - '202': + "202": content: application/json: schema: - $ref: '#/components/schemas/MetricBulkTagConfigResponse' + $ref: "#/components/schemas/MetricBulkTagConfigResponse" description: Accepted - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too Many Requests summary: Configure tags for multiple metrics tags: - - Metrics + - Metrics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - metric_tags_write + - metric_tags_write /api/v2/metrics/{metric_name}/active-configurations: get: - description: List tags and aggregations that are actively queried on dashboards, - notebooks, monitors, the Metrics Explorer, and using the API for a given metric - name. + description: |- + List tags and aggregations that are actively queried on dashboards, notebooks, monitors, the Metrics Explorer, and using the API for a given metric name. operationId: ListActiveMetricConfigurations parameters: - - $ref: '#/components/parameters/MetricName' - - description: 'The number of seconds of look back (from now). - - Default value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum - value is 2,630,000 (1 month).' - example: 7200 - in: query - name: window[seconds] - required: false - schema: - format: int64 - type: integer + - $ref: "#/components/parameters/MetricName" + - description: |- + The number of seconds of look back (from now). + Default value is 604,800 (1 week), minimum value is 7200 (2 hours), maximum value is 2,630,000 (1 month). + example: 7200 + in: query + name: window[seconds] + required: false + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MetricSuggestedTagsAndAggregationsResponse' + $ref: "#/components/schemas/MetricSuggestedTagsAndAggregationsResponse" description: Success - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too Many Requests summary: List active tags and aggregations tags: - - Metrics - x-permission: + - Metrics + "x-permission": operator: OR permissions: - - metrics_read + - metrics_read /api/v2/metrics/{metric_name}/all-tags: get: - description: 'View indexed and ingested tags for a given metric name. - - Results are filtered by the `window[seconds]` parameter, which defaults to - 14400 (4 hours).' + description: |- + View indexed and ingested tags for a given metric name. + Results are filtered by the `window[seconds]` parameter, which defaults to 14400 (4 hours). operationId: ListTagsByMetricName parameters: - - $ref: '#/components/parameters/MetricName' - - description: 'The number of seconds of look back (from now) to query for tag - data. - - Default value is 14400 (4 hours), minimum value is 14400 (4 hours).' - example: 14400 - in: query - name: window[seconds] - required: false - schema: - format: int64 - type: integer - - description: 'Filter results to tags from data points that have the specified - tags. - - For example, `filter[tags]=env:staging,host:123` returns tags only from - data points with both `env:staging` and `host:123`.' - example: env:staging,host:123 - in: query - name: filter[tags] - required: false - schema: - type: string - - description: 'Filter returned tags to those matching a substring. - - For example, `filter[match]=env` returns tags like `env:prod`, `environment:staging`, - etc.' - example: env - in: query - name: filter[match] - required: false - schema: - type: string - - description: 'Whether to include tag values in the response. - - Defaults to true.' - example: true - in: query - name: filter[include_tag_values] - required: false - schema: - type: boolean - - description: 'Whether to allow partial results. - - Defaults to false.' - example: false - in: query - name: filter[allow_partial] - required: false - schema: - type: boolean - - description: Maximum number of results to return. - example: 1000 - in: query - name: page[limit] - required: false - schema: - default: 1000000 - format: int32 - maximum: 1000000 - minimum: 1 - type: integer + - $ref: "#/components/parameters/MetricName" + - description: |- + The number of seconds of look back (from now) to query for tag data. + Default value is 14400 (4 hours), minimum value is 14400 (4 hours). + example: 14400 + in: query + name: window[seconds] + required: false + schema: + format: int64 + type: integer + - description: |- + Filter results to tags from data points that have the specified tags. + For example, `filter[tags]=env:staging,host:123` returns tags only from data points with both `env:staging` and `host:123`. + example: "env:staging,host:123" + in: query + name: filter[tags] + required: false + schema: + type: string + - description: |- + Filter returned tags to those matching a substring. + For example, `filter[match]=env` returns tags like `env:prod`, `environment:staging`, etc. + example: "env" + in: query + name: filter[match] + required: false + schema: + type: string + - description: |- + Whether to include tag values in the response. + Defaults to true. + example: true + in: query + name: filter[include_tag_values] + required: false + schema: + type: boolean + - description: |- + Whether to allow partial results. + Defaults to false. + example: false + in: query + name: filter[allow_partial] + required: false + schema: + type: boolean + - description: Maximum number of results to return. + example: 1000 + in: query + name: page[limit] + required: false + schema: + default: 1000000 + format: int32 + maximum: 1000000 + minimum: 1 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MetricAllTagsResponse' + $ref: "#/components/schemas/MetricAllTagsResponse" description: Success - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too Many Requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - metrics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - metrics_read summary: List tags by metric name tags: - - Metrics - x-permission: + - Metrics + "x-permission": operator: OR permissions: - - metrics_read + - metrics_read /api/v2/metrics/{metric_name}/assets: get: - description: Returns dashboards, monitors, notebooks, and SLOs that a metric - is stored in, if any. Updated every 24 hours. + description: Returns dashboards, monitors, notebooks, and SLOs that a metric is stored in, if any. Updated every 24 hours. operationId: ListMetricAssets parameters: - - $ref: '#/components/parameters/MetricName' + - $ref: "#/components/parameters/MetricName" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MetricAssetsResponse' + $ref: "#/components/schemas/MetricAssetsResponse" description: Success - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too Many Requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Related Assets to a Metric tags: - - Metrics + - Metrics /api/v2/metrics/{metric_name}/estimate: get: - description: Returns the estimated cardinality for a metric with a given tag, - percentile and number of aggregations configuration using Metrics without - Limits™. + description: Returns the estimated cardinality for a metric with a given tag, percentile and number of aggregations configuration using Metrics without Limits™. operationId: EstimateMetricsOutputSeries parameters: - - $ref: '#/components/parameters/MetricName' - - description: Filtered tag keys that the metric is configured to query with. - example: app,host - in: query - name: filter[groups] - required: false - schema: - type: string - - description: The number of hours of look back (from now) to estimate cardinality - with. If unspecified, it defaults to 0 hours. - example: 49 - in: query - name: filter[hours_ago] - required: false - schema: - format: int32 - maximum: 2147483647 - minimum: 49 - type: integer - - description: Deprecated. Number of aggregations has no impact on volume. - example: 1 - in: query - name: filter[num_aggregations] - required: false - schema: - format: int32 - maximum: 9 - type: integer - - description: A boolean, for distribution metrics only, to estimate cardinality - if the metric includes additional percentile aggregators. - example: true - in: query - name: filter[pct] - required: false - schema: - type: boolean - - description: A window, in hours, from the look back to estimate cardinality - with. The minimum and default is 1 hour. - example: 6 - in: query - name: filter[timespan_h] - required: false - schema: - format: int32 - maximum: 2147483647 - type: integer + - $ref: "#/components/parameters/MetricName" + - description: Filtered tag keys that the metric is configured to query with. + example: "app,host" + in: query + name: filter[groups] + required: false + schema: + type: string + - description: The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours. + example: 49 + in: query + name: filter[hours_ago] + required: false + schema: + format: int32 + maximum: 2147483647 + minimum: 49 + type: integer + - description: Deprecated. Number of aggregations has no impact on volume. + example: 1 + in: query + name: filter[num_aggregations] + required: false + schema: + format: int32 + maximum: 9 + type: integer + - description: A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators. + example: true + in: query + name: filter[pct] + required: false + schema: + type: boolean + - description: A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour. + example: 6 + in: query + name: filter[timespan_h] + required: false + schema: + format: int32 + maximum: 2147483647 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MetricEstimateResponse' + $ref: "#/components/schemas/MetricEstimateResponse" description: Success - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too Many Requests summary: Tag Configuration Cardinality Estimator tags: - - Metrics - x-permission: + - Metrics + "x-permission": operator: OPEN permissions: [] /api/v2/metrics/{metric_name}/tag-cardinalities: @@ -92313,292 +88335,278 @@ paths: description: Returns the cardinality details of tags for a specific metric. operationId: GetMetricTagCardinalityDetails parameters: - - $ref: '#/components/parameters/MetricName' + - $ref: "#/components/parameters/MetricName" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MetricTagCardinalitiesResponse' + $ref: "#/components/schemas/MetricTagCardinalitiesResponse" description: Success - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Too Many Requests summary: Get tag key cardinality details tags: - - Metrics - x-permission: + - Metrics + "x-permission": operator: OR permissions: - - metrics_read + - metrics_read /api/v2/metrics/{metric_name}/tags: delete: - description: 'Deletes a metric''s tag configuration. Can only be used with application - - keys from users with the `Manage Tags for Metrics` permission.' + description: |- + Deletes a metric's tag configuration. Can only be used with application + keys from users with the `Manage Tags for Metrics` permission. + Note: This operation is irreversible. operationId: DeleteTagConfiguration parameters: - - $ref: '#/components/parameters/MetricName' + - $ref: "#/components/parameters/MetricName" responses: - '204': + "204": description: No Content - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too Many Requests summary: Delete a tag configuration tags: - - Metrics - x-permission: + - Metrics + "x-permission": operator: OR permissions: - - metric_tags_write + - metric_tags_write get: description: Returns the tag configuration for the given metric name. operationId: ListTagConfigurationByName parameters: - - $ref: '#/components/parameters/MetricName' + - $ref: "#/components/parameters/MetricName" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MetricTagConfigurationResponse' + $ref: "#/components/schemas/MetricTagConfigurationResponse" description: Success - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too Many Requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - metrics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - metrics_read summary: List tag configuration by name tags: - - Metrics - x-permission: + - Metrics + "x-permission": operator: OR permissions: - - metrics_read + - metrics_read patch: - description: 'Update the tag configuration of a metric or percentile aggregations - of a distribution metric or custom aggregations - - of a count, rate, or gauge metric. By setting `exclude_tags_mode` to true - the behavior is changed - - from an allow-list to a deny-list, and tags in the defined list will not be - queryable. - - Can only be used with application keys from users with the `Manage Tags for - Metrics` permission. This endpoint requires - - a tag configuration to be created first.' + description: |- + Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations + of a count, rate, or gauge metric. By setting `exclude_tags_mode` to true the behavior is changed + from an allow-list to a deny-list, and tags in the defined list will not be queryable. + Can only be used with application keys from users with the `Manage Tags for Metrics` permission. This endpoint requires + a tag configuration to be created first. operationId: UpdateTagConfiguration parameters: - - $ref: '#/components/parameters/MetricName' + - $ref: "#/components/parameters/MetricName" requestBody: content: application/json: schema: - $ref: '#/components/schemas/MetricTagConfigurationUpdateRequest' + $ref: "#/components/schemas/MetricTagConfigurationUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MetricTagConfigurationResponse' + $ref: "#/components/schemas/MetricTagConfigurationResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Unprocessable Entity - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too Many Requests summary: Update a tag configuration tags: - - Metrics + - Metrics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - metric_tags_write + - metric_tags_write post: - description: 'Create and define a list of queryable tag keys for an existing - count/gauge/rate/distribution metric. - - Optionally, include percentile aggregations on any distribution metric. By - setting `exclude_tags_mode` - - to true, the behavior is changed from an allow-list to a deny-list, and tags - in the defined list are - - not queryable. Can only be used with application keys of users with the `Manage - Tags for Metrics` - - permission.' + description: |- + Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric. + Optionally, include percentile aggregations on any distribution metric. By setting `exclude_tags_mode` + to true, the behavior is changed from an allow-list to a deny-list, and tags in the defined list are + not queryable. Can only be used with application keys of users with the `Manage Tags for Metrics` + permission. operationId: CreateTagConfiguration parameters: - - $ref: '#/components/parameters/MetricName' + - $ref: "#/components/parameters/MetricName" requestBody: content: application/json: schema: - $ref: '#/components/schemas/MetricTagConfigurationCreateRequest' + $ref: "#/components/schemas/MetricTagConfigurationCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/MetricTagConfigurationResponse' + $ref: "#/components/schemas/MetricTagConfigurationResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Conflict - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too Many Requests summary: Create a tag configuration tags: - - Metrics + - Metrics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - metric_tags_write + - metric_tags_write /api/v2/metrics/{metric_name}/volumes: get: - description: 'View distinct metrics volumes for the given metric name. - + description: |- + View distinct metrics volumes for the given metric name. - Custom metrics generated in-app from other products will return `null` for - ingested volumes.' + Custom metrics generated in-app from other products will return `null` for ingested volumes. operationId: ListVolumesByMetricName parameters: - - $ref: '#/components/parameters/MetricName' + - $ref: "#/components/parameters/MetricName" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MetricVolumesResponse' + $ref: "#/components/schemas/MetricVolumesResponse" description: Success - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too Many Requests summary: List distinct metric volumes by metric name tags: - - Metrics - x-permission: + - Metrics + "x-permission": operator: OPEN permissions: [] /api/v2/monitor/notification_rule: @@ -92606,84 +88614,78 @@ paths: description: Returns a list of all monitor notification rules. operationId: GetMonitorNotificationRules parameters: - - description: The page to start paginating from. If `page` is not specified, - the argument defaults to the first page. - in: query - name: page - required: false - schema: - format: int32 - maximum: 1000000 - minimum: 0 - type: integer - - description: The number of rules to return per page. If `per_page` is not - specified, the argument defaults to 100. - in: query - name: per_page - required: false - schema: - format: int32 - maximum: 1000 - minimum: 1 - type: integer - - description: 'String for sort order, composed of field and sort order separated - by a colon, for example `name:asc`. Supported sort directions: `asc`, `desc`. - Supported fields: `name`, `created_at`.' - in: query - name: sort - required: false - schema: - type: string - - description: 'JSON-encoded filter object. Supported keys: - - * `text`: Free-text query matched against rule name, tags, and recipients. - - * `tags`: Array of strings. Return rules that have any of these tags. - - * `recipients`: Array of strings. Return rules that have any of these recipients.' - example: '{"text":"error","tags":["env:prod","team:my-team"],"recipients":["slack-monitor-app","email@example.com"]}' - in: query - name: filters - required: false - schema: - type: string - - description: 'Comma-separated list of resource paths for related resources - to include in the response. Supported resource - - path is `created_by`.' - in: query - name: include - required: false - schema: - example: created_by - type: string + - description: The page to start paginating from. If `page` is not specified, the argument defaults to the first page. + in: query + name: page + required: false + schema: + format: int32 + maximum: 1000000 + minimum: 0 + type: integer + - description: The number of rules to return per page. If `per_page` is not specified, the argument defaults to 100. + in: query + name: per_page + required: false + schema: + format: int32 + maximum: 1000 + minimum: 1 + type: integer + - description: |- + String for sort order, composed of field and sort order separated by a colon, for example `name:asc`. Supported sort directions: `asc`, `desc`. Supported fields: `name`, `created_at`. + in: query + name: sort + required: false + schema: + type: string + - description: |- + JSON-encoded filter object. Supported keys: + * `text`: Free-text query matched against rule name, tags, and recipients. + * `tags`: Array of strings. Return rules that have any of these tags. + * `recipients`: Array of strings. Return rules that have any of these recipients. + example: '{"text":"error","tags":["env:prod","team:my-team"],"recipients":["slack-monitor-app","email@example.com"]}' + in: query + name: filters + required: false + schema: + type: string + - description: |- + Comma-separated list of resource paths for related resources to include in the response. Supported resource + path is `created_by`. + in: query + name: include + required: false + schema: + example: "created_by" + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MonitorNotificationRuleListResponse' + $ref: "#/components/schemas/MonitorNotificationRuleListResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_read summary: Get all monitor notification rules tags: - - Monitors + - Monitors x-permission: operator: OR permissions: - - monitors_read + - monitors_read post: description: Creates a monitor notification rule. operationId: CreateMonitorNotificationRule @@ -92691,208 +88693,207 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MonitorNotificationRuleCreateRequest' + $ref: "#/components/schemas/MonitorNotificationRuleCreateRequest" description: Request body to create a monitor notification rule. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MonitorNotificationRuleResponse' + $ref: "#/components/schemas/MonitorNotificationRuleResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a monitor notification rule tags: - - Monitors + - Monitors x-permission: operator: OR permissions: - - monitor_config_policy_write + - monitor_config_policy_write /api/v2/monitor/notification_rule/{rule_id}: delete: description: Deletes a monitor notification rule by `rule_id`. operationId: DeleteMonitorNotificationRule parameters: - - description: ID of the monitor notification rule to delete. - in: path - name: rule_id - required: true - schema: - type: string + - description: ID of the monitor notification rule to delete. + in: path + name: rule_id + required: true + schema: + type: string responses: - '204': + "204": description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a monitor notification rule tags: - - Monitors + - Monitors x-permission: operator: OR permissions: - - monitor_config_policy_write + - monitor_config_policy_write get: description: Returns a monitor notification rule by `rule_id`. operationId: GetMonitorNotificationRule parameters: - - description: ID of the monitor notification rule to fetch. - in: path - name: rule_id - required: true - schema: - type: string - - description: 'Comma-separated list of resource paths for related resources - to include in the response. Supported resource - - path is `created_by`.' - in: query - name: include - required: false - schema: - example: created_by - type: string + - description: ID of the monitor notification rule to fetch. + in: path + name: rule_id + required: true + schema: + type: string + - description: |- + Comma-separated list of resource paths for related resources to include in the response. Supported resource + path is `created_by`. + in: query + name: include + required: false + schema: + example: "created_by" + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MonitorNotificationRuleResponse' + $ref: "#/components/schemas/MonitorNotificationRuleResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_read summary: Get a monitor notification rule tags: - - Monitors + - Monitors x-permission: operator: OR permissions: - - monitors_read + - monitors_read patch: description: Updates a monitor notification rule by `rule_id`. operationId: UpdateMonitorNotificationRule parameters: - - description: ID of the monitor notification rule to update. - in: path - name: rule_id - required: true - schema: - type: string + - description: ID of the monitor notification rule to update. + in: path + name: rule_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/MonitorNotificationRuleUpdateRequest' + $ref: "#/components/schemas/MonitorNotificationRuleUpdateRequest" description: Request body to update the monitor notification rule. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MonitorNotificationRuleResponse' + $ref: "#/components/schemas/MonitorNotificationRuleResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a monitor notification rule tags: - - Monitors + - Monitors x-codegen-request-body-name: body x-permission: operator: OR permissions: - - monitor_config_policy_write + - monitor_config_policy_write /api/v2/monitor/policy: get: description: Get all monitor configuration policies. operationId: ListMonitorConfigPolicies responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MonitorConfigPolicyListResponse' + $ref: "#/components/schemas/MonitorConfigPolicyListResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_read summary: Get all monitor configuration policies tags: - - Monitors - x-permission: + - Monitors + "x-permission": operator: OR permissions: - - monitors_read + - monitors_read post: description: Create a monitor configuration policy. operationId: CreateMonitorConfigPolicy @@ -92900,205 +88901,205 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MonitorConfigPolicyCreateRequest' + $ref: "#/components/schemas/MonitorConfigPolicyCreateRequest" description: Create a monitor configuration policy request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MonitorConfigPolicyResponse' + $ref: "#/components/schemas/MonitorConfigPolicyResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a monitor configuration policy tags: - - Monitors + - Monitors x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - monitor_config_policy_write + - monitor_config_policy_write /api/v2/monitor/policy/{policy_id}: delete: description: Delete a monitor configuration policy. operationId: DeleteMonitorConfigPolicy parameters: - - description: ID of the monitor configuration policy. - in: path - name: policy_id - required: true - schema: - example: 00000000-0000-1234-0000-000000000000 - type: string + - description: ID of the monitor configuration policy. + in: path + name: policy_id + required: true + schema: + example: "00000000-0000-1234-0000-000000000000" + type: string responses: - '204': + "204": description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a monitor configuration policy tags: - - Monitors - x-permission: + - Monitors + "x-permission": operator: OR permissions: - - monitor_config_policy_write + - monitor_config_policy_write get: description: Get a monitor configuration policy by `policy_id`. operationId: GetMonitorConfigPolicy parameters: - - description: ID of the monitor configuration policy. - in: path - name: policy_id - required: true - schema: - example: 00000000-0000-1234-0000-000000000000 - type: string + - description: ID of the monitor configuration policy. + in: path + name: policy_id + required: true + schema: + example: "00000000-0000-1234-0000-000000000000" + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MonitorConfigPolicyResponse' + $ref: "#/components/schemas/MonitorConfigPolicyResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_read summary: Get a monitor configuration policy tags: - - Monitors - x-permission: + - Monitors + "x-permission": operator: OR permissions: - - monitors_read + - monitors_read patch: description: Edit a monitor configuration policy. operationId: UpdateMonitorConfigPolicy parameters: - - description: ID of the monitor configuration policy. - in: path - name: policy_id - required: true - schema: - example: 00000000-0000-1234-0000-000000000000 - type: string + - description: ID of the monitor configuration policy. + in: path + name: policy_id + required: true + schema: + example: "00000000-0000-1234-0000-000000000000" + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/MonitorConfigPolicyEditRequest' + $ref: "#/components/schemas/MonitorConfigPolicyEditRequest" description: Description of the update. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MonitorConfigPolicyResponse' + $ref: "#/components/schemas/MonitorConfigPolicyResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Unprocessable Entity - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Edit a monitor configuration policy tags: - - Monitors + - Monitors x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - monitor_config_policy_write + - monitor_config_policy_write /api/v2/monitor/template: get: description: Retrieve all monitor user templates. operationId: ListMonitorUserTemplates responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MonitorUserTemplateListResponse' + $ref: "#/components/schemas/MonitorUserTemplateListResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_read summary: Get all monitor user templates tags: - - Monitors - x-permission: + - Monitors + "x-permission": operator: OR permissions: - - monitors_read - x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).' + - monitors_read + x-unstable: |- + **Note**: This endpoint is in Preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Create a new monitor user template. operationId: CreateMonitorUserTemplate @@ -93106,33 +89107,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MonitorUserTemplateCreateRequest' + $ref: "#/components/schemas/MonitorUserTemplateCreateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MonitorUserTemplateCreateResponse' + $ref: "#/components/schemas/MonitorUserTemplateCreateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a monitor user template tags: - - Monitors - x-permission: + - Monitors + "x-permission": operator: OR permissions: - - monitor_config_policy_write - x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).' + - monitor_config_policy_write + x-unstable: |- + **Note**: This endpoint is in Preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/monitor/template/validate: post: description: Validate the structure and content of a monitor user template. @@ -93141,295 +89142,293 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MonitorUserTemplateCreateRequest' + $ref: "#/components/schemas/MonitorUserTemplateCreateRequest" required: true responses: - '204': + "204": description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Validate a monitor user template tags: - - Monitors - x-permission: + - Monitors + "x-permission": operator: OR permissions: - - monitor_config_policy_write - x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).' + - monitor_config_policy_write + x-unstable: |- + **Note**: This endpoint is in Preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/monitor/template/{template_id}: delete: description: Delete an existing monitor user template by its ID. operationId: DeleteMonitorUserTemplate parameters: - - description: ID of the monitor user template. - in: path - name: template_id - required: true - schema: - type: string + - description: ID of the monitor user template. + in: path + name: template_id + required: true + schema: + type: string responses: - '204': + "204": description: OK - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a monitor user template tags: - - Monitors - x-permission: + - Monitors + "x-permission": operator: OR permissions: - - monitor_config_policy_write - x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).' + - monitor_config_policy_write + x-unstable: |- + **Note**: This endpoint is in Preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/). get: description: Retrieve a monitor user template by its ID. operationId: GetMonitorUserTemplate parameters: - - description: ID of the monitor user template. - in: path - name: template_id - required: true - schema: - example: 00000000-0000-1234-0000-000000000000 - type: string - - description: Whether to include all versions of the template in the response - in the versions field. - example: false - in: query - name: with_all_versions - required: false - schema: - type: boolean + - description: ID of the monitor user template. + in: path + name: template_id + required: true + schema: + example: "00000000-0000-1234-0000-000000000000" + type: string + - description: Whether to include all versions of the template in the response in the versions field. + example: false + in: query + name: with_all_versions + required: false + schema: + type: boolean responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MonitorUserTemplateResponse' + $ref: "#/components/schemas/MonitorUserTemplateResponse" description: OK - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_read summary: Get a monitor user template tags: - - Monitors - x-permission: + - Monitors + "x-permission": operator: OR permissions: - - monitors_read - x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).' + - monitors_read + x-unstable: |- + **Note**: This endpoint is in Preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/). put: description: Creates a new version of an existing monitor user template. operationId: UpdateMonitorUserTemplate parameters: - - description: ID of the monitor user template. - in: path - name: template_id - required: true - schema: - type: string + - description: ID of the monitor user template. + in: path + name: template_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/MonitorUserTemplateUpdateRequest' + $ref: "#/components/schemas/MonitorUserTemplateUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MonitorUserTemplateResponse' + $ref: "#/components/schemas/MonitorUserTemplateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a monitor user template to a new version tags: - - Monitors - x-permission: + - Monitors + "x-permission": operator: OR permissions: - - monitor_config_policy_write - x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).' + - monitor_config_policy_write + x-unstable: |- + **Note**: This endpoint is in Preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/monitor/template/{template_id}/validate: post: - description: Validate the structure and content of an existing monitor user - template being updated to a new version. + description: Validate the structure and content of an existing monitor user template being updated to a new version. operationId: ValidateExistingMonitorUserTemplate parameters: - - description: ID of the monitor user template. - in: path - name: template_id - required: true - schema: - example: 00000000-0000-1234-0000-000000000000 - type: string + - description: ID of the monitor user template. + in: path + name: template_id + required: true + schema: + example: "00000000-0000-1234-0000-000000000000" + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/MonitorUserTemplateUpdateRequest' + $ref: "#/components/schemas/MonitorUserTemplateUpdateRequest" required: true responses: - '204': + "204": description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Validate an existing monitor user template tags: - - Monitors - x-permission: + - Monitors + "x-permission": operator: OR permissions: - - monitor_config_policy_write - x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).' + - monitor_config_policy_write + x-unstable: |- + **Note**: This endpoint is in Preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/monitor/{monitor_id}/downtime_matches: get: description: Get all active downtimes for the specified monitor. operationId: ListMonitorDowntimes parameters: - - description: The id of the monitor. - in: path - name: monitor_id - required: true - schema: - format: int64 - type: integer - - $ref: '#/components/parameters/PageOffset' - - description: Maximum number of downtimes in the response. - example: 100 - in: query - name: page[limit] - required: false - schema: - default: 30 - format: int64 - type: integer + - description: The id of the monitor. + in: path + name: monitor_id + required: true + schema: + format: int64 + type: integer + - $ref: "#/components/parameters/PageOffset" + - description: Maximum number of downtimes in the response. + example: 100 + in: query + name: page[limit] + required: false + schema: + default: 30 + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MonitorDowntimeMatchResponse' + $ref: "#/components/schemas/MonitorDowntimeMatchResponse" description: OK - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Monitor Not Found error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - monitors_downtime + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - monitors_downtime summary: Get active downtimes for a monitor tags: - - Downtimes + - Downtimes x-codegen-request-body-name: body x-pagination: limitParam: page[limit] pageOffsetParam: page[offset] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - monitors_downtime + - monitors_downtime /api/v2/ndm/devices: get: description: Get the list of devices. operationId: ListDevices parameters: - - $ref: '#/components/parameters/NDMPageSize' - - $ref: '#/components/parameters/NDMPageNumber' - - description: The field to sort the devices by. Defaults to `name`. - example: status - in: query - name: sort - required: false - schema: - default: name - type: string - - description: Filter devices by tag. - example: status:ok - in: query - name: filter[tag] - required: false - schema: - type: string + - $ref: "#/components/parameters/NDMPageSize" + - $ref: "#/components/parameters/NDMPageNumber" + - description: The field to sort the devices by. Defaults to `name`. + example: status + in: query + name: sort + required: false + schema: + default: name + type: string + - description: Filter devices by tag. + example: status:ok + in: query + name: filter[tag] + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListDevicesResponse' + $ref: "#/components/schemas/ListDevicesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get the list of devices tags: - - Network Device Monitoring + - Network Device Monitoring x-pagination: limitParam: page[size] pageParam: page[number] @@ -93439,329 +89438,311 @@ paths: description: Get the device details. operationId: GetDevice parameters: - - description: The id of the device to fetch. - example: example:1.2.3.4 - in: path - name: device_id - required: true - schema: - type: string + - description: The id of the device to fetch. + example: example:1.2.3.4 + in: path + name: device_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GetDeviceResponse' + $ref: "#/components/schemas/GetDeviceResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get the device details tags: - - Network Device Monitoring + - Network Device Monitoring /api/v2/ndm/interfaces: get: description: Get the list of interfaces of the device. operationId: GetInterfaces parameters: - - description: The ID of the device to get interfaces from. - example: example:1.2.3.4 - in: query - name: device_id - required: true - schema: - type: string - - description: Whether to get the IP addresses of the interfaces. - example: true - in: query - name: get_ip_addresses - required: false - schema: - type: boolean + - description: The ID of the device to get interfaces from. + example: example:1.2.3.4 + in: query + name: device_id + required: true + schema: + type: string + - description: Whether to get the IP addresses of the interfaces. + example: true + in: query + name: get_ip_addresses + required: false + schema: + type: boolean responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GetInterfacesResponse' + $ref: "#/components/schemas/GetInterfacesResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get the list of interfaces of the device tags: - - Network Device Monitoring + - Network Device Monitoring /api/v2/ndm/tags/devices/{device_id}: get: description: Get the list of tags for a device. operationId: ListDeviceUserTags parameters: - - description: The id of the device to fetch tags for. - example: example:1.2.3.4 - in: path - name: device_id - required: true - schema: - type: string + - description: The id of the device to fetch tags for. + example: example:1.2.3.4 + in: path + name: device_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListTagsResponse' + $ref: "#/components/schemas/ListTagsResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get the list of tags for a device tags: - - Network Device Monitoring + - Network Device Monitoring patch: description: Update the tags for a device. operationId: UpdateDeviceUserTags parameters: - - description: The id of the device to update tags for. - example: example:1.2.3.4 - in: path - name: device_id - required: true - schema: - type: string + - description: The id of the device to update tags for. + example: example:1.2.3.4 + in: path + name: device_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ListTagsResponse' + $ref: "#/components/schemas/ListTagsResponse" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListTagsResponse' + $ref: "#/components/schemas/ListTagsResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update the tags for a device tags: - - Network Device Monitoring + - Network Device Monitoring /api/v2/ndm/tags/interfaces/{interface_id}: get: description: Returns the tags associated with the specified interface. operationId: ListInterfaceUserTags parameters: - - description: The ID of the interface for which to retrieve tags. - example: example:1.2.3.4:1 - in: path - name: interface_id - required: true - schema: - type: string + - description: The ID of the interface for which to retrieve tags. + example: example:1.2.3.4:1 + in: path + name: interface_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListInterfaceTagsResponse' + $ref: "#/components/schemas/ListInterfaceTagsResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List tags for an interface tags: - - Network Device Monitoring + - Network Device Monitoring patch: description: Updates the tags associated with the specified interface. operationId: UpdateInterfaceUserTags parameters: - - description: The ID of the interface for which to update tags. - example: example:1.2.3.4:1 - in: path - name: interface_id - required: true - schema: - type: string + - description: The ID of the interface for which to update tags. + example: example:1.2.3.4:1 + in: path + name: interface_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ListInterfaceTagsResponse' + $ref: "#/components/schemas/ListInterfaceTagsResponse" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListInterfaceTagsResponse' + $ref: "#/components/schemas/ListInterfaceTagsResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update the tags for an interface tags: - - Network Device Monitoring + - Network Device Monitoring /api/v2/network/connections/aggregate: get: description: Get all aggregated connections. operationId: GetAggregatedConnections parameters: - - 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]`. - in: query - name: from - schema: - format: int64 - type: integer - - 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]`. - in: query - name: to - schema: - format: int64 - type: integer - - description: Comma-separated list of fields to group connections by. The maximum - number of group_by(s) is 10. - in: query - name: group_by - schema: - type: string - - description: Comma-separated list of tags to filter connections by. - in: query - name: tags - schema: - type: string - - description: The number of connections to be returned. The maximum value is - 7500. The default is 100. - in: query - name: limit - schema: - default: 100 - format: int32 - maximum: 7500 - minimum: 1 - type: integer + - 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]`. + in: query + name: from + schema: + format: int64 + type: integer + - 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]`. + in: query + name: to + schema: + format: int64 + type: integer + - description: Comma-separated list of fields to group connections by. The maximum number of group_by(s) is 10. + in: query + name: group_by + schema: + type: string + - description: Comma-separated list of tags to filter connections by. + in: query + name: tags + schema: + type: string + - description: The number of connections to be returned. The maximum value is 7500. The default is 100. + in: query + name: limit + schema: + default: 100 + format: int32 + maximum: 7500 + minimum: 1 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SingleAggregatedConnectionResponseArray' + $ref: "#/components/schemas/SingleAggregatedConnectionResponseArray" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all aggregated connections tags: - - Cloud Network Monitoring + - Cloud Network Monitoring /api/v2/network/dns/aggregate: get: description: Get all aggregated DNS traffic. operationId: GetAggregatedDns parameters: - - 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]`. - in: query - name: from - schema: - format: int64 - type: integer - - 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]`. - in: query - name: to - schema: - format: int64 - type: integer - - description: Comma-separated list of fields to group DNS traffic by. The server - side defaults to `network.dns_query` if unspecified. `server_ungrouped` - may be used if groups are not desired. The maximum number of group_by(s) - is 10. - in: query - name: group_by - schema: - type: string - - description: Comma-separated list of tags to filter DNS traffic by. - in: query - name: tags - schema: - type: string - - description: The number of aggregated DNS entries to be returned. The maximum - value is 7500. The default is 100. - in: query - name: limit - schema: - default: 100 - format: int32 - maximum: 7500 - minimum: 1 - type: integer + - 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]`. + in: query + name: from + schema: + format: int64 + type: integer + - 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]`. + in: query + name: to + schema: + format: int64 + type: integer + - description: Comma-separated list of fields to group DNS traffic by. The server side defaults to `network.dns_query` if unspecified. `server_ungrouped` may be used if groups are not desired. The maximum number of group_by(s) is 10. + in: query + name: group_by + schema: + type: string + - description: Comma-separated list of tags to filter DNS traffic by. + in: query + name: tags + schema: + type: string + - description: The number of aggregated DNS entries to be returned. The maximum value is 7500. The default is 100. + in: query + name: limit + schema: + default: 100 + format: int32 + maximum: 7500 + minimum: 1 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SingleAggregatedDnsResponseArray' + $ref: "#/components/schemas/SingleAggregatedDnsResponseArray" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all aggregated DNS traffic tags: - - Cloud Network Monitoring + - Cloud Network Monitoring /api/v2/obs-pipelines/pipelines: get: description: Retrieve a list of pipelines. operationId: ListPipelines parameters: - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListPipelinesResponse' + $ref: "#/components/schemas/ListPipelinesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List pipelines tags: - - Observability Pipelines - x-permission: + - Observability Pipelines + "x-permission": operator: OR permissions: - - observability_pipelines_read + - observability_pipelines_read post: description: Create a new pipeline. operationId: CreatePipeline @@ -93769,1981 +89750,1936 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ObservabilityPipelineSpec' + $ref: "#/components/schemas/ObservabilityPipelineSpec" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/ObservabilityPipeline' + $ref: "#/components/schemas/ObservabilityPipeline" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a new pipeline tags: - - Observability Pipelines - x-permission: + - Observability Pipelines + "x-permission": operator: OR permissions: - - observability_pipelines_deploy + - observability_pipelines_deploy /api/v2/obs-pipelines/pipelines/validate: post: - description: 'Validates a pipeline configuration without creating or updating - any resources. - - Returns a list of validation errors, if any.' + description: |- + Validates a pipeline configuration without creating or updating any resources. + Returns a list of validation errors, if any. operationId: ValidatePipeline requestBody: content: application/json: schema: - $ref: '#/components/schemas/ObservabilityPipelineSpec' + $ref: "#/components/schemas/ObservabilityPipelineSpec" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ValidationResponse' + $ref: "#/components/schemas/ValidationResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Validate an observability pipeline tags: - - Observability Pipelines - x-permission: + - Observability Pipelines + "x-permission": operator: OR permissions: - - observability_pipelines_read + - observability_pipelines_read /api/v2/obs-pipelines/pipelines/{pipeline_id}: delete: description: Delete a pipeline. operationId: DeletePipeline parameters: - - description: The ID of the pipeline to delete. - in: path - name: pipeline_id - required: true - schema: - type: string + - description: The ID of the pipeline to delete. + in: path + name: pipeline_id + required: true + schema: + type: string responses: - '204': + "204": description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Conflict - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a pipeline tags: - - Observability Pipelines - x-permission: + - Observability Pipelines + "x-permission": operator: OR permissions: - - observability_pipelines_delete + - observability_pipelines_delete get: description: Get a specific pipeline by its ID. operationId: GetPipeline parameters: - - description: The ID of the pipeline to retrieve. - in: path - name: pipeline_id - required: true - schema: - type: string + - description: The ID of the pipeline to retrieve. + in: path + name: pipeline_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ObservabilityPipeline' + $ref: "#/components/schemas/ObservabilityPipeline" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a specific pipeline tags: - - Observability Pipelines - x-permission: + - Observability Pipelines + "x-permission": operator: OR permissions: - - observability_pipelines_read + - observability_pipelines_read put: description: Update a pipeline. operationId: UpdatePipeline parameters: - - description: The ID of the pipeline to update. - in: path - name: pipeline_id - required: true - schema: - type: string + - description: The ID of the pipeline to update. + in: path + name: pipeline_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ObservabilityPipeline' + $ref: "#/components/schemas/ObservabilityPipeline" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ObservabilityPipeline' + $ref: "#/components/schemas/ObservabilityPipeline" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a pipeline tags: - - Observability Pipelines - x-permission: + - Observability Pipelines + "x-permission": operator: OR permissions: - - observability_pipelines_deploy + - observability_pipelines_deploy /api/v2/on-call/escalation-policies: post: description: Create a new On-Call escalation policy operationId: CreateOnCallEscalationPolicy parameters: - - description: 'Comma-separated list of included relationships to be returned. - Allowed values: `teams`, `steps`, `steps.targets`.' - in: query - name: include - schema: - type: string + - description: "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`." + in: query + name: include + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/EscalationPolicyCreateRequest' + $ref: "#/components/schemas/EscalationPolicyCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/EscalationPolicy' + $ref: "#/components/schemas/EscalationPolicy" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Create On-Call escalation policy tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_write + - on_call_write /api/v2/on-call/escalation-policies/{policy_id}: delete: description: Delete an On-Call escalation policy operationId: DeleteOnCallEscalationPolicy parameters: - - description: The ID of the escalation policy - in: path - name: policy_id - required: true - schema: - example: a3000000-0000-0000-0000-000000000000 - type: string + - description: The ID of the escalation policy + in: path + name: policy_id + required: true + schema: + example: a3000000-0000-0000-0000-000000000000 + type: string responses: - '204': + "204": description: No Content - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Delete On-Call escalation policy tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_write + - on_call_write get: description: Get an On-Call escalation policy operationId: GetOnCallEscalationPolicy parameters: - - description: The ID of the escalation policy - in: path - name: policy_id - required: true - schema: - example: a3000000-0000-0000-0000-000000000000 - type: string - - description: 'Comma-separated list of included relationships to be returned. - Allowed values: `teams`, `steps`, `steps.targets`.' - in: query - name: include - schema: - type: string + - description: The ID of the escalation policy + in: path + name: policy_id + required: true + schema: + example: a3000000-0000-0000-0000-000000000000 + type: string + - description: "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`." + in: query + name: include + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EscalationPolicy' + $ref: "#/components/schemas/EscalationPolicy" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get On-Call escalation policy tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_read + - on_call_read put: description: Update an On-Call escalation policy operationId: UpdateOnCallEscalationPolicy parameters: - - description: The ID of the escalation policy - in: path - name: policy_id - required: true - schema: - example: a3000000-0000-0000-0000-000000000000 - type: string - - description: 'Comma-separated list of included relationships to be returned. - Allowed values: `teams`, `steps`, `steps.targets`.' - in: query - name: include - schema: - type: string + - description: The ID of the escalation policy + in: path + name: policy_id + required: true + schema: + example: a3000000-0000-0000-0000-000000000000 + type: string + - description: "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `steps`, `steps.targets`." + in: query + name: include + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/EscalationPolicyUpdateRequest' + $ref: "#/components/schemas/EscalationPolicyUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/EscalationPolicy' + $ref: "#/components/schemas/EscalationPolicy" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Update On-Call escalation policy tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_write + - on_call_write /api/v2/on-call/pages: post: - description: Trigger a new On-Call Page. + description: |- + Trigger a new On-Call Page. operationId: CreateOnCallPage requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreatePageRequest' + $ref: "#/components/schemas/CreatePageRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CreatePageResponse' + $ref: "#/components/schemas/CreatePageResponse" description: OK. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] servers: - - url: https://{site} - variables: - site: - default: navy.oncall.datadoghq.com - description: The globally available endpoint for On-Call. - enum: - - lava.oncall.datadoghq.com - - saffron.oncall.datadoghq.com - - navy.oncall.datadoghq.com - - coral.oncall.datadoghq.com - - teal.oncall.datadoghq.com - - beige.oncall.datadoghq.eu - - url: '{protocol}://{name}' - variables: - name: - default: api.datadoghq.com - description: Full site DNS name. - protocol: - default: https - description: The protocol for accessing the API. - - url: https://{subdomain}.{site} - variables: - site: - default: datadoghq.com - description: Any Datadog deployment. - subdomain: - default: api - description: The subdomain where the API is deployed. + - url: https://{site} + variables: + site: + default: navy.oncall.datadoghq.com + description: The globally available endpoint for On-Call. + enum: + - lava.oncall.datadoghq.com + - saffron.oncall.datadoghq.com + - navy.oncall.datadoghq.com + - coral.oncall.datadoghq.com + - teal.oncall.datadoghq.com + - beige.oncall.datadoghq.eu + - url: "{protocol}://{name}" + variables: + name: + default: api.datadoghq.com + description: Full site DNS name. + protocol: + default: https + description: The protocol for accessing the API. + - url: https://{subdomain}.{site} + variables: + site: + default: datadoghq.com + description: Any Datadog deployment. + subdomain: + default: api + description: The subdomain where the API is deployed. summary: Create On-Call Page tags: - - On-Call Paging + - On-Call Paging /api/v2/on-call/pages/{page_id}/acknowledge: post: - description: Acknowledges an On-Call Page. + description: |- + Acknowledges an On-Call Page. operationId: AcknowledgeOnCallPage parameters: - - description: The page ID. - in: path - name: page_id - required: true - schema: - example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f - format: uuid - type: string + - description: The page ID. + in: path + name: page_id + required: true + schema: + example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f + format: uuid + type: string responses: - '202': + "202": description: Accepted. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] servers: - - url: https://{site} - variables: - site: - default: navy.oncall.datadoghq.com - description: The globally available endpoint for On-Call. - enum: - - lava.oncall.datadoghq.com - - saffron.oncall.datadoghq.com - - navy.oncall.datadoghq.com - - coral.oncall.datadoghq.com - - teal.oncall.datadoghq.com - - beige.oncall.datadoghq.eu - - url: '{protocol}://{name}' - variables: - name: - default: api.datadoghq.com - description: Full site DNS name. - protocol: - default: https - description: The protocol for accessing the API. - - url: https://{subdomain}.{site} - variables: - site: - default: datadoghq.com - description: Any Datadog deployment. - subdomain: - default: api - description: The subdomain where the API is deployed. + - url: https://{site} + variables: + site: + default: navy.oncall.datadoghq.com + description: The globally available endpoint for On-Call. + enum: + - lava.oncall.datadoghq.com + - saffron.oncall.datadoghq.com + - navy.oncall.datadoghq.com + - coral.oncall.datadoghq.com + - teal.oncall.datadoghq.com + - beige.oncall.datadoghq.eu + - url: "{protocol}://{name}" + variables: + name: + default: api.datadoghq.com + description: Full site DNS name. + protocol: + default: https + description: The protocol for accessing the API. + - url: https://{subdomain}.{site} + variables: + site: + default: datadoghq.com + description: Any Datadog deployment. + subdomain: + default: api + description: The subdomain where the API is deployed. summary: Acknowledge On-Call Page tags: - - On-Call Paging + - On-Call Paging /api/v2/on-call/pages/{page_id}/escalate: post: - description: Escalates an On-Call Page. + description: |- + Escalates an On-Call Page. operationId: EscalateOnCallPage parameters: - - description: The page ID. - in: path - name: page_id - required: true - schema: - example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f - format: uuid - type: string + - description: The page ID. + in: path + name: page_id + required: true + schema: + example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f + format: uuid + type: string responses: - '202': + "202": description: Accepted. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] servers: - - url: https://{site} - variables: - site: - default: navy.oncall.datadoghq.com - description: The globally available endpoint for On-Call. - enum: - - lava.oncall.datadoghq.com - - saffron.oncall.datadoghq.com - - navy.oncall.datadoghq.com - - coral.oncall.datadoghq.com - - teal.oncall.datadoghq.com - - beige.oncall.datadoghq.eu - - url: '{protocol}://{name}' - variables: - name: - default: api.datadoghq.com - description: Full site DNS name. - protocol: - default: https - description: The protocol for accessing the API. - - url: https://{subdomain}.{site} - variables: - site: - default: datadoghq.com - description: Any Datadog deployment. - subdomain: - default: api - description: The subdomain where the API is deployed. + - url: https://{site} + variables: + site: + default: navy.oncall.datadoghq.com + description: The globally available endpoint for On-Call. + enum: + - lava.oncall.datadoghq.com + - saffron.oncall.datadoghq.com + - navy.oncall.datadoghq.com + - coral.oncall.datadoghq.com + - teal.oncall.datadoghq.com + - beige.oncall.datadoghq.eu + - url: "{protocol}://{name}" + variables: + name: + default: api.datadoghq.com + description: Full site DNS name. + protocol: + default: https + description: The protocol for accessing the API. + - url: https://{subdomain}.{site} + variables: + site: + default: datadoghq.com + description: Any Datadog deployment. + subdomain: + default: api + description: The subdomain where the API is deployed. summary: Escalate On-Call Page tags: - - On-Call Paging + - On-Call Paging /api/v2/on-call/pages/{page_id}/resolve: post: - description: Resolves an On-Call Page. + description: |- + Resolves an On-Call Page. operationId: ResolveOnCallPage parameters: - - description: The page ID. - in: path - name: page_id - required: true - schema: - example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f - format: uuid - type: string + - description: The page ID. + in: path + name: page_id + required: true + schema: + example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f + format: uuid + type: string responses: - '202': + "202": description: Accepted. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] servers: - - url: https://{site} - variables: - site: - default: navy.oncall.datadoghq.com - description: The globally available endpoint for On-Call. - enum: - - lava.oncall.datadoghq.com - - saffron.oncall.datadoghq.com - - navy.oncall.datadoghq.com - - coral.oncall.datadoghq.com - - teal.oncall.datadoghq.com - - beige.oncall.datadoghq.eu - - url: '{protocol}://{name}' - variables: - name: - default: api.datadoghq.com - description: Full site DNS name. - protocol: - default: https - description: The protocol for accessing the API. - - url: https://{subdomain}.{site} - variables: - site: - default: datadoghq.com - description: Any Datadog deployment. - subdomain: - default: api - description: The subdomain where the API is deployed. + - url: https://{site} + variables: + site: + default: navy.oncall.datadoghq.com + description: The globally available endpoint for On-Call. + enum: + - lava.oncall.datadoghq.com + - saffron.oncall.datadoghq.com + - navy.oncall.datadoghq.com + - coral.oncall.datadoghq.com + - teal.oncall.datadoghq.com + - beige.oncall.datadoghq.eu + - url: "{protocol}://{name}" + variables: + name: + default: api.datadoghq.com + description: Full site DNS name. + protocol: + default: https + description: The protocol for accessing the API. + - url: https://{subdomain}.{site} + variables: + site: + default: datadoghq.com + description: Any Datadog deployment. + subdomain: + default: api + description: The subdomain where the API is deployed. summary: Resolve On-Call Page tags: - - On-Call Paging + - On-Call Paging /api/v2/on-call/schedules: post: description: Create a new On-Call schedule operationId: CreateOnCallSchedule parameters: - - description: 'Comma-separated list of included relationships to be returned. - Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`.' - in: query - name: include - schema: - type: string + - description: "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`." + in: query + name: include + schema: + type: string requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/ScheduleCreateRequest' + $ref: "#/components/schemas/ScheduleCreateRequest" required: true responses: - '201': + "201": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/Schedule' + $ref: "#/components/schemas/Schedule" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Create On-Call schedule tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_write + - on_call_write /api/v2/on-call/schedules/{schedule_id}: delete: description: Delete an On-Call schedule operationId: DeleteOnCallSchedule parameters: - - description: The ID of the schedule - in: path - name: schedule_id - required: true - schema: - example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d - type: string + - description: The ID of the schedule + in: path + name: schedule_id + required: true + schema: + example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + type: string responses: - '204': + "204": description: No Content - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Delete On-Call schedule tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_write + - on_call_write get: description: Get an On-Call schedule operationId: GetOnCallSchedule parameters: - - description: 'Comma-separated list of included relationships to be returned. - Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`.' - in: query - name: include - schema: - type: string - - description: The ID of the schedule - in: path - name: schedule_id - required: true - schema: - example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d - type: string + - description: "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`." + in: query + name: include + schema: + type: string + - description: The ID of the schedule + in: path + name: schedule_id + required: true + schema: + example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + type: string responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/Schedule' + $ref: "#/components/schemas/Schedule" description: OK - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get On-Call schedule tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_read + - on_call_read put: description: Update a new On-Call schedule operationId: UpdateOnCallSchedule parameters: - - description: 'Comma-separated list of included relationships to be returned. - Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`.' - in: query - name: include - schema: - type: string - - description: The ID of the schedule - in: path - name: schedule_id - required: true - schema: - example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d - type: string + - description: "Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`." + in: query + name: include + schema: + type: string + - description: The ID of the schedule + in: path + name: schedule_id + required: true + schema: + example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + type: string requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/ScheduleUpdateRequest' + $ref: "#/components/schemas/ScheduleUpdateRequest" required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/Schedule' + $ref: "#/components/schemas/Schedule" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Update On-Call schedule tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_write + - on_call_write /api/v2/on-call/schedules/{schedule_id}/on-call: get: - description: Retrieves the user who is on-call for the specified schedule at - a given time. + description: "Retrieves the user who is on-call for the specified schedule at a given time." operationId: GetScheduleOnCallUser parameters: - - description: 'Specifies related resources to include in the response as a - comma-separated list. Allowed value: `user`.' - in: query - name: include - schema: - type: string - - description: The ID of the schedule. - in: path - name: schedule_id - required: true - schema: - example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d - type: string - - description: Retrieves the on-call user at the given timestamp in RFC3339 - format (for example, `2025-05-07T02:53:01Z` or `2025-05-07T02:53:01+00:00`). - When using timezone offsets with `+` or `-`, ensure proper URL encoding - (`+` should be encoded as `%2B`). Defaults to the current time if omitted. - in: query - name: filter[at_ts] - schema: - example: '2025-05-07T02:53:01Z' - type: string + - description: "Specifies related resources to include in the response as a comma-separated list. Allowed value: `user`." + in: query + name: include + schema: + type: string + - description: The ID of the schedule. + in: path + name: schedule_id + required: true + schema: + example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d + type: string + - description: Retrieves the on-call user at the given timestamp in RFC3339 format (for example, `2025-05-07T02:53:01Z` or `2025-05-07T02:53:01+00:00`). When using timezone offsets with `+` or `-`, ensure proper URL encoding (`+` should be encoded as `%2B`). Defaults to the current time if omitted. + in: query + name: filter[at_ts] + schema: + example: "2025-05-07T02:53:01Z" + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Shift' + $ref: "#/components/schemas/Shift" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get scheduled on-call user tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_read + - on_call_read /api/v2/on-call/teams/{team_id}/on-call: get: description: Get a team's on-call users at a given time operationId: GetTeamOnCallUsers parameters: - - description: 'Comma-separated list of included relationships to be returned. - Allowed values: `responders`, `escalations`, `escalations.responders`.' - in: query - name: include - schema: - type: string - - description: The team ID - in: path - name: team_id - required: true - schema: - example: 27590dae-47be-4a7d-9abf-8f4e45124020 - type: string + - description: "Comma-separated list of included relationships to be returned. Allowed values: `responders`, `escalations`, `escalations.responders`." + in: query + name: include + schema: + type: string + - description: The team ID + in: path + name: team_id + required: true + schema: + example: 27590dae-47be-4a7d-9abf-8f4e45124020 + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamOnCallResponders' + $ref: "#/components/schemas/TeamOnCallResponders" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get team on-call users tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_read + - on_call_read /api/v2/on-call/teams/{team_id}/routing-rules: get: description: Get a team's On-Call routing rules operationId: GetOnCallTeamRoutingRules parameters: - - description: The team ID - in: path - name: team_id - required: true - schema: - example: 27590dae-47be-4a7d-9abf-8f4e45124020 - type: string - - description: 'Comma-separated list of included relationships to be returned. - Allowed values: `rules`, `rules.policy`.' - in: query - name: include - schema: - type: string + - description: The team ID + in: path + name: team_id + required: true + schema: + example: 27590dae-47be-4a7d-9abf-8f4e45124020 + type: string + - description: "Comma-separated list of included relationships to be returned. Allowed values: `rules`, `rules.policy`." + in: query + name: include + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamRoutingRules' + $ref: "#/components/schemas/TeamRoutingRules" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get On-Call team routing rules tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_read + - on_call_read put: description: Set a team's On-Call routing rules operationId: SetOnCallTeamRoutingRules parameters: - - description: The team ID - in: path - name: team_id - required: true - schema: - example: 27590dae-47be-4a7d-9abf-8f4e45124020 - type: string - - description: 'Comma-separated list of included relationships to be returned. - Allowed values: `rules`, `rules.policy`.' - in: query - name: include - schema: - type: string - requestBody: + - description: The team ID + in: path + name: team_id + required: true + schema: + example: 27590dae-47be-4a7d-9abf-8f4e45124020 + type: string + - description: "Comma-separated list of included relationships to be returned. Allowed values: `rules`, `rules.policy`." + in: query + name: include + schema: + type: string + requestBody: content: application/json: schema: - $ref: '#/components/schemas/TeamRoutingRulesRequest' + $ref: "#/components/schemas/TeamRoutingRulesRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamRoutingRules' + $ref: "#/components/schemas/TeamRoutingRules" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Set On-Call team routing rules tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_write + - on_call_write /api/v2/on-call/users/{user_id}/notification-channels: get: - description: List the notification channels for a user. The authenticated user - must be the target user or have the `on_call_admin` permission + description: List the notification channels for a user. The authenticated user must be the target user or have the `on_call_admin` permission operationId: ListUserNotificationChannels parameters: - - description: The user ID - in: path - name: user_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000000 - type: string + - description: The user ID + in: path + name: user_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/ListNotificationChannelsResponse' + $ref: "#/components/schemas/ListNotificationChannelsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: List On-Call notification channels for a user tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_read + - on_call_read post: - description: Create a new notification channel for a user. The authenticated - user must be the target user or have the `on_call_admin` permission + description: Create a new notification channel for a user. The authenticated user must be the target user or have the `on_call_admin` permission operationId: CreateUserNotificationChannel parameters: - - description: The user ID - in: path - name: user_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000000 - type: string + - description: The user ID + in: path + name: user_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CreateUserNotificationChannelRequest' + $ref: "#/components/schemas/CreateUserNotificationChannelRequest" required: true responses: - '201': + "201": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/NotificationChannel' + $ref: "#/components/schemas/NotificationChannel" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Create an On-Call notification channel for a user tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_respond + - on_call_respond /api/v2/on-call/users/{user_id}/notification-channels/{channel_id}: delete: - description: Delete a notification channel for a user. The authenticated user - must be the target user or have the `on_call_admin` permission + description: Delete a notification channel for a user. The authenticated user must be the target user or have the `on_call_admin` permission operationId: DeleteUserNotificationChannel parameters: - - description: The user ID - in: path - name: user_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000000 - type: string - - description: The channel ID - in: path - name: channel_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000000 - type: string + - description: The user ID + in: path + name: user_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string + - description: The channel ID + in: path + name: channel_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Delete an On-Call notification channel for a user tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_respond + - on_call_respond get: - description: Get a notification channel for a user. The authenticated user must - be the target user or have the `on_call_admin` permission + description: Get a notification channel for a user. The authenticated user must be the target user or have the `on_call_admin` permission operationId: GetUserNotificationChannel parameters: - - description: The user ID - in: path - name: user_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000000 - type: string - - description: The channel ID - in: path - name: channel_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000000 - type: string + - description: The user ID + in: path + name: user_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string + - description: The channel ID + in: path + name: channel_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/NotificationChannel' + $ref: "#/components/schemas/NotificationChannel" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get an On-Call notification channel for a user tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_read + - on_call_read /api/v2/on-call/users/{user_id}/notification-rules: get: - description: List the notification rules for a user. The authenticated user - must be the target user or have the `on_call_admin` permission + description: List the notification rules for a user. The authenticated user must be the target user or have the `on_call_admin` permission operationId: ListUserNotificationRules parameters: - - description: 'Comma-separated list of included relationships to be returned. - Allowed values: `channel`.' - in: query - name: include - schema: - type: string - - description: The user ID - in: path - name: user_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000000 - type: string + - description: "Comma-separated list of included relationships to be returned. Allowed values: `channel`." + in: query + name: include + schema: + type: string + - description: The user ID + in: path + name: user_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/ListOnCallNotificationRulesResponse' + $ref: "#/components/schemas/ListOnCallNotificationRulesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: List On-Call notification rules for a user tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_read + - on_call_read post: - description: Create a new notification rule for a user. The authenticated user - must be the target user or have the `on_call_admin` permission + description: Create a new notification rule for a user. The authenticated user must be the target user or have the `on_call_admin` permission operationId: CreateUserNotificationRule parameters: - - description: The user ID - in: path - name: user_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000000 - type: string + - description: The user ID + in: path + name: user_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CreateOnCallNotificationRuleRequest' + $ref: "#/components/schemas/CreateOnCallNotificationRuleRequest" required: true responses: - '201': + "201": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/OnCallNotificationRule' + $ref: "#/components/schemas/OnCallNotificationRule" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Create an On-Call notification rule for a user tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: AND permissions: - - on_call_respond + - on_call_respond /api/v2/on-call/users/{user_id}/notification-rules/{rule_id}: delete: - description: Delete a notification rule for a user. The authenticated user must - be the target user or have the `on_call_admin` permission + description: Delete a notification rule for a user. The authenticated user must be the target user or have the `on_call_admin` permission operationId: DeleteUserNotificationRule parameters: - - description: The user ID - in: path - name: user_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000000 - type: string - - description: The rule ID - in: path - name: rule_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000000 - type: string + - description: The user ID + in: path + name: user_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string + - description: The rule ID + in: path + name: rule_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Delete an On-Call notification rule for a user tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: OR permissions: - - on_call_respond + - on_call_respond get: - description: Get a notification rule for a user. The authenticated user must - be the target user or have the `on_call_admin` permission + description: Get a notification rule for a user. The authenticated user must be the target user or have the `on_call_admin` permission operationId: GetUserNotificationRule parameters: - - description: The user ID - in: path - name: user_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000000 - type: string - - description: The rule ID - in: path - name: rule_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000000 - type: string - - description: 'Comma-separated list of included relationships to be returned. - Allowed values: `channel`.' - in: query - name: include - schema: - type: string + - description: The user ID + in: path + name: user_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string + - description: The rule ID + in: path + name: rule_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string + - description: "Comma-separated list of included relationships to be returned. Allowed values: `channel`." + in: query + name: include + schema: + type: string responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/OnCallNotificationRule' + $ref: "#/components/schemas/OnCallNotificationRule" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get an On-Call notification rule for a user tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: OR permissions: - - on_call_read + - on_call_read put: - description: Update a notification rule for a user. The authenticated user must - be the target user or have the `on_call_admin` permission + description: Update a notification rule for a user. The authenticated user must be the target user or have the `on_call_admin` permission operationId: UpdateUserNotificationRule parameters: - - description: The user ID - in: path - name: user_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000000 - type: string - - description: The rule ID - in: path - name: rule_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000000 - type: string - - description: 'Comma-separated list of included relationships to be returned. - Allowed values: `channel`.' - in: query - name: include - schema: - type: string + - description: The user ID + in: path + name: user_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string + - description: The rule ID + in: path + name: rule_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000000 + type: string + - description: "Comma-separated list of included relationships to be returned. Allowed values: `channel`." + in: query + name: include + schema: + type: string requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/UpdateOnCallNotificationRuleRequest' + $ref: "#/components/schemas/UpdateOnCallNotificationRuleRequest" required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/OnCallNotificationRule' + $ref: "#/components/schemas/OnCallNotificationRule" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Update an On-Call notification rule for a user tags: - - On-Call - x-permission: + - On-Call + "x-permission": operator: OR permissions: - - on_call_read + - on_call_read /api/v2/org_configs: get: description: Returns all Org Configs (name, description, and value). operationId: ListOrgConfigs responses: - '200': + "200": content: application/json: - schema: - $ref: '#/components/schemas/OrgConfigListResponse' + schema: {$ref: "#/components/schemas/OrgConfigListResponse"} description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": {$ref: "#/components/responses/BadRequestResponse"} + "401": {$ref: "#/components/responses/UnauthorizedResponse"} + "403": {$ref: "#/components/responses/ForbiddenResponse"} + "429": {$ref: "#/components/responses/TooManyRequestsResponse"} summary: List Org Configs - tags: - - Organizations - x-permission: + tags: [Organizations] + "x-permission": operator: OPEN permissions: [] /api/v2/org_configs/{org_config_name}: get: description: Return the name, description, and value of a specific Org Config. operationId: GetOrgConfig - parameters: - - $ref: '#/components/parameters/OrgConfigName' + parameters: [$ref: "#/components/parameters/OrgConfigName"] responses: - '200': + "200": content: application/json: - schema: - $ref: '#/components/schemas/OrgConfigGetResponse' + schema: {$ref: "#/components/schemas/OrgConfigGetResponse"} description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": {$ref: "#/components/responses/BadRequestResponse"} + "401": {$ref: "#/components/responses/UnauthorizedResponse"} + "403": {$ref: "#/components/responses/ForbiddenResponse"} + "404": {$ref: "#/components/responses/NotFoundResponse"} + "429": {$ref: "#/components/responses/TooManyRequestsResponse"} summary: Get a specific Org Config value - tags: - - Organizations - x-permission: + tags: [Organizations] + "x-permission": operator: OPEN permissions: [] patch: description: Update the value of a specific Org Config. operationId: UpdateOrgConfig - parameters: - - $ref: '#/components/parameters/OrgConfigName' + parameters: [$ref: "#/components/parameters/OrgConfigName"] requestBody: content: application/json: - schema: - $ref: '#/components/schemas/OrgConfigWriteRequest' + schema: {$ref: "#/components/schemas/OrgConfigWriteRequest"} required: true responses: - '200': + "200": content: application/json: - schema: - $ref: '#/components/schemas/OrgConfigGetResponse' + schema: {$ref: "#/components/schemas/OrgConfigGetResponse"} description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": {$ref: "#/components/responses/BadRequestResponse"} + "401": {$ref: "#/components/responses/UnauthorizedResponse"} + "403": {$ref: "#/components/responses/ForbiddenResponse"} + "404": {$ref: "#/components/responses/NotFoundResponse"} + "429": {$ref: "#/components/responses/TooManyRequestsResponse"} summary: Update a specific Org Config - tags: - - Organizations - x-permission: + tags: [Organizations] + "x-permission": operator: OR permissions: - - org_management + - org_management /api/v2/org_connections: get: description: Returns a list of org connections. operationId: ListOrgConnections parameters: - - description: The Org ID of the sink org. - example: 0879ce27-29a1-481f-a12e-bc2a48ec9ae1 - in: query - name: sink_org_id - required: false - schema: - type: string - - description: The Org ID of the source org. - example: 0879ce27-29a1-481f-a12e-bc2a48ec9ae1 - in: query - name: source_org_id - required: false - schema: - type: string - - description: The limit of number of entries you want to return. Default is - 1000. - example: 1000 - in: query - name: limit - required: false - schema: - format: int64 - type: integer - - description: The pagination offset which you want to query from. Default is - 0. - example: 0 - in: query - name: offset - required: false - schema: - format: int64 - type: integer + - description: The Org ID of the sink org. + example: "0879ce27-29a1-481f-a12e-bc2a48ec9ae1" + in: query + name: sink_org_id + required: false + schema: + type: string + - description: The Org ID of the source org. + example: "0879ce27-29a1-481f-a12e-bc2a48ec9ae1" + in: query + name: source_org_id + required: false + schema: + type: string + - description: The limit of number of entries you want to return. Default is 1000. + example: 1000 + in: query + name: limit + required: false + schema: + format: int64 + type: integer + - description: The pagination offset which you want to query from. Default is 0. + example: 0 + in: query + name: offset + required: false + schema: + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OrgConnectionListResponse' + $ref: "#/components/schemas/OrgConnectionListResponse" description: OK - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_connections_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_connections_read summary: List Org Connections - tags: - - Org Connections - x-permission: + tags: ["Org Connections"] + "x-permission": operator: OR permissions: - - org_connections_read + - org_connections_read post: - description: Create a new org connection between the current org and a target - org. + description: Create a new org connection between the current org and a target org. operationId: CreateOrgConnections requestBody: content: application/json: schema: - $ref: '#/components/schemas/OrgConnectionCreateRequest' + $ref: "#/components/schemas/OrgConnectionCreateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OrgConnectionResponse' + $ref: "#/components/schemas/OrgConnectionResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_connections_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_connections_write summary: Create Org Connection - tags: - - Org Connections + tags: ["Org Connections"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - org_connections_write + - org_connections_write /api/v2/org_connections/{connection_id}: delete: description: Delete an existing org connection. operationId: DeleteOrgConnections parameters: - - $ref: '#/components/parameters/OrgConnectionId' - responses: - '200': - description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_connections_write + - $ref: "#/components/parameters/OrgConnectionId" + responses: + "200": + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_connections_write summary: Delete Org Connection - tags: - - Org Connections - x-permission: + tags: ["Org Connections"] + "x-permission": operator: OR permissions: - - org_connections_write + - org_connections_write patch: description: Update an existing org connection. operationId: UpdateOrgConnections parameters: - - $ref: '#/components/parameters/OrgConnectionId' + - $ref: "#/components/parameters/OrgConnectionId" requestBody: content: application/json: schema: - $ref: '#/components/schemas/OrgConnectionUpdateRequest' + $ref: "#/components/schemas/OrgConnectionUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OrgConnectionResponse' + $ref: "#/components/schemas/OrgConnectionResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_connections_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_connections_write summary: Update Org Connection - tags: - - Org Connections - x-permission: + tags: ["Org Connections"] + "x-permission": operator: OR permissions: - - org_connections_write + - org_connections_write /api/v2/permissions: get: - description: Returns a list of all permissions, including name, description, - and ID. + description: |- + Returns a list of all permissions, including name, description, and ID. operationId: ListPermissions responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PermissionsResponse' + $ref: "#/components/schemas/PermissionsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_read summary: List permissions tags: - - Roles - x-permission: + - Roles + "x-permission": operator: OR permissions: - - user_access_read + - user_access_read /api/v2/posture_management/findings: get: - description: "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_key:tag_value&filter[tags]=tag_key_2:tag_value_2`\n\nHere, - `attribute_key` can be any of the filter keys described further below.\n\nQuery - parameters of type `integer` support comparison operators (`>`, `>=`, `<`, - `<=`). This is particularly useful when filtering by `evaluation_changed_at` - or `resource_discovery_timestamp`. For example: `?filter[evaluation_changed_at]=>20123123121`.\n\nYou - can also use the negation operator on strings. For example, use `filter[resource_type]=-aws*` - to filter for any non-AWS resources.\n\nThe operator must come after the equal - sign. For example, to filter with the `>=` operator, add the operator after - the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.\n\nQuery - parameters must be only among the documented ones and with values of correct - types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`) - are not allowed.\n\n### Additional extension fields\n\nAdditional extension - fields are available for some findings.\n\nThe data is available when you - include the query parameter `?detailed_findings=true` in the request.\n\nThe - following fields are available for findings:\n- `external_id`: The resource - external ID related to the finding.\n- `description`: The description and - remediation steps for the finding.\n- `datadog_link`: The Datadog relative - link for the finding.\n- `ip_addresses`: The list of private IP addresses - for the resource related to the finding.\n\n### Response\n\nThe response includes - an array of finding objects, pagination metadata, and a count of items that - match the query.\n\nEach finding object contains the following:\n\n- The finding - ID that can be used in a `GetFinding` request to retrieve the full finding - details.\n- Core attributes, including status, evaluation, high-level resource - details, muted state, and rule details.\n- `evaluation_changed_at` and `resource_discovery_date` - time stamps.\n- An array of associated tags." + description: |- + Get a list of findings. These include both misconfigurations and identity risks. + + **Note**: To filter and return only identity risks, add the following query parameter: `?filter[tags]=dd_rule_type:ciem` + + ### Filtering + + Filters can be applied by appending query parameters to the URL. + + - Using a single filter: `?filter[attribute_key]=attribute_value` + - Chaining filters: `?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...` + - Filtering on tags: `?filter[tags]=tag_key:tag_value&filter[tags]=tag_key_2:tag_value_2` + + Here, `attribute_key` can be any of the filter keys described further below. + + Query parameters of type `integer` support comparison operators (`>`, `>=`, `<`, `<=`). This is particularly useful when filtering by `evaluation_changed_at` or `resource_discovery_timestamp`. For example: `?filter[evaluation_changed_at]=>20123123121`. + + You can also use the negation operator on strings. For example, use `filter[resource_type]=-aws*` to filter for any non-AWS resources. + + The operator must come after the equal sign. For example, to filter with the `>=` operator, add the operator after the equal sign: `filter[evaluation_changed_at]=>=1678809373257`. + + Query parameters must be only among the documented ones and with values of correct types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`) are not allowed. + + ### Additional extension fields + + Additional extension fields are available for some findings. + + The data is available when you include the query parameter `?detailed_findings=true` in the request. + + The following fields are available for findings: + - `external_id`: The resource external ID related to the finding. + - `description`: The description and remediation steps for the finding. + - `datadog_link`: The Datadog relative link for the finding. + - `ip_addresses`: The list of private IP addresses for the resource related to the finding. + + ### Response + + The response includes an array of finding objects, pagination metadata, and a count of items that match the query. + + Each finding object contains the following: + + - The finding ID that can be used in a `GetFinding` request to retrieve the full finding details. + - Core attributes, including status, evaluation, high-level resource details, muted state, and rule details. + - `evaluation_changed_at` and `resource_discovery_date` time stamps. + - An array of associated tags. operationId: ListFindings parameters: - - description: Limit the number of findings returned. Must be <= 1000. - example: 50 - in: query - name: page[limit] - required: false - schema: - default: 100 - format: int64 - maximum: 1000 - minimum: 1 - type: integer - - description: Return findings for a given snapshot of time (Unix ms). - example: 1678721573794 - in: query - name: snapshot_timestamp - required: false - schema: - format: int64 - minimum: 1 - type: integer - - description: Return the next page of findings pointed to by the cursor. - example: eyJhZnRlciI6IkFRQUFBWWJiaEJXQS1OY1dqUUFBQUFCQldXSmlhRUpYUVVGQlJFSktkbTlDTUdaWFRVbDNRVUUiLCJ2YWx1ZXMiOlsiY3JpdGljYWwiXX0= - in: query - name: page[cursor] - required: false - schema: - type: string - - description: Return findings that have these associated tags (repeatable). - example: filter[tags]=cloud_provider:aws&filter[tags]=aws_account:999999999999 - in: query - name: filter[tags] - required: false - schema: - type: string - - 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). - example: '>=1678721573794' - in: query - name: filter[evaluation_changed_at] - required: false - schema: - type: string - - description: Set to `true` to return findings that are muted. Set to `false` - to return unmuted findings. - in: query - name: filter[muted] - required: false - schema: - type: boolean - - description: Return findings for the specified rule ID. - in: query - name: filter[rule_id] - required: false - schema: - type: string - - description: Return findings for the specified rule. - in: query - name: filter[rule_name] - required: false - schema: - type: string - - description: Return only findings for the specified resource type. - in: query - name: filter[resource_type] - required: false - schema: - type: string - - description: Return only findings for the specified resource id. - in: query - name: filter[@resource_id] - required: false - schema: - type: string - - description: Return findings that were found on a specified date (Unix ms) - or date range (using comparison operators). - example: '>=1678721573794' - in: query - name: filter[discovery_timestamp] - required: false - schema: - type: string - - description: Return only `pass` or `fail` findings. - example: pass - in: query - name: filter[evaluation] - required: false - schema: - $ref: '#/components/schemas/FindingEvaluation' - - description: Return only findings with the specified status. - example: critical - in: query - name: filter[status] - required: false - schema: - $ref: '#/components/schemas/FindingStatus' - - description: Return findings that match the selected vulnerability types (repeatable). - example: - - misconfiguration - explode: true - in: query - name: filter[vulnerability_type] - required: false - schema: - items: - $ref: '#/components/schemas/FindingVulnerabilityType' - type: array - - description: Return additional fields for some findings. - example: - - true - in: query - name: detailed_findings - required: false - schema: - type: boolean + - description: Limit the number of findings returned. Must be <= 1000. + example: 50 + in: query + name: page[limit] + required: false + schema: + default: 100 + format: int64 + maximum: 1000 + minimum: 1 + type: integer + - description: Return findings for a given snapshot of time (Unix ms). + example: 1678721573794 + in: query + name: snapshot_timestamp + required: false + schema: + format: int64 + minimum: 1 + type: integer + - description: Return the next page of findings pointed to by the cursor. + example: "eyJhZnRlciI6IkFRQUFBWWJiaEJXQS1OY1dqUUFBQUFCQldXSmlhRUpYUVVGQlJFSktkbTlDTUdaWFRVbDNRVUUiLCJ2YWx1ZXMiOlsiY3JpdGljYWwiXX0=" + in: query + name: page[cursor] + required: false + schema: + type: string + - description: Return findings that have these associated tags (repeatable). + example: filter[tags]=cloud_provider:aws&filter[tags]=aws_account:999999999999 + in: query + name: filter[tags] + required: false + schema: + type: string + - 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)." + example: ">=1678721573794" + in: query + name: filter[evaluation_changed_at] + required: false + schema: + type: string + - description: Set to `true` to return findings that are muted. Set to `false` to return unmuted findings. + in: query + name: filter[muted] + required: false + schema: + type: boolean + - description: Return findings for the specified rule ID. + in: query + name: filter[rule_id] + required: false + schema: + type: string + - description: Return findings for the specified rule. + in: query + name: filter[rule_name] + required: false + schema: + type: string + - description: Return only findings for the specified resource type. + in: query + name: filter[resource_type] + required: false + schema: + type: string + - description: Return only findings for the specified resource id. + in: query + name: filter[@resource_id] + required: false + schema: + type: string + - description: "Return findings that were found on a specified date (Unix ms) or date range (using comparison operators)." + example: ">=1678721573794" + in: query + name: filter[discovery_timestamp] + required: false + schema: + type: string + - description: Return only `pass` or `fail` findings. + example: pass + in: query + name: filter[evaluation] + required: false + schema: + $ref: "#/components/schemas/FindingEvaluation" + - description: Return only findings with the specified status. + example: critical + in: query + name: filter[status] + required: false + schema: + $ref: "#/components/schemas/FindingStatus" + - description: Return findings that match the selected vulnerability types (repeatable). + example: + - misconfiguration + explode: true + in: query + name: filter[vulnerability_type] + required: false + schema: + items: + $ref: "#/components/schemas/FindingVulnerabilityType" + type: array + - description: Return additional fields for some findings. + example: + - true + in: query + name: detailed_findings + required: false + schema: + type: boolean responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListFindingsResponse' + $ref: "#/components/schemas/ListFindingsResponse" description: OK - '400': - $ref: '#/components/responses/FindingsBadRequestResponse' - '403': - $ref: '#/components/responses/FindingsForbiddenResponse' - '404': - $ref: '#/components/responses/FindingsNotFoundResponse' - '429': - $ref: '#/components/responses/FindingsTooManyRequestsResponse' + "400": + $ref: "#/components/responses/FindingsBadRequestResponse" + "403": + $ref: "#/components/responses/FindingsForbiddenResponse" + "404": + $ref: "#/components/responses/FindingsNotFoundResponse" + "429": + $ref: "#/components/responses/FindingsTooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_findings_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read summary: List findings tags: - - Security Monitoring + - "Security Monitoring" x-pagination: cursorParam: page[cursor] cursorPath: meta.page.cursor limitParam: page[limit] resultsPath: data - x-unstable: '**Note**: This endpoint uses the legacy security findings data - model and is planned for deprecation. - + x-unstable: |- + **Note**: This endpoint uses the legacy security findings data model and is planned for deprecation. Use the [search security findings endpoint](https://docs.datadoghq.com/api/latest/security-monitoring/#search-security-findings), - - which is based on the [new security findings schema](https://docs.datadoghq.com/security/guide/findings-schema/), - to search security findings. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + which is based on the [new security findings schema](https://docs.datadoghq.com/security/guide/findings-schema/), to search security findings. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). patch: - description: Mute or unmute findings. + description: |- + Mute or unmute findings. operationId: MuteFindings requestBody: content: application/json: schema: - $ref: '#/components/schemas/BulkMuteFindingsRequest' - description: "### Attributes\n\nAll findings are updated with the same attributes. - The request body must include at least two attributes: `muted` and `reason`.\nThe - allowed reasons depend on whether the finding is being muted or unmuted:\n - \ - To mute a finding: `PENDING_FIX`, `FALSE_POSITIVE`, `ACCEPTED_RISK`, - `OTHER`.\n - To unmute a finding : `NO_PENDING_FIX`, `HUMAN_ERROR`, `NO_LONGER_ACCEPTED_RISK`, - `OTHER`.\n\n### Meta\n\nThe request body must include a list of the finding - IDs to be updated." + $ref: "#/components/schemas/BulkMuteFindingsRequest" + description: |- + ### Attributes + + All findings are updated with the same attributes. The request body must include at least two attributes: `muted` and `reason`. + The allowed reasons depend on whether the finding is being muted or unmuted: + - To mute a finding: `PENDING_FIX`, `FALSE_POSITIVE`, `ACCEPTED_RISK`, `OTHER`. + - To unmute a finding : `NO_PENDING_FIX`, `HUMAN_ERROR`, `NO_LONGER_ACCEPTED_RISK`, `OTHER`. + + ### Meta + + The request body must include a list of the finding IDs to be updated. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/BulkMuteFindingsResponse' + $ref: "#/components/schemas/BulkMuteFindingsResponse" description: OK - '400': - $ref: '#/components/responses/FindingsBadRequestResponse' - '403': - $ref: '#/components/responses/FindingsForbiddenResponse' - '404': - $ref: '#/components/responses/FindingsNotFoundResponse' - '422': + "400": + $ref: "#/components/responses/FindingsBadRequestResponse" + "403": + $ref: "#/components/responses/FindingsForbiddenResponse" + "404": + $ref: "#/components/responses/FindingsNotFoundResponse" + "422": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Invalid Request: The server understands the request syntax - but cannot process it due to invalid data.' - '429': - $ref: '#/components/responses/FindingsTooManyRequestsResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Invalid Request: The server understands the request syntax but cannot process it due to invalid data." + "429": + $ref: "#/components/responses/FindingsTooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Mute or unmute a batch of findings tags: - - Security Monitoring + - "Security Monitoring" x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_findings_write - - appsec_vm_write - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - security_monitoring_findings_write + - appsec_vm_write + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/posture_management/findings/{finding_id}: get: description: Returns a single finding with message and resource configuration. operationId: GetFinding parameters: - - description: The ID of the finding. - in: path - name: finding_id - required: true - schema: - type: string - - description: Return the finding for a given snapshot of time (Unix ms). - example: 1678721573794 - in: query - name: snapshot_timestamp - required: false - schema: - format: int64 - minimum: 1 - type: integer + - description: The ID of the finding. + in: path + name: finding_id + required: true + schema: + type: string + - description: Return the finding for a given snapshot of time (Unix ms). + example: 1678721573794 + in: query + name: snapshot_timestamp + required: false + schema: + format: int64 + minimum: 1 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GetFindingResponse' + $ref: "#/components/schemas/GetFindingResponse" description: OK - '400': - $ref: '#/components/responses/FindingsBadRequestResponse' - '403': - $ref: '#/components/responses/FindingsForbiddenResponse' - '404': - $ref: '#/components/responses/FindingsNotFoundResponse' - '429': - $ref: '#/components/responses/FindingsTooManyRequestsResponse' + "400": + $ref: "#/components/responses/FindingsBadRequestResponse" + "403": + $ref: "#/components/responses/FindingsForbiddenResponse" + "404": + $ref: "#/components/responses/FindingsNotFoundResponse" + "429": + $ref: "#/components/responses/FindingsTooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_findings_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read summary: Get a finding tags: - - Security Monitoring - x-unstable: '**Note**: This endpoint uses the legacy security findings data - model and is planned for deprecation. - + - "Security Monitoring" + x-unstable: |- + **Note**: This endpoint uses the legacy security findings data model and is planned for deprecation. Use the [search security findings endpoint](https://docs.datadoghq.com/api/latest/security-monitoring/#search-security-findings), - - which is based on the [new security findings schema](https://docs.datadoghq.com/security/guide/findings-schema/), - to search security findings. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + which is based on the [new security findings schema](https://docs.datadoghq.com/security/guide/findings-schema/), to search security findings. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/powerpacks: get: description: Get a list of all powerpacks. operationId: ListPowerpacks parameters: - - description: Maximum number of powerpacks in the response. - example: 25 - in: query - name: page[limit] - required: false - schema: - default: 25 - format: int64 - maximum: 1000 - type: integer - - $ref: '#/components/parameters/PageOffset' + - description: Maximum number of powerpacks in the response. + example: 25 + in: query + name: page[limit] + required: false + schema: + default: 25 + format: int64 + maximum: 1000 + type: integer + - $ref: "#/components/parameters/PageOffset" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListPowerpacksResponse' + $ref: "#/components/schemas/ListPowerpacksResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_read summary: Get all powerpacks tags: - - Powerpack + - Powerpack x-pagination: limitParam: page[limit] pageOffsetParam: page[offset] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - dashboards_read + - dashboards_read post: description: Create a powerpack. operationId: CreatePowerpack @@ -95751,321 +91687,283 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Powerpack' + $ref: "#/components/schemas/Powerpack" description: Create a powerpack request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PowerpackResponse' + $ref: "#/components/schemas/PowerpackResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_write summary: Create a new powerpack tags: - - Powerpack + - Powerpack x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - dashboards_write + - dashboards_write /api/v2/powerpacks/{powerpack_id}: delete: description: Delete a powerpack. operationId: DeletePowerpack parameters: - - description: Powerpack id - in: path - name: powerpack_id - required: true - schema: - type: string + - description: Powerpack id + in: path + name: powerpack_id + required: true + schema: + type: string responses: - '204': + "204": description: OK - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Powerpack Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_write summary: Delete a powerpack tags: - - Powerpack - x-permission: + - Powerpack + "x-permission": operator: OR permissions: - - dashboards_write + - dashboards_write get: description: Get a powerpack. operationId: GetPowerpack parameters: - - description: ID of the powerpack. - in: path - name: powerpack_id - required: true - schema: - type: string + - description: ID of the powerpack. + in: path + name: powerpack_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PowerpackResponse' + $ref: "#/components/schemas/PowerpackResponse" description: OK - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Powerpack Not Found. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_read summary: Get a Powerpack tags: - - Powerpack - x-permission: + - Powerpack + "x-permission": operator: OR permissions: - - dashboards_read + - dashboards_read patch: description: Update a powerpack. operationId: UpdatePowerpack parameters: - - description: ID of the powerpack. - in: path - name: powerpack_id - required: true - schema: - type: string + - description: ID of the powerpack. + in: path + name: powerpack_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Powerpack' + $ref: "#/components/schemas/Powerpack" description: Update a powerpack request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PowerpackResponse' + $ref: "#/components/schemas/PowerpackResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Powerpack Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - dashboards_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - dashboards_write summary: Update a powerpack tags: - - Powerpack + - Powerpack x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - dashboards_write + - dashboards_write /api/v2/processes: get: description: Get all processes for your organization. operationId: ListProcesses parameters: - - description: String to search processes by. - in: query - name: search - required: false - schema: - type: string - - description: Comma-separated list of tags to filter processes by. - example: account:prod,user:admin - in: query - name: tags - required: false - schema: - type: string - - description: 'Unix timestamp (number of seconds since epoch) of the start - of the query window. - - If not provided, the start of the query window will be 15 minutes before - the `to` timestamp. If neither - - `from` nor `to` are provided, the query window will be `[now - 15m, now]`.' - in: query - name: from - required: false - schema: - format: int64 - type: integer - - description: 'Unix timestamp (number of seconds since epoch) of the end of - the query window. - - If not provided, the end of the query window will be 15 minutes after the - `from` timestamp. If neither - - `from` nor `to` are provided, the query window will be `[now - 15m, now]`.' - in: query - name: to - required: false - schema: - format: int64 - type: integer - - description: Maximum number of results returned. - in: query - name: page[limit] - required: false - schema: - default: 1000 - format: int32 - maximum: 10000 - minimum: 1 - type: integer - - description: 'String to query the next page of results. - - This key is provided with each valid response from the API in `meta.page.after`.' - in: query - name: page[cursor] - required: false - schema: - type: string + - description: String to search processes by. + in: query + name: search + required: false + schema: + type: string + - description: Comma-separated list of tags to filter processes by. + example: account:prod,user:admin + in: query + name: tags + required: false + schema: + type: string + - description: |- + Unix timestamp (number of seconds since epoch) of the start of the query window. + If not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither + `from` nor `to` are provided, the query window will be `[now - 15m, now]`. + in: query + name: from + required: false + schema: + format: int64 + type: integer + - description: |- + Unix timestamp (number of seconds since epoch) of the end of the query window. + If not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither + `from` nor `to` are provided, the query window will be `[now - 15m, now]`. + in: query + name: to + required: false + schema: + format: int64 + type: integer + - description: Maximum number of results returned. + in: query + name: page[limit] + required: false + schema: + default: 1000 + format: int32 + maximum: 10000 + minimum: 1 + type: integer + - description: |- + String to query the next page of results. + This key is provided with each valid response from the API in `meta.page.after`. + in: query + name: page[cursor] + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ProcessSummariesResponse' + $ref: "#/components/schemas/ProcessSummariesResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get all processes tags: - - Processes + - Processes x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data - x-permission: + "x-permission": operator: OPEN permissions: [] /api/v2/prodlytics: post: - description: 'Send server-side events to Product Analytics. Server-side events - are retained for 15 months. - - - Server-Side events in Product Analytics are helpful for tracking events that - occur on the server, - - as opposed to client-side events, which are captured by Real User Monitoring - (RUM) SDKs. - - This allows for a more comprehensive view of the user journey by including - actions that happen on the server. + description: |- + Send server-side events to Product Analytics. Server-side events are retained for 15 months. + Server-Side events in Product Analytics are helpful for tracking events that occur on the server, + as opposed to client-side events, which are captured by Real User Monitoring (RUM) SDKs. + This allows for a more comprehensive view of the user journey by including actions that happen on the server. Typical examples could be `checkout.completed` or `payment.processed`. - - Ingested server-side events are integrated into Product Analytics to allow - users to select and filter - + Ingested server-side events are integrated into Product Analytics to allow users to select and filter these events in the event picker, similar to how views or actions are handled. - **Requirements:** - - - At least one of `usr`, `account`, or `session` must be provided with a valid - ID. - + - At least one of `usr`, `account`, or `session` must be provided with a valid ID. - The `application.id` must reference a Product Analytics-enabled application. - **Custom Attributes:** - Any additional fields in the payload are flattened and searchable as facets. - - For example, a payload with `{"customer": {"tier": "premium"}}` is searchable - with - + For example, a payload with `{"customer": {"tier": "premium"}}` is searchable with the syntax `@customer.tier:premium` in Datadog. - The status codes answered by the HTTP API are: - - 202: Accepted: The request has been accepted for processing - - 400: Bad request (likely an issue in the payload formatting) - - 401: Unauthorized (likely a missing API Key) - - 403: Permission issue (likely using an invalid API Key) - - 408: Request Timeout, request should be retried after some time - - 413: Payload too large (batch is above 5MB uncompressed) - - 429: Too Many Requests, request should be retried after some time - - - 500: Internal Server Error, the server encountered an unexpected condition - that prevented it from fulfilling the request, request should be retried after - some time - - - 503: Service Unavailable, the server is not ready to handle the request - probably because it is overloaded, request should be retried after some time' + - 500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time + - 503: Service Unavailable, the server is not ready to handle the request probably because it is overloaded, request should be retried after some time operationId: SubmitProductAnalyticsEvent requestBody: content: @@ -96076,169 +91974,168 @@ paths: summary: Event with account ID value: account: - id: account-456 + id: "account-456" application: - id: 123abcde-123a-123b-1234-123456789abc + id: "123abcde-123a-123b-1234-123456789abc" event: - name: checkout.completed - type: server + name: "checkout.completed" + type: "server" event-with-custom-attributes: description: Send a server-side event with additional custom attributes. summary: Event with custom attributes value: application: - id: 123abcde-123a-123b-1234-123456789abc + id: "123abcde-123a-123b-1234-123456789abc" customer: - tier: premium + tier: "premium" event: - name: payment.processed - type: server + name: "payment.processed" + type: "server" usr: - id: '123' + id: "123" event-with-session: description: Send a server-side event linked to a session. summary: Event with session ID value: application: - id: 123abcde-123a-123b-1234-123456789abc + id: "123abcde-123a-123b-1234-123456789abc" event: - name: form.submitted + name: "form.submitted" session: - id: session-789 - type: server + id: "session-789" + type: "server" simple-event-with-user: description: Send a server-side event linked to a user. summary: Simple event with user ID value: application: - id: 123abcde-123a-123b-1234-123456789abc + id: "123abcde-123a-123b-1234-123456789abc" event: - name: payment.processed - type: server + name: "payment.processed" + type: "server" usr: - id: '123' + id: "123" schema: - $ref: '#/components/schemas/ProductAnalyticsServerSideEventItem' + $ref: "#/components/schemas/ProductAnalyticsServerSideEventItem" description: Server-side event to send (JSON format). required: true responses: - '202': + "202": content: application/json: schema: type: object description: Request accepted for processing (always 202 empty JSON). - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors' + $ref: "#/components/schemas/ProductAnalyticsServerSideEventErrors" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors' + $ref: "#/components/schemas/ProductAnalyticsServerSideEventErrors" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors' + $ref: "#/components/schemas/ProductAnalyticsServerSideEventErrors" description: Forbidden - '408': + "408": content: application/json: schema: - $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors' + $ref: "#/components/schemas/ProductAnalyticsServerSideEventErrors" description: Request Timeout - '413': + "413": content: application/json: schema: - $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors' + $ref: "#/components/schemas/ProductAnalyticsServerSideEventErrors" description: Payload Too Large - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors' + $ref: "#/components/schemas/ProductAnalyticsServerSideEventErrors" description: Too Many Requests - '500': + "500": content: application/json: schema: - $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors' + $ref: "#/components/schemas/ProductAnalyticsServerSideEventErrors" description: Internal Server Error - '503': + "503": content: application/json: schema: - $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors' + $ref: "#/components/schemas/ProductAnalyticsServerSideEventErrors" description: Service Unavailable security: - - apiKeyAuth: [] + - apiKeyAuth: [] servers: - - url: https://{site} - variables: - site: - default: browser-intake-datadoghq.com - description: The intake domain for the regional site. - enum: - - browser-intake-datadoghq.com - - browser-intake-us3-datadoghq.com - - browser-intake-us5-datadoghq.com - - browser-intake-ap1-datadoghq.com - - browser-intake-ap2-datadoghq.com - - browser-intake-datadoghq.eu - - url: '{protocol}://{name}' - variables: - name: - default: browser-intake-datadoghq.com - description: Full site DNS name. - protocol: - default: https - description: The protocol for accessing the API. - - url: https://{subdomain}.{site} - variables: - site: - default: datadoghq.com - description: Any Datadog deployment. - subdomain: - default: api - description: The subdomain where the API is deployed. + - url: https://{site} + variables: + site: + default: browser-intake-datadoghq.com + description: The intake domain for the regional site. + enum: + - browser-intake-datadoghq.com + - browser-intake-us3-datadoghq.com + - browser-intake-us5-datadoghq.com + - browser-intake-ap1-datadoghq.com + - browser-intake-ap2-datadoghq.com + - browser-intake-datadoghq.eu + - url: "{protocol}://{name}" + variables: + name: + default: browser-intake-datadoghq.com + description: Full site DNS name. + protocol: + default: https + description: The protocol for accessing the API. + - url: https://{subdomain}.{site} + variables: + site: + default: datadoghq.com + description: Any Datadog deployment. + subdomain: + default: api + description: The subdomain where the API is deployed. summary: Send server-side events tags: - - Product Analytics + - Product Analytics x-codegen-request-body-name: body /api/v2/product-analytics/accounts/facet_info: post: - description: Get facet information for account attributes including possible - values and counts + description: Get facet information for account attributes including possible values and counts operationId: GetAccountFacetInfo requestBody: content: application/json: schema: - $ref: '#/components/schemas/FacetInfoRequest' + $ref: "#/components/schemas/FacetInfoRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FacetInfoResponse' + $ref: "#/components/schemas/FacetInfoResponse" description: Successful response with facet information - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get account facet info tags: - - Rum Audience Management - x-unstable: '**Note**: This endpoint may be subject to changes.' + - Rum Audience Management + x-unstable: "**Note**: This endpoint may be subject to changes." /api/v2/product-analytics/accounts/query: post: description: Query accounts with flexible filtering by account properties @@ -96247,418 +92144,408 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/QueryAccountRequest' + $ref: "#/components/schemas/QueryAccountRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/QueryResponse' + $ref: "#/components/schemas/QueryResponse" description: Successful response with account data - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Query accounts tags: - - Rum Audience Management - x-unstable: '**Note**: This endpoint may be subject to changes.' + - Rum Audience Management + x-unstable: "**Note**: This endpoint may be subject to changes." /api/v2/product-analytics/analytics/scalar: post: - description: 'Compute scalar analytics results for Product Analytics data. - - Returns aggregated values (counts, averages, percentiles) optionally grouped - by facets.' + description: |- + Compute scalar analytics results for Product Analytics data. + Returns aggregated values (counts, averages, percentiles) optionally grouped by facets. operationId: QueryProductAnalyticsScalar requestBody: content: application/json: schema: - $ref: '#/components/schemas/ProductAnalyticsAnalyticsRequest' + $ref: "#/components/schemas/ProductAnalyticsAnalyticsRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ProductAnalyticsScalarResponse' + $ref: "#/components/schemas/ProductAnalyticsScalarResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Compute scalar analytics tags: - - Product Analytics + - Product Analytics x-codegen-request-body-name: body x-permission: operator: OR permissions: - - rum_apps_read + - rum_apps_read /api/v2/product-analytics/analytics/timeseries: post: - description: 'Compute timeseries analytics results for Product Analytics data. - + description: |- + Compute timeseries analytics results for Product Analytics data. Returns time-bucketed values for charts and trend analysis. - - The `compute.interval` field (milliseconds) is required for time bucketing.' + The `compute.interval` field (milliseconds) is required for time bucketing. operationId: QueryProductAnalyticsTimeseries requestBody: content: application/json: schema: - $ref: '#/components/schemas/ProductAnalyticsAnalyticsRequest' + $ref: "#/components/schemas/ProductAnalyticsAnalyticsRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ProductAnalyticsTimeseriesResponse' + $ref: "#/components/schemas/ProductAnalyticsTimeseriesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Compute timeseries analytics tags: - - Product Analytics + - Product Analytics x-codegen-request-body-name: body x-permission: operator: OR permissions: - - rum_apps_read + - rum_apps_read /api/v2/product-analytics/users/event_filtered_query: post: - description: Query users filtered by both user properties and event platform - data + description: Query users filtered by both user properties and event platform data operationId: QueryEventFilteredUsers requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryEventFilteredUsersRequest' + $ref: "#/components/schemas/QueryEventFilteredUsersRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/QueryResponse' + $ref: "#/components/schemas/QueryResponse" description: Successful response with filtered user data - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Query event filtered users tags: - - Rum Audience Management - x-unstable: '**Note**: This endpoint may be subject to changes.' + - Rum Audience Management + x-unstable: "**Note**: This endpoint may be subject to changes." /api/v2/product-analytics/users/facet_info: post: - description: Get facet information for user attributes including possible values - and counts + description: Get facet information for user attributes including possible values and counts operationId: GetUserFacetInfo requestBody: content: application/json: schema: - $ref: '#/components/schemas/FacetInfoRequest' + $ref: "#/components/schemas/FacetInfoRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FacetInfoResponse' + $ref: "#/components/schemas/FacetInfoResponse" description: Successful response with facet information - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get user facet info tags: - - Rum Audience Management - x-unstable: '**Note**: This endpoint may be subject to changes.' + - Rum Audience Management + x-unstable: "**Note**: This endpoint may be subject to changes." /api/v2/product-analytics/users/query: post: - description: Query users with flexible filtering by user properties, with optional - wildcard search + description: Query users with flexible filtering by user properties, with optional wildcard search operationId: QueryUsers requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryUsersRequest' + $ref: "#/components/schemas/QueryUsersRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/QueryResponse' + $ref: "#/components/schemas/QueryResponse" description: Successful response with user data - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Query users tags: - - Rum Audience Management - x-unstable: '**Note**: This endpoint may be subject to changes.' + - Rum Audience Management + x-unstable: "**Note**: This endpoint may be subject to changes." /api/v2/product-analytics/{entity}/mapping: get: - description: Get entity mapping configuration including all available attributes - and their properties + description: Get entity mapping configuration including all available attributes and their properties operationId: GetMapping parameters: - - description: The entity for which to get the mapping - in: path - name: entity - required: true - schema: - example: users - type: string + - description: The entity for which to get the mapping + in: path + name: entity + required: true + schema: + example: users + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GetMappingResponse' + $ref: "#/components/schemas/GetMappingResponse" description: Successful response with entity mapping configuration - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get mapping tags: - - Rum Audience Management - x-unstable: '**Note**: This endpoint may be subject to changes.' + - Rum Audience Management + x-unstable: "**Note**: This endpoint may be subject to changes." /api/v2/product-analytics/{entity}/mapping/connection: post: description: Create a new data connection and its fields for an entity operationId: CreateConnection parameters: - - description: The entity for which to create the connection - in: path - name: entity - required: true - schema: - example: users - type: string + - description: The entity for which to create the connection + in: path + name: entity + required: true + schema: + example: users + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateConnectionRequest' + $ref: "#/components/schemas/CreateConnectionRequest" required: true responses: - '201': + "201": description: Connection created successfully - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Create connection tags: - - Rum Audience Management - x-unstable: '**Note**: This endpoint may be subject to changes.' + - Rum Audience Management + x-unstable: "**Note**: This endpoint may be subject to changes." put: - description: Update an existing data connection by adding, updating, or deleting - fields + description: Update an existing data connection by adding, updating, or deleting fields operationId: UpdateConnection parameters: - - description: The entity for which to update the connection - in: path - name: entity - required: true - schema: - example: users - type: string + - description: The entity for which to update the connection + in: path + name: entity + required: true + schema: + example: users + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateConnectionRequest' + $ref: "#/components/schemas/UpdateConnectionRequest" required: true responses: - '200': + "200": description: Connection updated successfully - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Update connection tags: - - Rum Audience Management - x-unstable: '**Note**: This endpoint may be subject to changes.' + - Rum Audience Management + x-unstable: "**Note**: This endpoint may be subject to changes." /api/v2/product-analytics/{entity}/mapping/connection/{id}: delete: description: Delete an existing data connection for an entity operationId: DeleteConnection parameters: - - description: The connection ID to delete - in: path - name: id - required: true - schema: - example: connection-id-123 - type: string - - description: The entity for which to delete the connection - in: path - name: entity - required: true - schema: - example: users - type: string + - description: The connection ID to delete + in: path + name: id + required: true + schema: + example: connection-id-123 + type: string + - description: The entity for which to delete the connection + in: path + name: entity + required: true + schema: + example: users + type: string responses: - '204': + "204": description: Connection deleted successfully - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Delete connection tags: - - Rum Audience Management - x-unstable: '**Note**: This endpoint may be subject to changes.' + - Rum Audience Management + x-unstable: "**Note**: This endpoint may be subject to changes." /api/v2/product-analytics/{entity}/mapping/connections: get: description: List all data connections for an entity operationId: ListConnections parameters: - - description: The entity for which to list connections - in: path - name: entity - required: true - schema: - example: users - type: string + - description: The entity for which to list connections + in: path + name: entity + required: true + schema: + example: users + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListConnectionsResponse' + $ref: "#/components/schemas/ListConnectionsResponse" description: Successful response with list of connections - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: List connections tags: - - Rum Audience Management - x-unstable: '**Note**: This endpoint may be subject to changes.' + - Rum Audience Management + x-unstable: "**Note**: This endpoint may be subject to changes." /api/v2/query/scalar: post: - description: 'Query scalar values (as seen on Query Value, Table, and Toplist - widgets). - + description: |- + Query scalar values (as seen on Query Value, Table, and Toplist widgets). Multiple data sources are supported with the ability to - - process the data using formulas and functions.' + process the data using formulas and functions. operationId: QueryScalarData requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/ScalarFormulaQueryRequest' + $ref: "#/components/schemas/ScalarFormulaQueryRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ScalarFormulaQueryResponse' + $ref: "#/components/schemas/ScalarFormulaQueryResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - timeseries_query + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - timeseries_query summary: Query scalar data across multiple products tags: - - Metrics + - Metrics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - timeseries_query + - timeseries_query /api/v2/query/timeseries: post: - description: 'Query timeseries data across various data sources and - - process the data by applying formulas and functions.' + description: |- + Query timeseries data across various data sources and + process the data by applying formulas and functions. operationId: QueryTimeseriesData requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/TimeseriesFormulaQueryRequest' + $ref: "#/components/schemas/TimeseriesFormulaQueryRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TimeseriesFormulaQueryResponse' + $ref: "#/components/schemas/TimeseriesFormulaQueryResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - timeseries_query + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - timeseries_query summary: Query timeseries data across multiple products tags: - - Metrics + - Metrics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - timeseries_query + - timeseries_query /api/v2/reference-tables/queries/batch-rows: post: - description: Batch query reference table rows by their primary key values. Returns - only found rows in the included array. + description: Batch query reference table rows by their primary key values. Returns only found rows in the included array. operationId: BatchRowsQuery requestBody: content: @@ -96670,122 +92557,120 @@ paths: data: attributes: row_ids: - - row_id_1 - - row_id_2 + - "row_id_1" + - "row_id_2" table_id: 00000000-0000-0000-0000-000000000000 type: reference-tables-batch-rows-query schema: - $ref: '#/components/schemas/BatchRowsQueryRequest' + $ref: "#/components/schemas/BatchRowsQueryRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/BatchRowsQueryResponse' - description: Successfully retrieved rows. Some or all requested rows were - found. Response includes found rows in the included section. - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + $ref: "#/components/schemas/BatchRowsQueryResponse" + description: Successfully retrieved rows. Some or all requested rows were found. Response includes found rows in the included section. + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Internal Server Error security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Batch rows query tags: - - Reference Tables + - Reference Tables /api/v2/reference-tables/tables: get: description: List all reference tables in this organization. operationId: ListTables parameters: - - description: Number of tables to return. - example: 15 - in: query - name: page[limit] - required: false - schema: - default: 15 - format: int64 - maximum: 100 - minimum: 1 - type: integer - - description: Number of tables to skip for pagination. - example: 0 - in: query - name: page[offset] - required: false - schema: - default: 0 - format: int64 - minimum: 0 - type: integer - - description: Sort field and direction for the list of reference tables. Use - field name for ascending, prefix with "-" for descending. - example: -updated_at - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/ReferenceTableSortType' - - description: Filter by table status. - example: DONE - in: query - name: filter[status] - required: false - schema: - type: string - - description: Filter by exact table name match. - example: my_reference_table - in: query - name: filter[table_name][exact] - required: false - schema: - type: string - - description: Filter by table name containing substring. - example: user - in: query - name: filter[table_name][contains] - required: false - schema: - type: string + - description: Number of tables to return. + example: 15 + in: query + name: page[limit] + required: false + schema: + default: 15 + format: int64 + maximum: 100 + minimum: 1 + type: integer + - description: Number of tables to skip for pagination. + example: 0 + in: query + name: page[offset] + required: false + schema: + default: 0 + format: int64 + minimum: 0 + type: integer + - description: Sort field and direction for the list of reference tables. Use field name for ascending, prefix with "-" for descending. + example: "-updated_at" + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/ReferenceTableSortType" + - description: Filter by table status. + example: DONE + in: query + name: filter[status] + required: false + schema: + type: string + - description: Filter by exact table name match. + example: "my_reference_table" + in: query + name: filter[table_name][exact] + required: false + schema: + type: string + - description: Filter by table name containing substring. + example: "user" + in: query + name: filter[table_name][contains] + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TableResultV2Array' + $ref: "#/components/schemas/TableResultV2Array" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: List tables tags: - - Reference Tables + - Reference Tables post: - description: "Creates a reference table. You can provide data in two ways:\n1. - Call POST /api/v2/reference-tables/upload to get an upload ID. Then, PUT the - CSV data\n (not the file itself) in chunks to each URL in the request body. - Finally, call this\n POST endpoint with `upload_id` in `file_metadata`.\n2. - Provide `access_details` in `file_metadata` pointing to a CSV file in cloud - storage." + description: |- + Creates a reference table. You can provide data in two ways: + 1. Call POST /api/v2/reference-tables/upload to get an upload ID. Then, PUT the CSV data + (not the file itself) in chunks to each URL in the request body. Finally, call this + POST endpoint with `upload_id` in `file_metadata`. + 2. Provide `access_details` in `file_metadata` pointing to a CSV file in cloud storage. operationId: CreateReferenceTable requestBody: content: @@ -96800,24 +92685,24 @@ paths: file_metadata: access_details: aws_detail: - aws_account_id: '924305315327' + aws_account_id: "924305315327" aws_bucket_name: my-data-bucket file_path: customers.csv sync_enabled: true schema: fields: - - name: customer_id - type: STRING - - name: customer_name - type: STRING - - name: email - type: STRING + - name: customer_id + type: STRING + - name: customer_name + type: STRING + - name: email + type: STRING primary_keys: - - customer_id + - customer_id source: S3 table_name: customer_reference_data tags: - - team:data-platform + - team:data-platform type: reference_table local_file: summary: Create table from local file upload @@ -96826,239 +92711,228 @@ paths: attributes: description: Product catalog uploaded via local file file_metadata: - upload_id: 00000000-0000-0000-0000-000000000000 + upload_id: "00000000-0000-0000-0000-000000000000" schema: fields: - - name: product_id - type: STRING - - name: product_name - type: STRING - - name: price - type: DOUBLE + - name: product_id + type: STRING + - name: product_name + type: STRING + - name: price + type: DOUBLE primary_keys: - - product_id + - product_id source: LOCAL_FILE table_name: product_catalog tags: - - team:ecommerce + - team:ecommerce type: reference_table schema: - $ref: '#/components/schemas/CreateTableRequest' + $ref: "#/components/schemas/CreateTableRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/TableResultV2' + $ref: "#/components/schemas/TableResultV2" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Create reference table tags: - - Reference Tables + - Reference Tables /api/v2/reference-tables/tables/{id}: delete: description: Delete a reference table by ID operationId: DeleteTable parameters: - - description: Unique identifier of the reference table to delete - in: path - name: id - required: true - schema: - type: string + - description: Unique identifier of the reference table to delete + in: path + name: id + required: true + schema: + type: string responses: - '200': + "200": description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Delete table tags: - - Reference Tables + - Reference Tables get: description: Get a reference table by ID operationId: GetTable parameters: - - description: Unique identifier of the reference table to retrieve - in: path - name: id - required: true - schema: - type: string + - description: Unique identifier of the reference table to retrieve + in: path + name: id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TableResultV2' + $ref: "#/components/schemas/TableResultV2" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get table tags: - - Reference Tables + - Reference Tables patch: - description: 'Update a reference table by ID. You can update the table''s data, - description, and tags. Note: The source type cannot be changed after table - creation. For data updates: For existing tables of type `source:LOCAL_FILE`, - call POST api/v2/reference-tables/uploads first to get an upload ID, then - PUT chunks of CSV data to each provided URL, and finally call this PATCH endpoint - with the upload_id in file_metadata. For existing tables with `source:` types - of `S3`, `GCS`, or `AZURE`, provide updated access_details in file_metadata - pointing to a CSV file in the same type of cloud storage.' + description: >- + Update a reference table by ID. You can update the table's data, description, and tags. Note: The source type cannot be changed after table creation. For data updates: For existing tables of type `source:LOCAL_FILE`, call POST api/v2/reference-tables/uploads first to get an upload ID, then PUT chunks of CSV data to each provided URL, and finally call this PATCH endpoint with the upload_id in file_metadata. For existing tables with `source:` types of `S3`, `GCS`, or `AZURE`, provide updated access_details in file_metadata pointing to a CSV file in the same type of cloud storage. operationId: UpdateReferenceTable parameters: - - description: Unique identifier of the reference table to update - in: path - name: id - required: true - schema: - type: string + - description: Unique identifier of the reference table to update + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchTableRequest' + $ref: "#/components/schemas/PatchTableRequest" required: true responses: - '200': + "200": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Update reference table tags: - - Reference Tables + - Reference Tables /api/v2/reference-tables/tables/{id}/rows: delete: - description: Delete multiple rows from a Reference Table by their primary key - values. + description: Delete multiple rows from a Reference Table by their primary key values. operationId: DeleteRows parameters: - - description: Unique identifier of the reference table to delete rows from - in: path - name: id - required: true - schema: - type: string + - description: Unique identifier of the reference table to delete rows from + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/BatchDeleteRowsRequestArray' + $ref: "#/components/schemas/BatchDeleteRowsRequestArray" required: true responses: - '200': + "200": description: Rows deleted successfully - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Internal Server Error security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Delete rows tags: - - Reference Tables + - Reference Tables get: description: Get reference table rows by their primary key values. operationId: GetRowsByID parameters: - - description: Unique identifier of the reference table to get rows from - example: table-123 - in: path - name: id - required: true - schema: - type: string - - description: List of row IDs (primary key values) to retrieve from the reference - table. - example: - - row1 - - row2 - explode: true - in: query - name: row_id - required: true - schema: - items: + - description: Unique identifier of the reference table to get rows from + example: "table-123" + in: path + name: id + required: true + schema: type: string - type: array + - description: List of row IDs (primary key values) to retrieve from the reference table. + example: ["row1", "row2"] + explode: true + in: query + name: row_id + required: true + schema: + items: + type: string + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TableRowResourceArray' + $ref: "#/components/schemas/TableRowResourceArray" description: Some or all requested rows were found. - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get rows by id tags: - - Reference Tables + - Reference Tables post: - description: Create or update rows in a Reference Table by their primary key - values. If a row with the specified primary key exists, it is updated; otherwise, - a new row is created. + description: >- + Create or update rows in a Reference Table by their primary key values. If a row with the specified primary key exists, it is updated; otherwise, a new row is created. operationId: UpsertRows parameters: - - description: Unique identifier of the reference table to upsert rows into - in: path - name: id - required: true - schema: - type: string + - description: Unique identifier of the reference table to upsert rows into + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: @@ -97067,40 +92941,40 @@ paths: summary: Upsert a row with mixed string and int values value: data: - - attributes: - values: - age: 25 - example_key_value: primary_key_value - name: row_name - id: primary_key_value - type: row + - attributes: + values: + age: 25 + example_key_value: "primary_key_value" + name: "row_name" + id: "primary_key_value" + type: row schema: - $ref: '#/components/schemas/BatchUpsertRowsRequestArray' + $ref: "#/components/schemas/BatchUpsertRowsRequestArray" required: true responses: - '200': + "200": description: Rows created or updated successfully - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Internal Server Error security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Upsert rows tags: - - Reference Tables + - Reference Tables /api/v2/reference-tables/uploads: post: description: Create a reference table upload for bulk data ingestion @@ -97109,46 +92983,46 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateUploadRequest' + $ref: "#/components/schemas/CreateUploadRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/CreateUploadResponse' + $ref: "#/components/schemas/CreateUploadResponse" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Create reference table upload tags: - - Reference Tables + - Reference Tables /api/v2/remote_config/products/asm/waf/custom_rules: get: description: Retrieve a list of WAF custom rule. operationId: ListApplicationSecurityWAFCustomRules responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleListResponse' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleListResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List all WAF custom rules tags: - - Application Security + - "Application Security" post: description: Create a new WAF custom rule with the given parameters. operationId: CreateApplicationSecurityWafCustomRule @@ -97156,103 +93030,103 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCreateRequest' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleCreateRequest" description: The definition of the new WAF Custom Rule. required: true responses: - '201': + "201": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleResponse' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleResponse" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConcurrentModificationResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConcurrentModificationResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a WAF custom rule tags: - - Application Security + - "Application Security" x-codegen-request-body-name: body /api/v2/remote_config/products/asm/waf/custom_rules/{custom_rule_id}: delete: description: Delete a specific WAF custom rule. operationId: DeleteApplicationSecurityWafCustomRule parameters: - - $ref: '#/components/parameters/ApplicationSecurityWafCustomRuleIDParam' + - $ref: "#/components/parameters/ApplicationSecurityWafCustomRuleIDParam" responses: - '204': + "204": description: No Content - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConcurrentModificationResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConcurrentModificationResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a WAF Custom Rule tags: - - Application Security + - "Application Security" x-terraform-resource: appsec_waf_custom_rule get: description: Retrieve a WAF custom rule by ID. operationId: GetApplicationSecurityWafCustomRule parameters: - - $ref: '#/components/parameters/ApplicationSecurityWafCustomRuleIDParam' + - $ref: "#/components/parameters/ApplicationSecurityWafCustomRuleIDParam" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleResponse' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a WAF custom rule tags: - - Application Security + - "Application Security" x-terraform-resource: appsec_waf_custom_rule put: - description: 'Update a specific WAF custom Rule. - - Returns the Custom Rule object when the request is successful.' + description: |- + Update a specific WAF custom Rule. + Returns the Custom Rule object when the request is successful. operationId: UpdateApplicationSecurityWafCustomRule parameters: - - $ref: '#/components/parameters/ApplicationSecurityWafCustomRuleIDParam' + - $ref: "#/components/parameters/ApplicationSecurityWafCustomRuleIDParam" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleUpdateRequest' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleUpdateRequest" description: New definition of the WAF Custom Rule. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleResponse' + $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConcurrentModificationResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConcurrentModificationResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a WAF Custom Rule tags: - - Application Security + - "Application Security" x-codegen-request-body-name: body x-terraform-resource: appsec_waf_custom_rule /api/v2/remote_config/products/asm/waf/exclusion_filters: @@ -97260,520 +93134,489 @@ paths: description: Retrieve a list of WAF exclusion filters. operationId: ListApplicationSecurityWafExclusionFilters responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFiltersResponse' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFiltersResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List all WAF exclusion filters tags: - - Application Security - x-permission: + - "Application Security" + "x-permission": operator: AND permissions: - - appsec_protect_read + - appsec_protect_read x-terraform-resource: appsec_waf_exclusion_filter post: - description: 'Create a new WAF exclusion filter with the given parameters. + description: |- + Create a new WAF exclusion filter with the given parameters. - - A request matched by an exclusion filter will be ignored by the Application - Security WAF product. - - Go to https://app.datadoghq.com/security/appsec/passlist to review existing - exclusion filters (also called passlist entries).' + A request matched by an exclusion filter will be ignored by the Application Security WAF product. + Go to https://app.datadoghq.com/security/appsec/passlist to review existing exclusion filters (also called passlist entries). operationId: CreateApplicationSecurityWafExclusionFilter requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterCreateRequest' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterCreateRequest" description: The definition of the new WAF exclusion filter. required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResponse' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConcurrentModificationResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConcurrentModificationResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a WAF exclusion filter tags: - - Application Security + - "Application Security" x-codegen-request-body-name: body - x-permission: + "x-permission": operator: AND permissions: - - appsec_protect_write + - appsec_protect_write x-terraform-resource: appsec_waf_exclusion_filter /api/v2/remote_config/products/asm/waf/exclusion_filters/{exclusion_filter_id}: delete: description: Delete a specific WAF exclusion filter using its identifier. operationId: DeleteApplicationSecurityWafExclusionFilter parameters: - - $ref: '#/components/parameters/ApplicationSecurityWafExclusionFilterID' + - $ref: "#/components/parameters/ApplicationSecurityWafExclusionFilterID" responses: - '204': + "204": description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConcurrentModificationResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConcurrentModificationResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a WAF exclusion filter tags: - - Application Security - x-permission: + - "Application Security" + "x-permission": operator: AND permissions: - - appsec_protect_write + - appsec_protect_write x-terraform-resource: appsec_waf_exclusion_filter get: description: Retrieve a specific WAF exclusion filter using its identifier. operationId: GetApplicationSecurityWafExclusionFilter parameters: - - $ref: '#/components/parameters/ApplicationSecurityWafExclusionFilterID' + - $ref: "#/components/parameters/ApplicationSecurityWafExclusionFilterID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResponse' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a WAF exclusion filter tags: - - Application Security - x-permission: + - "Application Security" + "x-permission": operator: AND permissions: - - appsec_protect_read + - appsec_protect_read x-terraform-resource: appsec_waf_exclusion_filter put: - description: 'Update a specific WAF exclusion filter using its identifier. - - Returns the exclusion filter object when the request is successful.' + description: |- + Update a specific WAF exclusion filter using its identifier. + Returns the exclusion filter object when the request is successful. operationId: UpdateApplicationSecurityWafExclusionFilter parameters: - - $ref: '#/components/parameters/ApplicationSecurityWafExclusionFilterID' + - $ref: "#/components/parameters/ApplicationSecurityWafExclusionFilterID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateRequest' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateRequest" description: The exclusion filter to update. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResponse' + $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConcurrentModificationResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConcurrentModificationResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a WAF exclusion filter tags: - - Application Security + - "Application Security" x-codegen-request-body-name: body - x-permission: + "x-permission": operator: AND permissions: - - appsec_protect_write + - appsec_protect_write x-terraform-resource: appsec_waf_exclusion_filter /api/v2/remote_config/products/cws/agent_rules: get: - description: 'Get the list of Workload Protection agent rules. + description: |- + Get the list of Workload Protection agent rules. - - **Note**: This endpoint is not available for the Government (US1-FED) site. - Please reference the (US1-FED) specific resource below.' + **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below. operationId: ListCSMThreatsAgentRules parameters: - - $ref: '#/components/parameters/CloudWorkloadSecurityQueryAgentPolicyID' + - $ref: "#/components/parameters/CloudWorkloadSecurityQueryAgentPolicyID" responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRulesListResponse' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRulesListResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all Workload Protection agent rules - tags: - - CSM Threats + tags: ["CSM Threats"] post: - description: 'Create a new Workload Protection agent rule with the given parameters. - + description: |- + Create a new Workload Protection agent rule with the given parameters. - **Note**: This endpoint is not available for the Government (US1-FED) site. - Please reference the (US1-FED) specific resource below.' + **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below. operationId: CreateCSMThreatsAgentRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest' - description: The definition of the new agent rule + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest" + description: "The definition of the new agent rule" required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a Workload Protection agent rule - tags: - - CSM Threats + tags: ["CSM Threats"] x-codegen-request-body-name: body /api/v2/remote_config/products/cws/agent_rules/{agent_rule_id}: delete: - description: 'Delete a specific Workload Protection agent rule. + description: |- + Delete a specific Workload Protection agent rule. - - **Note**: This endpoint is not available for the Government (US1-FED) site. - Please reference the (US1-FED) specific resource below.' + **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below. operationId: DeleteCSMThreatsAgentRule parameters: - - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' - - $ref: '#/components/parameters/CloudWorkloadSecurityQueryAgentPolicyID' + - $ref: "#/components/parameters/CloudWorkloadSecurityAgentRuleID" + - $ref: "#/components/parameters/CloudWorkloadSecurityQueryAgentPolicyID" responses: - '204': + "204": description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a Workload Protection agent rule - tags: - - CSM Threats + tags: ["CSM Threats"] get: - description: 'Get the details of a specific Workload Protection agent rule. + description: |- + Get the details of a specific Workload Protection agent rule. - - **Note**: This endpoint is not available for the Government (US1-FED) site. - Please reference the (US1-FED) specific resource below.' + **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below. operationId: GetCSMThreatsAgentRule parameters: - - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' - - $ref: '#/components/parameters/CloudWorkloadSecurityQueryAgentPolicyID' + - $ref: "#/components/parameters/CloudWorkloadSecurityAgentRuleID" + - $ref: "#/components/parameters/CloudWorkloadSecurityQueryAgentPolicyID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a Workload Protection agent rule - tags: - - CSM Threats + tags: ["CSM Threats"] patch: - description: 'Update a specific Workload Protection Agent rule. - + description: |- + Update a specific Workload Protection Agent rule. Returns the agent rule object when the request is successful. - - **Note**: This endpoint is not available for the Government (US1-FED) site. - Please reference the (US1-FED) specific resource below.' + **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below. operationId: UpdateCSMThreatsAgentRule parameters: - - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' - - $ref: '#/components/parameters/CloudWorkloadSecurityQueryAgentPolicyID' + - $ref: "#/components/parameters/CloudWorkloadSecurityAgentRuleID" + - $ref: "#/components/parameters/CloudWorkloadSecurityQueryAgentPolicyID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest' - description: New definition of the agent rule + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest" + description: "New definition of the agent rule" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConcurrentModificationResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConcurrentModificationResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a Workload Protection agent rule - tags: - - CSM Threats + tags: ["CSM Threats"] x-codegen-request-body-name: body /api/v2/remote_config/products/cws/policy: get: - description: 'Get the list of Workload Protection policies. + description: |- + Get the list of Workload Protection policies. - - **Note**: This endpoint is not available for the Government (US1-FED) site. - Please reference the (US1-FED) specific resource below.' + **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below. operationId: ListCSMThreatsAgentPolicies responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPoliciesListResponse' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPoliciesListResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all Workload Protection policies - tags: - - CSM Threats + tags: ["CSM Threats"] post: - description: 'Create a new Workload Protection policy with the given parameters. - + description: |- + Create a new Workload Protection policy with the given parameters. - **Note**: This endpoint is not available for the Government (US1-FED) site. - Please reference the (US1-FED) specific resource below.' + **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below. operationId: CreateCSMThreatsAgentPolicy requestBody: content: application/json: schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateRequest' - description: The definition of the new Agent policy + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateRequest" + description: "The definition of the new Agent policy" required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a Workload Protection policy - tags: - - CSM Threats + tags: ["CSM Threats"] x-codegen-request-body-name: body /api/v2/remote_config/products/cws/policy/download: get: - description: 'The download endpoint generates a Workload Protection policy file - from your currently active - - Workload Protection agent rules, and downloads them as a `.policy` file. This - file can then be deployed to - + description: |- + The download endpoint generates a Workload Protection policy file from your currently active + Workload Protection agent rules, and downloads them as a `.policy` file. This file can then be deployed to your agents to update the policy running in your environment. - - **Note**: This endpoint is not available for the Government (US1-FED) site. - Please reference the (US1-FED) specific resource below.' + **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below. operationId: DownloadCSMThreatsPolicy responses: - '200': + "200": content: application/zip: schema: format: binary type: string description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - summary: Download the Workload Protection policy - tags: - - CSM Threats + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: "Download the Workload Protection policy" + tags: ["CSM Threats"] /api/v2/remote_config/products/cws/policy/{policy_id}: delete: - description: 'Delete a specific Workload Protection policy. + description: |- + Delete a specific Workload Protection policy. - - **Note**: This endpoint is not available for the Government (US1-FED) site. - Please reference the (US1-FED) specific resource below.' + **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below. operationId: DeleteCSMThreatsAgentPolicy parameters: - - $ref: '#/components/parameters/CloudWorkloadSecurityPathAgentPolicyID' + - $ref: "#/components/parameters/CloudWorkloadSecurityPathAgentPolicyID" responses: - '202': + "202": description: OK - '204': + "204": description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a Workload Protection policy - tags: - - CSM Threats + tags: ["CSM Threats"] get: - description: 'Get the details of a specific Workload Protection policy. + description: |- + Get the details of a specific Workload Protection policy. - - **Note**: This endpoint is not available for the Government (US1-FED) site. - Please reference the (US1-FED) specific resource below.' + **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below. operationId: GetCSMThreatsAgentPolicy parameters: - - $ref: '#/components/parameters/CloudWorkloadSecurityPathAgentPolicyID' + - $ref: "#/components/parameters/CloudWorkloadSecurityPathAgentPolicyID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a Workload Protection policy - tags: - - CSM Threats + tags: ["CSM Threats"] patch: - description: 'Update a specific Workload Protection policy. - + description: |- + Update a specific Workload Protection policy. Returns the policy object when the request is successful. - - **Note**: This endpoint is not available for the Government (US1-FED) site. - Please reference the (US1-FED) specific resource below.' + **Note**: This endpoint is not available for the Government (US1-FED) site. Please reference the (US1-FED) specific resource below. operationId: UpdateCSMThreatsAgentPolicy parameters: - - $ref: '#/components/parameters/CloudWorkloadSecurityPathAgentPolicyID' + - $ref: "#/components/parameters/CloudWorkloadSecurityPathAgentPolicyID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateRequest' - description: New definition of the Agent policy + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateRequest" + description: "New definition of the Agent policy" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConcurrentModificationResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConcurrentModificationResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a Workload Protection policy - tags: - - CSM Threats + tags: ["CSM Threats"] x-codegen-request-body-name: body /api/v2/replay/heatmap/snapshots: get: description: List heatmap snapshots. operationId: ListReplayHeatmapSnapshots parameters: - - description: Device type to filter snapshots. - in: query - name: filter[device_type] - schema: - example: desktop - type: string - - description: View name to filter snapshots. - in: query - name: filter[view_name] - required: true - schema: - example: /home - type: string - - description: Maximum number of snapshots to return. - in: query - name: page[limit] - schema: - example: 10 - type: integer - - description: Filter by application ID. - in: query - name: filter[application_id] - schema: - example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb - type: string + - description: Device type to filter snapshots. + in: query + name: filter[device_type] + schema: + example: desktop + type: string + - description: View name to filter snapshots. + in: query + name: filter[view_name] + required: true + schema: + example: /home + type: string + - description: Maximum number of snapshots to return. + in: query + name: page[limit] + schema: + example: 10 + type: integer + - description: Filter by application ID. + in: query + name: filter[application_id] + schema: + example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SnapshotArray' + $ref: "#/components/schemas/SnapshotArray" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: List replay heatmap snapshots tags: - - Rum Replay Heatmaps + - Rum Replay Heatmaps post: description: Create a heatmap snapshot. operationId: CreateReplayHeatmapSnapshot @@ -97781,284 +93624,230 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SnapshotCreateRequest' + $ref: "#/components/schemas/SnapshotCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/Snapshot' + $ref: "#/components/schemas/Snapshot" description: Created - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Create replay heatmap snapshot tags: - - Rum Replay Heatmaps + - Rum Replay Heatmaps /api/v2/replay/heatmap/snapshots/{snapshot_id}: delete: description: Delete a heatmap snapshot. operationId: DeleteReplayHeatmapSnapshot parameters: - - description: Unique identifier of the heatmap snapshot. - in: path - name: snapshot_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000001 - type: string + - description: Unique identifier of the heatmap snapshot. + in: path + name: snapshot_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000001 + type: string responses: - '204': + "204": description: No Content - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Delete replay heatmap snapshot tags: - - Rum Replay Heatmaps + - Rum Replay Heatmaps patch: description: Update a heatmap snapshot. operationId: UpdateReplayHeatmapSnapshot parameters: - - description: Unique identifier of the heatmap snapshot. - in: path - name: snapshot_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000001 - type: string + - description: Unique identifier of the heatmap snapshot. + in: path + name: snapshot_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000001 + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SnapshotUpdateRequest' + $ref: "#/components/schemas/SnapshotUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Snapshot' + $ref: "#/components/schemas/Snapshot" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Update replay heatmap snapshot tags: - - Rum Replay Heatmaps + - Rum Replay Heatmaps /api/v2/restriction_policy/{resource_id}: delete: description: Deletes the restriction policy associated with a specified resource. operationId: DeleteRestrictionPolicy parameters: - - $ref: '#/components/parameters/ResourceID' + - $ref: "#/components/parameters/ResourceID" responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Delete a restriction policy tags: - - Restriction Policies - x-permission: + - Restriction Policies + "x-permission": operator: OPEN permissions: [] get: description: Retrieves the restriction policy associated with a specified resource. operationId: GetRestrictionPolicy parameters: - - $ref: '#/components/parameters/ResourceID' + - $ref: "#/components/parameters/ResourceID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RestrictionPolicyResponse' + $ref: "#/components/schemas/RestrictionPolicyResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get a restriction policy tags: - - Restriction Policies - x-permission: + - Restriction Policies + "x-permission": operator: OPEN permissions: [] post: - description: 'Updates the restriction policy associated with a resource. - + description: |- + Updates the restriction policy associated with a resource. #### Supported resources - Restriction policies can be applied to the following resources: - - Dashboards: `dashboard` - - Integration Services: `integration-service` - - Integration Webhooks: `integration-webhook` - - Notebooks: `notebook` - - Powerpacks: `powerpack` - - Reference Tables: `reference-table` - - Security Rules: `security-rule` - - Service Level Objectives: `slo` - - Synthetic Global Variables: `synthetics-global-variable` - - Synthetic Tests: `synthetics-test` - - Synthetic Private Locations: `synthetics-private-location` - - Monitors: `monitor` - - Workflows: `workflow` - - App Builder Apps: `app-builder-app` - - Connections: `connection` - - Connection Groups: `connection-group` - - RUM Applications: `rum-application` - - Cross Org Connections: `cross-org-connection` - - Spreadsheets: `spreadsheet` - - On-Call Schedules: `on-call-schedule` - - On-Call Escalation Policies: `on-call-escalation-policy` - - On-Call Team Routing Rules: `on-call-team-routing-rules` - - Logs Pipelines: `logs-pipeline` - - Case Management Projects: `case-management-project` - #### Supported relations for resources - Resource Type | Supported Relations - ----------------------------|-------------------------- - Dashboards | `viewer`, `editor` - Integration Services | `viewer`, `editor` - Integration Webhooks | `viewer`, `editor` - Notebooks | `viewer`, `editor` - Powerpacks | `viewer`, `editor` - Security Rules | `viewer`, `editor` - Service Level Objectives | `viewer`, `editor` - Synthetic Global Variables | `viewer`, `editor` - Synthetic Tests | `viewer`, `editor` - Synthetic Private Locations | `viewer`, `editor` - Monitors | `viewer`, `editor` - Reference Tables | `viewer`, `editor` - Workflows | `viewer`, `runner`, `editor` - App Builder Apps | `viewer`, `editor` - Connections | `viewer`, `resolver`, `editor` - Connection Groups | `viewer`, `editor` - RUM Application | `viewer`, `editor` - Cross Org Connections | `viewer`, `editor` - Spreadsheets | `viewer`, `editor` - On-Call Schedules | `viewer`, `overrider`, `editor` - On-Call Escalation Policies | `viewer`, `editor` - On-Call Team Routing Rules | `viewer`, `editor` - Logs Pipelines | `viewer`, `processors_editor`, `editor` - - Case Management Projects | `viewer`, `contributor`, `manager`' + Case Management Projects | `viewer`, `contributor`, `manager` operationId: UpdateRestrictionPolicy parameters: - - $ref: '#/components/parameters/ResourceID' - - 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. - in: query - name: allow_self_lockout - required: false - schema: - type: boolean + - $ref: "#/components/parameters/ResourceID" + - 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. + in: query + name: allow_self_lockout + required: false + schema: + type: boolean requestBody: content: application/json: schema: - $ref: '#/components/schemas/RestrictionPolicyUpdateRequest' + $ref: "#/components/schemas/RestrictionPolicyUpdateRequest" description: Restriction policy payload required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RestrictionPolicyResponse' + $ref: "#/components/schemas/RestrictionPolicyResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Update a restriction policy tags: - - Restriction Policies + - Restriction Policies x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OPEN permissions: [] /api/v2/roles: @@ -98066,59 +93855,56 @@ paths: description: Returns all roles, including their names and their unique identifiers. operationId: ListRoles parameters: - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' - - description: 'Sort roles depending on the given field. Sort order is **ascending** - by default. - - Sort order is **descending** if the field is prefixed by a negative sign, - for example: - - `sort=-name`.' - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/RolesSort' - - description: Filter all roles by the given string. - in: query - name: filter - required: false - schema: - type: string - - description: Filter all roles by the given list of role IDs. - in: query - name: filter[id] - required: false - schema: - type: string + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - description: |- + Sort roles depending on the given field. Sort order is **ascending** by default. + Sort order is **descending** if the field is prefixed by a negative sign, for example: + `sort=-name`. + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/RolesSort" + - description: Filter all roles by the given string. + in: query + name: filter + required: false + schema: + type: string + - description: Filter all roles by the given list of role IDs. + in: query + name: filter[id] + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RolesResponse' + $ref: "#/components/schemas/RolesResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_read summary: List roles tags: - - Roles - x-permission: + - Roles + "x-permission": operator: OR permissions: - - user_access_read + - user_access_read post: description: Create a new role for your organization. operationId: CreateRole @@ -98126,596 +93912,592 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoleCreateRequest' + $ref: "#/components/schemas/RoleCreateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RoleCreateResponse' + $ref: "#/components/schemas/RoleCreateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_manage + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_manage summary: Create role tags: - - Roles + - Roles x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage + - user_access_manage /api/v2/roles/templates: get: description: List all role templates operationId: ListRoleTemplates responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RoleTemplateArray' + $ref: "#/components/schemas/RoleTemplateArray" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_read summary: List role templates tags: - - Roles - x-unstable: '**Note**: This endpoint may be subject to changes.' + - Roles + x-unstable: "**Note**: This endpoint may be subject to changes." /api/v2/roles/{role_id}: delete: description: Disables a role. operationId: DeleteRole parameters: - - $ref: '#/components/parameters/RoleID' + - $ref: "#/components/parameters/RoleID" responses: - '204': + "204": description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_manage + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_manage summary: Delete role tags: - - Roles + - Roles x-codegen-request-body-name: body get: - description: "Get a role in the organization specified by the role\u2019s `role_id`." + description: Get a role in the organization specified by the role’s `role_id`. operationId: GetRole parameters: - - $ref: '#/components/parameters/RoleID' + - $ref: "#/components/parameters/RoleID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RoleResponse' + $ref: "#/components/schemas/RoleResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_read summary: Get a role tags: - - Roles + - Roles x-codegen-request-body-name: body patch: - description: Edit a role. Can only be used with application keys belonging to - administrators. + description: |- + Edit a role. Can only be used with application keys belonging to administrators. operationId: UpdateRole parameters: - - $ref: '#/components/parameters/RoleID' + - $ref: "#/components/parameters/RoleID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RoleUpdateRequest' + $ref: "#/components/schemas/RoleUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RoleUpdateResponse' + $ref: "#/components/schemas/RoleUpdateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Unprocessable Entity - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_manage + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_manage summary: Update a role tags: - - Roles + - Roles x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage + - user_access_manage /api/v2/roles/{role_id}/clone: post: description: Clone an existing role operationId: CloneRole parameters: - - $ref: '#/components/parameters/RoleID' + - $ref: "#/components/parameters/RoleID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RoleCloneRequest' + $ref: "#/components/schemas/RoleCloneRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RoleResponse' + $ref: "#/components/schemas/RoleResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Conflict - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_manage + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_manage summary: Create a new role by cloning an existing role tags: - - Roles + - Roles x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage + - user_access_manage /api/v2/roles/{role_id}/permissions: delete: description: Removes a permission from a role. operationId: RemovePermissionFromRole parameters: - - $ref: '#/components/parameters/RoleID' + - $ref: "#/components/parameters/RoleID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RelationshipToPermission' + $ref: "#/components/schemas/RelationshipToPermission" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PermissionsResponse' + $ref: "#/components/schemas/PermissionsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_manage + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_manage summary: Revoke permission tags: - - Roles + - Roles x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage + - user_access_manage get: description: Returns a list of all permissions for a single role. operationId: ListRolePermissions parameters: - - $ref: '#/components/parameters/RoleID' + - $ref: "#/components/parameters/RoleID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PermissionsResponse' + $ref: "#/components/schemas/PermissionsResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_read summary: List permissions for a role tags: - - Roles + - Roles x-codegen-request-body-name: body post: description: Adds a permission to a role. operationId: AddPermissionToRole parameters: - - $ref: '#/components/parameters/RoleID' + - $ref: "#/components/parameters/RoleID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RelationshipToPermission' + $ref: "#/components/schemas/RelationshipToPermission" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PermissionsResponse' + $ref: "#/components/schemas/PermissionsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_manage + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_manage summary: Grant permission to a role tags: - - Roles + - Roles x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage + - user_access_manage /api/v2/roles/{role_id}/users: delete: description: Removes a user from a role. operationId: RemoveUserFromRole parameters: - - $ref: '#/components/parameters/RoleID' + - $ref: "#/components/parameters/RoleID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UsersResponse' + $ref: "#/components/schemas/UsersResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_manage + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_manage summary: Remove a user from a role tags: - - Roles + - Roles x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage + - user_access_manage get: description: Gets all users of a role. operationId: ListRoleUsers parameters: - - $ref: '#/components/parameters/RoleID' - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' - - description: 'User attribute to order results by. Sort order is **ascending** - by default. - - Sort order is **descending** if the field is prefixed by a negative sign, - - for example `sort=-name`. Options: `name`, `email`, `status`.' - in: query - name: sort - required: false - schema: - default: name - type: string - - description: Filter all users by the given string. Defaults to no filtering. - in: query - name: filter - required: false - schema: - type: string + - $ref: "#/components/parameters/RoleID" + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - description: |- + User attribute to order results by. Sort order is **ascending** by default. + Sort order is **descending** if the field is prefixed by a negative sign, + for example `sort=-name`. Options: `name`, `email`, `status`. + in: query + name: sort + required: false + schema: + default: name + type: string + - description: Filter all users by the given string. Defaults to no filtering. + in: query + name: filter + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UsersResponse' + $ref: "#/components/schemas/UsersResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_read summary: Get all users of a role tags: - - Roles + - Roles post: description: Adds a user to a role. operationId: AddUserToRole parameters: - - $ref: '#/components/parameters/RoleID' + - $ref: "#/components/parameters/RoleID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RelationshipToUser' + $ref: "#/components/schemas/RelationshipToUser" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UsersResponse' + $ref: "#/components/schemas/UsersResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_manage + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_manage summary: Add a user to a role tags: - - Roles + - Roles x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage + - user_access_manage /api/v2/rum/analytics/aggregate: post: - description: The API endpoint to aggregate RUM events into buckets of computed - metrics and timeseries. + description: |- + The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries. operationId: AggregateRUMEvents requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/RUMAggregateRequest' + $ref: "#/components/schemas/RUMAggregateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RUMAnalyticsAggregateResponse' + $ref: "#/components/schemas/RUMAnalyticsAggregateResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Aggregate RUM events - tags: - - RUM + tags: ["RUM"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - rum_apps_read + - rum_apps_read /api/v2/rum/applications: get: description: List all the RUM applications in your organization. operationId: GetRUMApplications responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RUMApplicationsResponse' + $ref: "#/components/schemas/RUMApplicationsResponse" description: OK - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List all the RUM applications - tags: - - RUM - x-permission: + tags: ["RUM"] + "x-permission": operator: OR permissions: - - rum_apps_read + - rum_apps_read post: description: Create a new RUM application in your organization. operationId: CreateRUMApplication @@ -98723,583 +94505,568 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RUMApplicationCreateRequest' + $ref: "#/components/schemas/RUMApplicationCreateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RUMApplicationResponse' + $ref: "#/components/schemas/RUMApplicationResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a new RUM application - tags: - - RUM + tags: ["RUM"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - rum_apps_write + - rum_apps_write /api/v2/rum/applications/{app_id}/relationships/retention_filters: patch: - description: 'Order RUM retention filters for a RUM application. - - Returns RUM retention filter objects without attributes from the request body - when the request is successful.' + description: |- + Order RUM retention filters for a RUM application. + Returns RUM retention filter objects without attributes from the request body when the request is successful. operationId: OrderRetentionFilters parameters: - - $ref: '#/components/parameters/RumApplicationIDParameter' + - $ref: "#/components/parameters/RumApplicationIDParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RumRetentionFiltersOrderRequest' + $ref: "#/components/schemas/RumRetentionFiltersOrderRequest" description: New definition of the RUM retention filter. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RumRetentionFiltersOrderResponse' + $ref: "#/components/schemas/RumRetentionFiltersOrderResponse" description: Ordered - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Order RUM retention filters tags: - - Rum Retention Filters + - Rum Retention Filters x-codegen-request-body-name: body /api/v2/rum/applications/{app_id}/retention_filters: get: description: Get the list of RUM retention filters for a RUM application. operationId: ListRetentionFilters parameters: - - $ref: '#/components/parameters/RumApplicationIDParameter' + - $ref: "#/components/parameters/RumApplicationIDParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RumRetentionFiltersResponse' + $ref: "#/components/schemas/RumRetentionFiltersResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all RUM retention filters tags: - - Rum Retention Filters + - Rum Retention Filters post: - description: 'Create a RUM retention filter for a RUM application. - - Returns RUM retention filter objects from the request body when the request - is successful.' + description: |- + Create a RUM retention filter for a RUM application. + Returns RUM retention filter objects from the request body when the request is successful. operationId: CreateRetentionFilter parameters: - - $ref: '#/components/parameters/RumApplicationIDParameter' + - $ref: "#/components/parameters/RumApplicationIDParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RumRetentionFilterCreateRequest' + $ref: "#/components/schemas/RumRetentionFilterCreateRequest" description: The definition of the new RUM retention filter. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/RumRetentionFilterResponse' + $ref: "#/components/schemas/RumRetentionFilterResponse" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a RUM retention filter tags: - - Rum Retention Filters + - Rum Retention Filters x-codegen-request-body-name: body /api/v2/rum/applications/{app_id}/retention_filters/{rf_id}: delete: description: Delete a RUM retention filter for a RUM application. operationId: DeleteRetentionFilter parameters: - - $ref: '#/components/parameters/RumApplicationIDParameter' - - $ref: '#/components/parameters/RumRetentionFilterIDParameter' + - $ref: "#/components/parameters/RumApplicationIDParameter" + - $ref: "#/components/parameters/RumRetentionFilterIDParameter" responses: - '204': + "204": description: No Content - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a RUM retention filter tags: - - Rum Retention Filters + - Rum Retention Filters get: description: Get a RUM retention filter for a RUM application. operationId: GetRetentionFilter parameters: - - $ref: '#/components/parameters/RumApplicationIDParameter' - - $ref: '#/components/parameters/RumRetentionFilterIDParameter' + - $ref: "#/components/parameters/RumApplicationIDParameter" + - $ref: "#/components/parameters/RumRetentionFilterIDParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RumRetentionFilterResponse' + $ref: "#/components/schemas/RumRetentionFilterResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a RUM retention filter tags: - - Rum Retention Filters + - Rum Retention Filters patch: - description: 'Update a RUM retention filter for a RUM application. - - Returns RUM retention filter objects from the request body when the request - is successful.' + description: |- + Update a RUM retention filter for a RUM application. + Returns RUM retention filter objects from the request body when the request is successful. operationId: UpdateRetentionFilter parameters: - - $ref: '#/components/parameters/RumApplicationIDParameter' - - $ref: '#/components/parameters/RumRetentionFilterIDParameter' + - $ref: "#/components/parameters/RumApplicationIDParameter" + - $ref: "#/components/parameters/RumRetentionFilterIDParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RumRetentionFilterUpdateRequest' + $ref: "#/components/schemas/RumRetentionFilterUpdateRequest" description: New definition of the RUM retention filter. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RumRetentionFilterResponse' + $ref: "#/components/schemas/RumRetentionFilterResponse" description: Updated - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a RUM retention filter tags: - - Rum Retention Filters + - Rum Retention Filters x-codegen-request-body-name: body /api/v2/rum/applications/{id}: delete: description: Delete an existing RUM application in your organization. operationId: DeleteRUMApplication parameters: - - description: RUM application ID. - in: path - name: id - required: true - schema: - type: string + - description: RUM application ID. + in: path + name: id + required: true + schema: + type: string responses: - '204': + "204": description: No Content - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a RUM application - tags: - - RUM - x-permission: + tags: ["RUM"] + "x-permission": operator: OR permissions: - - rum_apps_write + - rum_apps_write get: description: Get the RUM application with given ID in your organization. operationId: GetRUMApplication parameters: - - description: RUM application ID. - in: path - name: id - required: true - schema: - type: string + - description: RUM application ID. + in: path + name: id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RUMApplicationResponse' + $ref: "#/components/schemas/RUMApplicationResponse" description: OK - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a RUM application - tags: - - RUM - x-permission: + tags: ["RUM"] + "x-permission": operator: OR permissions: - - rum_apps_read + - rum_apps_read patch: description: Update the RUM application with given ID in your organization. operationId: UpdateRUMApplication parameters: - - description: RUM application ID. - in: path - name: id - required: true - schema: - type: string + - description: RUM application ID. + in: path + name: id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/RUMApplicationUpdateRequest' + $ref: "#/components/schemas/RUMApplicationUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RUMApplicationResponse' + $ref: "#/components/schemas/RUMApplicationResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '422': + "400": + $ref: "#/components/responses/BadRequestResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "422": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Unprocessable Entity. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a RUM application - tags: - - RUM + tags: ["RUM"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - rum_apps_write + - rum_apps_write /api/v2/rum/config/metrics: get: description: Get the list of configured rum-based metrics with their definitions. operationId: ListRumMetrics responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RumMetricsResponse' + $ref: "#/components/schemas/RumMetricsResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all rum-based metrics tags: - - Rum Metrics + - Rum Metrics post: - description: 'Create a metric based on your organization''s RUM data. - - Returns the rum-based metric object from the request body when the request - is successful.' + description: |- + Create a metric based on your organization's RUM data. + Returns the rum-based metric object from the request body when the request is successful. operationId: CreateRumMetric requestBody: content: application/json: schema: - $ref: '#/components/schemas/RumMetricCreateRequest' + $ref: "#/components/schemas/RumMetricCreateRequest" description: The definition of the new rum-based metric. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/RumMetricResponse' + $ref: "#/components/schemas/RumMetricResponse" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a rum-based metric tags: - - Rum Metrics + - Rum Metrics x-codegen-request-body-name: body /api/v2/rum/config/metrics/{metric_id}: delete: description: Delete a specific rum-based metric from your organization. operationId: DeleteRumMetric parameters: - - $ref: '#/components/parameters/RumMetricIDParameter' + - $ref: "#/components/parameters/RumMetricIDParameter" responses: - '204': + "204": description: No Content - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a rum-based metric tags: - - Rum Metrics + - Rum Metrics get: description: Get a specific rum-based metric from your organization. operationId: GetRumMetric parameters: - - $ref: '#/components/parameters/RumMetricIDParameter' + - $ref: "#/components/parameters/RumMetricIDParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RumMetricResponse' + $ref: "#/components/schemas/RumMetricResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a rum-based metric tags: - - Rum Metrics + - Rum Metrics patch: - description: 'Update a specific rum-based metric from your organization. - - Returns the rum-based metric object from the request body when the request - is successful.' + description: |- + Update a specific rum-based metric from your organization. + Returns the rum-based metric object from the request body when the request is successful. operationId: UpdateRumMetric parameters: - - $ref: '#/components/parameters/RumMetricIDParameter' + - $ref: "#/components/parameters/RumMetricIDParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/RumMetricUpdateRequest' + $ref: "#/components/schemas/RumMetricUpdateRequest" description: New definition of the rum-based metric. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RumMetricResponse' + $ref: "#/components/schemas/RumMetricResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a rum-based metric tags: - - Rum Metrics + - Rum Metrics x-codegen-request-body-name: body /api/v2/rum/events: get: - description: 'List endpoint returns events that match a RUM search query. - + description: |- + List endpoint returns events that match a RUM search query. [Results are paginated][1]. - Use this endpoint to see your latest RUM events. - - [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination' + [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination operationId: ListRUMEvents parameters: - - description: Search query following RUM syntax. - example: '@type:session @application_id:xxxx' - in: query - name: filter[query] - required: false - schema: - type: string - - description: Minimum timestamp for requested events. - example: '2019-01-02T09:42:36.320Z' - in: query - name: filter[from] - required: false - schema: - format: date-time - type: string - - description: Maximum timestamp for requested events. - example: '2019-01-03T09:42:36.320Z' - in: query - name: filter[to] - required: false - schema: - format: date-time - type: string - - description: Order of events in results. - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/RUMSort' - - description: List following results with a cursor provided in the previous - query. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== - in: query - name: page[cursor] - required: false - schema: - type: string - - description: Maximum number of events in the response. - example: 25 - in: query - name: page[limit] - required: false - schema: - default: 10 - format: int32 - maximum: 1000 - type: integer + - description: Search query following RUM syntax. + example: "@type:session @application_id:xxxx" + in: query + name: filter[query] + required: false + schema: + type: string + - description: Minimum timestamp for requested events. + example: "2019-01-02T09:42:36.320Z" + in: query + name: filter[from] + required: false + schema: + format: date-time + type: string + - description: Maximum timestamp for requested events. + example: "2019-01-03T09:42:36.320Z" + in: query + name: filter[to] + required: false + schema: + format: date-time + type: string + - description: Order of events in results. + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/RUMSort" + - description: |- + List following results with a cursor provided in the previous query. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" + in: query + name: page[cursor] + required: false + schema: + type: string + - description: Maximum number of events in the response. + example: 25 + in: query + name: page[limit] + required: false + schema: + default: 10 + format: int32 + maximum: 1000 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RUMEventsResponse' + $ref: "#/components/schemas/RUMEventsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a list of RUM events - tags: - - RUM + tags: ["RUM"] x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - rum_apps_read + - rum_apps_read /api/v2/rum/events/search: post: - description: 'List endpoint returns RUM events that match a RUM search query. - + description: |- + List endpoint returns RUM events that match a RUM search query. [Results are paginated][1]. - Use this endpoint to build complex RUM events filtering and search. - - [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination' + [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination operationId: SearchRUMEvents requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/RUMSearchEventsRequest' + $ref: "#/components/schemas/RUMSearchEventsRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RUMEventsResponse' + $ref: "#/components/schemas/RUMEventsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Search RUM events - tags: - - RUM + tags: ["RUM"] x-codegen-request-body-name: body x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - rum_apps_read + - rum_apps_read /api/v2/rum/replay/playlists: get: description: List playlists. operationId: ListRumReplayPlaylists parameters: - - description: Filter playlists by the UUID of the user who created them. - in: query - name: filter[created_by_uuid] - schema: - example: 00000000-0000-0000-0000-000000000001 - type: string - - description: Search query to filter playlists by name. - in: query - name: filter[query] - schema: - example: my playlist - type: string - - description: Page number for pagination (0-indexed). - in: query - name: page[number] - schema: - example: 0 - type: integer - - description: Number of items per page. - in: query - name: page[size] - schema: - example: 25 - type: integer + - description: Filter playlists by the UUID of the user who created them. + in: query + name: filter[created_by_uuid] + schema: + example: 00000000-0000-0000-0000-000000000001 + type: string + - description: Search query to filter playlists by name. + in: query + name: filter[query] + schema: + example: my playlist + type: string + - description: Page number for pagination (0-indexed). + in: query + name: page[number] + schema: + example: 0 + type: integer + - description: Number of items per page. + in: query + name: page[size] + schema: + example: 25 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PlaylistArray' + $ref: "#/components/schemas/PlaylistArray" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: List rum replay playlists tags: - - Rum Replay Playlists + - Rum Replay Playlists post: description: Create a playlist. operationId: CreateRumReplayPlaylist @@ -99307,610 +95074,609 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Playlist' + $ref: "#/components/schemas/Playlist" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/Playlist' + $ref: "#/components/schemas/Playlist" description: Created - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Create rum replay playlist tags: - - Rum Replay Playlists + - Rum Replay Playlists /api/v2/rum/replay/playlists/{playlist_id}: delete: description: Delete a playlist. operationId: DeleteRumReplayPlaylist parameters: - - description: Unique identifier of the playlist. - in: path - name: playlist_id - required: true - schema: - example: 1234567 - type: integer + - description: Unique identifier of the playlist. + in: path + name: playlist_id + required: true + schema: + example: 1234567 + type: integer responses: - '204': + "204": description: No Content - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Delete rum replay playlist tags: - - Rum Replay Playlists + - Rum Replay Playlists get: description: Get a playlist. operationId: GetRumReplayPlaylist parameters: - - description: Unique identifier of the playlist. - in: path - name: playlist_id - required: true - schema: - example: 1234567 - type: integer + - description: Unique identifier of the playlist. + in: path + name: playlist_id + required: true + schema: + example: 1234567 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Playlist' + $ref: "#/components/schemas/Playlist" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get rum replay playlist tags: - - Rum Replay Playlists + - Rum Replay Playlists put: description: Update a playlist. operationId: UpdateRumReplayPlaylist parameters: - - description: Unique identifier of the playlist. - in: path - name: playlist_id - required: true - schema: - example: 1234567 - type: integer + - description: Unique identifier of the playlist. + in: path + name: playlist_id + required: true + schema: + example: 1234567 + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/Playlist' + $ref: "#/components/schemas/Playlist" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Playlist' + $ref: "#/components/schemas/Playlist" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Update rum replay playlist tags: - - Rum Replay Playlists + - Rum Replay Playlists /api/v2/rum/replay/playlists/{playlist_id}/sessions: delete: description: Remove sessions from a playlist. operationId: BulkRemoveRumReplayPlaylistSessions parameters: - - description: Unique identifier of the playlist. - in: path - name: playlist_id - required: true - schema: - example: 1234567 - type: integer + - description: Unique identifier of the playlist. + in: path + name: playlist_id + required: true + schema: + example: 1234567 + type: integer requestBody: content: application/json: schema: - $ref: '#/components/schemas/SessionIdArray' + $ref: "#/components/schemas/SessionIdArray" required: true responses: - '204': + "204": description: No Content - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Bulk remove rum replay playlist sessions tags: - - Rum Replay Playlists + - Rum Replay Playlists get: description: List sessions in a playlist. operationId: ListRumReplayPlaylistSessions parameters: - - description: Unique identifier of the playlist. - in: path - name: playlist_id - required: true - schema: - example: 1234567 - type: integer - - description: Page number for pagination (0-indexed). - in: query - name: page[number] - schema: - example: 0 - type: integer - - description: Number of items per page. - in: query - name: page[size] - schema: - example: 25 - type: integer + - description: Unique identifier of the playlist. + in: path + name: playlist_id + required: true + schema: + example: 1234567 + type: integer + - description: Page number for pagination (0-indexed). + in: query + name: page[number] + schema: + example: 0 + type: integer + - description: Number of items per page. + in: query + name: page[size] + schema: + example: 25 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PlaylistsSessionArray' + $ref: "#/components/schemas/PlaylistsSessionArray" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: List rum replay playlist sessions tags: - - Rum Replay Playlists + - Rum Replay Playlists /api/v2/rum/replay/playlists/{playlist_id}/sessions/{session_id}: delete: description: Remove a session from a playlist. operationId: RemoveRumReplaySessionFromPlaylist parameters: - - description: Unique identifier of the playlist. - in: path - name: playlist_id - required: true - schema: - example: 1234567 - type: integer - - description: Unique identifier of the session. - in: path - name: session_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000001 - type: string + - description: Unique identifier of the playlist. + in: path + name: playlist_id + required: true + schema: + example: 1234567 + type: integer + - description: Unique identifier of the session. + in: path + name: session_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000001 + type: string responses: - '204': + "204": description: No Content - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Remove rum replay session from playlist tags: - - Rum Replay Playlists + - Rum Replay Playlists put: description: Add a session to a playlist. operationId: AddRumReplaySessionToPlaylist parameters: - - description: 'Data source type. Valid values: ''rum'' or ''product_analytics''. - Defaults to ''rum''.' - in: query - name: data_source - schema: - example: rum - type: string - - description: Server-side timestamp in milliseconds. - in: query - name: ts - required: true - schema: - example: 1704067200000 - format: int64 - type: integer - - description: Unique identifier of the playlist. - in: path - name: playlist_id - required: true - schema: - example: 1234567 - type: integer - - description: Unique identifier of the session. - in: path - name: session_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000001 - type: string + - description: "Data source type. Valid values: 'rum' or 'product_analytics'. Defaults to 'rum'." + in: query + name: data_source + schema: + example: rum + type: string + - description: Server-side timestamp in milliseconds. + in: query + name: ts + required: true + schema: + example: 1704067200000 + format: int64 + type: integer + - description: Unique identifier of the playlist. + in: path + name: playlist_id + required: true + schema: + example: 1234567 + type: integer + - description: Unique identifier of the session. + in: path + name: session_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000001 + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PlaylistsSession' + $ref: "#/components/schemas/PlaylistsSession" description: OK - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/PlaylistsSession' + $ref: "#/components/schemas/PlaylistsSession" description: Created - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Add rum replay session to playlist tags: - - Rum Replay Playlists + - Rum Replay Playlists /api/v2/rum/replay/sessions/{session_id}/views/{view_id}/segments: get: description: Get segments for a view. operationId: GetSegments parameters: - - description: Unique identifier of the view. - in: path - name: view_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000002 - type: string - - description: 'Storage source: ''event_platform'' or ''blob''.' - in: query - name: source - schema: - example: event_platform - type: string - - description: Unique identifier of the session. - in: path - name: session_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000001 - type: string - - description: Server-side timestamp in milliseconds. - in: query - name: ts - schema: - example: 1704067200000 - format: int64 - type: integer - - description: Maximum size in bytes for the segment list. - in: query - name: max_list_size - schema: - example: 1048576 - type: integer - - description: Paging token for pagination. - in: query - name: paging - schema: - example: eyJuZXh0IjoiYWJjMTIzIn0 - type: string + - description: Unique identifier of the view. + in: path + name: view_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000002 + type: string + - description: "Storage source: 'event_platform' or 'blob'." + in: query + name: source + schema: + example: event_platform + type: string + - description: Unique identifier of the session. + in: path + name: session_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000001 + type: string + - description: Server-side timestamp in milliseconds. + in: query + name: ts + schema: + example: 1704067200000 + format: int64 + type: integer + - description: Maximum size in bytes for the segment list. + in: query + name: max_list_size + schema: + example: 1048576 + type: integer + - description: Paging token for pagination. + in: query + name: paging + schema: + example: eyJuZXh0IjoiYWJjMTIzIn0 + type: string responses: - '200': + "200": description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get segments tags: - - Rum Replay Sessions + - Rum Replay Sessions /api/v2/rum/replay/sessions/{session_id}/watchers: get: description: List session watchers. operationId: ListRumReplaySessionWatchers parameters: - - description: Number of items per page. - in: query - name: page[size] - schema: - example: 25 - type: integer - - description: Page number for pagination (0-indexed). - in: query - name: page[number] - schema: - example: 0 - type: integer - - description: Unique identifier of the session. - in: path - name: session_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000001 - type: string + - description: Number of items per page. + in: query + name: page[size] + schema: + example: 25 + type: integer + - description: Page number for pagination (0-indexed). + in: query + name: page[number] + schema: + example: 0 + type: integer + - description: Unique identifier of the session. + in: path + name: session_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000001 + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/WatcherArray' + $ref: "#/components/schemas/WatcherArray" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: List rum replay session watchers tags: - - Rum Replay Viewership + - Rum Replay Viewership /api/v2/rum/replay/sessions/{session_id}/watches: delete: description: Delete session watch history. operationId: DeleteRumReplaySessionWatch parameters: - - description: Unique identifier of the session. - in: path - name: session_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000001 - type: string + - description: Unique identifier of the session. + in: path + name: session_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000001 + type: string responses: - '204': + "204": description: No Content - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Delete rum replay session watch tags: - - Rum Replay Viewership + - Rum Replay Viewership post: description: Record a session watch. operationId: CreateRumReplaySessionWatch parameters: - - description: Unique identifier of the session. - in: path - name: session_id - required: true - schema: - example: 00000000-0000-0000-0000-000000000001 - type: string + - description: Unique identifier of the session. + in: path + name: session_id + required: true + schema: + example: 00000000-0000-0000-0000-000000000001 + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/Watch' + $ref: "#/components/schemas/Watch" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/Watch' + $ref: "#/components/schemas/Watch" description: Created - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Create rum replay session watch tags: - - Rum Replay Viewership + - Rum Replay Viewership /api/v2/rum/replay/viewership-history/sessions: get: description: List watched sessions. operationId: ListRumReplayViewershipHistorySessions parameters: - - description: Start timestamp in milliseconds for watched_at filter. - in: query - name: filter[watched_at][start] - schema: - example: 1704067200000 - format: int64 - type: integer - - description: Page number for pagination (0-indexed). - in: query - name: page[number] - schema: - example: 0 - type: integer - - description: Filter by user UUID. Defaults to current user if not specified. - in: query - name: filter[created_by] - schema: - example: 00000000-0000-0000-0000-000000000001 - type: string - - description: End timestamp in milliseconds for watched_at filter. - in: query - name: filter[watched_at][end] - schema: - example: 1704153600000 - format: int64 - type: integer - - description: Comma-separated list of session IDs to filter by. - in: query - name: filter[session_ids] - schema: - example: 11111111-2222-3333-4444-555555555555,22222222-3333-4444-5555-666666666666 - type: string - - description: Number of items per page. - in: query - name: page[size] - schema: - example: 25 - type: integer - - description: Filter by application ID. - in: query - name: filter[application_id] - schema: - example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb - type: string + - description: Start timestamp in milliseconds for watched_at filter. + in: query + name: filter[watched_at][start] + schema: + example: 1704067200000 + format: int64 + type: integer + - description: Page number for pagination (0-indexed). + in: query + name: page[number] + schema: + example: 0 + type: integer + - description: Filter by user UUID. Defaults to current user if not specified. + in: query + name: filter[created_by] + schema: + example: 00000000-0000-0000-0000-000000000001 + type: string + - description: End timestamp in milliseconds for watched_at filter. + in: query + name: filter[watched_at][end] + schema: + example: 1704153600000 + format: int64 + type: integer + - description: Comma-separated list of session IDs to filter by. + in: query + name: filter[session_ids] + schema: + example: 11111111-2222-3333-4444-555555555555,22222222-3333-4444-5555-666666666666 + type: string + - description: Number of items per page. + in: query + name: page[size] + schema: + example: 25 + type: integer + - description: Filter by application ID. + in: query + name: filter[application_id] + schema: + example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ViewershipHistorySessionArray' + $ref: "#/components/schemas/ViewershipHistorySessionArray" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: List rum replay viewership history sessions tags: - - Rum Replay Viewership + - Rum Replay Viewership /api/v2/saml_configurations/idp_metadata: post: - description: 'Endpoint for uploading IdP metadata for SAML setup. - + description: |- + Endpoint for uploading IdP metadata for SAML setup. - Use this endpoint to upload or replace IdP metadata for SAML login configuration.' + Use this endpoint to upload or replace IdP metadata for SAML login configuration. operationId: UploadIdPMetadata requestBody: content: multipart/form-data: schema: - $ref: '#/components/schemas/IdPMetadataFormData' + $ref: "#/components/schemas/IdPMetadataFormData" required: true responses: - '200': + "200": description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Upload IdP metadata tags: - - Organizations + - Organizations x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - org_management + - org_management /api/v2/scorecard/outcomes: get: description: Fetches all rule outcomes. operationId: ListScorecardOutcomes parameters: - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageOffset' - - description: Include related rule details in the response. - in: query - name: include - required: false - schema: - example: rule - type: string - - description: Return only specified values in the outcome attributes. - in: query - name: fields[outcome] - required: false - schema: - example: state, service_name - type: string - - description: Return only specified values in the included rule details. - in: query - name: fields[rule] - required: false - schema: - example: name - type: string - - description: Filter the outcomes on a specific service name. - in: query - name: filter[outcome][service_name] - required: false - schema: - example: web-store - type: string - - description: Filter the outcomes by a specific state. - in: query - name: filter[outcome][state] - required: false - schema: - example: fail - type: string - - description: Filter outcomes on whether a rule is enabled/disabled. - in: query - name: filter[rule][enabled] - required: false - schema: - example: true - type: boolean - - description: Filter outcomes based on rule ID. - in: query - name: filter[rule][id] - required: false - schema: - example: f4485c79-0762-449c-96cf-c31e54a659f6 - type: string - - description: Filter outcomes based on rule name. - in: query - name: filter[rule][name] - required: false - schema: - example: SLOs Defined - type: string + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageOffset" + - description: Include related rule details in the response. + in: query + name: include + required: false + schema: + example: rule + type: string + - description: Return only specified values in the outcome attributes. + in: query + name: fields[outcome] + required: false + schema: + example: state, service_name + type: string + - description: Return only specified values in the included rule details. + in: query + name: fields[rule] + required: false + schema: + example: name + type: string + - description: Filter the outcomes on a specific service name. + in: query + name: filter[outcome][service_name] + required: false + schema: + example: web-store + type: string + - description: Filter the outcomes by a specific state. + in: query + name: filter[outcome][state] + required: false + schema: + example: fail + type: string + - description: Filter outcomes on whether a rule is enabled/disabled. + in: query + name: filter[rule][enabled] + required: false + schema: + example: true + type: boolean + - description: Filter outcomes based on rule ID. + in: query + name: filter[rule][id] + required: false + schema: + example: f4485c79-0762-449c-96cf-c31e54a659f6 + type: string + - description: Filter outcomes based on rule name. + in: query + name: filter[rule][name] + required: false + schema: + example: SLOs Defined + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OutcomesResponse' + $ref: "#/components/schemas/OutcomesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_read summary: List all rule outcomes tags: - - Service Scorecards + - Service Scorecards x-pagination: limitParam: page[size] pageOffsetParam: page[offset] resultsPath: data - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Updates multiple scorecard rule outcomes in a single batched request. operationId: UpdateScorecardOutcomesAsync @@ -99918,32 +95684,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateOutcomesAsyncRequest' + $ref: "#/components/schemas/UpdateOutcomesAsyncRequest" description: Set of scorecard outcomes. required: true responses: - '202': + "202": description: Accepted - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_write summary: Update Scorecard outcomes asynchronously tags: - - Service Scorecards + - Service Scorecards x-codegen-request-body-name: body - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/scorecard/outcomes/batch: post: description: Sets multiple service-rule outcomes in a single batched request. @@ -99952,126 +95718,125 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OutcomesBatchRequest' + $ref: "#/components/schemas/OutcomesBatchRequest" description: Set of scorecard outcomes. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OutcomesBatchResponse' + $ref: "#/components/schemas/OutcomesBatchResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_write summary: Create outcomes batch tags: - - Service Scorecards + - Service Scorecards x-codegen-request-body-name: body - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/scorecard/rules: get: description: Fetch all rules. operationId: ListScorecardRules parameters: - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageOffset' - - description: Include related scorecard details in the response. - in: query - name: include - required: false - schema: - example: scorecard - type: string - - description: Filter the rules on a rule ID. - in: query - name: filter[rule][id] - required: false - schema: - example: 37d2f990-c885-4972-949b-8b798213a166 - type: string - - description: Filter for enabled rules only. - in: query - name: filter[rule][enabled] - required: false - schema: - example: true - type: boolean - - description: Filter for custom rules only. - in: query - name: filter[rule][custom] - required: false - schema: - example: true - type: boolean - - description: Filter rules on the rule name. - in: query - name: filter[rule][name] - required: false - schema: - example: Code Repos Defined - type: string - - description: Filter rules on the rule description. - in: query - name: filter[rule][description] - required: false - schema: - example: Identifying - type: string - - description: Return only specific fields in the response for rule attributes. - in: query - name: fields[rule] - required: false - schema: - example: name, description - type: string - - description: Return only specific fields in the included response for scorecard - attributes. - in: query - name: fields[scorecard] - required: false - schema: - example: name - type: string + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageOffset" + - description: Include related scorecard details in the response. + in: query + name: include + required: false + schema: + example: scorecard + type: string + - description: Filter the rules on a rule ID. + in: query + name: filter[rule][id] + required: false + schema: + example: 37d2f990-c885-4972-949b-8b798213a166 + type: string + - description: Filter for enabled rules only. + in: query + name: filter[rule][enabled] + required: false + schema: + example: true + type: boolean + - description: Filter for custom rules only. + in: query + name: filter[rule][custom] + required: false + schema: + example: true + type: boolean + - description: Filter rules on the rule name. + in: query + name: filter[rule][name] + required: false + schema: + example: Code Repos Defined + type: string + - description: Filter rules on the rule description. + in: query + name: filter[rule][description] + required: false + schema: + example: Identifying + type: string + - description: Return only specific fields in the response for rule attributes. + in: query + name: fields[rule] + required: false + schema: + example: name, description + type: string + - description: Return only specific fields in the included response for scorecard attributes. + in: query + name: fields[scorecard] + required: false + schema: + example: name + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListRulesResponse' + $ref: "#/components/schemas/ListRulesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_read summary: List all rules tags: - - Service Scorecards + - Service Scorecards x-pagination: limitParam: page[size] pageOffsetParam: page[offset] resultsPath: data - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: Creates a new rule. operationId: CreateScorecardRule @@ -100079,2158 +95844,2126 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateRuleRequest' + $ref: "#/components/schemas/CreateRuleRequest" description: Rule attributes. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/CreateRuleResponse' + $ref: "#/components/schemas/CreateRuleResponse" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_write summary: Create a new rule tags: - - Service Scorecards + - Service Scorecards x-codegen-request-body-name: body - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/scorecard/rules/{rule_id}: delete: description: Deletes a single rule. operationId: DeleteScorecardRule parameters: - - $ref: '#/components/parameters/RuleId' + - $ref: "#/components/parameters/RuleId" responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_write summary: Delete a rule tags: - - Service Scorecards - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Service Scorecards + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). put: description: Updates an existing rule. operationId: UpdateScorecardRule parameters: - - $ref: '#/components/parameters/RuleId' + - $ref: "#/components/parameters/RuleId" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateRuleRequest' + $ref: "#/components/schemas/UpdateRuleRequest" description: Rule attributes. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateRuleResponse' + $ref: "#/components/schemas/UpdateRuleResponse" description: Rule updated successfully - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_write summary: Update an existing rule tags: - - Service Scorecards + - Service Scorecards x-codegen-request-body-name: body - x-unstable: '**Note**: This endpoint is in public beta. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/seats/users: delete: - description: Unassign seats from users for a product code. + description: |- + Unassign seats from users for a product code. operationId: UnassignSeatsUser requestBody: content: application/json: schema: - $ref: '#/components/schemas/UnassignSeatsUserRequest' + $ref: "#/components/schemas/UnassignSeatsUserRequest" required: true responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '422': + "400": + $ref: "#/components/responses/BadRequestResponse" + "422": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Unprocessable Entity - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Unassign seats from users tags: - - Seats - x-permission: + - Seats + "x-permission": operator: OR permissions: - - billing_edit - - incident_write - - on_call_write + - billing_edit + - incident_write + - on_call_write get: - description: Get the list of users assigned seats for a product code. + description: |- + Get the list of users assigned seats for a product code. operationId: GetSeatsUsers parameters: - - description: The product code for which to retrieve seat users. - in: query - name: product_code - required: true - schema: - type: string - - description: Maximum number of results to return. - in: query - name: page[limit] - required: false - schema: - type: integer - - description: Cursor for pagination. - in: query - name: page[cursor] - required: false - schema: - type: string + - description: The product code for which to retrieve seat users. + in: query + name: product_code + required: true + schema: + type: string + - description: Maximum number of results to return. + in: query + name: page[limit] + required: false + schema: + type: integer + - description: Cursor for pagination. + in: query + name: page[cursor] + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SeatUserDataArray' + $ref: "#/components/schemas/SeatUserDataArray" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '422': + "400": + $ref: "#/components/responses/BadRequestResponse" + "422": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Unprocessable Entity - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get users with seats tags: - - Seats - x-permission: + - Seats + "x-permission": operator: OR permissions: - - billing_read - - incident_read - - on_call_read + - billing_read + - incident_read + - on_call_read post: - description: Assign seats to users for a product code. + description: |- + Assign seats to users for a product code. operationId: AssignSeatsUser requestBody: content: application/json: schema: - $ref: '#/components/schemas/AssignSeatsUserRequest' + $ref: "#/components/schemas/AssignSeatsUserRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/AssignSeatsUserResponse' + $ref: "#/components/schemas/AssignSeatsUserResponse" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '422': + "400": + $ref: "#/components/responses/BadRequestResponse" + "422": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Unprocessable Entity - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Assign seats to users tags: - - Seats - x-permission: + - Seats + "x-permission": operator: OR permissions: - - billing_edit - - incident_write - - on_call_write + - billing_edit + - incident_write + - on_call_write /api/v2/security-entities/risk-scores: get: - description: Get a list of entity risk scores for your organization. Entity - risk scores provide security risk assessment for entities like cloud resources, - identities, or services based on detected signals, misconfigurations, and - identity risks. + description: |- + Get a list of entity risk scores for your organization. Entity risk scores provide security risk assessment for entities like cloud resources, identities, or services based on detected signals, misconfigurations, and identity risks. operationId: ListEntityRiskScores parameters: - - description: Start time for the query in Unix timestamp (milliseconds). Defaults - to 2 weeks ago. - in: query - name: from - required: false - schema: - example: 1704067200000 - format: int64 - type: integer - - description: End time for the query in Unix timestamp (milliseconds). Defaults - to now. - in: query - name: to - required: false - schema: - example: 1705276800000 - format: int64 - type: integer - - description: Size of the page to return. Maximum is 1000. - in: query - name: page[size] - required: false - schema: - default: 10 - example: 10 - type: integer - - description: Page number to return (1-indexed). - in: query - name: page[number] - required: false - schema: - default: 1 - example: 1 - type: integer - - description: Query ID for pagination consistency. - in: query - name: page[queryId] - required: false - schema: - example: abc123def456 - type: string - - description: 'Sort order for results. Format: `field:direction` where direction - is `asc` or `desc`. - - Supported fields: `riskScore`, `lastDetected`, `firstDetected`, `entityName`, - `signalsDetected`.' - in: query - name: filter[sort] - required: false - schema: - example: riskScore:desc - type: string - - description: 'Supports filtering by entity attributes, risk scores, severity, - and more. - - Example: `severity:critical AND entityType:aws_iam_user`' - in: query - name: filter[query] - required: false - schema: - example: severity:critical - type: string - - description: Filter by entity type(s). Can specify multiple values. - explode: true - in: query - name: entityType - required: false - schema: - example: - - aws_iam_user - - aws_ec2_instance - items: - example: aws_iam_user + - description: Start time for the query in Unix timestamp (milliseconds). Defaults to 2 weeks ago. + in: query + name: from + required: false + schema: + example: 1704067200000 + format: int64 + type: integer + - description: End time for the query in Unix timestamp (milliseconds). Defaults to now. + in: query + name: to + required: false + schema: + example: 1705276800000 + format: int64 + type: integer + - description: Size of the page to return. Maximum is 1000. + in: query + name: page[size] + required: false + schema: + default: 10 + example: 10 + type: integer + - description: Page number to return (1-indexed). + in: query + name: page[number] + required: false + schema: + default: 1 + example: 1 + type: integer + - description: Query ID for pagination consistency. + in: query + name: page[queryId] + required: false + schema: + example: "abc123def456" type: string - type: array - style: form + - description: |- + Sort order for results. Format: `field:direction` where direction is `asc` or `desc`. + Supported fields: `riskScore`, `lastDetected`, `firstDetected`, `entityName`, `signalsDetected`. + in: query + name: filter[sort] + required: false + schema: + example: "riskScore:desc" + type: string + - description: |- + Supports filtering by entity attributes, risk scores, severity, and more. + Example: `severity:critical AND entityType:aws_iam_user` + in: query + name: filter[query] + required: false + schema: + example: "severity:critical" + type: string + - description: Filter by entity type(s). Can specify multiple values. + explode: true + in: query + name: entityType + required: false + schema: + example: ["aws_iam_user", "aws_ec2_instance"] + items: + example: "aws_iam_user" + type: string + type: array + style: form responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityEntityRiskScoresResponse' + $ref: "#/components/schemas/SecurityEntityRiskScoresResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List Entity Risk Scores tags: - - Entity Risk Scores - x-unstable: '**Note**: This endpoint is in public beta and it''s subject to - change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Entity Risk Scores + x-unstable: |- + **Note**: This endpoint is in public beta and it's subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/security/cloud_workload/policy/download: get: - description: 'The download endpoint generates a Workload Protection policy file - from your currently active - - Workload Protection agent rules, and downloads them as a `.policy` file. This - file can then be deployed to - + description: |- + The download endpoint generates a Workload Protection policy file from your currently active + Workload Protection agent rules, and downloads them as a `.policy` file. This file can then be deployed to your agents to update the policy running in your environment. - - **Note**: This endpoint should only be used for the Government (US1-FED) site.' + **Note**: This endpoint should only be used for the Government (US1-FED) site. operationId: DownloadCloudWorkloadPolicyFile responses: - '200': + "200": content: application/yaml: schema: format: binary type: string description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - summary: Download the Workload Protection policy (US1-FED) - tags: - - CSM Threats - x-permission: + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: "Download the Workload Protection policy (US1-FED)" + tags: ["CSM Threats"] + "x-permission": operator: OR permissions: - - security_monitoring_cws_agent_rules_read + - security_monitoring_cws_agent_rules_read /api/v2/security/findings: get: - description: 'Get a list of security findings that match a search query. [See - the schema for security findings](https://docs.datadoghq.com/security/guide/findings-schema/). - + description: |- + Get a list of security findings that match a search query. [See the schema for security findings](https://docs.datadoghq.com/security/guide/findings-schema/). ### Query Syntax + This endpoint uses the logs query syntax. Findings attributes (living in the attributes.attributes. namespace) are prefixed by @ when queried. Tags are queried without a prefix. - This endpoint uses the logs query syntax. Findings attributes (living in the - attributes.attributes. namespace) are prefixed by @ when queried. Tags are - queried without a prefix. - - - Example: `@severity:(critical OR high) @status:open team:platform`' + Example: `@severity:(critical OR high) @status:open team:platform` operationId: ListSecurityFindings parameters: - - description: The search query following log search syntax. - example: '@severity:(critical OR high) @status:open team:platform' - in: query - name: filter[query] - required: false - schema: - default: '*' - type: string - - description: Get the next page of results with a cursor provided in the previous - query. - example: eyJhZnRlciI6IkF3QUFBWnPcm1pd0FBQUJbVlBQUKBa1pqRTVdZUzSTBNemN0YWiIsLTE3Mjk0MzYwMjFdfQ== - in: query - name: page[cursor] - required: false - schema: - type: string - - description: The maximum number of findings in the response. - example: 25 - in: query - name: page[limit] - required: false - schema: - default: 10 - format: int64 - maximum: 150 - minimum: 1 - type: integer - - description: Sorts by @detection_changed_at. - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/SecurityFindingsSort' + - description: The search query following log search syntax. + example: "@severity:(critical OR high) @status:open team:platform" + in: query + name: filter[query] + required: false + schema: + default: "*" + type: string + - description: Get the next page of results with a cursor provided in the previous query. + example: "eyJhZnRlciI6IkF3QUFBWnPcm1pd0FBQUJbVlBQUKBa1pqRTVdZUzSTBNemN0YWiIsLTE3Mjk0MzYwMjFdfQ==" + in: query + name: page[cursor] + required: false + schema: + type: string + - description: The maximum number of findings in the response. + example: 25 + in: query + name: page[limit] + required: false + schema: + default: 10 + format: int64 + maximum: 150 + minimum: 1 + type: integer + - description: Sorts by @detection_changed_at. + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/SecurityFindingsSort" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListSecurityFindingsResponse' + $ref: "#/components/schemas/ListSecurityFindingsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_findings_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read summary: List security findings tags: - - Security Monitoring + - "Security Monitoring" x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_findings_read - - appsec_vm_read + - security_monitoring_findings_read + - appsec_vm_read /api/v2/security/findings/cases: delete: - description: 'Detach security findings from their case. + description: >- + Detach security findings from their case. - This operation dissociates security findings from their associated cases without - deleting the cases themselves. You can detach security findings from multiple - different cases in a single request, with a limit of 50 security findings - per request. Security findings that are not currently attached to any case - will be ignored.' + This operation dissociates security findings from their associated cases without deleting the cases themselves. You can detach security findings from multiple different cases in a single request, with a limit of 50 security findings per request. Security findings that are not currently attached to any case will be ignored. operationId: DetachCase requestBody: content: application/json: schema: - $ref: '#/components/schemas/DetachCaseRequest' + $ref: "#/components/schemas/DetachCaseRequest" required: true responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Detach security findings from their case tags: - - Security Monitoring + - "Security Monitoring" x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_findings_write - - appsec_vm_write + - security_monitoring_findings_write + - appsec_vm_write post: - description: 'Create cases for security findings. + description: >- + Create cases for security findings. - You can create up to 50 cases per request and associate up to 50 security - findings per case. Security findings that are already attached to another - case will be detached from their previous case and attached to the newly created - case.' + You can create up to 50 cases per request and associate up to 50 security findings per case. Security findings that are already attached to another case will be detached from their previous case and attached to the newly created case. operationId: CreateCases requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateCaseRequestArray' + $ref: "#/components/schemas/CreateCaseRequestArray" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/FindingCaseResponseArray' + $ref: "#/components/schemas/FindingCaseResponseArray" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Create cases for security findings tags: - - Security Monitoring + - "Security Monitoring" x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_findings_write - - appsec_vm_write + - security_monitoring_findings_write + - appsec_vm_write /api/v2/security/findings/cases/{case_id}: patch: - description: 'Attach security findings to a case. + description: >- + Attach security findings to a case. - You can attach up to 50 security findings per case. Security findings that - are already attached to another case will be detached from their previous - case and attached to the specified case.' + You can attach up to 50 security findings per case. Security findings that are already attached to another case will be detached from their previous case and attached to the specified case. operationId: AttachCase parameters: - - description: Unique identifier of the case to attach security findings to - in: path - name: case_id - required: true - schema: - type: string + - description: Unique identifier of the case to attach security findings to + in: path + name: case_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/AttachCaseRequest' + $ref: "#/components/schemas/AttachCaseRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FindingCaseResponse' + $ref: "#/components/schemas/FindingCaseResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Attach security findings to a case tags: - - Security Monitoring + - "Security Monitoring" x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_findings_write - - appsec_vm_write + - security_monitoring_findings_write + - appsec_vm_write /api/v2/security/findings/jira_issues: patch: - description: 'Attach security findings to a Jira issue by providing the Jira - issue URL. + description: >- + Attach security findings to a Jira issue by providing the Jira issue URL. - You can attach up to 50 security findings per Jira issue. If the Jira issue - is not linked to any case, this operation will create a case for the security - findings and link the Jira issue to the newly created case. To configure the - Jira integration, see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira). - Security findings that are already attached to another Jira issue will be - detached from their previous Jira issue and attached to the specified Jira - issue.' + You can attach up to 50 security findings per Jira issue. If the Jira issue is not linked to any case, this operation will create a case for the security findings and link the Jira issue to the newly created case. To configure the Jira integration, see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira). Security findings that are already attached to another Jira issue will be detached from their previous Jira issue and attached to the specified Jira issue. operationId: AttachJiraIssue requestBody: content: application/json: schema: - $ref: '#/components/schemas/AttachJiraIssueRequest' + $ref: "#/components/schemas/AttachJiraIssueRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FindingCaseResponse' + $ref: "#/components/schemas/FindingCaseResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Attach security findings to a Jira issue tags: - - Security Monitoring + - "Security Monitoring" x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_findings_write - - appsec_vm_write + - security_monitoring_findings_write + - appsec_vm_write post: - description: 'Create Jira issues for security findings. + description: >- + Create Jira issues for security findings. - This operation creates a case in Datadog and a Jira issue linked to that case - for bidirectional sync between Datadog and Jira. To configure the Jira integration, - see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira). - You can create up to 50 Jira issues per request and associate up to 50 security - findings per Jira issue. Security findings that are already attached to another - Jira issue will be detached from their previous Jira issue and attached to - the newly created Jira issue.' + This operation creates a case in Datadog and a Jira issue linked to that case for bidirectional sync between Datadog and Jira. To configure the Jira integration, see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira). You can create up to 50 Jira issues per request and associate up to 50 security findings per Jira issue. Security findings that are already attached to another Jira issue will be detached from their previous Jira issue and attached to the newly created Jira issue. operationId: CreateJiraIssues requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateJiraIssueRequestArray' + $ref: "#/components/schemas/CreateJiraIssueRequestArray" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/FindingCaseResponseArray' + $ref: "#/components/schemas/FindingCaseResponseArray" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Create Jira issues for security findings tags: - - Security Monitoring + - "Security Monitoring" x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_findings_write - - appsec_vm_write + - security_monitoring_findings_write + - appsec_vm_write /api/v2/security/findings/search: post: - description: 'Get a list of security findings that match a search query. [See - the schema for security findings](https://docs.datadoghq.com/security/guide/findings-schema/). - + description: |- + Get a list of security findings that match a search query. [See the schema for security findings](https://docs.datadoghq.com/security/guide/findings-schema/). ### Query Syntax + The API uses the logs query syntax. Findings attributes (living in the attributes.attributes. namespace) are prefixed by @ when queried. Tags are queried without a prefix. - The API uses the logs query syntax. Findings attributes (living in the attributes.attributes. - namespace) are prefixed by @ when queried. Tags are queried without a prefix. - - - Example: `@severity:(critical OR high) @status:open team:platform`' + Example: `@severity:(critical OR high) @status:open team:platform` operationId: SearchSecurityFindings requestBody: content: application/json: schema: - $ref: '#/components/schemas/SecurityFindingsSearchRequest' + $ref: "#/components/schemas/SecurityFindingsSearchRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListSecurityFindingsResponse' + $ref: "#/components/schemas/ListSecurityFindingsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_findings_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read summary: Search security findings tags: - - Security Monitoring + - "Security Monitoring" x-codegen-request-body-name: body x-pagination: cursorParam: body.data.attributes.page.cursor cursorPath: meta.page.after limitParam: body.data.attributes.page.limit resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_findings_read - - appsec_vm_read + - security_monitoring_findings_read + - appsec_vm_read /api/v2/security/sboms: get: - description: 'Get a list of assets SBOMs for an organization. - + description: |- + Get a list of assets SBOMs for an organization. ### Pagination - - Please review the [Pagination section](#pagination) for the "List Vulnerabilities" - endpoint. - + Please review the [Pagination section](#pagination) for the "List Vulnerabilities" endpoint. ### Filtering + Please review the [Filtering section](#filtering) for the "List Vulnerabilities" endpoint. - Please review the [Filtering section](#filtering) for the "List Vulnerabilities" - endpoint. + ### Metadata - - ### Metadata - - - Please review the [Metadata section](#metadata) for the "List Vulnerabilities" - endpoint.' + Please review the [Metadata section](#metadata) for the "List Vulnerabilities" endpoint. operationId: ListAssetsSBOMs parameters: - - description: Its value must come from the `links` section of the response - of the first request. Do not manually edit it. - example: b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4 - in: query - name: page[token] - required: false - schema: - type: string - - description: The page number to be retrieved. It should be equal to or greater - than 1. - example: 1 - in: query - name: page[number] - required: false - schema: - format: int64 - minimum: 1 - type: integer - - description: The type of the assets for the SBOM request. - example: Repository - in: query - name: filter[asset_type] - required: false - schema: - $ref: '#/components/schemas/AssetType' - - description: The name of the asset for the SBOM request. - example: github.com/datadog/datadog-agent - in: query - name: filter[asset_name] - required: false - schema: - type: string - - description: The name of the component that is a dependency of an asset. - example: opentelemetry-api - in: query - name: filter[package_name] - required: false - schema: - type: string - - description: The version of the component that is a dependency of an asset. - example: 1.33.1 - in: query - name: filter[package_version] - required: false - schema: - type: string - - description: The software license name of the component that is a dependency - of an asset. - example: Apache-2.0 - in: query - name: filter[license_name] - required: false - schema: - type: string - - description: The software license type of the component that is a dependency - of an asset. - example: network_strong_copyleft - in: query - name: filter[license_type] - required: false - schema: - $ref: '#/components/schemas/SBOMComponentLicenseType' + - description: Its value must come from the `links` section of the response of the first request. Do not manually edit it. + example: "b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4" + in: query + name: page[token] + required: false + schema: + type: string + - description: The page number to be retrieved. It should be equal to or greater than 1. + example: 1 + in: query + name: page[number] + required: false + schema: + format: int64 + minimum: 1 + type: integer + - description: The type of the assets for the SBOM request. + example: Repository + in: query + name: filter[asset_type] + required: false + schema: + $ref: "#/components/schemas/AssetType" + - description: The name of the asset for the SBOM request. + example: "github.com/datadog/datadog-agent" + in: query + name: filter[asset_name] + required: false + schema: + type: string + - description: The name of the component that is a dependency of an asset. + example: "opentelemetry-api" + in: query + name: filter[package_name] + required: false + schema: + type: string + - description: The version of the component that is a dependency of an asset. + example: "1.33.1" + in: query + name: filter[package_version] + required: false + schema: + type: string + - description: The software license name of the component that is a dependency of an asset. + example: "Apache-2.0" + in: query + name: filter[license_name] + required: false + schema: + type: string + - description: The software license type of the component that is a dependency of an asset. + example: "network_strong_copyleft" + in: query + name: filter[license_type] + required: false + schema: + $ref: "#/components/schemas/SBOMComponentLicenseType" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListAssetsSBOMsResponse' + $ref: "#/components/schemas/ListAssetsSBOMsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Bad request: The server cannot process the request due to - invalid syntax in the request.' - '403': + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Bad request: The server cannot process the request due to invalid syntax in the request." + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Forbidden: Access denied' - '404': + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Forbidden: Access denied" + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Not found: asset not found' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Not found: asset not found" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: List assets SBOMs tags: - - Security Monitoring + - "Security Monitoring" x-permission: operator: OR permissions: - - appsec_vm_read + - appsec_vm_read /api/v2/security/sboms/{asset_type}: get: - description: Get a single SBOM related to an asset by its type and name. + description: |- + Get a single SBOM related to an asset by its type and name. operationId: GetSBOM parameters: - - description: The type of the asset for the SBOM request. - example: Repository - in: path - name: asset_type - required: true - schema: - $ref: '#/components/schemas/AssetType' - - description: The name of the asset for the SBOM request. - example: github.com/datadog/datadog-agent - in: query - name: filter[asset_name] - required: true - schema: - type: string - - description: The container image `repo_digest` for the SBOM request. When - the requested asset type is 'Image', this filter is mandatory. - example: sha256:0ae7da091191787229d321e3638e39c319a97d6e20f927d465b519d699215bf7 - in: query - name: filter[repo_digest] - required: false - schema: - type: string - - description: The standard of the SBOM. - example: CycloneDX - in: query - name: ext:format - required: false - schema: - $ref: '#/components/schemas/SBOMFormat' + - description: The type of the asset for the SBOM request. + example: Repository + in: path + name: asset_type + required: true + schema: + $ref: "#/components/schemas/AssetType" + - description: The name of the asset for the SBOM request. + example: "github.com/datadog/datadog-agent" + in: query + name: filter[asset_name] + required: true + schema: + type: string + - description: The container image `repo_digest` for the SBOM request. When the requested asset type is 'Image', this filter is mandatory. + example: "sha256:0ae7da091191787229d321e3638e39c319a97d6e20f927d465b519d699215bf7" + in: query + name: filter[repo_digest] + required: false + schema: + type: string + - description: The standard of the SBOM. + example: CycloneDX + in: query + name: ext:format + required: false + schema: + $ref: "#/components/schemas/SBOMFormat" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GetSBOMResponse' + $ref: "#/components/schemas/GetSBOMResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Bad request: The server cannot process the request due to - invalid syntax in the request.' - '403': + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Bad request: The server cannot process the request due to invalid syntax in the request." + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Forbidden: Access denied' - '404': + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Forbidden: Access denied" + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Not found: asset not found' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Not found: asset not found" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get SBOM tags: - - Security Monitoring + - "Security Monitoring" x-permission: operator: OR permissions: - - appsec_vm_read + - appsec_vm_read /api/v2/security/scanned-assets-metadata: get: - description: "Get a list of security scanned assets metadata for an organization.\n\n### - Pagination\n\nFor the \"List Vulnerabilities\" endpoint, see the [Pagination - section](#pagination).\n\n### Filtering\n\nFor the \"List Vulnerabilities\" - endpoint, see the [Filtering section](#filtering).\n\n### Metadata\n\n For - the \"List Vulnerabilities\" endpoint, see the [Metadata section](#metadata).\n\n### - Related endpoints\n\nThis endpoint returns additional metadata for cloud resources - that is not available from the standard resource endpoints. To access a richer - dataset, call this endpoint together with the relevant resource endpoint(s) - and merge (join) their results using the resource identifier.\n\n**Hosts**\n\nTo - enrich host data, join the response from the [Hosts](https://docs.datadoghq.com/api/latest/hosts/) - endpoint with the response from the scanned-assets-metadata endpoint on the - following key fields:\n\n| ENDPOINT | JOIN KEY | TYPE |\n| --- | --- | --- - |\n| [/api/v1/hosts](https://docs.datadoghq.com/api/latest/hosts/) | host_list.host_name - | string |\n| /api/v2/security/scanned-assets-metadata | data.attributes.asset.name - | string |\n\n**Host Images**\n\nTo enrich host image data, join the response - from the [Hosts](https://docs.datadoghq.com/api/latest/hosts/) endpoint with - the response from the scanned-assets-metadata endpoint on the following key - fields:\n\n| ENDPOINT | JOIN KEY | TYPE |\n| --- | --- | --- |\n| [/api/v1/hosts](https://docs.datadoghq.com/api/latest/hosts/) - | host_list.tags_by_source[\"Amazon Web Services\"][\"image\"] | string |\n| - /api/v2/security/scanned-assets-metadata | data.attributes.asset.name | string - |\n\n**Container Images**\n\nTo enrich container image data, join the response - from the [Container Images](https://docs.datadoghq.com/api/latest/container-images/) - endpoint with the response from the scanned-assets-metadata endpoint on the - following key fields:\n\n| ENDPOINT | JOIN KEY | TYPE |\n| --- | --- | --- - |\n| [/api/v2/container_images](https://docs.datadoghq.com/api/latest/container-images/) - | `data.attributes.name`@`data.attributes.repo_digest` | string |\n| /api/v2/security/scanned-assets-metadata - | data.attributes.asset.name | string |" + description: |- + Get a list of security scanned assets metadata for an organization. + + ### Pagination + + For the "List Vulnerabilities" endpoint, see the [Pagination section](#pagination). + + ### Filtering + + For the "List Vulnerabilities" endpoint, see the [Filtering section](#filtering). + + ### Metadata + + For the "List Vulnerabilities" endpoint, see the [Metadata section](#metadata). + + ### Related endpoints + + This endpoint returns additional metadata for cloud resources that is not available from the standard resource endpoints. To access a richer dataset, call this endpoint together with the relevant resource endpoint(s) and merge (join) their results using the resource identifier. + + **Hosts** + + To enrich host data, join the response from the [Hosts](https://docs.datadoghq.com/api/latest/hosts/) endpoint with the response from the scanned-assets-metadata endpoint on the following key fields: + + | ENDPOINT | JOIN KEY | TYPE | + | --- | --- | --- | + | [/api/v1/hosts](https://docs.datadoghq.com/api/latest/hosts/) | host_list.host_name | string | + | /api/v2/security/scanned-assets-metadata | data.attributes.asset.name | string | + + **Host Images** + + To enrich host image data, join the response from the [Hosts](https://docs.datadoghq.com/api/latest/hosts/) endpoint with the response from the scanned-assets-metadata endpoint on the following key fields: + + | ENDPOINT | JOIN KEY | TYPE | + | --- | --- | --- | + | [/api/v1/hosts](https://docs.datadoghq.com/api/latest/hosts/) | host_list.tags_by_source["Amazon Web Services"]["image"] | string | + | /api/v2/security/scanned-assets-metadata | data.attributes.asset.name | string | + + **Container Images** + + To enrich container image data, join the response from the [Container Images](https://docs.datadoghq.com/api/latest/container-images/) endpoint with the response from the scanned-assets-metadata endpoint on the following key fields: + + | ENDPOINT | JOIN KEY | TYPE | + | --- | --- | --- | + | [/api/v2/container_images](https://docs.datadoghq.com/api/latest/container-images/) | `data.attributes.name`@`data.attributes.repo_digest` | string | + | /api/v2/security/scanned-assets-metadata | data.attributes.asset.name | string | operationId: ListScannedAssetsMetadata parameters: - - description: Its value must come from the `links` section of the response - of the first request. Do not manually edit it. - example: b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4 - in: query - name: page[token] - required: false - schema: - type: string - - description: The page number to be retrieved. It should be equal to or greater - than 1. - example: 1 - in: query - name: page[number] - required: false - schema: - format: int64 - minimum: 1 - type: integer - - description: The type of the scanned asset. - example: Host - in: query - name: filter[asset.type] - required: false - schema: - $ref: '#/components/schemas/CloudAssetType' - - description: The name of the scanned asset. - example: i-0fc7edef1ab26d7ef - in: query - name: filter[asset.name] - required: false - schema: - type: string - - description: The origin of last success scan. - example: agent - in: query - name: filter[last_success.origin] - required: false - schema: - type: string - - description: The environment of last success scan. - example: prod - in: query - name: filter[last_success.env] - required: false - schema: - type: string + - description: Its value must come from the `links` section of the response of the first request. Do not manually edit it. + example: "b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4" + in: query + name: page[token] + required: false + schema: + type: string + - description: The page number to be retrieved. It should be equal to or greater than 1. + example: 1 + in: query + name: page[number] + required: false + schema: + format: int64 + minimum: 1 + type: integer + - description: The type of the scanned asset. + example: Host + in: query + name: filter[asset.type] + required: false + schema: + $ref: "#/components/schemas/CloudAssetType" + - description: The name of the scanned asset. + example: "i-0fc7edef1ab26d7ef" + in: query + name: filter[asset.name] + required: false + schema: + type: string + - description: The origin of last success scan. + example: "agent" + in: query + name: filter[last_success.origin] + required: false + schema: + type: string + - description: The environment of last success scan. + example: "prod" + in: query + name: filter[last_success.env] + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ScannedAssetsMetadata' + $ref: "#/components/schemas/ScannedAssetsMetadata" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Bad request: The server cannot process the request due to - invalid syntax in the request.' - '403': + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Bad request: The server cannot process the request due to invalid syntax in the request." + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Forbidden: Access denied' - '404': + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Forbidden: Access denied" + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Not found: asset not found' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Not found: asset not found" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: List scanned assets metadata tags: - - Security Monitoring + - "Security Monitoring" x-permission: operator: OR permissions: - - appsec_vm_read - x-unstable: '**Note**: This endpoint is a private preview. - - If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).' + - appsec_vm_read + x-unstable: |- + **Note**: This endpoint is a private preview. + If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9). /api/v2/security/signals/notification_rules: get: description: Returns the list of notification rules for security signals. operationId: GetSignalNotificationRules responses: - '200': - $ref: '#/components/responses/NotificationRulesList' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "200": + $ref: "#/components/responses/NotificationRulesList" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get the list of signal-based notification rules tags: - - Security Monitoring - x-permission: + - Security Monitoring + "x-permission": operator: OR permissions: - - security_monitoring_notification_profiles_read + - security_monitoring_notification_profiles_read post: - description: Create a new notification rule for security signals and return - the created rule. + description: Create a new notification rule for security signals and return the created rule. operationId: CreateSignalNotificationRule requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CreateNotificationRuleParameters' - description: 'The body of the create notification rule request is composed - of the rule type and the rule attributes: - - the rule name, the selectors, the notification targets, and the rule enabled - status.' + $ref: "#/components/schemas/CreateNotificationRuleParameters" + description: |- + The body of the create notification rule request is composed of the rule type and the rule attributes: + the rule name, the selectors, the notification targets, and the rule enabled status. required: true responses: - '201': + "201": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/NotificationRuleResponse' + $ref: "#/components/schemas/NotificationRuleResponse" description: Successfully created the notification rule. - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] summary: Create a new signal-based notification rule tags: - - Security Monitoring + - Security Monitoring x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_notification_profiles_write + - security_monitoring_notification_profiles_write /api/v2/security/signals/notification_rules/{id}: delete: description: Delete a notification rule for security signals. operationId: DeleteSignalNotificationRule parameters: - - description: ID of the notification rule. - in: path - name: id - required: true - schema: - type: string + - description: ID of the notification rule. + in: path + name: id + required: true + schema: + type: string responses: - '204': - description: Rule successfully deleted. - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] + "204": + description: "Rule successfully deleted." + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] summary: Delete a signal-based notification rule tags: - - Security Monitoring - x-permission: + - Security Monitoring + "x-permission": operator: OR permissions: - - security_monitoring_notification_profiles_write + - security_monitoring_notification_profiles_write get: description: Get the details of a notification rule for security signals. operationId: GetSignalNotificationRule parameters: - - description: ID of the notification rule. - in: path - name: id - required: true - schema: - type: string + - description: ID of the notification rule. + in: path + name: id + required: true + schema: + type: string responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/NotificationRuleResponse' + $ref: "#/components/schemas/NotificationRuleResponse" description: Notification rule details. - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] summary: Get details of a signal-based notification rule tags: - - Security Monitoring - x-permission: + - Security Monitoring + "x-permission": operator: OR permissions: - - security_monitoring_notification_profiles_read + - security_monitoring_notification_profiles_read patch: - description: Partially update the notification rule. All fields are optional; - if a field is not provided, it is not updated. + description: "Partially update the notification rule. All fields are optional; if a field is not provided, it is not updated." operationId: PatchSignalNotificationRule parameters: - - description: ID of the notification rule. - in: path - name: id - required: true - schema: - type: string + - description: ID of the notification rule. + in: path + name: id + required: true + schema: + type: string requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/PatchNotificationRuleParameters' + $ref: "#/components/schemas/PatchNotificationRuleParameters" required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/NotificationRuleResponse' + $ref: "#/components/schemas/NotificationRuleResponse" description: Notification rule successfully patched. - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '422': - $ref: '#/components/responses/UnprocessableEntityResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "422": + $ref: "#/components/responses/UnprocessableEntityResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] summary: Patch a signal-based notification rule tags: - - Security Monitoring + - Security Monitoring x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_notification_profiles_write + - security_monitoring_notification_profiles_write /api/v2/security/vulnerabilities: get: - description: "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/vulnerabilities\",\n - \ \"first\": \"https://.../api/v2/security/vulnerabilities?page[number]=1&page[token]=abc\",\n - \ \"last\": \"https://.../api/v2/security/vulnerabilities?page[number]=43&page[token]=abc\",\n - \ \"next\": \"https://.../api/v2/security/vulnerabilities?page[number]=2&page[token]=abc\"\n - \ }\n}\n```\n\n\n- `links.previous` is empty if the first page is requested.\n- - `links.next` is empty if the last page is requested.\n\n#### Token\n\nVulnerabilities - can be created, updated or deleted at any point in time.\n\nUpon the first - request, a token is created to ensure consistency across subsequent paginated - requests.\n\nA token is valid only for 24 hours.\n\n#### First request\n\nWe - consider a request to be the first request when there is no `page[token]` - parameter.\n\nThe response of this first request contains the newly created - token in the `links` section.\n\nThis token can then be used in the subsequent - paginated requests.\n\n*Note: The first request may take longer to complete - than subsequent requests.*\n\n#### Subsequent requests\n\nAny request containing - valid `page[token]` and `page[number]` parameters will be considered a subsequent - request.\n\nIf the `token` is invalid, a `404` response will be returned.\n\nIf - the page `number` is invalid, a `400` response will be returned.\n\nThe returned - `token` is valid for all requests in the pagination sequence. To send paginated - requests in parallel, reuse the same `token` and change only the `page[number]` - parameter.\n\n### Filtering\n\nThe request can include some filter parameters - to filter the data to be retrieved. The format of the filter parameters follows - the [JSON:API format](https://jsonapi.org/format/#fetching-filtering): `filter[$prop_name]`, - where `prop_name` is the property name in the entity being filtered by.\n\nAll - filters can include multiple values, where data will be filtered with an OR - clause: `filter[title]=Title1,Title2` will filter all vulnerabilities where - title is equal to `Title1` OR `Title2`.\n\nString filters are case sensitive.\n\nBoolean - filters accept `true` or `false` as values.\n\nNumber filters must include - an operator as a second filter input: `filter[$prop_name][$operator]`. For - example, for the vulnerabilities endpoint: `filter[cvss.base.score][lte]=8`.\n\nAvailable - operators are: `eq` (==), `lt` (<), `lte` (<=), `gt` (>) and `gte` (>=).\n\n### - Metadata\n\nFollowing [JSON:API format](https://jsonapi.org/format/#document-meta), - object including non-standard meta-information.\n\nThis endpoint includes - the meta member in the response. For more details on each of the properties - included in this section, check the endpoints response tables.\n\n```JSON\n{\n - \ \"data\": [...],\n \"meta\": {\n \"total\": 1500,\n \"count\": 18732,\n - \ \"token\": \"some_token\"\n },\n \"links\": {...}\n}\n```\n### Extensions\n\nRequests - may include extensions to modify the behavior of the requested endpoint. The - filter parameters follow the [JSON:API format](https://jsonapi.org/extensions/#extensions) - format: `ext:$extension_name`, where `extension_name` is the name of the modifier - that is being applied.\n\nExtensions can only include one value: `ext:modifier=value`." + description: |- + Get a list of vulnerabilities. + + ### Pagination + + Pagination 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. + + This endpoint will return paginated responses. The pages are stored in the links section of the response: + + ```JSON + { + "data": [...], + "meta": {...}, + "links": { + "self": "https://.../api/v2/security/vulnerabilities", + "first": "https://.../api/v2/security/vulnerabilities?page[number]=1&page[token]=abc", + "last": "https://.../api/v2/security/vulnerabilities?page[number]=43&page[token]=abc", + "next": "https://.../api/v2/security/vulnerabilities?page[number]=2&page[token]=abc" + } + } + ``` + + + - `links.previous` is empty if the first page is requested. + - `links.next` is empty if the last page is requested. + + #### Token + + Vulnerabilities can be created, updated or deleted at any point in time. + + Upon the first request, a token is created to ensure consistency across subsequent paginated requests. + + A token is valid only for 24 hours. + + #### First request + + We consider a request to be the first request when there is no `page[token]` parameter. + + The response of this first request contains the newly created token in the `links` section. + + This token can then be used in the subsequent paginated requests. + + *Note: The first request may take longer to complete than subsequent requests.* + + #### Subsequent requests + + Any request containing valid `page[token]` and `page[number]` parameters will be considered a subsequent request. + + If the `token` is invalid, a `404` response will be returned. + + If the page `number` is invalid, a `400` response will be returned. + + The returned `token` is valid for all requests in the pagination sequence. To send paginated requests in parallel, reuse the same `token` and change only the `page[number]` parameter. + + ### Filtering + + The request can include some filter parameters to filter the data to be retrieved. The format of the filter parameters follows the [JSON:API format](https://jsonapi.org/format/#fetching-filtering): `filter[$prop_name]`, where `prop_name` is the property name in the entity being filtered by. + + All filters can include multiple values, where data will be filtered with an OR clause: `filter[title]=Title1,Title2` will filter all vulnerabilities where title is equal to `Title1` OR `Title2`. + + String filters are case sensitive. + + Boolean filters accept `true` or `false` as values. + + Number filters must include an operator as a second filter input: `filter[$prop_name][$operator]`. For example, for the vulnerabilities endpoint: `filter[cvss.base.score][lte]=8`. + + Available operators are: `eq` (==), `lt` (<), `lte` (<=), `gt` (>) and `gte` (>=). + + ### Metadata + + Following [JSON:API format](https://jsonapi.org/format/#document-meta), object including non-standard meta-information. + + This endpoint includes the meta member in the response. For more details on each of the properties included in this section, check the endpoints response tables. + + ```JSON + { + "data": [...], + "meta": { + "total": 1500, + "count": 18732, + "token": "some_token" + }, + "links": {...} + } + ``` + ### Extensions + + Requests may include extensions to modify the behavior of the requested endpoint. The filter parameters follow the [JSON:API format](https://jsonapi.org/extensions/#extensions) format: `ext:$extension_name`, where `extension_name` is the name of the modifier that is being applied. + + Extensions can only include one value: `ext:modifier=value`. operationId: ListVulnerabilities parameters: - - description: Its value must come from the `links` section of the response - of the first request. Do not manually edit it. - example: b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4 - in: query - name: page[token] - required: false - schema: - type: string - - description: The page number to be retrieved. It should be equal or greater - than `1` - example: 1 - in: query - name: page[number] - required: false - schema: - format: int64 - minimum: 1 - type: integer - - description: Filter by vulnerability type. - example: WeakCipher - in: query - name: filter[type] - required: false - schema: - $ref: '#/components/schemas/VulnerabilityType' - - description: Filter by vulnerability base (i.e. from the original advisory) - severity score. - example: 5.5 - in: query - name: filter[cvss.base.score][`$op`] - required: false - schema: - format: double - maximum: 10 - minimum: 0 - type: number - - description: Filter by vulnerability base severity. - example: Medium - in: query - name: filter[cvss.base.severity] - required: false - schema: - $ref: '#/components/schemas/VulnerabilitySeverity' - - description: Filter by vulnerability base CVSS vector. - example: CVSS:3.0/AV:L/AC:L/PR:L/UI:N/S:U/C:N/I:N/A:H - in: query - name: filter[cvss.base.vector] - required: false - schema: - type: string - - description: Filter by vulnerability Datadog severity score. - example: 4.3 - in: query - name: filter[cvss.datadog.score][`$op`] - required: false - schema: - format: double - maximum: 10 - minimum: 0 - type: number - - description: Filter by vulnerability Datadog severity. - example: Medium - in: query - name: filter[cvss.datadog.severity] - required: false - schema: - $ref: '#/components/schemas/VulnerabilitySeverity' - - description: Filter by vulnerability Datadog CVSS vector. - example: 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 - in: query - name: filter[cvss.datadog.vector] - required: false - schema: - type: string - - description: Filter by the status of the vulnerability. - example: Open - in: query - name: filter[status] - required: false - schema: - $ref: '#/components/schemas/VulnerabilityStatus' - - description: Filter by the tool of the vulnerability. - example: SCA - in: query - name: filter[tool] - required: false - schema: - $ref: '#/components/schemas/VulnerabilityTool' - - description: Filter by library name. - example: linux-aws-5.15 - in: query - name: filter[library.name] - required: false - schema: - type: string - - description: Filter by library version. - example: 5.15.0 - in: query - name: filter[library.version] - required: false - schema: - type: string - - description: Filter by advisory ID. - example: CVE-2023-0615 - in: query - name: filter[advisory.id] - required: false - schema: - type: string - - description: Filter by exploitation probability. - example: false - in: query - name: filter[risks.exploitation_probability] - required: false - schema: - type: boolean - - description: Filter by POC exploit availability. - example: false - in: query - name: filter[risks.poc_exploit_available] - required: false - schema: - type: boolean - - description: Filter by public exploit availability. - example: false - in: query - name: filter[risks.exploit_available] - required: false - schema: - type: boolean - - description: Filter by vulnerability [EPSS](https://www.first.org/epss/) severity - score. - example: 0.00042 - in: query - name: filter[risks.epss.score][`$op`] - required: false - schema: - format: double - maximum: 1 - minimum: 0 - type: number - - description: Filter by vulnerability [EPSS](https://www.first.org/epss/) severity. - example: Low - in: query - name: filter[risks.epss.severity] - required: false - schema: - $ref: '#/components/schemas/VulnerabilitySeverity' - - description: Filter by language. - example: ubuntu - in: query - name: filter[language] - required: false - schema: - type: string - - description: Filter by ecosystem. - example: Deb - in: query - name: filter[ecosystem] - required: false - schema: - $ref: '#/components/schemas/VulnerabilityEcosystem' - - description: Filter by vulnerability location. - example: com.example.Class:100 - in: query - name: filter[code_location.location] - required: false - schema: - type: string - - description: Filter by vulnerability file path. - example: src/Class.java:100 - in: query - name: filter[code_location.file_path] - required: false - schema: - type: string - - description: Filter by method. - example: FooBar - in: query - name: filter[code_location.method] - required: false - schema: - type: string - - description: Filter by fix availability. - example: false - in: query - name: filter[fix_available] - required: false - schema: - type: boolean - - description: Filter by vulnerability `repo_digest` (when the vulnerability - is related to `Image` asset). - example: sha256:0ae7da091191787229d321e3638e39c319a97d6e20f927d465b519d699215bf7 - in: query - name: filter[repo_digests] - required: false - schema: - type: string - - description: Filter by origin. - example: agentless-scanner - in: query - name: filter[origin] - required: false - schema: - type: string - - description: Filter for whether the vulnerability affects a running kernel - (for vulnerabilities related to a `Host` asset). - example: true - in: query - name: filter[running_kernel] - required: false - schema: - type: boolean - - description: Filter by asset name. This field supports the usage of wildcards - (*). - example: datadog-agent - in: query - name: filter[asset.name] - required: false - schema: - type: string - - description: Filter by asset type. - example: Host - in: query - name: filter[asset.type] - required: false - schema: - $ref: '#/components/schemas/AssetType' - - description: Filter by the first version of the asset this vulnerability has - been detected on. - example: v1.15.1 - in: query - name: filter[asset.version.first] - required: false - schema: - type: string - - description: Filter by the last version of the asset this vulnerability has - been detected on. - example: v1.15.1 - in: query - name: filter[asset.version.last] - required: false - schema: - type: string - - description: Filter by the repository url associated to the asset. - example: github.com/DataDog/datadog-agent.git - in: query - name: filter[asset.repository_url] - required: false - schema: - type: string - - description: Filter whether the asset is in production or not. - example: false - in: query - name: filter[asset.risks.in_production] - required: false - schema: - type: boolean - - description: Filter whether the asset is under attack or not. - example: false - in: query - name: filter[asset.risks.under_attack] - required: false - schema: - type: boolean - - description: Filter whether the asset is publicly accessible or not. - example: false - in: query - name: filter[asset.risks.is_publicly_accessible] - required: false - schema: - type: boolean - - description: Filter whether the asset is publicly accessible or not. - example: false - in: query - name: filter[asset.risks.has_privileged_access] - required: false - schema: - type: boolean - - description: Filter whether the asset has access to sensitive data or not. - example: false - in: query - name: filter[asset.risks.has_access_to_sensitive_data] - required: false - schema: - type: boolean - - description: Filter by asset environments. - example: staging - in: query - name: filter[asset.environments] - required: false - schema: - type: string - - description: Filter by asset teams. - example: compute - in: query - name: filter[asset.teams] - required: false - schema: - type: string - - description: Filter by asset architecture. - example: arm64 - in: query - name: filter[asset.arch] - required: false - schema: - type: string - - description: Filter by asset operating system name. - example: ubuntu - in: query - name: filter[asset.operating_system.name] - required: false - schema: - type: string - - description: Filter by asset operating system version. - example: '24.04' - in: query - name: filter[asset.operating_system.version] - required: false - schema: - type: string + - description: Its value must come from the `links` section of the response of the first request. Do not manually edit it. + example: "b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4" + in: query + name: page[token] + required: false + schema: + type: string + - description: The page number to be retrieved. It should be equal or greater than `1` + example: 1 + in: query + name: page[number] + required: false + schema: + format: int64 + minimum: 1 + type: integer + - description: Filter by vulnerability type. + example: WeakCipher + in: query + name: filter[type] + required: false + schema: + $ref: "#/components/schemas/VulnerabilityType" + - description: Filter by vulnerability base (i.e. from the original advisory) severity score. + example: 5.5 + in: query + name: filter[cvss.base.score][`$op`] + required: false + schema: + format: double + maximum: 10 + minimum: 0 + type: number + - description: Filter by vulnerability base severity. + example: Medium + in: query + name: filter[cvss.base.severity] + required: false + schema: + $ref: "#/components/schemas/VulnerabilitySeverity" + - description: Filter by vulnerability base CVSS vector. + example: "CVSS:3.0/AV:L/AC:L/PR:L/UI:N/S:U/C:N/I:N/A:H" + in: query + name: filter[cvss.base.vector] + required: false + schema: + type: string + - description: Filter by vulnerability Datadog severity score. + example: 4.3 + in: query + name: filter[cvss.datadog.score][`$op`] + required: false + schema: + format: double + maximum: 10 + minimum: 0 + type: number + - description: Filter by vulnerability Datadog severity. + example: Medium + in: query + name: filter[cvss.datadog.severity] + required: false + schema: + $ref: "#/components/schemas/VulnerabilitySeverity" + - description: Filter by vulnerability Datadog CVSS vector. + example: "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" + in: query + name: filter[cvss.datadog.vector] + required: false + schema: + type: string + - description: Filter by the status of the vulnerability. + example: Open + in: query + name: filter[status] + required: false + schema: + $ref: "#/components/schemas/VulnerabilityStatus" + - description: Filter by the tool of the vulnerability. + example: SCA + in: query + name: filter[tool] + required: false + schema: + $ref: "#/components/schemas/VulnerabilityTool" + - description: Filter by library name. + example: linux-aws-5.15 + in: query + name: filter[library.name] + required: false + schema: + type: string + - description: Filter by library version. + example: 5.15.0 + in: query + name: filter[library.version] + required: false + schema: + type: string + - description: Filter by advisory ID. + example: CVE-2023-0615 + in: query + name: filter[advisory.id] + required: false + schema: + type: string + - description: Filter by exploitation probability. + example: false + in: query + name: filter[risks.exploitation_probability] + required: false + schema: + type: boolean + - description: Filter by POC exploit availability. + example: false + in: query + name: filter[risks.poc_exploit_available] + required: false + schema: + type: boolean + - description: Filter by public exploit availability. + example: false + in: query + name: filter[risks.exploit_available] + required: false + schema: + type: boolean + - description: Filter by vulnerability [EPSS](https://www.first.org/epss/) severity score. + example: 0.00042 + in: query + name: filter[risks.epss.score][`$op`] + required: false + schema: + format: double + maximum: 1 + minimum: 0 + type: number + - description: Filter by vulnerability [EPSS](https://www.first.org/epss/) severity. + example: Low + in: query + name: filter[risks.epss.severity] + required: false + schema: + $ref: "#/components/schemas/VulnerabilitySeverity" + - description: Filter by language. + example: ubuntu + in: query + name: filter[language] + required: false + schema: + type: string + - description: Filter by ecosystem. + example: Deb + in: query + name: filter[ecosystem] + required: false + schema: + $ref: "#/components/schemas/VulnerabilityEcosystem" + - description: Filter by vulnerability location. + example: "com.example.Class:100" + in: query + name: filter[code_location.location] + required: false + schema: + type: string + - description: Filter by vulnerability file path. + example: "src/Class.java:100" + in: query + name: filter[code_location.file_path] + required: false + schema: + type: string + - description: Filter by method. + example: FooBar + in: query + name: filter[code_location.method] + required: false + schema: + type: string + - description: Filter by fix availability. + example: false + in: query + name: filter[fix_available] + required: false + schema: + type: boolean + - description: Filter by vulnerability `repo_digest` (when the vulnerability is related to `Image` asset). + example: "sha256:0ae7da091191787229d321e3638e39c319a97d6e20f927d465b519d699215bf7" + in: query + name: filter[repo_digests] + required: false + schema: + type: string + - description: Filter by origin. + example: agentless-scanner + in: query + name: filter[origin] + required: false + schema: + type: string + - description: Filter for whether the vulnerability affects a running kernel (for vulnerabilities related to a `Host` asset). + example: true + in: query + name: filter[running_kernel] + required: false + schema: + type: boolean + - description: Filter by asset name. This field supports the usage of wildcards (*). + example: datadog-agent + in: query + name: filter[asset.name] + required: false + schema: + type: string + - description: Filter by asset type. + example: Host + in: query + name: filter[asset.type] + required: false + schema: + $ref: "#/components/schemas/AssetType" + - description: Filter by the first version of the asset this vulnerability has been detected on. + example: v1.15.1 + in: query + name: filter[asset.version.first] + required: false + schema: + type: string + - description: Filter by the last version of the asset this vulnerability has been detected on. + example: v1.15.1 + in: query + name: filter[asset.version.last] + required: false + schema: + type: string + - description: Filter by the repository url associated to the asset. + example: github.com/DataDog/datadog-agent.git + in: query + name: filter[asset.repository_url] + required: false + schema: + type: string + - description: Filter whether the asset is in production or not. + example: false + in: query + name: filter[asset.risks.in_production] + required: false + schema: + type: boolean + - description: Filter whether the asset is under attack or not. + example: false + in: query + name: filter[asset.risks.under_attack] + required: false + schema: + type: boolean + - description: Filter whether the asset is publicly accessible or not. + example: false + in: query + name: filter[asset.risks.is_publicly_accessible] + required: false + schema: + type: boolean + - description: Filter whether the asset is publicly accessible or not. + example: false + in: query + name: filter[asset.risks.has_privileged_access] + required: false + schema: + type: boolean + - description: Filter whether the asset has access to sensitive data or not. + example: false + in: query + name: filter[asset.risks.has_access_to_sensitive_data] + required: false + schema: + type: boolean + - description: Filter by asset environments. + example: staging + in: query + name: filter[asset.environments] + required: false + schema: + type: string + - description: Filter by asset teams. + example: compute + in: query + name: filter[asset.teams] + required: false + schema: + type: string + - description: Filter by asset architecture. + example: arm64 + in: query + name: filter[asset.arch] + required: false + schema: + type: string + - description: Filter by asset operating system name. + example: ubuntu + in: query + name: filter[asset.operating_system.name] + required: false + schema: + type: string + - description: Filter by asset operating system version. + example: "24.04" + in: query + name: filter[asset.operating_system.version] + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListVulnerabilitiesResponse' + $ref: "#/components/schemas/ListVulnerabilitiesResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Bad request: The server cannot process the request due to - invalid syntax in the request.' - '403': + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Bad request: The server cannot process the request due to invalid syntax in the request." + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Forbidden: Access denied' - '404': + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Forbidden: Access denied" + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Not found: There is no request associated with the provided - token.' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Not found: There is no request associated with the provided token." + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: List vulnerabilities tags: - - Security Monitoring + - "Security Monitoring" x-permission: operator: OR permissions: - - appsec_vm_read - x-unstable: '**Note**: This endpoint is a private preview. - - If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).' + - appsec_vm_read + x-unstable: |- + **Note**: This endpoint is a private preview. + If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9). /api/v2/security/vulnerabilities/notification_rules: get: description: Returns the list of notification rules for security vulnerabilities. operationId: GetVulnerabilityNotificationRules responses: - '200': - $ref: '#/components/responses/NotificationRulesList' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "200": + $ref: "#/components/responses/NotificationRulesList" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: Get the list of vulnerability notification rules tags: - - Security Monitoring - x-permission: + - Security Monitoring + "x-permission": operator: OR permissions: - - security_monitoring_notification_profiles_read + - security_monitoring_notification_profiles_read post: - description: Create a new notification rule for security vulnerabilities and - return the created rule. + description: Create a new notification rule for security vulnerabilities and return the created rule. operationId: CreateVulnerabilityNotificationRule requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CreateNotificationRuleParameters' - description: 'The body of the create notification rule request is composed - of the rule type and the rule attributes: - - the rule name, the selectors, the notification targets, and the rule enabled - status.' + $ref: "#/components/schemas/CreateNotificationRuleParameters" + description: |- + The body of the create notification rule request is composed of the rule type and the rule attributes: + the rule name, the selectors, the notification targets, and the rule enabled status. required: true responses: - '201': + "201": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/NotificationRuleResponse' + $ref: "#/components/schemas/NotificationRuleResponse" description: Successfully created the notification rule. - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] summary: Create a new vulnerability-based notification rule tags: - - Security Monitoring + - Security Monitoring x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_notification_profiles_write + - security_monitoring_notification_profiles_write /api/v2/security/vulnerabilities/notification_rules/{id}: delete: description: Delete a notification rule for security vulnerabilities. operationId: DeleteVulnerabilityNotificationRule parameters: - - description: ID of the notification rule. - in: path - name: id - required: true - schema: - type: string + - description: ID of the notification rule. + in: path + name: id + required: true + schema: + type: string responses: - '204': - description: Rule successfully deleted. - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] + "204": + description: "Rule successfully deleted." + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] summary: Delete a vulnerability-based notification rule tags: - - Security Monitoring - x-permission: + - Security Monitoring + "x-permission": operator: OR permissions: - - security_monitoring_notification_profiles_write + - security_monitoring_notification_profiles_write get: description: Get the details of a notification rule for security vulnerabilities. operationId: GetVulnerabilityNotificationRule parameters: - - description: ID of the notification rule. - in: path - name: id - required: true - schema: - type: string + - description: ID of the notification rule. + in: path + name: id + required: true + schema: + type: string responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/NotificationRuleResponse' + $ref: "#/components/schemas/NotificationRuleResponse" description: Notification rule details. - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] summary: Get details of a vulnerability notification rule tags: - - Security Monitoring - x-permission: + - Security Monitoring + "x-permission": operator: OR permissions: - - security_monitoring_notification_profiles_read + - security_monitoring_notification_profiles_read patch: - description: Partially update the notification rule. All fields are optional; - if a field is not provided, it is not updated. + description: "Partially update the notification rule. All fields are optional; if a field is not provided, it is not updated." operationId: PatchVulnerabilityNotificationRule parameters: - - description: ID of the notification rule. - in: path - name: id - required: true - schema: - type: string + - description: ID of the notification rule. + in: path + name: id + required: true + schema: + type: string requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/PatchNotificationRuleParameters' + $ref: "#/components/schemas/PatchNotificationRuleParameters" required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/NotificationRuleResponse' + $ref: "#/components/schemas/NotificationRuleResponse" description: Notification rule successfully patched. - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '422': - $ref: '#/components/responses/UnprocessableEntityResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "422": + $ref: "#/components/responses/UnprocessableEntityResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] summary: Patch a vulnerability-based notification rule tags: - - Security Monitoring + - Security Monitoring x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_notification_profiles_write + - security_monitoring_notification_profiles_write /api/v2/security/vulnerable-assets: get: - description: 'Get a list of vulnerable assets. - + description: |- + Get a list of vulnerable assets. ### Pagination - - Please review the [Pagination section for the "List Vulnerabilities"](#pagination) - endpoint. - + Please review the [Pagination section for the "List Vulnerabilities"](#pagination) endpoint. ### Filtering - - Please review the [Filtering section for the "List Vulnerabilities"](#filtering) - endpoint. - + Please review the [Filtering section for the "List Vulnerabilities"](#filtering) endpoint. ### Metadata - - Please review the [Metadata section for the "List Vulnerabilities"](#metadata) - endpoint.' + Please review the [Metadata section for the "List Vulnerabilities"](#metadata) endpoint. operationId: ListVulnerableAssets parameters: - - description: Its value must come from the `links` section of the response - of the first request. Do not manually edit it. - example: b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4 - in: query - name: page[token] - required: false - schema: - type: string - - description: The page number to be retrieved. It should be equal or greater - than `1` - example: 1 - in: query - name: page[number] - required: false - schema: - format: int64 - minimum: 1 - type: integer - - description: Filter by name. This field supports the usage of wildcards (*). - example: datadog-agent - in: query - name: filter[name] - required: false - schema: - type: string - - description: Filter by type. - example: Host - in: query - name: filter[type] - required: false - schema: - $ref: '#/components/schemas/AssetType' - - description: Filter by the first version of the asset since it has been vulnerable. - example: v1.15.1 - in: query - name: filter[version.first] - required: false - schema: - type: string - - description: Filter by the last detected version of the asset. - example: v1.15.1 - in: query - name: filter[version.last] - required: false - schema: - type: string - - description: Filter by the repository url associated to the asset. - example: github.com/DataDog/datadog-agent.git - in: query - name: filter[repository_url] - required: false - schema: - type: string - - description: Filter whether the asset is in production or not. - example: false - in: query - name: filter[risks.in_production] - required: false - schema: - type: boolean - - description: Filter whether the asset (Service) is under attack or not. - example: false - in: query - name: filter[risks.under_attack] - required: false - schema: - type: boolean - - description: Filter whether the asset (Host) is publicly accessible or not. - example: false - in: query - name: filter[risks.is_publicly_accessible] - required: false - schema: - type: boolean - - description: Filter whether the asset (Host) has privileged access or not. - example: false - in: query - name: filter[risks.has_privileged_access] - required: false - schema: - type: boolean - - description: Filter whether the asset (Host) has access to sensitive data - or not. - example: false - in: query - name: filter[risks.has_access_to_sensitive_data] - required: false - schema: - type: boolean - - description: Filter by environment. - example: staging - in: query - name: filter[environments] - required: false - schema: - type: string - - description: Filter by teams. - example: compute - in: query - name: filter[teams] - required: false - schema: - type: string - - description: Filter by architecture. - example: arm64 - in: query - name: filter[arch] - required: false - schema: - type: string - - description: Filter by operating system name. - example: ubuntu - in: query - name: filter[operating_system.name] - required: false - schema: - type: string - - description: Filter by operating system version. - example: '24.04' - in: query - name: filter[operating_system.version] - required: false - schema: - type: string + - description: Its value must come from the `links` section of the response of the first request. Do not manually edit it. + example: "b82cef018aab81ed1d4bb4xb35xxfc065da7efa685fbcecdbd338f3015e3afabbbfa3a911b4984_721ee28a-zecb-4e45-9960-c42065b574f4" + in: query + name: page[token] + required: false + schema: + type: string + - description: The page number to be retrieved. It should be equal or greater than `1` + example: 1 + in: query + name: page[number] + required: false + schema: + format: int64 + minimum: 1 + type: integer + - description: Filter by name. This field supports the usage of wildcards (*). + example: datadog-agent + in: query + name: filter[name] + required: false + schema: + type: string + - description: Filter by type. + example: Host + in: query + name: filter[type] + required: false + schema: + $ref: "#/components/schemas/AssetType" + - description: Filter by the first version of the asset since it has been vulnerable. + example: v1.15.1 + in: query + name: filter[version.first] + required: false + schema: + type: string + - description: Filter by the last detected version of the asset. + example: v1.15.1 + in: query + name: filter[version.last] + required: false + schema: + type: string + - description: Filter by the repository url associated to the asset. + example: github.com/DataDog/datadog-agent.git + in: query + name: filter[repository_url] + required: false + schema: + type: string + - description: Filter whether the asset is in production or not. + example: false + in: query + name: filter[risks.in_production] + required: false + schema: + type: boolean + - description: Filter whether the asset (Service) is under attack or not. + example: false + in: query + name: filter[risks.under_attack] + required: false + schema: + type: boolean + - description: Filter whether the asset (Host) is publicly accessible or not. + example: false + in: query + name: filter[risks.is_publicly_accessible] + required: false + schema: + type: boolean + - description: Filter whether the asset (Host) has privileged access or not. + example: false + in: query + name: filter[risks.has_privileged_access] + required: false + schema: + type: boolean + - description: Filter whether the asset (Host) has access to sensitive data or not. + example: false + in: query + name: filter[risks.has_access_to_sensitive_data] + required: false + schema: + type: boolean + - description: Filter by environment. + example: staging + in: query + name: filter[environments] + required: false + schema: + type: string + - description: Filter by teams. + example: compute + in: query + name: filter[teams] + required: false + schema: + type: string + - description: Filter by architecture. + example: arm64 + in: query + name: filter[arch] + required: false + schema: + type: string + - description: Filter by operating system name. + example: ubuntu + in: query + name: filter[operating_system.name] + required: false + schema: + type: string + - description: Filter by operating system version. + example: "24.04" + in: query + name: filter[operating_system.version] + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListVulnerableAssetsResponse' + $ref: "#/components/schemas/ListVulnerableAssetsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Bad request: The server cannot process the request due to - invalid syntax in the request.' - '403': + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Bad request: The server cannot process the request due to invalid syntax in the request." + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Forbidden: Access denied' - '404': + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Forbidden: Access denied" + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' - description: 'Not found: There is no request associated with the provided - token.' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: "Not found: There is no request associated with the provided token." + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] summary: List vulnerable assets tags: - - Security Monitoring + - "Security Monitoring" x-permission: operator: OR permissions: - - appsec_vm_read - x-unstable: '**Note**: This endpoint is a private preview. - - If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9).' + - appsec_vm_read + x-unstable: |- + **Note**: This endpoint is a private preview. + If you are interested in accessing this API, [fill out this form](https://forms.gle/kMYC1sDr6WDUBDsx9). /api/v2/security_monitoring/cloud_workload_security/agent_rules: get: - description: 'Get the list of agent rules. - + description: |- + Get the list of agent rules. - **Note**: This endpoint should only be used for the Government (US1-FED) site.' + **Note**: This endpoint should only be used for the Government (US1-FED) site. operationId: ListCloudWorkloadSecurityAgentRules responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRulesListResponse' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRulesListResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get all Workload Protection agent rules (US1-FED) - tags: - - CSM Threats - x-permission: + tags: ["CSM Threats"] + "x-permission": operator: OR permissions: - - security_monitoring_cws_agent_rules_read + - security_monitoring_cws_agent_rules_read post: - description: 'Create a new agent rule with the given parameters. - + description: |- + Create a new agent rule with the given parameters. - **Note**: This endpoint should only be used for the Government (US1-FED) site.' + **Note**: This endpoint should only be used for the Government (US1-FED) site. operationId: CreateCloudWorkloadSecurityAgentRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest' - description: The definition of the new agent rule + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest" + description: "The definition of the new agent rule" required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a Workload Protection agent rule (US1-FED) - tags: - - CSM Threats + tags: ["CSM Threats"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_cws_agent_rules_write + - security_monitoring_cws_agent_rules_write /api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}: delete: - description: 'Delete a specific agent rule. + description: |- + Delete a specific agent rule. - - **Note**: This endpoint should only be used for the Government (US1-FED) site.' + **Note**: This endpoint should only be used for the Government (US1-FED) site. operationId: DeleteCloudWorkloadSecurityAgentRule parameters: - - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' + - $ref: "#/components/parameters/CloudWorkloadSecurityAgentRuleID" responses: - '204': + "204": description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a Workload Protection agent rule (US1-FED) - tags: - - CSM Threats - x-permission: + tags: ["CSM Threats"] + "x-permission": operator: OR permissions: - - security_monitoring_cws_agent_rules_write + - security_monitoring_cws_agent_rules_write get: - description: 'Get the details of a specific agent rule. + description: |- + Get the details of a specific agent rule. - - **Note**: This endpoint should only be used for the Government (US1-FED) site.' + **Note**: This endpoint should only be used for the Government (US1-FED) site. operationId: GetCloudWorkloadSecurityAgentRule parameters: - - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' + - $ref: "#/components/parameters/CloudWorkloadSecurityAgentRuleID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a Workload Protection agent rule (US1-FED) - tags: - - CSM Threats - x-permission: + tags: ["CSM Threats"] + "x-permission": operator: OR permissions: - - security_monitoring_cws_agent_rules_read + - security_monitoring_cws_agent_rules_read patch: - description: 'Update a specific agent rule. - + description: |- + Update a specific agent rule. Returns the agent rule object when the request is successful. - - **Note**: This endpoint should only be used for the Government (US1-FED) site.' + **Note**: This endpoint should only be used for the Government (US1-FED) site. operationId: UpdateCloudWorkloadSecurityAgentRule parameters: - - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' + - $ref: "#/components/parameters/CloudWorkloadSecurityAgentRuleID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest' - description: New definition of the agent rule + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest" + description: "New definition of the agent rule" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse' + $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConcurrentModificationResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConcurrentModificationResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update a Workload Protection agent rule (US1-FED) - tags: - - CSM Threats + tags: ["CSM Threats"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_cws_agent_rules_write + - security_monitoring_cws_agent_rules_write /api/v2/security_monitoring/configuration/critical_assets: get: description: Get the list of all critical assets. operationId: ListSecurityMonitoringCriticalAssets parameters: - - description: Query string. - in: query - name: query - required: false - schema: - type: string + - description: Query string. + in: query + name: query + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetsResponse' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetsResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_critical_assets_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_critical_assets_read summary: Get all critical assets tags: - - Security Monitoring + - Security Monitoring post: description: Create a new critical asset. operationId: CreateSecurityMonitoringCriticalAsset @@ -102238,370 +97971,361 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetCreateRequest' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetCreateRequest" description: The definition of the new critical asset. required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetResponse' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_critical_assets_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_critical_assets_write summary: Create a critical asset tags: - - Security Monitoring + - Security Monitoring x-codegen-request-body-name: body /api/v2/security_monitoring/configuration/critical_assets/rules/{rule_id}: get: - description: Get the list of critical assets that affect a specific existing - rule by the rule's ID. + description: Get the list of critical assets that affect a specific existing rule by the rule's ID. operationId: GetCriticalAssetsAffectingRule parameters: - - $ref: '#/components/parameters/SecurityMonitoringRuleID' + - $ref: "#/components/parameters/SecurityMonitoringRuleID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetsResponse' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetsResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_critical_assets_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_critical_assets_read summary: Get critical assets affecting a specific rule tags: - - Security Monitoring + - Security Monitoring /api/v2/security_monitoring/configuration/critical_assets/{critical_asset_id}: delete: description: Delete a specific critical asset. operationId: DeleteSecurityMonitoringCriticalAsset parameters: - - $ref: '#/components/parameters/SecurityMonitoringCriticalAssetID' + - $ref: "#/components/parameters/SecurityMonitoringCriticalAssetID" responses: - '204': + "204": description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_critical_assets_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_critical_assets_write summary: Delete a critical asset tags: - - Security Monitoring + - Security Monitoring get: description: Get the details of a specific critical asset. operationId: GetSecurityMonitoringCriticalAsset parameters: - - $ref: '#/components/parameters/SecurityMonitoringCriticalAssetID' + - $ref: "#/components/parameters/SecurityMonitoringCriticalAssetID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetResponse' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_critical_assets_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_critical_assets_read summary: Get a critical asset tags: - - Security Monitoring + - Security Monitoring patch: description: Update a specific critical asset. operationId: UpdateSecurityMonitoringCriticalAsset parameters: - - $ref: '#/components/parameters/SecurityMonitoringCriticalAssetID' + - $ref: "#/components/parameters/SecurityMonitoringCriticalAssetID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetUpdateRequest' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetUpdateRequest" description: New definition of the critical asset. Supports partial updates. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringCriticalAssetResponse' + $ref: "#/components/schemas/SecurityMonitoringCriticalAssetResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConcurrentModificationResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConcurrentModificationResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_critical_assets_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_critical_assets_write summary: Update a critical asset tags: - - Security Monitoring + - Security Monitoring /api/v2/security_monitoring/configuration/security_filters: get: description: Get the list of configured security filters with their definitions. operationId: ListSecurityFilters responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityFiltersResponse' + $ref: "#/components/schemas/SecurityFiltersResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_filters_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_filters_read summary: Get all security filters - tags: - - Security Monitoring - x-permission: + tags: ["Security Monitoring"] + "x-permission": operator: OR permissions: - - security_monitoring_filters_read + - security_monitoring_filters_read post: - description: 'Create a security filter. - + description: |- + Create a security filter. See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/) - - for more examples.' + for more examples. operationId: CreateSecurityFilter requestBody: content: application/json: schema: - $ref: '#/components/schemas/SecurityFilterCreateRequest' + $ref: "#/components/schemas/SecurityFilterCreateRequest" description: The definition of the new security filter. required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityFilterResponse' + $ref: "#/components/schemas/SecurityFilterResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_filters_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_filters_write summary: Create a security filter - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_filters_write + - security_monitoring_filters_write /api/v2/security_monitoring/configuration/security_filters/{security_filter_id}: delete: description: Delete a specific security filter. operationId: DeleteSecurityFilter parameters: - - $ref: '#/components/parameters/SecurityFilterID' + - $ref: "#/components/parameters/SecurityFilterID" responses: - '204': + "204": description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_filters_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_filters_write summary: Delete a security filter - tags: - - Security Monitoring - x-permission: + tags: ["Security Monitoring"] + "x-permission": operator: OR permissions: - - security_monitoring_filters_write + - security_monitoring_filters_write get: - description: 'Get the details of a specific security filter. - + description: |- + Get the details of a specific security filter. See the [security filter guide](https://docs.datadoghq.com/security_platform/guide/how-to-setup-security-filters-using-security-monitoring-api/) - - for more examples.' + for more examples. operationId: GetSecurityFilter parameters: - - $ref: '#/components/parameters/SecurityFilterID' + - $ref: "#/components/parameters/SecurityFilterID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityFilterResponse' + $ref: "#/components/schemas/SecurityFilterResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_filters_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_filters_read summary: Get a security filter - tags: - - Security Monitoring - x-permission: + tags: ["Security Monitoring"] + "x-permission": operator: OR permissions: - - security_monitoring_filters_read + - security_monitoring_filters_read patch: - description: 'Update a specific security filter. - - Returns the security filter object when the request is successful.' + description: |- + Update a specific security filter. + Returns the security filter object when the request is successful. operationId: UpdateSecurityFilter parameters: - - $ref: '#/components/parameters/SecurityFilterID' + - $ref: "#/components/parameters/SecurityFilterID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SecurityFilterUpdateRequest' + $ref: "#/components/schemas/SecurityFilterUpdateRequest" description: New definition of the security filter. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityFilterResponse' + $ref: "#/components/schemas/SecurityFilterResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConcurrentModificationResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConcurrentModificationResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_filters_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_filters_write summary: Update a security filter - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_filters_write + - security_monitoring_filters_write /api/v2/security_monitoring/configuration/suppressions: get: description: Get the list of all suppression rules. operationId: ListSecurityMonitoringSuppressions parameters: - - description: Query string. - in: query - name: query - required: false - schema: - type: string - - description: Attribute used to sort the list of suppression rules. Prefix - with `-` to sort in descending order. - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/SecurityMonitoringSuppressionSort' - - description: Size for a given page. Use `-1` to return all items. - in: query - name: page[size] - required: false - schema: - default: -1 - example: 10 - format: int64 - type: integer - - $ref: '#/components/parameters/PageNumber' + - description: Query string. + in: query + name: query + required: false + schema: + type: string + - description: Attribute used to sort the list of suppression rules. Prefix with `-` to sort in descending order. + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/SecurityMonitoringSuppressionSort" + - description: Size for a given page. Use `-1` to return all items. + in: query + name: page[size] + required: false + schema: + default: -1 + example: 10 + format: int64 + type: integer + - $ref: "#/components/parameters/PageNumber" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringPaginatedSuppressionsResponse' + $ref: "#/components/schemas/SecurityMonitoringPaginatedSuppressionsResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_suppressions_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_suppressions_read summary: Get all suppression rules tags: - - Security Monitoring + - Security Monitoring post: description: Create a new suppression rule. operationId: CreateSecurityMonitoringSuppression @@ -102609,32 +98333,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSuppressionCreateRequest' + $ref: "#/components/schemas/SecurityMonitoringSuppressionCreateRequest" description: The definition of the new suppression rule. required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringSuppressionResponse' + $ref: "#/components/schemas/SecurityMonitoringSuppressionResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_suppressions_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_suppressions_write summary: Create a suppression rule tags: - - Security Monitoring + - Security Monitoring x-codegen-request-body-name: body /api/v2/security_monitoring/configuration/suppressions/rules: post: @@ -102642,1095 +98366,1047 @@ paths: operationId: GetSuppressionsAffectingFutureRule requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringRuleCreatePayload' + $ref: "#/components/schemas/SecurityMonitoringRuleCreatePayload" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSuppressionsResponse' + $ref: "#/components/schemas/SecurityMonitoringSuppressionsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_suppressions_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_suppressions_read summary: Get suppressions affecting future rule tags: - - Security Monitoring + - Security Monitoring /api/v2/security_monitoring/configuration/suppressions/rules/{rule_id}: get: - description: Get the list of suppressions that affect a specific existing rule - by its ID. + description: Get the list of suppressions that affect a specific existing rule by its ID. operationId: GetSuppressionsAffectingRule parameters: - - $ref: '#/components/parameters/SecurityMonitoringRuleID' + - $ref: "#/components/parameters/SecurityMonitoringRuleID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSuppressionsResponse' + $ref: "#/components/schemas/SecurityMonitoringSuppressionsResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_suppressions_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_suppressions_read summary: Get suppressions affecting a specific rule tags: - - Security Monitoring + - Security Monitoring /api/v2/security_monitoring/configuration/suppressions/validation: post: description: Validate a suppression rule. operationId: ValidateSecurityMonitoringSuppression requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringSuppressionCreateRequest' + $ref: "#/components/schemas/SecurityMonitoringSuppressionCreateRequest" required: true responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_suppressions_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_suppressions_write summary: Validate a suppression rule - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_suppressions_write + - security_monitoring_suppressions_write /api/v2/security_monitoring/configuration/suppressions/{suppression_id}: delete: description: Delete a specific suppression rule. operationId: DeleteSecurityMonitoringSuppression parameters: - - $ref: '#/components/parameters/SecurityMonitoringSuppressionID' + - $ref: "#/components/parameters/SecurityMonitoringSuppressionID" responses: - '204': + "204": description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_suppressions_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_suppressions_write summary: Delete a suppression rule tags: - - Security Monitoring + - Security Monitoring get: description: Get the details of a specific suppression rule. operationId: GetSecurityMonitoringSuppression parameters: - - $ref: '#/components/parameters/SecurityMonitoringSuppressionID' + - $ref: "#/components/parameters/SecurityMonitoringSuppressionID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSuppressionResponse' + $ref: "#/components/schemas/SecurityMonitoringSuppressionResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_suppressions_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_suppressions_read summary: Get a suppression rule tags: - - Security Monitoring + - Security Monitoring patch: description: Update a specific suppression rule. operationId: UpdateSecurityMonitoringSuppression parameters: - - $ref: '#/components/parameters/SecurityMonitoringSuppressionID' + - $ref: "#/components/parameters/SecurityMonitoringSuppressionID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSuppressionUpdateRequest' + $ref: "#/components/schemas/SecurityMonitoringSuppressionUpdateRequest" description: New definition of the suppression rule. Supports partial updates. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSuppressionResponse' + $ref: "#/components/schemas/SecurityMonitoringSuppressionResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConcurrentModificationResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConcurrentModificationResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_suppressions_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_suppressions_write summary: Update a suppression rule tags: - - Security Monitoring + - Security Monitoring /api/v2/security_monitoring/configuration/suppressions/{suppression_id}/version_history: get: description: Get a suppression's version history. operationId: GetSuppressionVersionHistory parameters: - - $ref: '#/components/parameters/SecurityMonitoringSuppressionID' - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' + - $ref: "#/components/parameters/SecurityMonitoringSuppressionID" + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GetSuppressionVersionHistoryResponse' + $ref: "#/components/schemas/GetSuppressionVersionHistoryResponse" description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_suppressions_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_suppressions_read summary: Get a suppression's version history tags: - - Security Monitoring + - Security Monitoring /api/v2/security_monitoring/content_packs/states: get: - description: 'Get the activation and configuration states for all security monitoring - content packs. - - This endpoint returns status information about each content pack including - activation state, - - integration status, and log collection status.' + description: |- + Get the activation and configuration states for all security monitoring content packs. + This endpoint returns status information about each content pack including activation state, + integration status, and log collection status. operationId: GetContentPacksStates responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringContentPackStatesResponse' + $ref: "#/components/schemas/SecurityMonitoringContentPackStatesResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get content pack states tags: - - Security Monitoring - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Security Monitoring + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/security_monitoring/content_packs/{content_pack_id}/activate: put: - description: 'Activate a security monitoring content pack. This operation configures - the necessary - - log filters or security filters depending on the pricing model and updates - the content - - pack activation state.' + description: |- + Activate a security monitoring content pack. This operation configures the necessary + log filters or security filters depending on the pricing model and updates the content + pack activation state. operationId: ActivateContentPack parameters: - - description: The ID of the content pack to activate. - in: path - name: content_pack_id - required: true - schema: - example: aws-cloudtrail - type: string + - description: The ID of the content pack to activate. + in: path + name: content_pack_id + required: true + schema: + example: aws-cloudtrail + type: string responses: - '202': + "202": description: Accepted - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Activate content pack tags: - - Security Monitoring - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Security Monitoring + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/security_monitoring/content_packs/{content_pack_id}/deactivate: put: - description: 'Deactivate a security monitoring content pack. This operation - removes the content pack''s - - configuration from log filters or security filters and updates the content - pack activation state.' + description: |- + Deactivate a security monitoring content pack. This operation removes the content pack's + configuration from log filters or security filters and updates the content pack activation state. operationId: DeactivateContentPack parameters: - - description: The ID of the content pack to deactivate. - in: path - name: content_pack_id - required: true - schema: - example: aws-cloudtrail - type: string + - description: The ID of the content pack to deactivate. + in: path + name: content_pack_id + required: true + schema: + example: aws-cloudtrail + type: string responses: - '202': + "202": description: Accepted - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Deactivate content pack tags: - - Security Monitoring - x-unstable: '**Note**: This endpoint is in preview and is subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Security Monitoring + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/security_monitoring/rules: get: description: List rules. operationId: ListSecurityMonitoringRules parameters: - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' - - description: A search query to filter security rules. You can filter by attributes - such as `type`, `source`, `tags`. - example: type:signal_correlation source:cloudtrail - in: query - name: query - required: false - schema: - type: string - - description: Attribute used to sort rules. Prefix with `-` to sort in descending - order. - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/SecurityMonitoringRuleSort' + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - description: A search query to filter security rules. You can filter by attributes such as `type`, `source`, `tags`. + example: "type:signal_correlation source:cloudtrail" + in: query + name: query + required: false + schema: + type: string + - description: Attribute used to sort rules. Prefix with `-` to sort in descending order. + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/SecurityMonitoringRuleSort" responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringListRulesResponse' + $ref: "#/components/schemas/SecurityMonitoringListRulesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_read summary: List rules - tags: - - Security Monitoring - x-permission: + tags: ["Security Monitoring"] + "x-permission": operator: OR permissions: - - security_monitoring_rules_read + - security_monitoring_rules_read post: description: Create a detection rule. operationId: CreateSecurityMonitoringRule requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringRuleCreatePayload' + $ref: "#/components/schemas/SecurityMonitoringRuleCreatePayload" required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringRuleResponse' + $ref: "#/components/schemas/SecurityMonitoringRuleResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_write summary: Create a detection rule - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_rules_write + - security_monitoring_rules_write /api/v2/security_monitoring/rules/bulk_export: post: - description: 'Export a list of security monitoring rules as a ZIP file containing - JSON rule definitions. - - The endpoint accepts a list of rule IDs and returns a ZIP archive where each - rule is - - saved as a separate JSON file named after the rule.' + description: |- + Export a list of security monitoring rules as a ZIP file containing JSON rule definitions. + The endpoint accepts a list of rule IDs and returns a ZIP archive where each rule is + saved as a separate JSON file named after the rule. operationId: BulkExportSecurityMonitoringRules requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringRuleBulkExportPayload' + $ref: "#/components/schemas/SecurityMonitoringRuleBulkExportPayload" required: true responses: - '200': + "200": content: application/zip: schema: format: binary type: string description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_read + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_read summary: Bulk export security monitoring rules - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_rules_read + - security_monitoring_rules_read /api/v2/security_monitoring/rules/convert: post: - description: 'Convert a rule that doesn''t (yet) exist from JSON to Terraform - for Datadog provider - - resource `datadog_security_monitoring_rule`. You can do so for the following - rule types: - + description: |- + Convert a rule that doesn't (yet) exist from JSON to Terraform for Datadog provider + resource `datadog_security_monitoring_rule`. You can do so for the following rule types: - App and API Protection - - Cloud SIEM (log detection and signal correlation) - - Workload Protection - - You can convert Cloud Security configuration rules using Terraform''s [Datadog - Cloud Configuration Rule resource](https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/cloud_configuration_rule).' + You can convert Cloud Security configuration rules using Terraform's [Datadog Cloud Configuration Rule resource](https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/cloud_configuration_rule). operationId: ConvertSecurityMonitoringRuleFromJSONToTerraform requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringRuleConvertPayload' + $ref: "#/components/schemas/SecurityMonitoringRuleConvertPayload" required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringRuleConvertResponse' + $ref: "#/components/schemas/SecurityMonitoringRuleConvertResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/ConcurrentModificationResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/ConcurrentModificationResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_write summary: Convert a rule from JSON to Terraform - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_rules_write + - security_monitoring_rules_write /api/v2/security_monitoring/rules/test: post: - description: Test a rule. + description: |- + Test a rule. operationId: TestSecurityMonitoringRule requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringRuleTestRequest' + $ref: "#/components/schemas/SecurityMonitoringRuleTestRequest" required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringRuleTestResponse' + $ref: "#/components/schemas/SecurityMonitoringRuleTestResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/ConcurrentModificationResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/ConcurrentModificationResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_write summary: Test a rule - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_rules_write + - security_monitoring_rules_write /api/v2/security_monitoring/rules/validation: post: description: Validate a detection rule. operationId: ValidateSecurityMonitoringRule requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringRuleValidatePayload' + $ref: "#/components/schemas/SecurityMonitoringRuleValidatePayload" required: true responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_write summary: Validate a detection rule - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_rules_write + - security_monitoring_rules_write /api/v2/security_monitoring/rules/{rule_id}: delete: - description: Delete an existing rule. Default rules cannot be deleted. + description: |- + Delete an existing rule. Default rules cannot be deleted. operationId: DeleteSecurityMonitoringRule parameters: - - $ref: '#/components/parameters/SecurityMonitoringRuleID' + - $ref: "#/components/parameters/SecurityMonitoringRuleID" responses: - '204': + "204": description: OK - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_write summary: Delete an existing rule - tags: - - Security Monitoring - x-permission: + tags: ["Security Monitoring"] + "x-permission": operator: OR permissions: - - security_monitoring_rules_write + - security_monitoring_rules_write get: description: Get a rule's details. operationId: GetSecurityMonitoringRule parameters: - - $ref: '#/components/parameters/SecurityMonitoringRuleID' + - $ref: "#/components/parameters/SecurityMonitoringRuleID" responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringRuleResponse' + $ref: "#/components/schemas/SecurityMonitoringRuleResponse" description: OK - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_read summary: Get a rule's details - tags: - - Security Monitoring - x-permission: + tags: ["Security Monitoring"] + "x-permission": operator: OR permissions: - - security_monitoring_rules_read + - security_monitoring_rules_read put: - description: 'Update an existing rule. When updating `cases`, `queries` or `options`, - the whole field - - must be included. For example, when modifying a query all queries must be - included. - - Default rules can only be updated to be enabled, to change notifications, - or to update - - the tags (default tags cannot be removed).' + description: |- + Update an existing rule. When updating `cases`, `queries` or `options`, the whole field + must be included. For example, when modifying a query all queries must be included. + Default rules can only be updated to be enabled, to change notifications, or to update + the tags (default tags cannot be removed). operationId: UpdateSecurityMonitoringRule parameters: - - $ref: '#/components/parameters/SecurityMonitoringRuleID' + - $ref: "#/components/parameters/SecurityMonitoringRuleID" requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringRuleUpdatePayload' + $ref: "#/components/schemas/SecurityMonitoringRuleUpdatePayload" required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringRuleResponse' + $ref: "#/components/schemas/SecurityMonitoringRuleResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/ConcurrentModificationResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/ConcurrentModificationResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_write summary: Update an existing rule - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_rules_write + - security_monitoring_rules_write /api/v2/security_monitoring/rules/{rule_id}/convert: get: - description: 'Convert an existing rule from JSON to Terraform for Datadog provider - - resource `datadog_security_monitoring_rule`. You can do so for the following - rule types: - + description: |- + Convert an existing rule from JSON to Terraform for Datadog provider + resource `datadog_security_monitoring_rule`. You can do so for the following rule types: - App and API Protection - - Cloud SIEM (log detection and signal correlation) - - Workload Protection - - You can convert Cloud Security configuration rules using Terraform''s [Datadog - Cloud Configuration Rule resource](https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/cloud_configuration_rule).' + You can convert Cloud Security configuration rules using Terraform's [Datadog Cloud Configuration Rule resource](https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/cloud_configuration_rule). operationId: ConvertExistingSecurityMonitoringRule parameters: - - $ref: '#/components/parameters/SecurityMonitoringRuleID' + - $ref: "#/components/parameters/SecurityMonitoringRuleID" responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringRuleConvertResponse' + $ref: "#/components/schemas/SecurityMonitoringRuleConvertResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_read summary: Convert an existing rule from JSON to Terraform - tags: - - Security Monitoring - x-permission: + tags: ["Security Monitoring"] + "x-permission": operator: OR permissions: - - security_monitoring_rules_read + - security_monitoring_rules_read /api/v2/security_monitoring/rules/{rule_id}/test: post: - description: Test an existing rule. + description: |- + Test an existing rule. operationId: TestExistingSecurityMonitoringRule parameters: - - $ref: '#/components/parameters/SecurityMonitoringRuleID' + - $ref: "#/components/parameters/SecurityMonitoringRuleID" requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringRuleTestRequest' + $ref: "#/components/schemas/SecurityMonitoringRuleTestRequest" required: true responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringRuleTestResponse' + $ref: "#/components/schemas/SecurityMonitoringRuleTestResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/ConcurrentModificationResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/ConcurrentModificationResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_write summary: Test an existing rule - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_rules_write + - security_monitoring_rules_write /api/v2/security_monitoring/rules/{rule_id}/version_history: get: description: Get a rule's version history. operationId: GetRuleVersionHistory parameters: - - $ref: '#/components/parameters/SecurityMonitoringRuleID' - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' + - $ref: "#/components/parameters/SecurityMonitoringRuleID" + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/GetRuleVersionHistoryResponse' + $ref: "#/components/schemas/GetRuleVersionHistoryResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a rule's version history - tags: - - Security Monitoring - x-permission: + tags: ["Security Monitoring"] + "x-permission": operator: OR permissions: - - security_monitoring_rules_read - x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.' + - security_monitoring_rules_read + x-unstable: |- + **Note**: This endpoint is in beta and may be subject to changes. /api/v2/security_monitoring/signals: get: - description: 'The list endpoint returns security signals that match a search - query. - - Both this endpoint and the POST endpoint can be used interchangeably when - listing - - security signals.' + description: |- + The list endpoint returns security signals that match a search query. + Both this endpoint and the POST endpoint can be used interchangeably when listing + security signals. operationId: ListSecurityMonitoringSignals parameters: - - $ref: '#/components/parameters/QueryFilterSearch' - - $ref: '#/components/parameters/QueryFilterFrom' - - $ref: '#/components/parameters/QueryFilterTo' - - $ref: '#/components/parameters/QuerySort' - - $ref: '#/components/parameters/QueryPageCursor' - - $ref: '#/components/parameters/QueryPageLimit' + - $ref: "#/components/parameters/QueryFilterSearch" + - $ref: "#/components/parameters/QueryFilterFrom" + - $ref: "#/components/parameters/QueryFilterTo" + - $ref: "#/components/parameters/QuerySort" + - $ref: "#/components/parameters/QueryPageCursor" + - $ref: "#/components/parameters/QueryPageLimit" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSignalsListResponse' + $ref: "#/components/schemas/SecurityMonitoringSignalsListResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_signals_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_signals_read summary: Get a quick list of security signals - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_signals_read + - security_monitoring_signals_read /api/v2/security_monitoring/signals/search: post: - description: 'Returns security signals that match a search query. - + description: |- + Returns security signals that match a search query. Both this endpoint and the GET endpoint can be used interchangeably for listing - - security signals.' + security signals. operationId: SearchSecurityMonitoringSignals requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringSignalListRequest' + $ref: "#/components/schemas/SecurityMonitoringSignalListRequest" required: false responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSignalsListResponse' + $ref: "#/components/schemas/SecurityMonitoringSignalsListResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_signals_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_signals_read summary: Get a list of security signals - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_signals_read + - security_monitoring_signals_read /api/v2/security_monitoring/signals/{signal_id}: get: description: Get a signal's details. operationId: GetSecurityMonitoringSignal parameters: - - $ref: '#/components/parameters/SignalID' + - $ref: "#/components/parameters/SignalID" responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringSignalResponse' + $ref: "#/components/schemas/SecurityMonitoringSignalResponse" description: OK - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_signals_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_signals_read summary: Get a signal's details - tags: - - Security Monitoring - x-permission: + tags: ["Security Monitoring"] + "x-permission": operator: OR permissions: - - security_monitoring_signals_read + - security_monitoring_signals_read /api/v2/security_monitoring/signals/{signal_id}/assignee: patch: - description: Modify the triage assignee of a security signal. + description: |- + Modify the triage assignee of a security signal. operationId: EditSecurityMonitoringSignalAssignee parameters: - - $ref: '#/components/parameters/SignalID' + - $ref: "#/components/parameters/SignalID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSignalAssigneeUpdateRequest' + $ref: "#/components/schemas/SecurityMonitoringSignalAssigneeUpdateRequest" description: Attributes describing the signal update. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse' + $ref: "#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Modify the triage assignee of a security signal - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_signals_write + - security_monitoring_signals_write /api/v2/security_monitoring/signals/{signal_id}/incidents: patch: - description: Change the related incidents for a security signal. + description: |- + Change the related incidents for a security signal. operationId: EditSecurityMonitoringSignalIncidents parameters: - - $ref: '#/components/parameters/SignalID' + - $ref: "#/components/parameters/SignalID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSignalIncidentsUpdateRequest' + $ref: "#/components/schemas/SecurityMonitoringSignalIncidentsUpdateRequest" description: Attributes describing the signal update. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse' + $ref: "#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Change the related incidents of a security signal - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_signals_write + - security_monitoring_signals_write /api/v2/security_monitoring/signals/{signal_id}/state: patch: - description: Change the triage state of a security signal. + description: |- + Change the triage state of a security signal. operationId: EditSecurityMonitoringSignalState parameters: - - $ref: '#/components/parameters/SignalID' + - $ref: "#/components/parameters/SignalID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateRequest' + $ref: "#/components/schemas/SecurityMonitoringSignalStateUpdateRequest" description: Attributes describing the signal update. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse' + $ref: "#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Change the triage state of a security signal - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_signals_write + - security_monitoring_signals_write /api/v2/sensitive-data-scanner/config: get: description: List all the Scanning groups in your organization. operationId: ListScanningGroups responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SensitiveDataScannerGetConfigResponse' + $ref: "#/components/schemas/SensitiveDataScannerGetConfigResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List Scanning Groups tags: - - Sensitive Data Scanner - x-permission: + - Sensitive Data Scanner + "x-permission": operator: OR permissions: - - data_scanner_read + - data_scanner_read patch: description: Reorder the list of groups. operationId: ReorderScanningGroups @@ -103738,421 +99414,409 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SensitiveDataScannerConfigRequest' + $ref: "#/components/schemas/SensitiveDataScannerConfigRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SensitiveDataScannerReorderGroupsResponse' + $ref: "#/components/schemas/SensitiveDataScannerReorderGroupsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Reorder Groups tags: - - Sensitive Data Scanner + - Sensitive Data Scanner x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - data_scanner_write + - data_scanner_write /api/v2/sensitive-data-scanner/config/groups: post: - description: 'Create a scanning group. - + description: |- + Create a scanning group. The request MAY include a configuration relationship. - - A rules relationship can be omitted entirely, but if it is included it MUST - be - + A rules relationship can be omitted entirely, but if it is included it MUST be null or an empty array (rules cannot be created at the same time). - - The new group will be ordered last within the configuration.' + The new group will be ordered last within the configuration. operationId: CreateScanningGroup requestBody: content: application/json: schema: - $ref: '#/components/schemas/SensitiveDataScannerGroupCreateRequest' + $ref: "#/components/schemas/SensitiveDataScannerGroupCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/SensitiveDataScannerCreateGroupResponse' + $ref: "#/components/schemas/SensitiveDataScannerCreateGroupResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create Scanning Group tags: - - Sensitive Data Scanner + - Sensitive Data Scanner x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - data_scanner_write + - data_scanner_write /api/v2/sensitive-data-scanner/config/groups/{group_id}: delete: description: Delete a given group. operationId: DeleteScanningGroup parameters: - - $ref: '#/components/parameters/SensitiveDataScannerGroupID' + - $ref: "#/components/parameters/SensitiveDataScannerGroupID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SensitiveDataScannerGroupDeleteRequest' + $ref: "#/components/schemas/SensitiveDataScannerGroupDeleteRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SensitiveDataScannerGroupDeleteResponse' + $ref: "#/components/schemas/SensitiveDataScannerGroupDeleteResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete Scanning Group tags: - - Sensitive Data Scanner + - Sensitive Data Scanner x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - data_scanner_write + - data_scanner_write patch: - description: 'Update a group, including the order of the rules. - - Rules within the group are reordered by including a rules relationship. If - the rules - - relationship is present, its data section MUST contain linkages for all of - the rules - - currently in the group, and MUST NOT contain any others.' + description: |- + Update a group, including the order of the rules. + Rules within the group are reordered by including a rules relationship. If the rules + relationship is present, its data section MUST contain linkages for all of the rules + currently in the group, and MUST NOT contain any others. operationId: UpdateScanningGroup parameters: - - $ref: '#/components/parameters/SensitiveDataScannerGroupID' + - $ref: "#/components/parameters/SensitiveDataScannerGroupID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SensitiveDataScannerGroupUpdateRequest' + $ref: "#/components/schemas/SensitiveDataScannerGroupUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SensitiveDataScannerGroupUpdateResponse' + $ref: "#/components/schemas/SensitiveDataScannerGroupUpdateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update Scanning Group tags: - - Sensitive Data Scanner + - Sensitive Data Scanner x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - data_scanner_write + - data_scanner_write /api/v2/sensitive-data-scanner/config/rules: post: - description: 'Create a scanning rule in a sensitive data scanner group, ordered - last. - + description: |- + Create a scanning rule in a sensitive data scanner group, ordered last. The posted rule MUST include a group relationship. - - It MUST include either a standard_pattern relationship or a regex attribute, - but not both. - + It MUST include either a standard_pattern relationship or a regex attribute, but not both. If included_attributes is empty or missing, we will scan all attributes except - - excluded_attributes. If both are missing, we will scan the whole event.' + excluded_attributes. If both are missing, we will scan the whole event. operationId: CreateScanningRule requestBody: content: application/json: schema: - $ref: '#/components/schemas/SensitiveDataScannerRuleCreateRequest' + $ref: "#/components/schemas/SensitiveDataScannerRuleCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/SensitiveDataScannerCreateRuleResponse' + $ref: "#/components/schemas/SensitiveDataScannerCreateRuleResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create Scanning Rule tags: - - Sensitive Data Scanner + - Sensitive Data Scanner x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - data_scanner_write + - data_scanner_write /api/v2/sensitive-data-scanner/config/rules/{rule_id}: delete: description: Delete a given rule. operationId: DeleteScanningRule parameters: - - $ref: '#/components/parameters/SensitiveDataScannerRuleID' + - $ref: "#/components/parameters/SensitiveDataScannerRuleID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SensitiveDataScannerRuleDeleteRequest' + $ref: "#/components/schemas/SensitiveDataScannerRuleDeleteRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SensitiveDataScannerRuleDeleteResponse' + $ref: "#/components/schemas/SensitiveDataScannerRuleDeleteResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete Scanning Rule tags: - - Sensitive Data Scanner + - Sensitive Data Scanner x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - data_scanner_write + - data_scanner_write patch: - description: 'Update a scanning rule. - - The request body MUST NOT include a standard_pattern relationship, as that - relationship - + description: |- + Update a scanning rule. + The request body MUST NOT include a standard_pattern relationship, as that relationship is non-editable. Trying to edit the regex attribute of a rule with a standard_pattern - - relationship will also result in an error.' + relationship will also result in an error. operationId: UpdateScanningRule parameters: - - $ref: '#/components/parameters/SensitiveDataScannerRuleID' + - $ref: "#/components/parameters/SensitiveDataScannerRuleID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SensitiveDataScannerRuleUpdateRequest' + $ref: "#/components/schemas/SensitiveDataScannerRuleUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SensitiveDataScannerRuleUpdateResponse' + $ref: "#/components/schemas/SensitiveDataScannerRuleUpdateResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update Scanning Rule tags: - - Sensitive Data Scanner + - Sensitive Data Scanner x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - data_scanner_write + - data_scanner_write /api/v2/sensitive-data-scanner/config/standard-patterns: get: description: Returns all standard patterns. operationId: ListStandardPatterns responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SensitiveDataScannerStandardPatternsResponseData' + $ref: "#/components/schemas/SensitiveDataScannerStandardPatternsResponseData" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication Error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List standard patterns tags: - - Sensitive Data Scanner - x-permission: + - Sensitive Data Scanner + "x-permission": operator: OR permissions: - - data_scanner_read + - data_scanner_read /api/v2/series: post: - description: "The metrics end-point allows you to post time-series data that - can be graphed on Datadog\u2019s 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\u2019re submitting - metrics directly to the Datadog API without using DogStatsD, expect:\n\n- - 64 bits for the timestamp\n- 64 bits for the value\n- 20 bytes for the metric - names\n- 50 bytes for the timeseries\n- The full payload is approximately - 100 bytes.\n\nHost name is one of the resources in the Resources field." + description: |- + The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards. + The maximum payload size is 500 kilobytes (512000 bytes). Compressed payloads must have a decompressed size of less than 5 megabytes (5242880 bytes). + + If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect: + + - 64 bits for the timestamp + - 64 bits for the value + - 20 bytes for the metric names + - 50 bytes for the timeseries + - The full payload is approximately 100 bytes. + + Host name is one of the resources in the Resources field. operationId: SubmitMetrics parameters: - - description: HTTP header used to compress the media-type. - in: header - name: Content-Encoding - required: false - schema: - $ref: '#/components/schemas/MetricContentEncoding' + - description: HTTP header used to compress the media-type. + in: header + name: Content-Encoding + required: false + schema: + $ref: "#/components/schemas/MetricContentEncoding" requestBody: content: application/json: examples: dynamic-points: - description: "Post time-series data that can be graphed on Datadog\u2019s - dashboards." + description: Post time-series data that can be graphed on Datadog’s dashboards. externalValue: examples/metrics/dynamic-points.json.sh summary: Dynamic Points x-variables: NOW: $(date +%s) schema: - $ref: '#/components/schemas/MetricPayload' + $ref: "#/components/schemas/MetricPayload" required: true responses: - '202': + "202": content: application/json: schema: - $ref: '#/components/schemas/IntakePayloadAccepted' + $ref: "#/components/schemas/IntakePayloadAccepted" description: Payload accepted - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '408': + "408": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Request timeout - '413': + "413": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Payload too large - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] + - apiKeyAuth: [] summary: Submit metrics tags: - - Metrics + - Metrics x-codegen-request-body-name: body /api/v2/service_accounts: post: @@ -104162,277 +99826,277 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceAccountCreateRequest' + $ref: "#/components/schemas/ServiceAccountCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/UserResponse' + $ref: "#/components/schemas/UserResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create a service account tags: - - Service Accounts + - Service Accounts x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - service_account_write + - service_account_write /api/v2/service_accounts/{service_account_id}/application_keys: get: description: List all application keys available for this service account. operationId: ListServiceAccountApplicationKeys parameters: - - $ref: '#/components/parameters/ServiceAccountID' - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' - - $ref: '#/components/parameters/ApplicationKeysSortParameter' - - $ref: '#/components/parameters/ApplicationKeyFilterParameter' - - $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter' - - $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter' + - $ref: "#/components/parameters/ServiceAccountID" + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - $ref: "#/components/parameters/ApplicationKeysSortParameter" + - $ref: "#/components/parameters/ApplicationKeyFilterParameter" + - $ref: "#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter" + - $ref: "#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ListApplicationKeysResponse' + $ref: "#/components/schemas/ListApplicationKeysResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: List application keys for this service account tags: - - Service Accounts - x-permission: + - Service Accounts + "x-permission": operator: OR permissions: - - service_account_write + - service_account_write post: description: Create an application key for this service account. operationId: CreateServiceAccountApplicationKey parameters: - - $ref: '#/components/parameters/ServiceAccountID' + - $ref: "#/components/parameters/ServiceAccountID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApplicationKeyCreateRequest' + $ref: "#/components/schemas/ApplicationKeyCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/ApplicationKeyResponse' + $ref: "#/components/schemas/ApplicationKeyResponse" description: Created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create an application key for this service account tags: - - Service Accounts + - Service Accounts x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - service_account_write + - service_account_write /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id}: delete: description: Delete an application key owned by this service account. operationId: DeleteServiceAccountApplicationKey parameters: - - $ref: '#/components/parameters/ServiceAccountID' - - $ref: '#/components/parameters/ApplicationKeyID' + - $ref: "#/components/parameters/ServiceAccountID" + - $ref: "#/components/parameters/ApplicationKeyID" responses: - '204': + "204": description: No Content - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete an application key for this service account tags: - - Service Accounts - x-permission: + - Service Accounts + "x-permission": operator: OR permissions: - - service_account_write + - service_account_write get: description: Get an application key owned by this service account. operationId: GetServiceAccountApplicationKey parameters: - - $ref: '#/components/parameters/ServiceAccountID' - - $ref: '#/components/parameters/ApplicationKeyID' + - $ref: "#/components/parameters/ServiceAccountID" + - $ref: "#/components/parameters/ApplicationKeyID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PartialApplicationKeyResponse' + $ref: "#/components/schemas/PartialApplicationKeyResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get one application key for this service account tags: - - Service Accounts - x-permission: + - Service Accounts + "x-permission": operator: OR permissions: - - service_account_write + - service_account_write patch: description: Edit an application key owned by this service account. operationId: UpdateServiceAccountApplicationKey parameters: - - $ref: '#/components/parameters/ServiceAccountID' - - $ref: '#/components/parameters/ApplicationKeyID' + - $ref: "#/components/parameters/ServiceAccountID" + - $ref: "#/components/parameters/ApplicationKeyID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ApplicationKeyUpdateRequest' + $ref: "#/components/schemas/ApplicationKeyUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PartialApplicationKeyResponse' + $ref: "#/components/schemas/PartialApplicationKeyResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Edit an application key for this service account tags: - - Service Accounts + - Service Accounts x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - service_account_write + - service_account_write /api/v2/services: get: deprecated: true - description: 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. + description: >- + 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. operationId: ListIncidentServices parameters: - - $ref: '#/components/parameters/IncidentServiceIncludeQueryParameter' - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageOffset' - - $ref: '#/components/parameters/IncidentServiceSearchQueryParameter' + - $ref: "#/components/parameters/IncidentServiceIncludeQueryParameter" + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageOffset" + - $ref: "#/components/parameters/IncidentServiceSearchQueryParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentServicesResponse' + $ref: "#/components/schemas/IncidentServicesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read summary: Get a list of all incident services tags: - - Incident Services - x-permission: + - Incident Services + "x-permission": operator: OR permissions: - - incident_read - x-unstable: '**Note**: This endpoint is deprecated.' + - incident_read + x-unstable: |- + **Note**: This endpoint is deprecated. post: deprecated: true description: Creates a new incident service. @@ -104441,76 +100105,76 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/IncidentServiceCreateRequest' + $ref: "#/components/schemas/IncidentServiceCreateRequest" description: Incident Service Payload. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/IncidentServiceResponse' + $ref: "#/components/schemas/IncidentServiceResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_settings_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_write summary: Create a new incident service tags: - - Incident Services + - Incident Services x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - incident_settings_write - x-unstable: '**Note**: This endpoint is deprecated.' + - incident_settings_write + x-unstable: |- + **Note**: This endpoint is deprecated. /api/v2/services/definitions: get: - description: Get a list of all service definitions from the Datadog Service - Catalog. + description: Get a list of all service definitions from the Datadog Service Catalog. operationId: ListServiceDefinitions parameters: - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' - - $ref: '#/components/parameters/SchemaVersion' + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - $ref: "#/components/parameters/SchemaVersion" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceDefinitionsListResponse' + $ref: "#/components/schemas/ServiceDefinitionsListResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_read summary: Get all service definitions tags: - - Service Definition + - Service Definition x-pagination: limitParam: page[size] pageParam: page[number] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - apm_service_catalog_read + - apm_service_catalog_read post: description: Create or update service definition in the Datadog Service Catalog. operationId: CreateOrUpdateServiceDefinitions @@ -104518,826 +100182,806 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceDefinitionsCreateRequest' + $ref: "#/components/schemas/ServiceDefinitionsCreateRequest" description: Service Definition YAML/JSON. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceDefinitionCreateResponse' + $ref: "#/components/schemas/ServiceDefinitionCreateResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_write summary: Create or update service definition tags: - - Service Definition + - Service Definition x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - apm_service_catalog_write + - apm_service_catalog_write /api/v2/services/definitions/{service_name}: delete: description: Delete a single service definition in the Datadog Service Catalog. operationId: DeleteServiceDefinition parameters: - - $ref: '#/components/parameters/ServiceName' + - $ref: "#/components/parameters/ServiceName" responses: - '204': + "204": description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_write summary: Delete a single service definition tags: - - Service Definition - x-permission: + - Service Definition + "x-permission": operator: OR permissions: - - apm_service_catalog_write + - apm_service_catalog_write get: description: Get a single service definition from the Datadog Service Catalog. operationId: GetServiceDefinition parameters: - - $ref: '#/components/parameters/ServiceName' - - $ref: '#/components/parameters/SchemaVersion' + - $ref: "#/components/parameters/ServiceName" + - $ref: "#/components/parameters/SchemaVersion" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ServiceDefinitionGetResponse' + $ref: "#/components/schemas/ServiceDefinitionGetResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_service_catalog_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_read summary: Get a single service definition tags: - - Service Definition - x-permission: + - Service Definition + "x-permission": operator: OR permissions: - - apm_service_catalog_read + - apm_service_catalog_read /api/v2/services/{service_id}: delete: deprecated: true description: Deletes an existing incident service. operationId: DeleteIncidentService parameters: - - $ref: '#/components/parameters/IncidentServiceIDPathParameter' - responses: - '204': - description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_settings_write + - $ref: "#/components/parameters/IncidentServiceIDPathParameter" + responses: + "204": + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_write summary: Delete an existing incident service tags: - - Incident Services - x-permission: + - Incident Services + "x-permission": operator: OR permissions: - - incident_settings_write - x-unstable: '**Note**: This endpoint is deprecated.' + - incident_settings_write + x-unstable: |- + **Note**: This endpoint is deprecated. get: deprecated: true - description: 'Get details of an incident service. If the `include[users]` query - parameter is provided, - - the included attribute will contain the users related to these incident services.' + description: |- + Get details of an incident service. If the `include[users]` query parameter is provided, + the included attribute will contain the users related to these incident services. operationId: GetIncidentService parameters: - - $ref: '#/components/parameters/IncidentServiceIDPathParameter' - - $ref: '#/components/parameters/IncidentServiceIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentServiceIDPathParameter" + - $ref: "#/components/parameters/IncidentServiceIncludeQueryParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentServiceResponse' + $ref: "#/components/schemas/IncidentServiceResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read summary: Get details of an incident service tags: - - Incident Services - x-permission: + - Incident Services + "x-permission": operator: OR permissions: - - incident_read - x-unstable: '**Note**: This endpoint is deprecated.' + - incident_read + x-unstable: |- + **Note**: This endpoint is deprecated. patch: deprecated: true - description: Updates an existing incident service. Only provide the attributes - which should be updated as this request is a partial update. + description: >- + Updates an existing incident service. Only provide the attributes which should be updated as this request is a partial update. operationId: UpdateIncidentService parameters: - - $ref: '#/components/parameters/IncidentServiceIDPathParameter' + - $ref: "#/components/parameters/IncidentServiceIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentServiceUpdateRequest' + $ref: "#/components/schemas/IncidentServiceUpdateRequest" description: Incident Service Payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentServiceResponse' + $ref: "#/components/schemas/IncidentServiceResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_settings_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_write summary: Update an existing incident service tags: - - Incident Services + - Incident Services x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - incident_settings_write - x-unstable: '**Note**: This endpoint is deprecated.' + - incident_settings_write + x-unstable: |- + **Note**: This endpoint is deprecated. /api/v2/siem-threat-hunting/histsignals: get: description: List hist signals. operationId: ListSecurityMonitoringHistsignals parameters: - - $ref: '#/components/parameters/QueryFilterSearch' - - $ref: '#/components/parameters/QueryFilterFrom' - - $ref: '#/components/parameters/QueryFilterTo' - - $ref: '#/components/parameters/QuerySort' - - $ref: '#/components/parameters/QueryPageCursor' - - $ref: '#/components/parameters/QueryPageLimit' + - $ref: "#/components/parameters/QueryFilterSearch" + - $ref: "#/components/parameters/QueryFilterFrom" + - $ref: "#/components/parameters/QueryFilterTo" + - $ref: "#/components/parameters/QuerySort" + - $ref: "#/components/parameters/QueryPageCursor" + - $ref: "#/components/parameters/QueryPageLimit" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSignalsListResponse' + $ref: "#/components/schemas/SecurityMonitoringSignalsListResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_signals_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_signals_read summary: List hist signals - tags: - - Security Monitoring - x-permission: + tags: ["Security Monitoring"] + "x-permission": operator: OR permissions: - - security_monitoring_signals_read - x-unstable: '**Note**: This endpoint is in beta and may be subject to changes. - - Please check the documentation regularly for updates.' + - security_monitoring_signals_read + x-unstable: |- + **Note**: This endpoint is in beta and may be subject to changes. + Please check the documentation regularly for updates. /api/v2/siem-threat-hunting/histsignals/search: get: description: Search hist signals. operationId: SearchSecurityMonitoringHistsignals requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringSignalListRequest' + $ref: "#/components/schemas/SecurityMonitoringSignalListRequest" required: false responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSignalsListResponse' + $ref: "#/components/schemas/SecurityMonitoringSignalsListResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_signals_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_signals_read summary: Search hist signals - tags: - - Security Monitoring - x-permission: + tags: ["Security Monitoring"] + "x-permission": operator: OR permissions: - - security_monitoring_signals_read - x-unstable: '**Note**: This endpoint is in beta and may be subject to changes. - - Please check the documentation regularly for updates.' + - security_monitoring_signals_read + x-unstable: |- + **Note**: This endpoint is in beta and may be subject to changes. + Please check the documentation regularly for updates. /api/v2/siem-threat-hunting/histsignals/{histsignal_id}: get: description: Get a hist signal's details. operationId: GetSecurityMonitoringHistsignal parameters: - - $ref: '#/components/parameters/ThreatHuntingSignalID' + - $ref: "#/components/parameters/ThreatHuntingSignalID" responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SecurityMonitoringSignalResponse' + $ref: "#/components/schemas/SecurityMonitoringSignalResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_signals_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_signals_read summary: Get a hist signal's details - tags: - - Security Monitoring - x-permission: + tags: ["Security Monitoring"] + "x-permission": operator: OR permissions: - - security_monitoring_signals_read - x-unstable: '**Note**: This endpoint is in beta and may be subject to changes. - - Please check the documentation regularly for updates.' + - security_monitoring_signals_read + x-unstable: |- + **Note**: This endpoint is in beta and may be subject to changes. + Please check the documentation regularly for updates. /api/v2/siem-threat-hunting/jobs: get: description: List threat hunting jobs. operationId: ListThreatHuntingJobs parameters: - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' - - description: The order of the jobs in results. - example: status - in: query - name: sort - required: false - schema: - type: string - - description: Query used to filter items from the fetched list. - example: security:attack status:high - in: query - name: filter[query] - required: false - schema: - type: string + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - description: The order of the jobs in results. + example: "status" + in: query + name: sort + required: false + schema: + type: string + - description: Query used to filter items from the fetched list. + example: "security:attack status:high" + in: query + name: filter[query] + required: false + schema: + type: string responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/ListThreatHuntingJobsResponse' + $ref: "#/components/schemas/ListThreatHuntingJobsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: List threat hunting jobs - tags: - - Security Monitoring - x-unstable: '**Note**: This endpoint is in beta and may be subject to changes. - - Please check the documentation regularly for updates.' + tags: ["Security Monitoring"] + x-unstable: |- + **Note**: This endpoint is in beta and may be subject to changes. + Please check the documentation regularly for updates. post: - description: Run a threat hunting job. + description: |- + Run a threat hunting job. operationId: RunThreatHuntingJob requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/RunThreatHuntingJobRequest' + $ref: "#/components/schemas/RunThreatHuntingJobRequest" required: true responses: - '201': + "201": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/JobCreateResponse' + $ref: "#/components/schemas/JobCreateResponse" description: Status created - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/ConcurrentModificationResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/ConcurrentModificationResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_write summary: Run a threat hunting job - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_rules_write - x-unstable: '**Note**: This endpoint is in beta and may be subject to changes. - - Please check the documentation regularly for updates.' + - security_monitoring_rules_write + x-unstable: |- + **Note**: This endpoint is in beta and may be subject to changes. + Please check the documentation regularly for updates. /api/v2/siem-threat-hunting/jobs/signal_convert: post: - description: Convert a job result to a signal. + description: |- + Convert a job result to a signal. operationId: ConvertJobResultToSignal requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/ConvertJobResultsToSignalsRequest' + $ref: "#/components/schemas/ConvertJobResultsToSignalsRequest" required: true responses: - '204': - description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/ConcurrentModificationResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "204": + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/ConcurrentModificationResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Convert a job result to a signal - tags: - - Security Monitoring + tags: ["Security Monitoring"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - security_monitoring_signals_write - x-unstable: '**Note**: This endpoint is in beta and may be subject to changes. - - Please check the documentation regularly for updates.' + - security_monitoring_signals_write + x-unstable: |- + **Note**: This endpoint is in beta and may be subject to changes. + Please check the documentation regularly for updates. /api/v2/siem-threat-hunting/jobs/{job_id}: delete: - description: Delete an existing job. + description: |- + Delete an existing job. operationId: DeleteThreatHuntingJob parameters: - - $ref: '#/components/parameters/ThreatHuntingJobID' - responses: - '204': - description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/ConcurrentModificationResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - $ref: "#/components/parameters/ThreatHuntingJobID" + responses: + "204": + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/ConcurrentModificationResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Delete an existing job - tags: - - Security Monitoring - x-unstable: '**Note**: This endpoint is in beta and may be subject to changes. - - Please check the documentation regularly for updates.' + tags: ["Security Monitoring"] + x-unstable: |- + **Note**: This endpoint is in beta and may be subject to changes. + Please check the documentation regularly for updates. get: description: Get a job's details. operationId: GetThreatHuntingJob parameters: - - $ref: '#/components/parameters/ThreatHuntingJobID' + - $ref: "#/components/parameters/ThreatHuntingJobID" responses: - '200': + "200": content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/ThreatHuntingJobResponse' + $ref: "#/components/schemas/ThreatHuntingJobResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_read summary: Get a job's details - tags: - - Security Monitoring - x-permission: + tags: ["Security Monitoring"] + "x-permission": operator: OR permissions: - - security_monitoring_rules_read - x-unstable: '**Note**: This endpoint is in beta and may be subject to changes. - - Please check the documentation regularly for updates.' + - security_monitoring_rules_read + x-unstable: |- + **Note**: This endpoint is in beta and may be subject to changes. + Please check the documentation regularly for updates. /api/v2/siem-threat-hunting/jobs/{job_id}/cancel: patch: description: Cancel a threat hunting job. operationId: CancelThreatHuntingJob parameters: - - $ref: '#/components/parameters/ThreatHuntingJobID' - responses: - '204': - description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/ConcurrentModificationResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_rules_write + - $ref: "#/components/parameters/ThreatHuntingJobID" + responses: + "204": + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/ConcurrentModificationResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_write summary: Cancel a threat hunting job - tags: - - Security Monitoring - x-permission: + tags: ["Security Monitoring"] + "x-permission": operator: OR permissions: - - security_monitoring_rules_write - x-unstable: '**Note**: This endpoint is in beta and may be subject to changes. - - Please check the documentation regularly for updates.' + - security_monitoring_rules_write + x-unstable: |- + **Note**: This endpoint is in beta and may be subject to changes. + Please check the documentation regularly for updates. /api/v2/siem-threat-hunting/jobs/{job_id}/histsignals: get: description: Get a job's hist signals. operationId: GetSecurityMonitoringHistsignalsByJobId parameters: - - $ref: '#/components/parameters/ThreatHuntingJobID' - - $ref: '#/components/parameters/QueryFilterSearch' - - $ref: '#/components/parameters/QueryFilterFrom' - - $ref: '#/components/parameters/QueryFilterTo' - - $ref: '#/components/parameters/QuerySort' - - $ref: '#/components/parameters/QueryPageCursor' - - $ref: '#/components/parameters/QueryPageLimit' + - $ref: "#/components/parameters/ThreatHuntingJobID" + - $ref: "#/components/parameters/QueryFilterSearch" + - $ref: "#/components/parameters/QueryFilterFrom" + - $ref: "#/components/parameters/QueryFilterTo" + - $ref: "#/components/parameters/QuerySort" + - $ref: "#/components/parameters/QueryPageCursor" + - $ref: "#/components/parameters/QueryPageLimit" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecurityMonitoringSignalsListResponse' + $ref: "#/components/schemas/SecurityMonitoringSignalsListResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - security_monitoring_signals_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_signals_read summary: Get a job's hist signals - tags: - - Security Monitoring - x-permission: + tags: ["Security Monitoring"] + "x-permission": operator: OR permissions: - - security_monitoring_signals_read - x-unstable: '**Note**: This endpoint is in beta and may be subject to changes. - - Please check the documentation regularly for updates.' + - security_monitoring_signals_read + x-unstable: |- + **Note**: This endpoint is in beta and may be subject to changes. + Please check the documentation regularly for updates. /api/v2/slo/report: post: - description: '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. - + description: |- + 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. - Check the status of the job and download the CSV report using the returned - `report_id`.' + Check the status of the job and download the CSV report using the returned `report_id`. operationId: CreateSLOReportJob requestBody: content: application/json: schema: - $ref: '#/components/schemas/SloReportCreateRequest' + $ref: "#/components/schemas/SloReportCreateRequest" description: Create SLO report job request body. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SLOReportPostResponse' + $ref: "#/components/schemas/SLOReportPostResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - slos_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - slos_read summary: Create a new SLO report tags: - - Service Level Objectives + - Service Level Objectives x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - slos_read - x-unstable: '**Note**: This feature is in private beta. To request access, use - the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export) - docs.' + - slos_read + x-unstable: |- + **Note**: This feature is in private beta. To request access, use the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export) docs. /api/v2/slo/report/{report_id}/download: get: - description: 'Download an SLO report. This can only be performed after the report - job has completed. - + description: |- + Download an SLO report. This can only be performed after the report job has completed. - Reports are not guaranteed to exist indefinitely. Datadog recommends that - you download the report as soon as it is available.' + Reports are not guaranteed to exist indefinitely. Datadog recommends that you download the report as soon as it is available. operationId: GetSLOReport parameters: - - $ref: '#/components/parameters/ReportID' + - $ref: "#/components/parameters/ReportID" responses: - '200': + "200": content: text/csv: schema: type: string description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - slos_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - slos_read summary: Get SLO report tags: - - Service Level Objectives - x-unstable: '**Note**: This feature is in private beta. To request access, use - the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export) - docs.' + - Service Level Objectives + x-unstable: |- + **Note**: This feature is in private beta. To request access, use the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export) docs. /api/v2/slo/report/{report_id}/status: get: description: Get the status of the SLO report job. operationId: GetSLOReportJobStatus parameters: - - $ref: '#/components/parameters/ReportID' + - $ref: "#/components/parameters/ReportID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SLOReportStatusGetResponse' + $ref: "#/components/schemas/SLOReportStatusGetResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - slos_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - slos_read summary: Get SLO report status tags: - - Service Level Objectives - x-unstable: '**Note**: This feature is in private beta. To request access, use - the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export) - docs.' + - Service Level Objectives + x-unstable: |- + **Note**: This feature is in private beta. To request access, use the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export) docs. /api/v2/slo/{slo_id}/status: get: - description: 'Get the status of a Service Level Objective (SLO) for a given - time period. + description: |- + Get the status of a Service Level Objective (SLO) for a given time period. - - This endpoint returns the current SLI value, error budget remaining, and other - status information for the specified SLO.' + This endpoint returns the current SLI value, error budget remaining, and other status information for the specified SLO. operationId: GetSloStatus parameters: - - $ref: '#/components/parameters/SloID' - - $ref: '#/components/parameters/FromTimestamp' - - $ref: '#/components/parameters/ToTimestamp' - - $ref: '#/components/parameters/DisableCorrections' + - $ref: "#/components/parameters/SloID" + - $ref: "#/components/parameters/FromTimestamp" + - $ref: "#/components/parameters/ToTimestamp" + - $ref: "#/components/parameters/DisableCorrections" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SloStatusResponse' + $ref: "#/components/schemas/SloStatusResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not Found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - slos_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - slos_read summary: Get SLO status tags: - - Service Level Objectives - x-permission: + - Service Level Objectives + "x-permission": operator: OR permissions: - - slos_read - x-unstable: '**Note**: This endpoint is in public beta and it''s subject to - change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - slos_read + x-unstable: |- + **Note**: This endpoint is in public beta and it's subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/spa/recommendations/{service}: get: - description: This endpoint is currently experimental and restricted to Datadog - internal use only. Retrieve resource recommendations for a Spark job. The - caller (Spark Gateway or DJM UI) provides a service name and SPA returns structured - recommendations for driver and executor resources. The version with a shard - should be preferred, where possible, as it gives more accurate results. + description: This endpoint is currently experimental and restricted to Datadog internal use only. Retrieve resource recommendations for a Spark job. The caller (Spark Gateway or DJM UI) provides a service name and SPA returns structured recommendations for driver and executor resources. The version with a shard should be preferred, where possible, as it gives more accurate results. operationId: GetSPARecommendations parameters: - - description: The recommendation service should not use its metrics cache. - in: query - name: bypass_cache - schema: - type: string - - description: The service name for a spark job. - in: path - name: service - required: true - schema: - type: string + - description: The recommendation service should not use its metrics cache. + in: query + name: bypass_cache + schema: + type: string + - description: The service name for a spark job. + in: path + name: service + required: true + schema: + type: string responses: - '200': + "200": content: application/json: example: @@ -105345,70 +100989,60 @@ paths: attributes: driver: estimation: - cpu: - max: 1500 - p75: 1000 - p95: 1200 + cpu: {max: 1500, p75: 1000, p95: 1200} ephemeral_storage: 896 heap: 6144 memory: 7168 overhead: 1024 executor: estimation: - cpu: - max: 2000 - p75: 1200 - p95: 1500 + cpu: {max: 2000, p75: 1200, p95: 1500} ephemeral_storage: 512 heap: 3072 memory: 4096 overhead: 1024 - id: dedupeactivecontexts:adp_dedupeactivecontexts_org2 + id: "dedupeactivecontexts:adp_dedupeactivecontexts_org2" type: recommendation schema: - $ref: '#/components/schemas/RecommendationDocument' + $ref: "#/components/schemas/RecommendationDocument" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - AuthZ: [] + - AuthZ: [] summary: Get SPA Recommendations tags: - - Spa - x-unstable: '**Note**: This endpoint is in preview and may change in the future. - It is not yet recommended for production use.' + - Spa + x-unstable: |- + **Note**: This endpoint is in preview and may change in the future. It is not yet recommended for production use. /api/v2/spa/recommendations/{service}/{shard}: get: - description: This endpoint is currently experimental and restricted to Datadog - internal use only. Retrieve resource recommendations for a Spark job. The - caller (Spark Gateway or DJM UI) provides a service name and shard identifier, - and SPA returns structured recommendations for driver and executor resources. + description: This endpoint is currently experimental and restricted to Datadog internal use only. Retrieve resource recommendations for a Spark job. The caller (Spark Gateway or DJM UI) provides a service name and shard identifier, and SPA returns structured recommendations for driver and executor resources. operationId: GetSPARecommendationsWithShard parameters: - - description: The shard tag for a spark job, which differentiates jobs within - the same service that have different resource needs - in: path - name: shard - required: true - schema: - type: string - - description: The service name for a spark job - in: path - name: service - required: true - schema: - type: string - - description: The recommendation service should not use its metrics cache. - in: query - name: bypass_cache - schema: - type: string + - description: The shard tag for a spark job, which differentiates jobs within the same service that have different resource needs + in: path + name: shard + required: true + schema: + type: string + - description: The service name for a spark job + in: path + name: service + required: true + schema: + type: string + - description: The recommendation service should not use its metrics cache. + in: query + name: bypass_cache + schema: + type: string responses: - '200': + "200": content: application/json: example: @@ -105416,166 +101050,152 @@ paths: attributes: driver: estimation: - cpu: - max: 1500 - p75: 1000 - p95: 1200 + cpu: {max: 1500, p75: 1000, p95: 1200} ephemeral_storage: 896 heap: 6144 memory: 7168 overhead: 1024 executor: estimation: - cpu: - max: 2000 - p75: 1200 - p95: 1500 + cpu: {max: 2000, p75: 1200, p95: 1500} ephemeral_storage: 512 heap: 3072 memory: 4096 overhead: 1024 - id: dedupeactivecontexts:adp_dedupeactivecontexts_org2 + id: "dedupeactivecontexts:adp_dedupeactivecontexts_org2" type: recommendation schema: - $ref: '#/components/schemas/RecommendationDocument' + $ref: "#/components/schemas/RecommendationDocument" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - AuthZ: [] + - AuthZ: [] summary: Get SPA Recommendations with a shard parameter tags: - - Spa - x-unstable: '**Note**: This endpoint is in preview and may change in the future. - It is not yet recommended for production use.' + - Spa + x-unstable: |- + **Note**: This endpoint is in preview and may change in the future. It is not yet recommended for production use. /api/v2/spans/analytics/aggregate: post: - description: 'The API endpoint to aggregate spans into buckets and compute metrics - and timeseries. - - This endpoint is rate limited to `300` requests per hour.' + description: |- + The API endpoint to aggregate spans into buckets and compute metrics and timeseries. + This endpoint is rate limited to `300` requests per hour. operationId: AggregateSpans requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SpansAggregateRequest' + $ref: "#/components/schemas/SpansAggregateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SpansAggregateResponse' + $ref: "#/components/schemas/SpansAggregateResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_read summary: Aggregate spans - tags: - - Spans + tags: ["Spans"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - apm_read + - apm_read /api/v2/spans/events: get: - description: 'List endpoint returns spans that match a span search query. - + description: |- + List endpoint returns spans that match a span search query. [Results are paginated][1]. - Use this endpoint to see your latest spans. - This endpoint is rate limited to `300` requests per hour. - - [1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api' + [1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api operationId: ListSpansGet parameters: - - description: Search query following spans syntax. - example: '@datacenter:us @role:db' - in: query - name: filter[query] - required: false - schema: - type: string - - description: Minimum timestamp for requested spans. Supports date-time ISO8601, - date math, and regular timestamps (milliseconds). - example: '2023-01-02T09:42:36.320Z' - in: query - name: filter[from] - required: false - schema: - type: string - - description: Maximum timestamp for requested spans. Supports date-time ISO8601, - date math, and regular timestamps (milliseconds). - example: '2023-01-03T09:42:36.320Z' - in: query - name: filter[to] - required: false - schema: - type: string - - description: Order of spans in results. - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/SpansSort' - - description: List following results with a cursor provided in the previous - query. - example: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== - in: query - name: page[cursor] - required: false - schema: - type: string - - description: Maximum number of spans in the response. - example: 25 - in: query - name: page[limit] - required: false - schema: - default: 10 - format: int32 - maximum: 1000 - type: integer + - description: Search query following spans syntax. + example: "@datacenter:us @role:db" + in: query + name: filter[query] + required: false + schema: + type: string + - description: Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds). + example: "2023-01-02T09:42:36.320Z" + in: query + name: filter[from] + required: false + schema: + type: string + - description: Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds). + example: "2023-01-03T09:42:36.320Z" + in: query + name: filter[to] + required: false + schema: + type: string + - description: Order of spans in results. + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/SpansSort" + - description: |- + List following results with a cursor provided in the previous query. + example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" + in: query + name: page[cursor] + required: false + schema: + type: string + - description: Maximum number of spans in the response. + example: 25 + in: query + name: page[limit] + required: false + schema: + default: 10 + format: int32 + maximum: 1000 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SpansListResponse' + $ref: "#/components/schemas/SpansListResponse" description: OK - '400': - $ref: '#/components/responses/SpansBadRequestResponse' - '403': - $ref: '#/components/responses/SpansForbiddenResponse' - '422': - $ref: '#/components/responses/SpansUnprocessableEntityResponse' - '429': - $ref: '#/components/responses/SpansTooManyRequestsResponse' + "400": + $ref: "#/components/responses/SpansBadRequestResponse" + "403": + $ref: "#/components/responses/SpansForbiddenResponse" + "422": + $ref: "#/components/responses/SpansUnprocessableEntityResponse" + "429": + $ref: "#/components/responses/SpansTooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_read summary: Get a list of spans - tags: - - Spans + tags: ["Spans"] x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after @@ -105583,47 +101203,43 @@ paths: resultsPath: data /api/v2/spans/events/search: post: - description: 'List endpoint returns spans that match a span search query. - + description: |- + List endpoint returns spans that match a span search query. [Results are paginated][1]. - Use this endpoint to build complex spans filtering and search. - This endpoint is rate limited to `300` requests per hour. - - [1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api' + [1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api operationId: ListSpans requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/SpansListRequest' + $ref: "#/components/schemas/SpansListRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SpansListResponse' + $ref: "#/components/schemas/SpansListResponse" description: OK - '400': - $ref: '#/components/responses/SpansBadRequestResponse' - '403': - $ref: '#/components/responses/SpansForbiddenResponse' - '422': - $ref: '#/components/responses/SpansUnprocessableEntityResponse' - '429': - $ref: '#/components/responses/SpansTooManyRequestsResponse' + "400": + $ref: "#/components/responses/SpansBadRequestResponse" + "403": + $ref: "#/components/responses/SpansForbiddenResponse" + "422": + $ref: "#/components/responses/SpansUnprocessableEntityResponse" + "429": + $ref: "#/components/responses/SpansTooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - apm_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_read summary: Search spans - tags: - - Spans + tags: ["Spans"] x-codegen-request-body-name: body x-pagination: cursorParam: body.data.attributes.page.cursor @@ -105637,22 +101253,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ScaRequest' + $ref: "#/components/schemas/ScaRequest" required: true responses: - '200': + "200": description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - code_analysis_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - code_analysis_read summary: Post dependencies for analysis tags: - - Static Analysis - x-unstable: '**Note**: This endpoint may be subject to changes.' + - Static Analysis + x-unstable: "**Note**: This endpoint may be subject to changes." /api/v2/static-analysis-sca/vulnerabilities/resolve-vulnerable-symbols: post: operationId: CreateSCAResolveVulnerableSymbols @@ -105660,534 +101276,514 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ResolveVulnerableSymbolsRequest' + $ref: "#/components/schemas/ResolveVulnerableSymbolsRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/ResolveVulnerableSymbolsResponse' + $ref: "#/components/schemas/ResolveVulnerableSymbolsResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - code_analysis_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - code_analysis_read summary: POST request to resolve vulnerable symbols tags: - - Static Analysis - x-unstable: '**Note**: This endpoint may be subject to changes.' + - Static Analysis + x-unstable: "**Note**: This endpoint may be subject to changes." /api/v2/static-analysis/custom/rulesets/{ruleset_name}: delete: description: Delete a custom ruleset operationId: DeleteCustomRuleset parameters: - - description: The ruleset name - in: path - name: ruleset_name - required: true - schema: - type: string + - description: The ruleset name + in: path + name: ruleset_name + required: true + schema: + type: string responses: - '200': + "200": description: Successfully deleted - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - custom rules not enabled - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Ruleset not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete Custom Ruleset tags: - - Static Analysis - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Static Analysis + x-unstable: "This endpoint is in Preview and may introduce breaking changes.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." get: description: Get a custom ruleset by name operationId: GetCustomRuleset parameters: - - description: The ruleset name - in: path - name: ruleset_name - required: true - schema: - type: string + - description: The ruleset name + in: path + name: ruleset_name + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomRulesetResponse' + $ref: "#/components/schemas/CustomRulesetResponse" description: Successful response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - custom rules not enabled - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Ruleset not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Show Custom Ruleset tags: - - Static Analysis - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Static Analysis + x-unstable: "This endpoint is in Preview and may introduce breaking changes.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." patch: description: Update an existing custom ruleset operationId: UpdateCustomRuleset parameters: - - description: The ruleset name - in: path - name: ruleset_name - required: true - schema: - type: string + - description: The ruleset name + in: path + name: ruleset_name + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CustomRulesetRequest' + $ref: "#/components/schemas/CustomRulesetRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomRulesetResponse' + $ref: "#/components/schemas/CustomRulesetResponse" description: Successfully updated - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - custom rules not enabled - '412': + "412": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Precondition failed - validation error or ruleset not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Update Custom Ruleset tags: - - Static Analysis - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Static Analysis + x-unstable: "This endpoint is in Preview and may introduce breaking changes.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." /api/v2/static-analysis/custom/rulesets/{ruleset_name}/rules: put: description: Create a new custom rule within a ruleset operationId: CreateCustomRule parameters: - - description: The ruleset name - in: path - name: ruleset_name - required: true - schema: - type: string + - description: The ruleset name + in: path + name: ruleset_name + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CustomRuleRequest' + $ref: "#/components/schemas/CustomRuleRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomRuleResponse' + $ref: "#/components/schemas/CustomRuleResponse" description: Successfully created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - custom rules not enabled - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Conflict - rule already exists - '412': + "412": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Precondition failed - validation error or ruleset not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create Custom Rule tags: - - Static Analysis - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Static Analysis + x-unstable: "This endpoint is in Preview and may introduce breaking changes.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." /api/v2/static-analysis/custom/rulesets/{ruleset_name}/rules/{rule_name}: delete: description: Delete a custom rule operationId: DeleteCustomRule parameters: - - description: The ruleset name - in: path - name: ruleset_name - required: true - schema: - type: string - - description: The rule name - in: path - name: rule_name - required: true - schema: - type: string + - description: The ruleset name + in: path + name: ruleset_name + required: true + schema: + type: string + - description: The rule name + in: path + name: rule_name + required: true + schema: + type: string responses: - '200': + "200": description: Successfully deleted - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - custom rules not enabled - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Rule not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete Custom Rule tags: - - Static Analysis - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Static Analysis + x-unstable: "This endpoint is in Preview and may introduce breaking changes.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." get: description: Get a custom rule by name operationId: GetCustomRule parameters: - - description: The ruleset name - in: path - name: ruleset_name - required: true - schema: - type: string - - description: The rule name - in: path - name: rule_name - required: true - schema: - type: string + - description: The ruleset name + in: path + name: ruleset_name + required: true + schema: + type: string + - description: The rule name + in: path + name: rule_name + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomRuleResponse' + $ref: "#/components/schemas/CustomRuleResponse" description: Successful response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - custom rules not enabled - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Rule not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Show Custom Rule tags: - - Static Analysis - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Static Analysis + x-unstable: "This endpoint is in Preview and may introduce breaking changes.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." /api/v2/static-analysis/custom/rulesets/{ruleset_name}/rules/{rule_name}/revisions: get: description: Get all revisions for a custom rule operationId: ListCustomRuleRevisions parameters: - - description: The ruleset name - in: path - name: ruleset_name - required: true - schema: - type: string - - description: The rule name - in: path - name: rule_name - required: true - schema: - type: string - - description: Pagination offset - in: query - name: page[offset] - required: false - schema: - default: 0 - type: integer - - description: Pagination limit - in: query - name: page[limit] - required: false - schema: - default: 10 - type: integer + - description: The ruleset name + in: path + name: ruleset_name + required: true + schema: + type: string + - description: The rule name + in: path + name: rule_name + required: true + schema: + type: string + - description: Pagination offset + in: query + name: page[offset] + required: false + schema: + default: 0 + type: integer + - description: Pagination limit + in: query + name: page[limit] + required: false + schema: + default: 10 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomRuleRevisionsResponse' + $ref: "#/components/schemas/CustomRuleRevisionsResponse" description: Successful response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - custom rules not enabled - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Rule not found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Too many requests summary: List Custom Rule Revisions tags: - - Static Analysis + - Static Analysis x-pagination: limitParam: page[limit] pageOffsetParam: page[offset] resultsPath: data - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + x-unstable: "This endpoint is in Preview and may introduce breaking changes.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." put: description: Create a new revision for a custom rule operationId: CreateCustomRuleRevision parameters: - - description: The ruleset name - in: path - name: ruleset_name - required: true - schema: - type: string - - description: The rule name - in: path - name: rule_name - required: true - schema: - type: string + - description: The ruleset name + in: path + name: ruleset_name + required: true + schema: + type: string + - description: The rule name + in: path + name: rule_name + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CustomRuleRevisionRequest' + $ref: "#/components/schemas/CustomRuleRevisionRequest" required: true responses: - '200': + "200": description: Successfully created - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - custom rules not enabled - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Rule not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Create Custom Rule Revision tags: - - Static Analysis - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Static Analysis + x-unstable: "This endpoint is in Preview and may introduce breaking changes.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." /api/v2/static-analysis/custom/rulesets/{ruleset_name}/rules/{rule_name}/revisions/revert: post: description: Revert a custom rule to a previous revision operationId: RevertCustomRuleRevision parameters: - - description: The ruleset name - in: path - name: ruleset_name - required: true - schema: - type: string - - description: The rule name - in: path - name: rule_name - required: true - schema: - type: string + - description: The ruleset name + in: path + name: ruleset_name + required: true + schema: + type: string + - description: The rule name + in: path + name: rule_name + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/RevertCustomRuleRevisionRequest' + $ref: "#/components/schemas/RevertCustomRuleRevisionRequest" required: true responses: - '200': + "200": description: Successfully reverted - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - custom rules not enabled - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Revert Custom Rule Revision tags: - - Static Analysis - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Static Analysis + x-unstable: "This endpoint is in Preview and may introduce breaking changes.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." /api/v2/static-analysis/custom/rulesets/{ruleset_name}/rules/{rule_name}/revisions/{id}: get: description: Get a specific revision of a custom rule operationId: GetCustomRuleRevision parameters: - - description: The ruleset name - in: path - name: ruleset_name - required: true - schema: - type: string - - description: The rule name - in: path - name: rule_name - required: true - schema: - type: string - - description: The revision ID - in: path - name: id - required: true - schema: - type: string + - description: The ruleset name + in: path + name: ruleset_name + required: true + schema: + type: string + - description: The rule name + in: path + name: rule_name + required: true + schema: + type: string + - description: The revision ID + in: path + name: id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/CustomRuleRevisionResponse' + $ref: "#/components/schemas/CustomRuleRevisionResponse" description: Successful response - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '401': + "401": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Unauthorized - custom rules not enabled - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Revision not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Show Custom Rule Revision tags: - - Static Analysis - x-unstable: 'This endpoint is in Preview and may introduce breaking changes. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - Static Analysis + x-unstable: "This endpoint is in Preview and may introduce breaking changes.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." /api/v2/static-analysis/rulesets: post: description: Get rules for multiple rulesets in batch. @@ -106196,949 +101792,926 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetMultipleRulesetsRequest' + $ref: "#/components/schemas/GetMultipleRulesetsRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GetMultipleRulesetsResponse' + $ref: "#/components/schemas/GetMultipleRulesetsResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - code_analysis_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - code_analysis_read summary: Ruleset get multiple tags: - - Security Monitoring - x-unstable: '**Note**: This endpoint may be subject to changes.' + - "Security Monitoring" + x-unstable: "**Note**: This endpoint may be subject to changes." /api/v2/static-analysis/secrets/rules: get: - description: Returns a list of Secrets rules with ID, Pattern, Description, - Priority, and SDS ID. + description: |- + Returns a list of Secrets rules with ID, Pattern, Description, Priority, and SDS ID. operationId: GetSecretsRules responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SecretRuleArray' + $ref: "#/components/schemas/SecretRuleArray" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - code_analysis_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - code_analysis_read summary: Returns a list of Secrets rules tags: - - Security Monitoring - x-unstable: '**Note**: This endpoint may be subject to changes.' + - "Security Monitoring" + x-unstable: "**Note**: This endpoint may be subject to changes." /api/v2/statuspages: get: description: Lists all status pages for the organization. operationId: ListStatusPages parameters: - - description: Offset to use as the start of the page. - in: query - name: page[offset] - schema: - default: 0 - type: integer - - description: The number of status pages to return per page. - in: query - name: page[limit] - schema: - default: 50 - type: integer - - description: 'Comma-separated list of resources to include. Supported values: - created_by_user, last_modified_by_user.' - in: query - name: include - schema: - type: string + - description: Offset to use as the start of the page. + in: query + name: page[offset] + schema: + default: 0 + type: integer + - description: The number of status pages to return per page. + in: query + name: page[limit] + schema: + default: 50 + type: integer + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user." + in: query + name: include + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/StatusPageArray' + $ref: "#/components/schemas/StatusPageArray" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: List status pages tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_settings_read + - status_pages_settings_read post: description: Creates a new status page. operationId: CreateStatusPage parameters: - - description: 'Comma-separated list of resources to include. Supported values: - created_by_user, last_modified_by_user.' - in: query - name: include - schema: - type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user." + in: query + name: include + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateStatusPageRequest' + $ref: "#/components/schemas/CreateStatusPageRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/StatusPage' + $ref: "#/components/schemas/StatusPage" description: Created - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Create status page tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_settings_write + - status_pages_settings_write /api/v2/statuspages/degradations: get: - description: Lists all degradations for the organization. Optionally filter - by status and page. + description: Lists all degradations for the organization. Optionally filter by status and page. operationId: ListDegradations parameters: - - description: Optional page id filter. - in: query - name: filter[page_id] - schema: - type: string - - description: Offset to use as the start of the page. - in: query - name: page[offset] - schema: - default: 0 - type: integer - - description: The number of degradations to return per page. - in: query - name: page[limit] - schema: - default: 50 - type: integer - - description: 'Comma-separated list of resources to include. Supported values: - created_by_user, last_modified_by_user, status_page.' - in: query - name: include - schema: - type: string - - description: 'Optional degradation status filter. Supported values: investigating, - identified, monitoring, resolved.' - in: query - name: filter[status] - schema: - type: string - - description: 'Sort order. Prefix with ''-'' for descending. Supported values: - created_at, -created_at, modified_at, -modified_at.' - in: query - name: sort - schema: - type: string + - description: Optional page id filter. + in: query + name: filter[page_id] + schema: + type: string + - description: Offset to use as the start of the page. + in: query + name: page[offset] + schema: + default: 0 + type: integer + - description: The number of degradations to return per page. + in: query + name: page[limit] + schema: + default: 50 + type: integer + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page." + in: query + name: include + schema: + type: string + - description: "Optional degradation status filter. Supported values: investigating, identified, monitoring, resolved." + in: query + name: filter[status] + schema: + type: string + - description: "Sort order. Prefix with '-' for descending. Supported values: created_at, -created_at, modified_at, -modified_at." + in: query + name: sort + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DegradationArray' + $ref: "#/components/schemas/DegradationArray" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: List degradations tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_settings_read + - status_pages_settings_read /api/v2/statuspages/maintenances: get: - description: Lists all maintenances for the organization. Optionally filter - by status and page. + description: Lists all maintenances for the organization. Optionally filter by status and page. operationId: ListMaintenances parameters: - - description: Optional page id filter. - in: query - name: filter[page_id] - schema: - type: string - - description: Offset to use as the start of the page. - in: query - name: page[offset] - schema: - default: 0 - type: integer - - description: The number of maintenances to return per page. - in: query - name: page[limit] - schema: - default: 50 - type: integer - - description: 'Comma-separated list of resources to include. Supported values: - created_by_user, last_modified_by_user, status_page.' - in: query - name: include - schema: - type: string - - description: 'Optional maintenance status filter. Supported values: scheduled, - in_progress, completed.' - in: query - name: filter[status] - schema: - type: string - - description: 'Sort order. Prefix with ''-'' for descending. Supported values: - created_at, -created_at, start_date, -start_date.' - in: query - name: sort - schema: - type: string + - description: Optional page id filter. + in: query + name: filter[page_id] + schema: + type: string + - description: Offset to use as the start of the page. + in: query + name: page[offset] + schema: + default: 0 + type: integer + - description: The number of maintenances to return per page. + in: query + name: page[limit] + schema: + default: 50 + type: integer + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page." + in: query + name: include + schema: + type: string + - description: "Optional maintenance status filter. Supported values: scheduled, in_progress, completed." + in: query + name: filter[status] + schema: + type: string + - description: "Sort order. Prefix with '-' for descending. Supported values: created_at, -created_at, start_date, -start_date." + in: query + name: sort + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/MaintenanceArray' + $ref: "#/components/schemas/MaintenanceArray" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: List maintenances tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_settings_read + - status_pages_settings_read /api/v2/statuspages/{page_id}: delete: description: Deletes a status page by its ID. operationId: DeleteStatusPage parameters: - - description: The ID of the status page. - in: path - name: page_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string responses: - '204': + "204": description: No Content - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Delete status page tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_settings_write + - status_pages_settings_write get: description: Retrieves a specific status page by its ID. operationId: GetStatusPage parameters: - - description: The ID of the status page. - in: path - name: page_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string - - description: 'Comma-separated list of resources to include. Supported values: - created_by_user, last_modified_by_user.' - in: query - name: include - schema: - type: string + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user." + in: query + name: include + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/StatusPage' + $ref: "#/components/schemas/StatusPage" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get status page tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_settings_read + - status_pages_settings_read patch: description: Updates an existing status page's attributes. operationId: UpdateStatusPage parameters: - - description: Whether to delete existing subscribers when updating a status - page's type. - in: query - name: delete_subscribers - schema: - default: false - type: boolean - - description: The ID of the status page. - in: path - name: page_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string - - description: 'Comma-separated list of resources to include. Supported values: - created_by_user, last_modified_by_user.' - in: query - name: include - schema: - type: string + - description: Whether to delete existing subscribers when updating a status page's type. + in: query + name: delete_subscribers + schema: + default: false + type: boolean + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user." + in: query + name: include + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchStatusPageRequest' + $ref: "#/components/schemas/PatchStatusPageRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/StatusPage' + $ref: "#/components/schemas/StatusPage" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Update status page tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_settings_write + - status_pages_settings_write /api/v2/statuspages/{page_id}/components: get: description: Lists all components for a status page. operationId: ListComponents parameters: - - description: The ID of the status page. - in: path - name: page_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string - - description: 'Comma-separated list of resources to include. Supported values: - created_by_user, last_modified_by_user, status_page, group.' - in: query - name: include - schema: - type: string + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group." + in: query + name: include + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/StatusPagesComponentArray' + $ref: "#/components/schemas/StatusPagesComponentArray" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: List components tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_settings_read + - status_pages_settings_read post: description: Creates a new component. operationId: CreateComponent parameters: - - description: The ID of the status page. - in: path - name: page_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string - - description: 'Comma-separated list of resources to include. Supported values: - created_by_user, last_modified_by_user, status_page, group.' - in: query - name: include - schema: - type: string + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group." + in: query + name: include + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateComponentRequest' + $ref: "#/components/schemas/CreateComponentRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/StatusPagesComponent' + $ref: "#/components/schemas/StatusPagesComponent" description: Created - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Create component tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_settings_write + - status_pages_settings_write /api/v2/statuspages/{page_id}/components/{component_id}: delete: description: Deletes a component by its ID. operationId: DeleteComponent parameters: - - description: The ID of the status page. - in: path - name: page_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string - - description: The ID of the component. - in: path - name: component_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + - description: The ID of the component. + in: path + name: component_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string responses: - '204': + "204": description: No Content - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Delete component tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_settings_write + - status_pages_settings_write get: description: Retrieves a specific component by its ID. operationId: GetComponent parameters: - - description: The ID of the status page. - in: path - name: page_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string - - description: The ID of the component. - in: path - name: component_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string - - description: 'Comma-separated list of resources to include. Supported values: - created_by_user, last_modified_by_user, status_page, group.' - in: query - name: include - schema: - type: string + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + - description: The ID of the component. + in: path + name: component_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group." + in: query + name: include + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/StatusPagesComponent' + $ref: "#/components/schemas/StatusPagesComponent" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get component tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_settings_read + - status_pages_settings_read patch: description: Updates an existing component's attributes. operationId: UpdateComponent parameters: - - description: The ID of the status page. - in: path - name: page_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string - - description: The ID of the component. - in: path - name: component_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string - - description: 'Comma-separated list of resources to include. Supported values: - created_by_user, last_modified_by_user, status_page, group.' - in: query - name: include - schema: - type: string + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + - description: The ID of the component. + in: path + name: component_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group." + in: query + name: include + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchComponentRequest' + $ref: "#/components/schemas/PatchComponentRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/StatusPagesComponent' + $ref: "#/components/schemas/StatusPagesComponent" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Update component tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_settings_write + - status_pages_settings_write /api/v2/statuspages/{page_id}/degradations: post: description: Creates a new degradation. operationId: CreateDegradation parameters: - - description: The ID of the status page. - in: path - name: page_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string - - description: Whether to notify page subscribers of the degradation. - in: query - name: notify_subscribers - schema: - default: true - type: boolean - - description: 'Comma-separated list of resources to include. Supported values: - created_by_user, last_modified_by_user, status_page.' - in: query - name: include - schema: - type: string + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + - description: Whether to notify page subscribers of the degradation. + in: query + name: notify_subscribers + schema: + default: true + type: boolean + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page." + in: query + name: include + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateDegradationRequest' + $ref: "#/components/schemas/CreateDegradationRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/Degradation' + $ref: "#/components/schemas/Degradation" description: Created - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Create degradation tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_incident_write + - status_pages_incident_write /api/v2/statuspages/{page_id}/degradations/{degradation_id}: delete: description: Deletes a degradation by its ID. operationId: DeleteDegradation parameters: - - description: The ID of the status page. - in: path - name: page_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string - - description: The ID of the degradation. - in: path - name: degradation_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + - description: The ID of the degradation. + in: path + name: degradation_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string responses: - '204': + "204": description: No Content - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Delete degradation tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_incident_write + - status_pages_incident_write get: description: Retrieves a specific degradation by its ID. operationId: GetDegradation parameters: - - description: The ID of the status page. - in: path - name: page_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string - - description: The ID of the degradation. - in: path - name: degradation_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string - - description: 'Comma-separated list of resources to include. Supported values: - created_by_user, last_modified_by_user, status_page.' - in: query - name: include - schema: - type: string + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + - description: The ID of the degradation. + in: path + name: degradation_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page." + in: query + name: include + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Degradation' + $ref: "#/components/schemas/Degradation" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get degradation tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_settings_read + - status_pages_settings_read patch: description: Updates an existing degradation's attributes. operationId: UpdateDegradation parameters: - - description: The ID of the status page. - in: path - name: page_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string - - description: Whether to notify page subscribers of the degradation. - in: query - name: notify_subscribers - schema: - default: true - type: boolean - - description: The ID of the degradation. - in: path - name: degradation_id - required: true - schema: - example: 1234abcd-12ab-34cd-56ef-123456abcdef - format: uuid - type: string - - description: 'Comma-separated list of resources to include. Supported values: - created_by_user, last_modified_by_user, status_page.' - in: query - name: include - schema: - type: string + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + - description: Whether to notify page subscribers of the degradation. + in: query + name: notify_subscribers + schema: + default: true + type: boolean + - description: The ID of the degradation. + in: path + name: degradation_id + required: true + schema: + example: 1234abcd-12ab-34cd-56ef-123456abcdef + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page." + in: query + name: include + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchDegradationRequest' + $ref: "#/components/schemas/PatchDegradationRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Degradation' + $ref: "#/components/schemas/Degradation" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Update degradation tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_incident_write + - status_pages_incident_write /api/v2/statuspages/{page_id}/maintenances: post: description: Schedules a new maintenance. operationId: CreateMaintenance parameters: - - description: The ID of the status page. - in: path - name: page_id - required: true - schema: - format: uuid - type: string - - description: Whether to notify page subscribers of the maintenance. - in: query - name: notify_subscribers - schema: - default: true - type: boolean - - description: 'Comma-separated list of resources to include. Supported values: - created_by_user, last_modified_by_user, status_page.' - in: query - name: include - schema: - type: string + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + format: uuid + type: string + - description: Whether to notify page subscribers of the maintenance. + in: query + name: notify_subscribers + schema: + default: true + type: boolean + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page." + in: query + name: include + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateMaintenanceRequest' + $ref: "#/components/schemas/CreateMaintenanceRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/Maintenance' + $ref: "#/components/schemas/Maintenance" description: Created - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Schedule maintenance tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_incident_write + - status_pages_incident_write /api/v2/statuspages/{page_id}/maintenances/{maintenance_id}: get: description: Retrieves a specific maintenance by its ID. operationId: GetMaintenance parameters: - - description: The ID of the status page. - in: path - name: page_id - required: true - schema: - format: uuid - type: string - - description: The ID of the maintenance. - in: path - name: maintenance_id - required: true - schema: - format: uuid - type: string - - description: 'Comma-separated list of resources to include. Supported values: - created_by_user, last_modified_by_user, status_page.' - in: query - name: include - schema: - type: string + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + format: uuid + type: string + - description: The ID of the maintenance. + in: path + name: maintenance_id + required: true + schema: + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page." + in: query + name: include + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Maintenance' + $ref: "#/components/schemas/Maintenance" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get maintenance tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_settings_read + - status_pages_settings_read patch: description: Updates an existing maintenance's attributes. operationId: UpdateMaintenance parameters: - - description: The ID of the status page. - in: path - name: page_id - required: true - schema: - format: uuid - type: string - - description: Whether to notify page subscribers of the maintenance. - in: query - name: notify_subscribers - schema: - default: true - type: boolean - - description: The ID of the maintenance. - in: path - name: maintenance_id - required: true - schema: - format: uuid - type: string - - description: 'Comma-separated list of resources to include. Supported values: - created_by_user, last_modified_by_user, status_page.' - in: query - name: include - schema: - type: string + - description: The ID of the status page. + in: path + name: page_id + required: true + schema: + format: uuid + type: string + - description: Whether to notify page subscribers of the maintenance. + in: query + name: notify_subscribers + schema: + default: true + type: boolean + - description: The ID of the maintenance. + in: path + name: maintenance_id + required: true + schema: + format: uuid + type: string + - description: "Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page." + in: query + name: include + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/PatchMaintenanceRequest' + $ref: "#/components/schemas/PatchMaintenanceRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/Maintenance' + $ref: "#/components/schemas/Maintenance" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Update maintenance tags: - - Status Pages + - Status Pages x-permission: operator: AND permissions: - - status_pages_incident_write + - status_pages_incident_write /api/v2/synthetics/settings/on_demand_concurrency_cap: get: description: Get the on-demand concurrency cap. operationId: GetOnDemandConcurrencyCap responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OnDemandConcurrencyCapResponse' + $ref: "#/components/schemas/OnDemandConcurrencyCapResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Get the on-demand concurrency cap tags: - - Synthetics - x-permission: + - Synthetics + "x-permission": operator: OR permissions: - - billing_read + - billing_read post: description: Save new value for on-demand concurrency cap. operationId: SetOnDemandConcurrencyCap @@ -107146,26 +102719,26 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/OnDemandConcurrencyCapAttributes' + $ref: "#/components/schemas/OnDemandConcurrencyCapAttributes" description: . required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/OnDemandConcurrencyCapResponse' + $ref: "#/components/schemas/OnDemandConcurrencyCapResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Save new value for on-demand concurrency cap tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - billing_edit + - billing_edit /api/v2/synthetics/suites: post: operationId: CreateSyntheticsSuite @@ -107173,36 +102746,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SuiteCreateEditRequest' + $ref: "#/components/schemas/SuiteCreateEditRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsSuiteResponse' + $ref: "#/components/schemas/SyntheticsSuiteResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Create a test suite tags: - - Synthetics + - Synthetics x-permission: operator: OR permissions: - - synthetics_write - - synthetics_create_edit_trigger + - synthetics_write + - synthetics_create_edit_trigger /api/v2/synthetics/suites/bulk-delete: post: operationId: DeleteSyntheticsSuites @@ -107210,183 +102783,183 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeletedSuitesRequestDeleteRequest' + $ref: "#/components/schemas/DeletedSuitesRequestDeleteRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DeletedSuitesResponse' + $ref: "#/components/schemas/DeletedSuitesResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Bulk delete suites tags: - - Synthetics + - Synthetics x-permission: operator: OR permissions: - - synthetics_write + - synthetics_write /api/v2/synthetics/suites/search: get: description: Search for test suites. operationId: SearchSuites parameters: - - description: The search query. - in: query - name: query - required: false - schema: - type: string - - description: The sort order for the results (e.g., `name,asc` or `name,desc`). - in: query - name: sort - required: false - schema: - default: name,asc - type: string - - description: If true, return only facets instead of full test details. - in: query - name: facets_only - required: false - schema: - default: false - type: boolean - - description: The offset from which to start returning results. - in: query - name: start - required: false - schema: - default: 0 - format: int64 - type: integer - - description: The maximum number of results to return. - in: query - name: count - required: false - schema: - default: 50 - format: int64 - type: integer + - description: The search query. + in: query + name: query + required: false + schema: + type: string + - description: The sort order for the results (e.g., `name,asc` or `name,desc`). + in: query + name: sort + required: false + schema: + default: name,asc + type: string + - description: If true, return only facets instead of full test details. + in: query + name: facets_only + required: false + schema: + default: false + type: boolean + - description: The offset from which to start returning results. + in: query + name: start + required: false + schema: + default: 0 + format: int64 + type: integer + - description: The maximum number of results to return. + in: query + name: count + required: false + schema: + default: 50 + format: int64 + type: integer responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsSuiteSearchResponse' + $ref: "#/components/schemas/SyntheticsSuiteSearchResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_read summary: Search test suites tags: - - Synthetics - x-permission: + - Synthetics + "x-permission": operator: OR permissions: - - synthetics_read + - synthetics_read /api/v2/synthetics/suites/{public_id}: get: operationId: GetSyntheticsSuite parameters: - - description: The public ID of the suite to get details from. - in: path - name: public_id - required: true - schema: - type: string + - description: The public ID of the suite to get details from. + in: path + name: public_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsSuiteResponse' + $ref: "#/components/schemas/SyntheticsSuiteResponse" description: OK - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_read summary: Get a suite tags: - - Synthetics + - Synthetics x-permission: operator: OR permissions: - - synthetics_read + - synthetics_read put: operationId: EditSyntheticsSuite parameters: - - description: The public ID of the suite to edit. - in: path - name: public_id - required: true - schema: - type: string + - description: The public ID of the suite to edit. + in: path + name: public_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SuiteCreateEditRequest' + $ref: "#/components/schemas/SuiteCreateEditRequest" description: New suite details to be saved. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsSuiteResponse' + $ref: "#/components/schemas/SyntheticsSuiteResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Edit a test suite tags: - - Synthetics + - Synthetics x-permission: operator: OR permissions: - - synthetics_write + - synthetics_write /api/v2/synthetics/tests/bulk-delete: post: operationId: DeleteSyntheticsTests @@ -107394,41 +102967,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DeletedTestsRequestDeleteRequest' + $ref: "#/components/schemas/DeletedTestsRequestDeleteRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/DeletedTestsResponse' + $ref: "#/components/schemas/DeletedTestsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Bulk delete tests tags: - - Synthetics + - Synthetics x-permission: operator: OR permissions: - - synthetics_write + - synthetics_write /api/v2/synthetics/tests/network: post: operationId: CreateSyntheticsNetworkTest @@ -107436,652 +103009,635 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsNetworkTestEditRequest' + $ref: "#/components/schemas/SyntheticsNetworkTestEditRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsNetworkTestResponse' + $ref: "#/components/schemas/SyntheticsNetworkTestResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Create a Network Path test tags: - - Synthetics + - Synthetics x-permission: operator: OR permissions: - - synthetics_write - - synthetics_create_edit_trigger + - synthetics_write + - synthetics_create_edit_trigger /api/v2/synthetics/tests/network/{public_id}: get: operationId: GetSyntheticsNetworkTest parameters: - - description: The public ID of the Network Path test to get details from. - in: path - name: public_id - required: true - schema: - type: string + - description: The public ID of the Network Path test to get details from. + in: path + name: public_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsNetworkTestResponse' + $ref: "#/components/schemas/SyntheticsNetworkTestResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_read summary: Get a Network Path test tags: - - Synthetics + - Synthetics x-permission: operator: OR permissions: - - synthetics_read + - synthetics_read put: operationId: UpdateSyntheticsNetworkTest parameters: - - description: The public ID of the Network Path test to edit. - in: path - name: public_id - required: true - schema: - type: string + - description: The public ID of the Network Path test to edit. + in: path + name: public_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/SyntheticsNetworkTestEditRequest' + $ref: "#/components/schemas/SyntheticsNetworkTestEditRequest" description: New Network Path test details to be saved. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/SyntheticsNetworkTestResponse' + $ref: "#/components/schemas/SyntheticsNetworkTestResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - synthetics_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - synthetics_write summary: Edit a Network Path test tags: - - Synthetics + - Synthetics x-permission: operator: OR permissions: - - synthetics_write - - synthetics_create_edit_trigger + - synthetics_write + - synthetics_create_edit_trigger /api/v2/synthetics/variables/{variable_id}/jsonpatch: patch: - description: 'Patch a global variable using JSON Patch (RFC 6902). - - This endpoint allows partial updates to a global variable by specifying only - the fields to modify. - + description: |- + Patch a global variable using JSON Patch (RFC 6902). + This endpoint allows partial updates to a global variable by specifying only the fields to modify. Common operations include: - - Replace field values: `{"op": "replace", "path": "/name", "value": "new_name"}` - - - Update nested values: `{"op": "replace", "path": "/value/value", "value": - "new_value"}` - + - Update nested values: `{"op": "replace", "path": "/value/value", "value": "new_value"}` - Add/update tags: `{"op": "add", "path": "/tags/-", "value": "new_tag"}` - - - Remove fields: `{"op": "remove", "path": "/description"}`' + - Remove fields: `{"op": "remove", "path": "/description"}` operationId: PatchGlobalVariable parameters: - - description: The ID of the global variable. - in: path - name: variable_id - required: true - schema: - type: string + - description: The ID of the global variable. + in: path + name: variable_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/GlobalVariableJsonPatchRequest' + $ref: "#/components/schemas/GlobalVariableJsonPatchRequest" description: JSON Patch document with operations to apply. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GlobalVariableResponse' + $ref: "#/components/schemas/GlobalVariableResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Patch a global variable tags: - - Synthetics + - Synthetics x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - synthetics_global_variable_write + - synthetics_global_variable_write /api/v2/tags/enrichment: get: - description: List all tag pipeline rulesets - Retrieve a list of all tag pipeline - rulesets for the organization + description: List all tag pipeline rulesets - Retrieve a list of all tag pipeline rulesets for the organization operationId: ListTagPipelinesRulesets responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RulesetRespArray' + $ref: "#/components/schemas/RulesetRespArray" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: List tag pipeline rulesets tags: - - Cloud Cost Management + - Cloud Cost Management post: - description: Create a new tag pipeline ruleset with the specified rules and - configuration + description: Create a new tag pipeline ruleset with the specified rules and configuration operationId: CreateTagPipelinesRuleset requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateRulesetRequest' + $ref: "#/components/schemas/CreateRulesetRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RulesetResp' + $ref: "#/components/schemas/RulesetResp" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Create tag pipeline ruleset tags: - - Cloud Cost Management + - Cloud Cost Management /api/v2/tags/enrichment/reorder: post: - description: Reorder tag pipeline rulesets - Change the execution order of tag - pipeline rulesets + description: Reorder tag pipeline rulesets - Change the execution order of tag pipeline rulesets operationId: ReorderTagPipelinesRulesets requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReorderRulesetResourceArray' + $ref: "#/components/schemas/ReorderRulesetResourceArray" required: true responses: - '204': + "204": description: Successfully reordered rulesets - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Reorder tag pipeline rulesets tags: - - Cloud Cost Management + - Cloud Cost Management /api/v2/tags/enrichment/validate-query: post: - description: Validate a tag pipeline query - Validate the syntax and structure - of a tag pipeline query + description: Validate a tag pipeline query - Validate the syntax and structure of a tag pipeline query operationId: ValidateQuery requestBody: content: application/json: schema: - $ref: '#/components/schemas/RulesValidateQueryRequest' + $ref: "#/components/schemas/RulesValidateQueryRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RulesValidateQueryResponse' + $ref: "#/components/schemas/RulesValidateQueryResponse" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: Validate query tags: - - Cloud Cost Management + - Cloud Cost Management /api/v2/tags/enrichment/{ruleset_id}: delete: - description: Delete a tag pipeline ruleset - Delete an existing tag pipeline - ruleset by its ID + description: Delete a tag pipeline ruleset - Delete an existing tag pipeline ruleset by its ID operationId: DeleteTagPipelinesRuleset parameters: - - description: The unique identifier of the ruleset - in: path - name: ruleset_id - required: true - schema: - type: string + - description: The unique identifier of the ruleset + in: path + name: ruleset_id + required: true + schema: + type: string responses: - '204': + "204": description: No Content - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Delete tag pipeline ruleset tags: - - Cloud Cost Management + - Cloud Cost Management get: - description: Get a specific tag pipeline ruleset - Retrieve a specific tag pipeline - ruleset by its ID + description: Get a specific tag pipeline ruleset - Retrieve a specific tag pipeline ruleset by its ID operationId: GetTagPipelinesRuleset parameters: - - description: The unique identifier of the ruleset - in: path - name: ruleset_id - required: true - schema: - type: string + - description: The unique identifier of the ruleset + in: path + name: ruleset_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RulesetResp' + $ref: "#/components/schemas/RulesetResp" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read summary: Get a tag pipeline ruleset tags: - - Cloud Cost Management + - Cloud Cost Management patch: - description: Update a tag pipeline ruleset - Update an existing tag pipeline - ruleset with new rules and configuration + description: Update a tag pipeline ruleset - Update an existing tag pipeline ruleset with new rules and configuration operationId: UpdateTagPipelinesRuleset parameters: - - description: The unique identifier of the ruleset - in: path - name: ruleset_id - required: true - schema: - type: string + - description: The unique identifier of the ruleset + in: path + name: ruleset_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateRulesetRequest' + $ref: "#/components/schemas/UpdateRulesetRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/RulesetResp' + $ref: "#/components/schemas/RulesetResp" description: OK - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write summary: Update tag pipeline ruleset tags: - - Cloud Cost Management + - Cloud Cost Management /api/v2/team: get: - description: 'Get all teams. - - Can be used to search for teams using the `filter[keyword]` and `filter[me]` - query parameters.' + description: |- + Get all teams. + Can be used to search for teams using the `filter[keyword]` and `filter[me]` query parameters. operationId: ListTeams parameters: - - $ref: '#/components/parameters/PageNumber' - - $ref: '#/components/parameters/PageSize' - - description: Specifies the order of the returned teams - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/ListTeamsSort' - - description: 'Included related resources optionally requested. Allowed enum - values: `team_links, user_team_permissions`' - in: query - name: include - required: false - schema: - items: - $ref: '#/components/schemas/ListTeamsInclude' - type: array - - description: Search query. Can be team name, team handle, or email of team - member - in: query - name: filter[keyword] - required: false - schema: - type: string - - description: When true, only returns teams the current user belongs to - in: query - name: filter[me] - required: false - schema: - type: boolean - - description: List of fields that need to be fetched. - explode: false - in: query - name: fields[team] - required: false - schema: - items: - $ref: '#/components/schemas/TeamsField' - type: array + - $ref: "#/components/parameters/PageNumber" + - $ref: "#/components/parameters/PageSize" + - description: Specifies the order of the returned teams + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/ListTeamsSort" + - description: |- + Included related resources optionally requested. Allowed enum values: `team_links, user_team_permissions` + in: query + name: include + required: false + schema: + items: + $ref: "#/components/schemas/ListTeamsInclude" + type: array + - description: Search query. Can be team name, team handle, or email of team member + in: query + name: filter[keyword] + required: false + schema: + type: string + - description: When true, only returns teams the current user belongs to + in: query + name: filter[me] + required: false + schema: + type: boolean + - description: List of fields that need to be fetched. + explode: false + in: query + name: fields[team] + required: false + schema: + items: + $ref: "#/components/schemas/TeamsField" + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamsResponse' + $ref: "#/components/schemas/TeamsResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Get all teams tags: - - Teams + - Teams x-pagination: limitParam: page[size] pageParam: page[number] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - teams_read + - teams_read post: - description: 'Create a new team. - - User IDs passed through the `users` relationship field are added to the team.' + description: |- + Create a new team. + User IDs passed through the `users` relationship field are added to the team. operationId: CreateTeam requestBody: content: application/json: schema: - $ref: '#/components/schemas/TeamCreateRequest' + $ref: "#/components/schemas/TeamCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/TeamResponse' + $ref: "#/components/schemas/TeamResponse" description: CREATED - '403': - $ref: '#/components/responses/ForbiddenResponse' - '409': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read - - teams_manage + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + - teams_manage summary: Create a team tags: - - Teams + - Teams x-codegen-request-body-name: body - x-permission: + "x-permission": operator: AND permissions: - - teams_read - - teams_manage + - teams_read + - teams_manage /api/v2/team-hierarchy-links: get: description: List all team hierarchy links that match the provided filters. operationId: ListTeamHierarchyLinks parameters: - - $ref: '#/components/parameters/PageNumber' - - $ref: '#/components/parameters/PageSize' - - description: Filter by parent team ID - in: query - name: filter[parent_team] - required: false - schema: - type: string - - description: Filter by sub team ID - in: query - name: filter[sub_team] - required: false - schema: - type: string + - $ref: "#/components/parameters/PageNumber" + - $ref: "#/components/parameters/PageSize" + - description: Filter by parent team ID + in: query + name: filter[parent_team] + required: false + schema: + type: string + - description: Filter by sub team ID + in: query + name: filter[sub_team] + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamHierarchyLinksResponse' + $ref: "#/components/schemas/TeamHierarchyLinksResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Get team hierarchy links tags: - - Teams + - Teams x-pagination: limitParam: page[size] pageParam: page[number] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - teams_read + - teams_read post: - description: Create a new team hierarchy link between a parent team and a sub - team. + description: Create a new team hierarchy link between a parent team and a sub team. operationId: AddTeamHierarchyLink requestBody: content: application/json: schema: - $ref: '#/components/schemas/TeamHierarchyLinkCreateRequest' + $ref: "#/components/schemas/TeamHierarchyLinkCreateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamHierarchyLinkResponse' + $ref: "#/components/schemas/TeamHierarchyLinkResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '409': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Conflict - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read - - teams_manage + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + - teams_manage summary: Create a team hierarchy link tags: - - Teams - x-permission: + - Teams + "x-permission": operator: AND permissions: - - teams_read - - teams_manage + - teams_read + - teams_manage /api/v2/team-hierarchy-links/{link_id}: delete: description: Remove a team hierarchy link by the given link_id. operationId: RemoveTeamHierarchyLink parameters: - - description: The team hierarchy link's identifier - in: path - name: link_id - required: true - schema: - type: string + - description: The team hierarchy link's identifier + in: path + name: link_id + required: true + schema: + type: string responses: - '204': + "204": description: No Content - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read - - teams_manage + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + - teams_manage summary: Remove a team hierarchy link tags: - - Teams - x-permission: + - Teams + "x-permission": operator: AND permissions: - - teams_read - - teams_manage + - teams_read + - teams_manage get: description: Get a single team hierarchy link for the given link_id. operationId: GetTeamHierarchyLink parameters: - - description: The team hierarchy link's identifier - in: path - name: link_id - required: true - schema: - type: string + - description: The team hierarchy link's identifier + in: path + name: link_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamHierarchyLinkResponse' + $ref: "#/components/schemas/TeamHierarchyLinkResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Get a team hierarchy link tags: - - Teams - x-permission: + - Teams + "x-permission": operator: OR permissions: - - teams_read + - teams_read /api/v2/team/connections: delete: description: Delete multiple team connections. @@ -108090,110 +103646,110 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamConnectionDeleteRequest' + $ref: "#/components/schemas/TeamConnectionDeleteRequest" required: true responses: - '204': + "204": description: No Content - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Delete team connections tags: - - Teams - x-permission: + - Teams + "x-permission": operator: OR permissions: - - teams_read + - teams_read get: description: Returns all team connections. operationId: ListTeamConnections parameters: - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' - - description: Filter team connections by external source systems. - explode: false - in: query - name: filter[sources] - required: false - schema: - items: - example: github - type: string - type: array - style: form - - description: Filter team connections by Datadog team IDs. - explode: false - in: query - name: filter[team_ids] - required: false - schema: - items: - example: 12345678-1234-5678-9abc-123456789012 - type: string - type: array - style: form - - description: Filter team connections by connected team IDs from external systems. - explode: false - in: query - name: filter[connected_team_ids] - required: false - schema: - items: - example: '@MyGitHubAccount/my-team-name' - type: string - type: array - style: form - - description: Filter team connections by connection IDs. - explode: false - in: query - name: filter[connection_ids] - required: false - schema: - items: - example: 12345678-1234-5678-9abc-123456789012 - type: string - type: array - style: form + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - description: Filter team connections by external source systems. + explode: false + in: query + name: filter[sources] + required: false + schema: + items: + example: "github" + type: string + type: array + style: form + - description: Filter team connections by Datadog team IDs. + explode: false + in: query + name: filter[team_ids] + required: false + schema: + items: + example: "12345678-1234-5678-9abc-123456789012" + type: string + type: array + style: form + - description: Filter team connections by connected team IDs from external systems. + explode: false + in: query + name: filter[connected_team_ids] + required: false + schema: + items: + example: "@MyGitHubAccount/my-team-name" + type: string + type: array + style: form + - description: Filter team connections by connection IDs. + explode: false + in: query + name: filter[connection_ids] + required: false + schema: + items: + example: "12345678-1234-5678-9abc-123456789012" + type: string + type: array + style: form responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamConnectionsResponse' + $ref: "#/components/schemas/TeamConnectionsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: List team connections tags: - - Teams + - Teams x-pagination: limitParam: page[size] pageParam: page[number] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - teams_read + - teams_read post: description: Create multiple team connections. operationId: CreateTeamConnections @@ -108201,192 +103757,175 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamConnectionCreateRequest' + $ref: "#/components/schemas/TeamConnectionCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/TeamConnectionsResponse' + $ref: "#/components/schemas/TeamConnectionsResponse" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '409': - $ref: '#/components/responses/ConflictResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "409": + $ref: "#/components/responses/ConflictResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Create team connections tags: - - Teams - x-permission: + - Teams + "x-permission": operator: OR permissions: - - teams_read + - teams_read /api/v2/team/sync: get: - description: 'Get all team synchronization configurations. - - Returns a list of configurations used for linking or provisioning teams with - external sources like GitHub.' + description: |- + Get all team synchronization configurations. + Returns a list of configurations used for linking or provisioning teams with external sources like GitHub. operationId: GetTeamSync parameters: - - description: Filter by the external source platform for team synchronization - in: query - name: filter[source] - required: true - schema: - $ref: '#/components/schemas/TeamSyncAttributesSource' + - description: Filter by the external source platform for team synchronization + in: query + name: filter[source] + required: true + schema: + $ref: "#/components/schemas/TeamSyncAttributesSource" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamSyncResponse' + $ref: "#/components/schemas/TeamSyncResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Team sync configurations not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Get team sync configurations tags: - - Teams + - Teams x-permission: operator: OR permissions: - - teams_read + - teams_read post: - description: 'This endpoint attempts to link your existing Datadog teams with - GitHub teams by matching their names. - - It evaluates all current Datadog teams and compares them against teams in - the GitHub organization - - connected to your Datadog account, based on Datadog Team handle and GitHub - Team slug - + description: |- + This endpoint attempts to link your existing Datadog teams with GitHub teams by matching their names. + It evaluates all current Datadog teams and compares them against teams in the GitHub organization + connected to your Datadog account, based on Datadog Team handle and GitHub Team slug (lowercased and kebab-cased). - - This operation is read-only on the GitHub side, no teams will be modified - or created. - + This operation is read-only on the GitHub side, no teams will be modified or created. [A GitHub organization must be connected to your Datadog account](https://docs.datadoghq.com/integrations/github/), - - and the GitHub App integrated with Datadog must have the `Members Read` permission. - Matching is performed by comparing the Datadog team handle to the GitHub team - slug - - using a normalized exact match; case is ignored and spaces are removed. No - modifications are made - - to teams in GitHub. This only creates new teams in Datadog when type is set - to `provision`.' + and the GitHub App integrated with Datadog must have the `Members Read` permission. Matching is performed by comparing the Datadog team handle to the GitHub team slug + using a normalized exact match; case is ignored and spaces are removed. No modifications are made + to teams in GitHub. This only creates new teams in Datadog when type is set to `provision`. operationId: SyncTeams requestBody: content: application/json: schema: - $ref: '#/components/schemas/TeamSyncRequest' + $ref: "#/components/schemas/TeamSyncRequest" required: true responses: - '200': + "200": description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - '500': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Internal Server Error - Unexpected error during linking. security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_manage + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_manage summary: Link Teams with GitHub Teams tags: - - Teams + - Teams x-codegen-request-body-name: body x-permission: operator: AND permissions: - - teams_manage + - teams_manage /api/v2/team/{super_team_id}/member_teams: get: deprecated: true - description: 'Get all member teams. - + description: |- + Get all member teams. **Note**: This API is deprecated. For team hierarchy relationships (parent-child - - teams), use the team hierarchy links API: `GET /api/v2/team-hierarchy-links`.' + teams), use the team hierarchy links API: `GET /api/v2/team-hierarchy-links`. operationId: ListMemberTeams parameters: - - description: None - in: path - name: super_team_id - required: true - schema: - type: string - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' - - description: List of fields that need to be fetched. - explode: false - in: query - name: fields[team] - required: false - schema: - items: - $ref: '#/components/schemas/TeamsField' - type: array + - description: None + in: path + name: super_team_id + required: true + schema: + type: string + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - description: List of fields that need to be fetched. + explode: false + in: query + name: fields[team] + required: false + schema: + items: + $ref: "#/components/schemas/TeamsField" + type: array responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamsResponse' + $ref: "#/components/schemas/TeamsResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Get all member teams tags: - - Teams + - Teams x-pagination: limitParam: page[size] pageParam: page[number] @@ -108394,1072 +103933,1057 @@ paths: x-permission: operator: OR permissions: - - teams_read - x-sunset: '2026-06-01' - x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).' + - teams_read + x-sunset: "2026-06-01" + x-unstable: |- + **Note**: This endpoint is in Preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/). post: deprecated: true - description: 'Add a member team. - - Adds the team given by the `id` in the body as a member team of the super - team. + description: |- + Add a member team. + Adds the team given by the `id` in the body as a member team of the super team. - - **Note**: This API is deprecated. For creating team hierarchy links, use the - team hierarchy links API: `POST /api/v2/team-hierarchy-links`.' + **Note**: This API is deprecated. For creating team hierarchy links, use the team hierarchy links API: `POST /api/v2/team-hierarchy-links`. operationId: AddMemberTeam parameters: - - description: None - in: path - name: super_team_id - required: true - schema: - type: string + - description: None + in: path + name: super_team_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/AddMemberTeamRequest' + $ref: "#/components/schemas/AddMemberTeamRequest" required: true responses: - '204': + "204": description: Added - '403': - $ref: '#/components/responses/ForbiddenResponse' - '409': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Add a member team tags: - - Teams + - Teams x-permission: operator: OR permissions: - - teams_read - x-sunset: '2026-06-01' - x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).' + - teams_read + x-sunset: "2026-06-01" + x-unstable: |- + **Note**: This endpoint is in Preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/team/{super_team_id}/member_teams/{member_team_id}: delete: deprecated: true - description: 'Remove a super team''s member team identified by `member_team_id`. + description: |- + Remove a super team's member team identified by `member_team_id`. - - **Note**: This API is deprecated. For deleting team hierarchy links, use the - team hierarchy links API: `DELETE /api/v2/team-hierarchy-links/{link_id}`.' + **Note**: This API is deprecated. For deleting team hierarchy links, use the team hierarchy links API: `DELETE /api/v2/team-hierarchy-links/{link_id}`. operationId: RemoveMemberTeam parameters: - - description: None - in: path - name: super_team_id - required: true - schema: - type: string - - description: None - in: path - name: member_team_id - required: true - schema: - type: string + - description: None + in: path + name: super_team_id + required: true + schema: + type: string + - description: None + in: path + name: member_team_id + required: true + schema: + type: string responses: - '204': + "204": description: No Content - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Remove a member team tags: - - Teams + - Teams x-permission: operator: OR permissions: - - teams_read - x-sunset: '2026-06-01' - x-unstable: '**Note**: This endpoint is in Preview. If you have any feedback, - - contact [Datadog support](https://docs.datadoghq.com/help/).' + - teams_read + x-sunset: "2026-06-01" + x-unstable: |- + **Note**: This endpoint is in Preview. If you have any feedback, + contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/team/{team_id}: delete: description: Remove a team using the team's `id`. operationId: DeleteTeam parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string responses: - '204': + "204": description: No Content - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read - - teams_manage + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + - teams_manage summary: Remove a team tags: - - Teams - x-permission: + - Teams + "x-permission": operator: AND permissions: - - teams_read - - teams_manage + - teams_read + - teams_manage get: description: Get a single team using the team's `id`. operationId: GetTeam parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamResponse' + $ref: "#/components/schemas/TeamResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Get a team tags: - - Teams - x-permission: + - Teams + "x-permission": operator: OR permissions: - - teams_read + - teams_read patch: - description: 'Update a team using the team''s `id`. - - If 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.' + description: |- + Update a team using the team's `id`. + If 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. operationId: UpdateTeam parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TeamUpdateRequest' + $ref: "#/components/schemas/TeamUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamResponse' + $ref: "#/components/schemas/TeamResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Update a team tags: - - Teams + - Teams x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - teams_read + - teams_read /api/v2/team/{team_id}/links: get: description: Get all links for a given team. operationId: GetTeamLinks parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamLinksResponse' + $ref: "#/components/schemas/TeamLinksResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Get links for a team tags: - - Teams - x-permission: + - Teams + "x-permission": operator: OR permissions: - - teams_read + - teams_read post: description: Add a new link to a team. operationId: CreateTeamLink parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TeamLinkCreateRequest' + $ref: "#/components/schemas/TeamLinkCreateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamLinkResponse' + $ref: "#/components/schemas/TeamLinkResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Create a team link tags: - - Teams + - Teams x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - teams_read + - teams_read /api/v2/team/{team_id}/links/{link_id}: delete: description: Remove a link from a team. operationId: DeleteTeamLink parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string - - description: None - in: path - name: link_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string + - description: None + in: path + name: link_id + required: true + schema: + type: string responses: - '204': + "204": description: No Content - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Remove a team link tags: - - Teams - x-permission: + - Teams + "x-permission": operator: OR permissions: - - teams_read + - teams_read get: description: Get a single link for a team. operationId: GetTeamLink parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string - - description: None - in: path - name: link_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string + - description: None + in: path + name: link_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamLinkResponse' + $ref: "#/components/schemas/TeamLinkResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Get a team link tags: - - Teams - x-permission: + - Teams + "x-permission": operator: OR permissions: - - teams_read + - teams_read patch: description: Update a team link. operationId: UpdateTeamLink parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string - - description: None - in: path - name: link_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string + - description: None + in: path + name: link_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TeamLinkCreateRequest' + $ref: "#/components/schemas/TeamLinkCreateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamLinkResponse' + $ref: "#/components/schemas/TeamLinkResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Update a team link tags: - - Teams + - Teams x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - teams_read + - teams_read /api/v2/team/{team_id}/memberships: get: description: Get a paginated list of members for a team operationId: GetTeamMemberships parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' - - description: Specifies the order of returned team memberships - in: query - name: sort - required: false - schema: - $ref: '#/components/schemas/GetTeamMembershipsSort' - - description: Search query, can be user email or name - in: query - name: filter[keyword] - required: false - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - description: Specifies the order of returned team memberships + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/GetTeamMembershipsSort" + - description: Search query, can be user email or name + in: query + name: filter[keyword] + required: false + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserTeamsResponse' + $ref: "#/components/schemas/UserTeamsResponse" description: Represents a user's association to a team - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Get team memberships tags: - - Teams + - Teams x-pagination: limitParam: page[size] pageParam: page[number] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - teams_read + - teams_read post: - description: 'Add a user to a team. + description: |- + Add a user to a team. - - **Note**: Each team has a setting that determines who is allowed to modify - membership of the team. The `user_access_manage` permission generally grants - access to modify membership of any team. To get the full picture, see [Team - Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership).' + **Note**: Each team has a setting that determines who is allowed to modify membership of the team. The `user_access_manage` permission generally grants access to modify membership of any team. To get the full picture, see [Team Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership). operationId: CreateTeamMembership parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/UserTeamRequest' + $ref: "#/components/schemas/UserTeamRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserTeamResponse' + $ref: "#/components/schemas/UserTeamResponse" description: Represents a user's association to a team - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Add a user to a team tags: - - Teams + - Teams x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - teams_read + - teams_read /api/v2/team/{team_id}/memberships/{user_id}: delete: - description: 'Remove a user from a team. + description: |- + Remove a user from a team. - - **Note**: Each team has a setting that determines who is allowed to modify - membership of the team. The `user_access_manage` permission generally grants - access to modify membership of any team. To get the full picture, see [Team - Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership).' + **Note**: Each team has a setting that determines who is allowed to modify membership of the team. The `user_access_manage` permission generally grants access to modify membership of any team. To get the full picture, see [Team Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership). operationId: DeleteTeamMembership parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string - - description: None - in: path - name: user_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string + - description: None + in: path + name: user_id + required: true + schema: + type: string responses: - '204': + "204": description: No Content - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Remove a user from a team tags: - - Teams - x-permission: + - Teams + "x-permission": operator: OR permissions: - - teams_read + - teams_read patch: - description: 'Update a user''s membership attributes on a team. - + description: |- + Update a user's membership attributes on a team. - **Note**: Each team has a setting that determines who is allowed to modify - membership of the team. The `user_access_manage` permission generally grants - access to modify membership of any team. To get the full picture, see [Team - Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership).' + **Note**: Each team has a setting that determines who is allowed to modify membership of the team. The `user_access_manage` permission generally grants access to modify membership of any team. To get the full picture, see [Team Membership documentation](https://docs.datadoghq.com/account_management/teams/manage/#team-membership). operationId: UpdateTeamMembership parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string - - description: None - in: path - name: user_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string + - description: None + in: path + name: user_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/UserTeamUpdateRequest' + $ref: "#/components/schemas/UserTeamUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserTeamResponse' + $ref: "#/components/schemas/UserTeamResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Update a user's membership attributes on a team tags: - - Teams + - Teams x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - teams_read + - teams_read /api/v2/team/{team_id}/notification-rules: get: operationId: GetTeamNotificationRules parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamNotificationRulesResponse' + $ref: "#/components/schemas/TeamNotificationRulesResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Get team notification rules tags: - - Teams + - Teams x-permission: operator: OR permissions: - - teams_read + - teams_read post: operationId: CreateTeamNotificationRule parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TeamNotificationRuleRequest' + $ref: "#/components/schemas/TeamNotificationRuleRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/TeamNotificationRuleResponse' + $ref: "#/components/schemas/TeamNotificationRuleResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '409': + "409": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Create team notification rule tags: - - Teams + - Teams x-permission: operator: OR permissions: - - teams_read + - teams_read /api/v2/team/{team_id}/notification-rules/{rule_id}: delete: operationId: DeleteTeamNotificationRule parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string - - description: None - in: path - name: rule_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string + - description: None + in: path + name: rule_id + required: true + schema: + type: string responses: - '204': + "204": description: No Content - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Delete team notification rule tags: - - Teams + - Teams x-permission: operator: OR permissions: - - teams_read + - teams_read get: operationId: GetTeamNotificationRule parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string - - description: None - in: path - name: rule_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string + - description: None + in: path + name: rule_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamNotificationRuleResponse' + $ref: "#/components/schemas/TeamNotificationRuleResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Get team notification rule tags: - - Teams + - Teams x-permission: operator: OR permissions: - - teams_read + - teams_read put: operationId: UpdateTeamNotificationRule parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string - - description: None - in: path - name: rule_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string + - description: None + in: path + name: rule_id + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TeamNotificationRuleRequest' + $ref: "#/components/schemas/TeamNotificationRuleRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamNotificationRuleResponse' + $ref: "#/components/schemas/TeamNotificationRuleResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Update team notification rule tags: - - Teams + - Teams x-permission: operator: OR permissions: - - teams_read + - teams_read /api/v2/team/{team_id}/permission-settings: get: description: Get all permission settings for a given team. operationId: GetTeamPermissionSettings parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamPermissionSettingsResponse' + $ref: "#/components/schemas/TeamPermissionSettingsResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Get permission settings for a team tags: - - Teams - x-permission: + - Teams + "x-permission": operator: OR permissions: - - teams_read + - teams_read /api/v2/team/{team_id}/permission-settings/{action}: put: description: Update a team permission setting for a given team. operationId: UpdateTeamPermissionSetting parameters: - - description: None - in: path - name: team_id - required: true - schema: - type: string - - description: None - in: path - name: action - required: true - schema: - type: string + - description: None + in: path + name: team_id + required: true + schema: + type: string + - description: None + in: path + name: action + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/TeamPermissionSettingUpdateRequest' + $ref: "#/components/schemas/TeamPermissionSettingUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/TeamPermissionSettingResponse' + $ref: "#/components/schemas/TeamPermissionSettingResponse" description: OK - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Update permission setting for team tags: - - Teams + - Teams x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - teams_read + - teams_read /api/v2/teams: get: deprecated: true - description: 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. + description: >- + 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. operationId: ListIncidentTeams parameters: - - $ref: '#/components/parameters/IncidentTeamIncludeQueryParameter' - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageOffset' - - $ref: '#/components/parameters/IncidentTeamSearchQueryParameter' + - $ref: "#/components/parameters/IncidentTeamIncludeQueryParameter" + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageOffset" + - $ref: "#/components/parameters/IncidentTeamSearchQueryParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentTeamsResponse' + $ref: "#/components/schemas/IncidentTeamsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read summary: Get a list of all incident teams tags: - - Incident Teams - x-permission: + - Incident Teams + "x-permission": operator: OR permissions: - - incident_read - x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).' + - incident_read + x-unstable: |- + **Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/). post: deprecated: true description: Creates a new incident team. @@ -109468,1029 +104992,945 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/IncidentTeamCreateRequest' + $ref: "#/components/schemas/IncidentTeamCreateRequest" description: Incident Team Payload. required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/IncidentTeamResponse' + $ref: "#/components/schemas/IncidentTeamResponse" description: CREATED - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_settings_write + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_write summary: Create a new incident team tags: - - Incident Teams + - Incident Teams x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - incident_settings_write - x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).' + - incident_settings_write + x-unstable: |- + **Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/). /api/v2/teams/{team_id}: delete: deprecated: true description: Deletes an existing incident team. operationId: DeleteIncidentTeam parameters: - - $ref: '#/components/parameters/IncidentTeamIDPathParameter' - responses: - '204': - description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_settings_write + - $ref: "#/components/parameters/IncidentTeamIDPathParameter" + responses: + "204": + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_write summary: Delete an existing incident team tags: - - Incident Teams - x-permission: + - Incident Teams + "x-permission": operator: OR permissions: - - incident_settings_write - x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).' + - incident_settings_write + x-unstable: |- + **Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/). get: deprecated: true - description: 'Get details of an incident team. If the `include[users]` query - parameter is provided, - - the included attribute will contain the users related to these incident teams.' + description: |- + Get details of an incident team. If the `include[users]` query parameter is provided, + the included attribute will contain the users related to these incident teams. operationId: GetIncidentTeam parameters: - - $ref: '#/components/parameters/IncidentTeamIDPathParameter' - - $ref: '#/components/parameters/IncidentTeamIncludeQueryParameter' + - $ref: "#/components/parameters/IncidentTeamIDPathParameter" + - $ref: "#/components/parameters/IncidentTeamIncludeQueryParameter" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentTeamResponse' + $ref: "#/components/schemas/IncidentTeamResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_read summary: Get details of an incident team tags: - - Incident Teams - x-permission: + - Incident Teams + "x-permission": operator: OR permissions: - - incident_read - x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).' + - incident_read + x-unstable: |- + **Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/). patch: deprecated: true - description: Updates an existing incident team. Only provide the attributes - which should be updated as this request is a partial update. + description: >- + Updates an existing incident team. Only provide the attributes which should be updated as this request is a partial update. operationId: UpdateIncidentTeam parameters: - - $ref: '#/components/parameters/IncidentTeamIDPathParameter' + - $ref: "#/components/parameters/IncidentTeamIDPathParameter" requestBody: content: application/json: schema: - $ref: '#/components/schemas/IncidentTeamUpdateRequest' + $ref: "#/components/schemas/IncidentTeamUpdateRequest" description: Incident Team Payload. required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/IncidentTeamResponse' + $ref: "#/components/schemas/IncidentTeamResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '401': - $ref: '#/components/responses/UnauthorizedResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "401": + $ref: "#/components/responses/UnauthorizedResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - incident_settings_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_write summary: Update an existing incident team tags: - - Incident Teams + - Incident Teams x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - incident_settings_write - x-unstable: '**Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/).' + - incident_settings_write + x-unstable: |- + **Note**: This endpoint is deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/). /api/v2/test/flaky-test-management/tests: patch: - description: Update the state of multiple flaky tests in Flaky Test Management. + description: |- + Update the state of multiple flaky tests in Flaky Test Management. operationId: UpdateFlakyTests requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/UpdateFlakyTestsRequest' + $ref: "#/components/schemas/UpdateFlakyTestsRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateFlakyTestsResponse' + $ref: "#/components/schemas/UpdateFlakyTestsResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - test_optimization_write + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - test_optimization_write summary: Update flaky test states - tags: - - Test Optimization + tags: ["Test Optimization"] x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - test_optimization_write - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - test_optimization_write + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: - description: 'List endpoint returning flaky tests from Flaky Test Management. - Results are paginated. - + description: |- + List endpoint returning flaky tests from Flaky Test Management. Results are paginated. The response includes comprehensive test information including: - - Test identification and metadata (module, suite, name) - - Flaky state and categorization - - First and last flake occurrences (timestamp, branch, commit SHA) - - Test execution statistics from the last 7 days (failure rate) - - Pipeline impact metrics (failed pipelines count, total lost time) - - Complete status change history (optional, ordered from most recent to oldest) - - Set `include_history` to `true` in the request to receive the status change - history for each test. - + Set `include_history` to `true` in the request to receive the status change history for each test. History is disabled by default for better performance. - - Results support filtering by various facets including service, environment, - repository, branch, and test state.' + Results support filtering by various facets including service, environment, repository, branch, and test state. operationId: SearchFlakyTests requestBody: content: - application/json: + "application/json": schema: - $ref: '#/components/schemas/FlakyTestsSearchRequest' + $ref: "#/components/schemas/FlakyTestsSearchRequest" required: false responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/FlakyTestsSearchResponse' + $ref: "#/components/schemas/FlakyTestsSearchResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/NotAuthorizedResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - test_optimization_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - test_optimization_read summary: Search flaky tests - tags: - - Test Optimization + tags: ["Test Optimization"] x-codegen-request-body-name: body x-pagination: cursorParam: body.data.attributes.page.cursor cursorPath: meta.pagination.next_page limitParam: body.data.attributes.page.limit resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - test_optimization_read - x-unstable: '**Note**: This endpoint is in preview and may be subject to change. - - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + - test_optimization_read + x-unstable: |- + **Note**: This endpoint is in preview and may be subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/usage/application_security: get: deprecated: true - description: 'Get hourly usage for application security . - - **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)' + description: |- + Get hourly usage for application security . + **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) operationId: GetUsageApplicationSecurityMonitoring parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageApplicationSecurityMonitoringResponse' + $ref: "#/components/schemas/UsageApplicationSecurityMonitoringResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for application security tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v2/usage/billing_dimension_mapping: get: - description: 'Get a mapping of billing dimensions to the corresponding keys - for the supported usage metering public API endpoints. - + description: |- + Get a mapping of billing dimensions to the corresponding keys for the supported usage metering public API endpoints. Mapping data is updated on a monthly cadence. - - This endpoint is only accessible to [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).' + This endpoint is only accessible to [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/). operationId: GetBillingDimensionMapping parameters: - - description: Datetime in ISO-8601 format, UTC, and for mappings beginning - this month. Defaults to the current month. - in: query - name: filter[month] - required: false - schema: - format: date-time - type: string - - 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`. - in: query - name: filter[view] - required: false - schema: - default: active - type: string + - description: "Datetime in ISO-8601 format, UTC, and for mappings beginning this month. Defaults to the current month." + in: query + name: filter[month] + required: false + schema: + format: date-time + type: string + - 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`." + in: query + name: filter[view] + required: false + schema: + default: active + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/BillingDimensionsMappingResponse' + $ref: "#/components/schemas/BillingDimensionsMappingResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get billing dimension mapping for usage endpoints tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v2/usage/cost_by_org: get: deprecated: true - description: 'Get cost across multi-org account. - - Cost by org data for a given month becomes available no later than the 16th - of the following month. - + description: |- + Get cost across multi-org account. + Cost by org data for a given month becomes available no later than the 16th of the following month. **Note:** This endpoint has been deprecated. Please use the new endpoint - [`/historical_cost`](https://docs.datadoghq.com/api/latest/usage-metering/#get-historical-cost-across-your-account) - instead. - - This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).' + This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/). operationId: GetCostByOrg parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` - for cost beginning this month.' - in: query - name: start_month - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` - for cost ending this month.' - in: query - name: end_month - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month." + in: query + name: start_month + required: true + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month." + in: query + name: end_month + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/CostByOrgResponse' + $ref: "#/components/schemas/CostByOrgResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read - - billing_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read + - billing_read summary: Get cost across multi-org account tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: AND permissions: - - usage_read - - billing_read + - usage_read + - billing_read /api/v2/usage/estimated_cost: get: - description: 'Get estimated cost across multi-org and single root-org accounts. - + description: |- + Get estimated cost across multi-org and single root-org accounts. Estimated cost data is only available for the current month and previous month - and is delayed by up to 72 hours from when it was incurred. - To access historical costs prior to this, use the `/historical_cost` endpoint. - - This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).' + This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/). operationId: GetEstimatedCostByOrg parameters: - - 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`. - in: query - name: view - required: false - schema: - type: string - - 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.' - in: query - name: start_month - required: false - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` - for cost ending this month.' - in: query - name: end_month - required: false - schema: - format: date-time - type: string - - 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.' - in: query - name: start_date - required: false - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` - for cost ending this day.' - in: query - name: end_date - required: false - schema: - format: date-time - type: string - - 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`. - in: query - name: include_connected_accounts - required: false - schema: - default: false - type: boolean + - 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`." + in: query + name: view + required: false + schema: + type: string + - 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." + in: query + name: start_month + required: false + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month." + in: query + name: end_month + required: false + schema: + format: date-time + type: string + - 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." + in: query + name: start_date + required: false + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to day: `[YYYY-MM-DD]` for cost ending this day." + in: query + name: end_date + required: false + schema: + format: date-time + type: string + - 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`." + in: query + name: include_connected_accounts + required: false + schema: + default: false + type: boolean responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/CostByOrgResponse' + $ref: "#/components/schemas/CostByOrgResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read - - billing_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read + - billing_read summary: Get estimated cost across your account tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: AND permissions: - - usage_read - - billing_read + - usage_read + - billing_read /api/v2/usage/historical_cost: get: - description: 'Get historical cost across multi-org and single root-org accounts. - - Cost data for a given month becomes available no later than the 16th of the - following month. - + description: |- + Get historical cost across multi-org and single root-org accounts. + Cost data for a given month becomes available no later than the 16th of the following month. - This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).' + This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/). operationId: GetHistoricalCostByOrg parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` - for cost beginning this month.' - in: query - name: start_month - required: true - schema: - format: date-time - type: string - - 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`. - in: query - name: view - required: false - schema: - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` - for cost ending this month.' - in: query - name: end_month - required: false - schema: - format: date-time - type: string - - 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`. - in: query - name: include_connected_accounts - required: false - schema: - default: false - type: boolean + - description: "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost beginning this month." + in: query + name: start_month + required: true + schema: + format: date-time + type: string + - 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`." + in: query + name: view + required: false + schema: + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for cost ending this month." + in: query + name: end_month + required: false + schema: + format: date-time + type: string + - 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`." + in: query + name: include_connected_accounts + required: false + schema: + default: false + type: boolean responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/CostByOrgResponse' + $ref: "#/components/schemas/CostByOrgResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read - - billing_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read + - billing_read summary: Get historical cost across your account tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: AND permissions: - - usage_read - - billing_read + - usage_read + - billing_read /api/v2/usage/hourly_usage: get: description: Get hourly usage by product family. operationId: GetHourlyUsage parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage beginning at this hour.' - in: query - name: filter[timestamp][start] - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] - for usage ending **before** this hour.' - in: query - name: filter[timestamp][end] - required: false - schema: - format: date-time - type: string - - description: 'Comma separated list of product families to retrieve. Available - families are `all`, `analyzed_logs`, - - `application_security`, `audit_trail`, `bits_ai`, `serverless`, `ci_app`, - `cloud_cost_management`, `cloud_siem`, - - `csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`, - `cws`, `dbm`, `error_tracking`, - - `fargate`, `infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, - `ingested_spans`, `iot`, - - `lambda_traced_invocations`, `llm_observability`, `logs`, `network_flows`, - `network_hosts`, `network_monitoring`, - - `observability_pipelines`, `online_archive`, `profiling`, `product_analytics`, - `rum`, `rum_browser_sessions`, - - `rum_mobile_sessions`, `sds`, `snmp`, `software_delivery`, `synthetics_api`, - `synthetics_browser`, - - `synthetics_mobile`, `synthetics_parallel_testing`, `timeseries`, `vuln_management` - and `workflow_executions`. - - The following product family has been **deprecated**: `audit_logs`.' - in: query - name: filter[product_families] - required: true - schema: - type: string - - description: Include child org usage in the response. Defaults to false. - in: query - name: filter[include_descendants] - required: false - schema: - default: false - type: boolean - - 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. - in: query - name: filter[include_connected_accounts] - required: false - schema: - default: false - type: boolean - - description: Include breakdown of usage by subcategories where applicable - (for product family logs only). Defaults to false. - in: query - name: filter[include_breakdown] - required: false - schema: - default: false - type: boolean - - description: 'Comma separated list of product family versions to use in the - format `product_family:version`. For example, - - `infra_hosts:1.0.0`. If this parameter is not used, the API will use the - latest version of each requested - - product family. Currently all families have one version `1.0.0`.' - in: query - name: filter[versions] - required: false - schema: - type: string - - description: Maximum number of results to return (between 1 and 500) - defaults - to 500 if limit not specified. - in: query - name: page[limit] - required: false - schema: - default: 500 - format: int32 - maximum: 500 - minimum: 1 - type: integer - - description: List following results with a next_record_id provided in the - previous query. - in: query - name: page[next_record_id] - required: false - schema: - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour." + in: query + name: filter[timestamp][start] + required: true + schema: + format: date-time + type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour." + in: query + name: filter[timestamp][end] + required: false + schema: + format: date-time + type: string + - description: |- + Comma separated list of product families to retrieve. Available families are `all`, `analyzed_logs`, + `application_security`, `audit_trail`, `bits_ai`, `serverless`, `ci_app`, `cloud_cost_management`, `cloud_siem`, + `csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`, `cws`, `dbm`, `error_tracking`, + `fargate`, `infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`, `iot`, + `lambda_traced_invocations`, `llm_observability`, `logs`, `network_flows`, `network_hosts`, `network_monitoring`, + `observability_pipelines`, `online_archive`, `profiling`, `product_analytics`, `rum`, `rum_browser_sessions`, + `rum_mobile_sessions`, `sds`, `snmp`, `software_delivery`, `synthetics_api`, `synthetics_browser`, + `synthetics_mobile`, `synthetics_parallel_testing`, `timeseries`, `vuln_management` and `workflow_executions`. + The following product family has been **deprecated**: `audit_logs`. + in: query + name: filter[product_families] + required: true + schema: + type: string + - description: "Include child org usage in the response. Defaults to false." + in: query + name: filter[include_descendants] + required: false + schema: + default: false + type: boolean + - 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." + in: query + name: filter[include_connected_accounts] + required: false + schema: + default: false + type: boolean + - description: "Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false." + in: query + name: filter[include_breakdown] + required: false + schema: + default: false + type: boolean + - description: |- + Comma separated list of product family versions to use in the format `product_family:version`. For example, + `infra_hosts:1.0.0`. If this parameter is not used, the API will use the latest version of each requested + product family. Currently all families have one version `1.0.0`. + in: query + name: filter[versions] + required: false + schema: + type: string + - description: "Maximum number of results to return (between 1 and 500) - defaults to 500 if limit not specified." + in: query + name: page[limit] + required: false + schema: + default: 500 + format: int32 + maximum: 500 + minimum: 1 + type: integer + - description: "List following results with a next_record_id provided in the previous query." + in: query + name: page[next_record_id] + required: false + schema: + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/HourlyUsageResponse' + $ref: "#/components/schemas/HourlyUsageResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage by product family tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v2/usage/lambda_traced_invocations: get: deprecated: true - description: 'Get hourly usage for Lambda traced invocations. - - **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)' + description: |- + Get hourly usage for Lambda traced invocations. + **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) operationId: GetUsageLambdaTracedInvocations parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageLambdaTracedInvocationsResponse' + $ref: "#/components/schemas/UsageLambdaTracedInvocationsResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for Lambda traced invocations tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v2/usage/observability_pipelines: get: deprecated: true - description: 'Get hourly usage for observability pipelines. - - **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)' + description: |- + Get hourly usage for observability pipelines. + **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) operationId: GetUsageObservabilityPipelines parameters: - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage beginning at this hour.' - in: query - name: start_hr - required: true - schema: - format: date-time - type: string - - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` - for usage ending - - **before** this hour.' - in: query - name: end_hr - required: false - schema: - format: date-time - type: string + - description: "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour." + in: query + name: start_hr + required: true + schema: + format: date-time + type: string + - description: |- + Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending + **before** this hour. + in: query + name: end_hr + required: false + schema: + format: date-time + type: string responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageObservabilityPipelinesResponse' + $ref: "#/components/schemas/UsageObservabilityPipelinesResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get hourly usage for observability pipelines tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v2/usage/projected_cost: get: - description: 'Get projected cost across multi-org and single root-org accounts. - - Projected cost data is only available for the current month and becomes available - around the 12th of the month. - + description: |- + Get projected cost across multi-org and single root-org accounts. + Projected cost data is only available for the current month and becomes available around the 12th of the month. - This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).' + This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/). operationId: GetProjectedCost parameters: - - 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`. - in: query - name: view - required: false - schema: - type: string - - 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`. - in: query - name: include_connected_accounts - required: false - schema: - default: false - type: boolean + - 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`." + in: query + name: view + required: false + schema: + type: string + - 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`." + in: query + name: include_connected_accounts + required: false + schema: + default: false + type: boolean responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/ProjectedCostResponse' + $ref: "#/components/schemas/ProjectedCostResponse" description: OK - '400': + "400": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read - - billing_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read + - billing_read summary: Get projected cost across your account tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: AND permissions: - - usage_read - - billing_read + - usage_read + - billing_read /api/v2/usage/usage-attribution-types: get: - description: Get usage attribution types. + description: |- + Get usage attribution types. operationId: GetUsageAttributionTypes responses: - '200': + "200": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/UsageAttributionTypesResponse' + $ref: "#/components/schemas/UsageAttributionTypesResponse" description: OK - '403': + "403": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Forbidden - User is not authorized - '429': + "429": content: application/json;datetime-format=rfc3339: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Too many requests security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - usage_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read summary: Get usage attribution types tags: - - Usage Metering - x-permission: + - Usage Metering + "x-permission": operator: OR permissions: - - usage_read + - usage_read /api/v2/user_invitations: post: description: Sends emails to one or more users inviting them to join the organization. @@ -110499,173 +105939,169 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UserInvitationsRequest' + $ref: "#/components/schemas/UserInvitationsRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/UserInvitationsResponse' + $ref: "#/components/schemas/UserInvitationsResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_invite + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_invite summary: Send invitation emails tags: - - Users + - Users x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_invite + - user_access_invite /api/v2/user_invitations/{user_invitation_uuid}: get: description: Returns a single user invitation by its UUID. operationId: GetInvitation parameters: - - description: The UUID of the user invitation. - in: path - name: user_invitation_uuid - required: true - schema: - example: 00000000-0000-0000-3456-000000000000 - type: string + - description: The UUID of the user invitation. + in: path + name: user_invitation_uuid + required: true + schema: + example: "00000000-0000-0000-3456-000000000000" + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserInvitationResponse' + $ref: "#/components/schemas/UserInvitationResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_invite + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_invite summary: Get a user invitation tags: - - Users + - Users x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_invite + - user_access_invite /api/v2/users: get: - description: 'Get the list of all users in the organization. This list includes - - all users even if they are deactivated or unverified.' + description: |- + Get the list of all users in the organization. This list includes + all users even if they are deactivated or unverified. operationId: ListUsers parameters: - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' - - description: 'User attribute to order results by. Sort order is ascending - by default. - - Sort order is descending if the field - - is prefixed by a negative sign, for example `sort=-name`. Options: `name`, - - `modified_at`, `user_count`.' - in: query - name: sort - required: false - schema: - default: name - example: name - type: string - - description: 'Direction of sort. Options: `asc`, `desc`.' - in: query - name: sort_dir - required: false - schema: - $ref: '#/components/schemas/QuerySortOrder' - - description: Filter all users by the given string. Defaults to no filtering. - in: query - name: filter - required: false - schema: - type: string - - description: 'Filter on status attribute. - - Comma separated list, with possible values `Active`, `Pending`, and `Disabled`. - - Defaults to no filtering.' - in: query - name: filter[status] - required: false - schema: - example: Active - type: string + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - description: |- + User attribute to order results by. Sort order is ascending by default. + Sort order is descending if the field + is prefixed by a negative sign, for example `sort=-name`. Options: `name`, + `modified_at`, `user_count`. + in: query + name: sort + required: false + schema: + default: name + example: name + type: string + - description: "Direction of sort. Options: `asc`, `desc`." + in: query + name: sort_dir + required: false + schema: + $ref: "#/components/schemas/QuerySortOrder" + - description: Filter all users by the given string. Defaults to no filtering. + in: query + name: filter + required: false + schema: + type: string + - description: |- + Filter on status attribute. + Comma separated list, with possible values `Active`, `Pending`, and `Disabled`. + Defaults to no filtering. + in: query + name: filter[status] + required: false + schema: + example: Active + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UsersResponse' + $ref: "#/components/schemas/UsersResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_read summary: List all users tags: - - Users + - Users x-codegen-request-body-name: body x-pagination: limitParam: page[size] pageParam: page[number] resultsPath: data - x-permission: + "x-permission": operator: OR permissions: - - user_access_read + - user_access_read post: description: Create a user for your organization. operationId: CreateUser @@ -110673,1344 +106109,1150 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UserCreateRequest' + $ref: "#/components/schemas/UserCreateRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/UserResponse' + $ref: "#/components/schemas/UserResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_invite + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_invite summary: Create a user tags: - - Users + - Users x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_invite + - user_access_invite /api/v2/users/{user_id}: delete: - description: 'Disable a user. Can only be used with an application key belonging - - to an administrator user.' + description: |- + Disable a user. Can only be used with an application key belonging + to an administrator user. operationId: DisableUser parameters: - - $ref: '#/components/parameters/UserID' + - $ref: "#/components/parameters/UserID" responses: - '204': + "204": description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_manage + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_manage summary: Disable a user tags: - - Users + - Users x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage - - service_account_write + - user_access_manage + - service_account_write get: - description: "Get a user in the organization specified by the user\u2019s `user_id`." + description: Get a user in the organization specified by the user’s `user_id`. operationId: GetUser parameters: - - $ref: '#/components/parameters/UserID' + - $ref: "#/components/parameters/UserID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserResponse' + $ref: "#/components/schemas/UserResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_read summary: Get user details tags: - - Users + - Users x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_read + - user_access_read patch: - description: 'Edit a user. Can only be used with an application key belonging - - to an administrator user.' + description: |- + Edit a user. Can only be used with an application key belonging + to an administrator user. operationId: UpdateUser parameters: - - $ref: '#/components/parameters/UserID' + - $ref: "#/components/parameters/UserID" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UserUpdateRequest' + $ref: "#/components/schemas/UserUpdateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserResponse' + $ref: "#/components/schemas/UserResponse" description: OK - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Bad Request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '422': + "422": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Unprocessable Entity - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_manage + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_manage summary: Update a user tags: - - Users + - Users x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_manage - - service_account_write + - user_access_manage + - service_account_write /api/v2/users/{user_id}/orgs: get: - description: 'Get a user organization. Returns the user information and all - organizations - - joined by this user.' + description: |- + Get a user organization. Returns the user information and all organizations + joined by this user. operationId: ListUserOrganizations parameters: - - $ref: '#/components/parameters/UserID' + - $ref: "#/components/parameters/UserID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserResponse' + $ref: "#/components/schemas/UserResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: [] + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] summary: Get a user organization tags: - - Users + - Users x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OPEN permissions: [] /api/v2/users/{user_id}/permissions: get: - description: "Get a user permission set. Returns a list of the user\u2019s permissions\ngranted - by the associated user's roles." + description: |- + Get a user permission set. Returns a list of the user’s permissions + granted by the associated user's roles. operationId: ListUserPermissions parameters: - - $ref: '#/components/parameters/UserID' + - $ref: "#/components/parameters/UserID" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/PermissionsResponse' + $ref: "#/components/schemas/PermissionsResponse" description: OK - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Authentication error - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: Not found - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - user_access_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_read summary: Get a user permissions tags: - - Users + - Users x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - user_access_read + - user_access_read /api/v2/users/{user_uuid}/memberships: get: description: Get a list of memberships for a user operationId: GetUserMemberships parameters: - - description: None - in: path - name: user_uuid - required: true - schema: - type: string + - description: None + in: path + name: user_uuid + required: true + schema: + type: string responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UserTeamsResponse' + $ref: "#/components/schemas/UserTeamsResponse" description: Represents a user's association to a team - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" description: API error response. - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - teams_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read summary: Get user memberships tags: - - Teams - x-permission: + - Teams + "x-permission": operator: OR permissions: - - teams_read + - teams_read /api/v2/workflows: post: - description: Create a new workflow, returning the workflow ID. This API requires - a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: Create a new workflow, returning the workflow ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: CreateWorkflow requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateWorkflowRequest' + $ref: "#/components/schemas/CreateWorkflowRequest" required: true responses: - '201': + "201": content: application/json: schema: - $ref: '#/components/schemas/CreateWorkflowResponse' + $ref: "#/components/schemas/CreateWorkflowResponse" description: Successfully created a workflow. - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Too many requests summary: Create a Workflow tags: - - Workflow Automation - x-permission: + - Workflow Automation + "x-permission": operator: OR permissions: - - workflows_write + - workflows_write /api/v2/workflows/{workflow_id}: delete: - description: Delete a workflow by ID. This API requires a [registered application - key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: Delete a workflow by ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: DeleteWorkflow parameters: - - $ref: '#/components/parameters/WorkflowId' + - $ref: "#/components/parameters/WorkflowId" responses: - '204': + "204": description: Successfully deleted a workflow. - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Too many requests summary: Delete an existing Workflow tags: - - Workflow Automation - x-permission: + - Workflow Automation + "x-permission": operator: OR permissions: - - workflows_write + - workflows_write get: - description: Get a workflow by ID. This API requires a [registered application - key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: Get a workflow by ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: GetWorkflow parameters: - - $ref: '#/components/parameters/WorkflowId' + - $ref: "#/components/parameters/WorkflowId" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/GetWorkflowResponse' + $ref: "#/components/schemas/GetWorkflowResponse" description: Successfully got a workflow. - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Too many requests summary: Get an existing Workflow tags: - - Workflow Automation - x-permission: + - Workflow Automation + "x-permission": operator: OR permissions: - - workflows_read + - workflows_read patch: - description: Update a workflow by ID. This API requires a [registered application - key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: Update a workflow by ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: UpdateWorkflow parameters: - - $ref: '#/components/parameters/WorkflowId' + - $ref: "#/components/parameters/WorkflowId" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateWorkflowRequest' + $ref: "#/components/schemas/UpdateWorkflowRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateWorkflowResponse' + $ref: "#/components/schemas/UpdateWorkflowResponse" description: Successfully updated a workflow. - '400': + "400": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad request - '403': + "403": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Forbidden - '404': + "404": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Not found - '429': + "429": content: application/json: schema: - $ref: '#/components/schemas/JSONAPIErrorResponse' + $ref: "#/components/schemas/JSONAPIErrorResponse" description: Too many requests summary: Update an existing Workflow tags: - - Workflow Automation - x-permission: + - Workflow Automation + "x-permission": operator: OR permissions: - - workflows_write + - workflows_write /api/v2/workflows/{workflow_id}/instances: get: - description: List all instances of a given workflow. This API requires a [registered - application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: List all instances of a given workflow. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: ListWorkflowInstances parameters: - - $ref: '#/components/parameters/WorkflowId' - - $ref: '#/components/parameters/PageSize' - - $ref: '#/components/parameters/PageNumber' + - $ref: "#/components/parameters/WorkflowId" + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/WorkflowListInstancesResponse' + $ref: "#/components/schemas/WorkflowListInstancesResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - workflows_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - workflows_read summary: List workflow instances tags: - - Workflow Automation - x-permission: + - Workflow Automation + "x-permission": operator: OR permissions: - - workflows_read + - workflows_read post: - description: Execute the given workflow. This API requires a [registered application - key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: Execute the given workflow. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: CreateWorkflowInstance parameters: - - $ref: '#/components/parameters/WorkflowId' + - $ref: "#/components/parameters/WorkflowId" requestBody: content: application/json: schema: - $ref: '#/components/schemas/WorkflowInstanceCreateRequest' + $ref: "#/components/schemas/WorkflowInstanceCreateRequest" required: true responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/WorkflowInstanceCreateResponse' + $ref: "#/components/schemas/WorkflowInstanceCreateResponse" description: Created - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - workflows_run + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - workflows_run summary: Execute a workflow tags: - - Workflow Automation + - Workflow Automation x-codegen-request-body-name: body - x-permission: + "x-permission": operator: OR permissions: - - workflows_run + - workflows_run /api/v2/workflows/{workflow_id}/instances/{instance_id}: get: - description: Get a specific execution of a given workflow. This API requires - a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: Get a specific execution of a given workflow. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: GetWorkflowInstance parameters: - - $ref: '#/components/parameters/WorkflowId' - - $ref: '#/components/parameters/InstanceId' + - $ref: "#/components/parameters/WorkflowId" + - $ref: "#/components/parameters/InstanceId" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/WorklflowGetInstanceResponse' + $ref: "#/components/schemas/WorklflowGetInstanceResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - workflows_read + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - workflows_read summary: Get a workflow instance tags: - - Workflow Automation - x-permission: + - Workflow Automation + "x-permission": operator: OR permissions: - - workflows_read + - workflows_read /api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel: put: - description: Cancels a specific execution of a given workflow. This API requires - a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). - Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). + description: Cancels a specific execution of a given workflow. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access). operationId: CancelWorkflowInstance parameters: - - $ref: '#/components/parameters/WorkflowId' - - $ref: '#/components/parameters/InstanceId' + - $ref: "#/components/parameters/WorkflowId" + - $ref: "#/components/parameters/InstanceId" responses: - '200': + "200": content: application/json: schema: - $ref: '#/components/schemas/WorklflowCancelInstanceResponse' + $ref: "#/components/schemas/WorklflowCancelInstanceResponse" description: OK - '400': - $ref: '#/components/responses/BadRequestResponse' - '403': - $ref: '#/components/responses/ForbiddenResponse' - '404': - $ref: '#/components/responses/NotFoundResponse' - '429': - $ref: '#/components/responses/TooManyRequestsResponse' + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" summary: Cancel a workflow instance tags: - - Workflow Automation - x-permission: + - Workflow Automation + "x-permission": operator: OR permissions: - - workflows_run + - workflows_run security: -- apiKeyAuth: [] - appKeyAuth: [] + - apiKeyAuth: [] + appKeyAuth: [] servers: -- url: https://{subdomain}.{site} - variables: - site: - default: datadoghq.com - description: The regional site for Datadog customers. - enum: - - datadoghq.com - - us3.datadoghq.com - - us5.datadoghq.com - - ap1.datadoghq.com - - ap2.datadoghq.com - - datadoghq.eu - - ddog-gov.com - subdomain: - default: api - description: The subdomain where the API is deployed. -- url: '{protocol}://{name}' - variables: - name: - default: api.datadoghq.com - description: Full site DNS name. - protocol: - default: https - description: The protocol for accessing the API. -- url: https://{subdomain}.{site} - variables: - site: - default: datadoghq.com - description: Any Datadog deployment. - subdomain: - default: api - description: The subdomain where the API is deployed. + - url: https://{subdomain}.{site} + variables: + site: + default: datadoghq.com + description: The regional site for Datadog customers. + enum: + - datadoghq.com + - us3.datadoghq.com + - us5.datadoghq.com + - ap1.datadoghq.com + - ap2.datadoghq.com + - datadoghq.eu + - ddog-gov.com + subdomain: + default: api + description: The subdomain where the API is deployed. + - url: "{protocol}://{name}" + variables: + name: + default: api.datadoghq.com + description: Full site DNS name. + protocol: + default: https + description: The protocol for accessing the API. + - url: https://{subdomain}.{site} + variables: + site: + default: datadoghq.com + description: Any Datadog deployment. + subdomain: + default: api + description: The subdomain where the API is deployed. tags: -- description: Configure your API endpoints through the Datadog API. - name: API Management -- description: Observe, troubleshoot, and improve cloud-scale applications with all - telemetry in context - name: APM -- description: Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters) - for your organization. You need an API and application key with Admin rights to - interact with this endpoint. See [retention filters](https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/#retention-filters) - on the Trace Retention page for more information. - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/ - name: APM Retention Filters -- description: 'Configure your Datadog-AWS integration directly through the Datadog - API. - - For more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services).' - name: AWS Integration -- description: 'Configure your Datadog-AWS-Logs integration directly through Datadog - API. - - For more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection).' - externalDocs: - url: https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection - name: AWS Logs Integration -- description: "Action connections extend your installed integrations and allow you - to take action in your third-party systems\n(e.g. AWS, GitLab, and Statuspage) - with Datadog\u2019s Workflow Automation and App Builder products.\n\nDatadog\u2019s - Integrations automatically provide authentication for Slack, Microsoft Teams, - PagerDuty, Opsgenie,\nJIRA, GitHub, and Statuspage. You do not need additional - connections in order to access these tools within\nWorkflow Automation and App - Builder.\n\nWe offer granular access control for editing and resolving connections." - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/service_management/workflows/connections/ - name: Action Connection -- description: 'Leverage the Actions Datastore API to create, modify, and delete - - items in datastores owned by your organization.' - externalDocs: - url: https://docs.datadoghq.com/actions/datastore - name: Actions Datastores -- description: "Datadog Agentless Scanning provides visibility into risks and vulnerabilities\nwithin - your hosts, running containers, and serverless functions\u2014all without\nrequiring - teams to install Agents on every host or where Agents cannot be installed.\nAgentless - offers also Sensitive Data Scanning capabilities on your storage.\nGo to https://www.datadoghq.com/blog/agentless-scanning/ - to learn more." - name: Agentless Scanning -- description: Datadog App Builder provides a low-code solution to rapidly develop - and integrate secure, customized applications into your monitoring stack that - are built to accelerate remediation at scale. These API endpoints allow you to - create, read, update, delete, and publish apps. - name: App Builder -- description: '[Datadog Application Security](https://docs.datadoghq.com/security/application_security/) - provides protection against - - application-level attacks that aim to exploit code-level vulnerabilities, - - such as Server-Side-Request-Forgery (SSRF), SQL injection, Log4Shell, and - - Reflected Cross-Site-Scripting (XSS). You can monitor and protect apps - - hosted directly on a server, Docker, Kubernetes, Amazon ECS, and (for - - supported languages) AWS Fargate.' - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/security/application_security/ - name: Application Security -- description: Search your Audit Logs events over HTTP. - name: Audit -- description: '[The AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example) - - is used to automatically map groups of users to roles in Datadog using attributes - - sent from Identity Providers. Use these endpoints to manage your AuthN Mappings.' - name: AuthN Mappings -- description: Search or aggregate your CI Visibility pipeline events and send them - to your Datadog site over HTTP. See the [CI Pipeline Visibility in Datadog page](https://docs.datadoghq.com/continuous_integration/pipelines/) - for more information. - name: CI Visibility Pipelines -- description: Search or aggregate your CI Visibility test events over HTTP. See the - [Test Visibility in Datadog page](https://docs.datadoghq.com/tests/) for more - information. - name: CI Visibility Tests -- description: 'Datadog Cloud Security Management (CSM) delivers real-time threat - detection - - and continuous configuration audits across your entire cloud infrastructure, - - all in a unified view for seamless collaboration and faster remediation. - - Go to https://docs.datadoghq.com/security/cloud_security_management to learn more' - name: CSM Agents -- description: 'Datadog Cloud Security Management (CSM) delivers real-time threat - detection - - and continuous configuration audits across your entire cloud infrastructure, - - all in a unified view for seamless collaboration and faster remediation. - - Go to https://docs.datadoghq.com/security/cloud_security_management to learn more.' - name: CSM Coverage Analysis -- description: 'Workload Protection monitors file, network, and process activity across - your environment to detect real-time threats to your infrastructure. See [Workload - Protection](https://docs.datadoghq.com/security/workload_protection/) for more - information on setting up Workload Protection. - - - **Note**: These endpoints are split based on whether you are using the US1-FED - site or not. Please reference the specific resource for the site you are using.' - name: CSM Threats -- description: View and manage cases and projects within Case Management. See the - [Case Management page](https://docs.datadoghq.com/service_management/case_management/) - for more information. - name: Case Management -- description: View and configure custom attributes within Case Management. See the - [Case Management page](https://docs.datadoghq.com/service_management/case_management/) - for more information. - name: Case Management Attribute -- description: View and configure case types within Case Management. See the [Case - Management page](https://docs.datadoghq.com/service_management/case_management/) - for more information. - name: Case Management Type -- description: View and manage change requests within Change Management. See the [Case - Management page](https://docs.datadoghq.com/service_management/case_management/) - for more information. - name: Change Management -- description: Configure AWS cloud authentication mappings for persona and intake - authentication through the Datadog API. - name: Cloud Authentication -- description: The Cloud Cost Management API allows you to set up, edit, and delete - Cloud Cost Management accounts for AWS, Azure, and Google Cloud. You can query - your cost data by using the [Metrics endpoint](https://docs.datadoghq.com/api/latest/metrics/#query-timeseries-data-across-multiple-products) - and the `cloud_cost` data source. For more information, see the [Cloud Cost Management - documentation](https://docs.datadoghq.com/cloud_cost_management/). - name: Cloud Cost Management -- description: The Cloud Network Monitoring API allows you to fetch aggregated connections - and DNS traffic with their attributes. See the [Cloud Network Monitoring page](https://docs.datadoghq.com/network_monitoring/cloud_network_monitoring/) - and [DNS Monitoring page](https://docs.datadoghq.com/network_monitoring/dns/) - for more information. - name: Cloud Network Monitoring -- description: Manage your Datadog Cloudflare integration directly through the Datadog - API. See the [Cloudflare integration page](https://docs.datadoghq.com/integrations/cloudflare/) - for more information. - name: Cloudflare Integration -- description: Retrieve and analyze code coverage data from Code Coverage. See the - [Code Coverage page](https://docs.datadoghq.com/code_coverage/) for more information. - name: Code Coverage -- description: Manage your Datadog Confluent Cloud integration accounts and account - resources directly through the Datadog API. See the [Confluent Cloud page](https://docs.datadoghq.com/integrations/confluent_cloud/) - for more information. - name: Confluent Cloud -- description: The Container Images API allows you to query Container Image data for - your organization. See the [Container Images View page](https://docs.datadoghq.com/infrastructure/containers/container_images/) - for more information. - name: Container Images -- description: The Containers API allows you to query container data for your organization. - See the [Container Monitoring page](https://docs.datadoghq.com/containers/) for - more information. - name: Containers -- description: 'Search, send, or delete events for DORA Metrics to measure and improve - your software delivery performance. See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/) - for more information. - - - **Note**: DORA Metrics are not available in the US1-FED site.' - name: DORA Metrics -- description: 'Interact with your dashboard lists through the API to - - organize, find, and share all of your dashboards with your team and - - organization.' - name: Dashboard Lists -- description: The Data Deletion API allows the user to target and delete data from - the allowed products. It's currently enabled for Logs and RUM and depends on `logs_delete_data` - and `rum_delete_data` permissions respectively. - name: Data Deletion -- description: 'Data Access Controls in Datadog is a feature that allows administrators - and access managers to regulate - - access to sensitive data. By defining Restricted Datasets, you can ensure that - only specific teams or roles can - - view certain types of telemetry (for example, logs, traces, metrics, and RUM data).' - name: Datasets -- description: Manage Deployment Gates using this API to reduce the likelihood and - impact of incidents caused by deployments. See the [Deployment Gates documentation](https://docs.datadoghq.com/deployment_gates/) - for more information. - name: Deployment Gates -- description: 'Configure your Datadog Email Domain Allowlist directly through the - Datadog API. - - The Email Domain Allowlist controls the domains that certain datadog emails can - be sent to. - - For more information, see the [Domain Allowlist docs page](https://docs.datadoghq.com/account_management/org_settings/domain_allowlist)' - name: Domain Allowlist -- description: '**Note**: Downtime V2 is currently in private beta. To request access, - contact [Datadog support](https://docs.datadoghq.com/help/). - - - [Downtiming](https://docs.datadoghq.com/monitors/notify/downtimes) gives - - you greater control over monitor notifications by allowing you to globally exclude - - scopes from alerting. Downtime settings, which can be scheduled with start and - - end times, prevent all alerting related to specified Datadog tags.' - name: Downtimes -- description: Retrieves security risk scores for entities in your organization. - name: Entity Risk Scores -- description: View and manage issues within Error Tracking. See the [Error Tracking - page](https://docs.datadoghq.com/error_tracking/) for more information. - name: Error Tracking -- description: 'The Event Management API allows you to programmatically post events - to the Events Explorer and fetch events from the Events Explorer. See the [Event - Management page](https://docs.datadoghq.com/service_management/events/) for more - information. - - - **Update to Datadog monitor events `aggregation_key` starting March 1, 2025:** - The Datadog monitor events `aggregation_key` is unique to each Monitor ID. Starting - March 1st, this key will also include Monitor Group, making it unique per *Monitor - ID and Monitor Group*. If you''re using monitor events `aggregation_key` in dashboard - queries or the Event API, you must migrate to use `@monitor.id`. Reach out to - [support](https://www.datadoghq.com/support/) if you have any question.' - name: Events -- description: Manage your Datadog Fastly integration accounts and services directly - through the Datadog API. See the [Fastly integration page](https://docs.datadoghq.com/integrations/fastly/) - for more information. - name: Fastly Integration -- description: 'Manage automated deployments across your fleet of hosts. - - - Fleet Automation provides two types of deployments: - - - Configuration Deployments (`/configure`): - - - Apply configuration file changes to target hosts - - - Support merge-patch operations to update specific configuration fields - - - Support delete operations to remove configuration files - - - Useful for updating Datadog Agent settings, integration configs, and more - - - Package Upgrade Deployments (`/upgrade`): - - - Upgrade the Datadog Agent to specific versions' - name: Fleet Automation -- description: 'Configure your Datadog-Google Cloud Platform (GCP) integration directly - - through the Datadog API. Read more about the [Datadog-Google Cloud Platform integration](https://docs.datadoghq.com/integrations/google_cloud_platform).' - externalDocs: - url: https://docs.datadoghq.com/integrations/google_cloud_platform - name: GCP Integration -- description: 'Configure your [Datadog Google Chat integration](https://docs.datadoghq.com/integrations/google-hangouts-chat/) - - directly through the Datadog API.' - externalDocs: - description: For more information about the Datadog Google Chat integration, see - the integration page. - url: https://docs.datadoghq.com/integrations/google-hangouts-chat/ - name: Google Chat Integration -- description: 'Configure High Availability Multi-Region (HAMR) connections between - Datadog organizations. - - HAMR provides disaster recovery capabilities by maintaining synchronized data - between primary - - and secondary organizations across different datacenters.' - name: High Availability MultiRegion -- description: 'The IP allowlist API is used to manage the IP addresses that - - can access the Datadog API and web UI. It does not block - - access to intake APIs or public dashboards. - - - This is an enterprise-only feature. Request access by - - contacting Datadog support, or see the [IP Allowlist page](https://docs.datadoghq.com/account_management/org_settings/ip_allowlist/) - for more information.' - name: IP Allowlist -- description: Create, update, delete, and retrieve services which can be associated - with incidents. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/) - for more information. - name: Incident Services -- description: The Incident Teams endpoints are deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/) - to create, update, delete, and retrieve teams which can be associated with incidents. - name: Incident Teams -- description: Manage incident response, as well as associated attachments, metadata, - and todos. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/) - for more information. - name: Incidents -- description: 'The Integrations API is used to list available integrations - - and retrieve information about their installation status.' - name: Integrations -- description: Manage your Jira Integration. Atlassian Jira is a project management - and issue tracking tool for teams to coordinate work and handle tasks efficiently. - name: Jira Integration -- description: 'Manage your Datadog API and application keys. You need an API key - and an - - application key for a user with the required permissions to interact with these - endpoints. - - - Consult the following pages to view and manage your keys: - - - - [API Keys](https://app.datadoghq.com/organization-settings/api-keys) - - - [Application Keys](https://app.datadoghq.com/personal-settings/application-keys)' - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/account_management/api-app-keys/ - name: Key Management -- description: Manage LLM Observability projects, datasets, dataset records, and experiments - via the Experiments API. - name: LLM Observability -- description: Search your logs and send them to your Datadog platform over HTTP. - See the [Log Management page](https://docs.datadoghq.com/logs/) for more information. - name: Logs -- description: 'Archives forward all the logs ingested to a cloud storage system. - - - See the [Archives Page](https://app.datadoghq.com/logs/pipelines/archives) - - for a list of the archives currently configured in Datadog.' - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/logs/archives/ - name: Logs Archives -- description: 'Custom Destinations forward all the logs ingested to an external destination. - - - **Note**: Log forwarding is not available for the Government (US1-FED) site. Contact - your account representative for more information. - - - See the [Custom Destinations Page](https://app.datadoghq.com/logs/pipelines/log-forwarding/custom-destinations) - - for a list of the custom destinations currently configured in web UI.' - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/logs/log_configuration/forwarding_custom_destinations/ - name: Logs Custom Destinations -- description: Manage configuration of [log-based metrics](https://app.datadoghq.com/logs/pipelines/generate-metrics) - for your organization. - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/logs/logs_to_metrics/ - name: Logs Metrics -- description: '**Note: This endpoint is in public beta. If you have any feedback, - contact [Datadog support](https://docs.datadoghq.com/help/).** - - - A Restriction Query is a logs query that restricts which logs the `logs_read_data` - permission grants read access to. - - For users whose roles have Restriction Queries, any log query they make only returns - those log events that also match - - one of their Restriction Queries. This is true whether the user queries log events - from any log-related feature, including - - the log explorer, Live Tail, re-hydration, or a dashboard widget. - - - Restriction Queries currently only support use of the following components of - log events: - - - - Reserved attributes - - - The log message - - - Tags - - - To restrict read access on log data, add a team tag to log events to indicate - which teams own them, and then scope Restriction Queries to the relevant values - of the team tag. Tags can be applied to log events in many ways, and a log event - can have multiple tags with the same key (like team) and different values. This - means the same log event can be visible to roles whose restriction queries are - scoped to different team values. - - - See [How to Set Up RBAC for Logs](https://docs.datadoghq.com/logs/guide/logs-rbac/?tab=api#restrict-access-to-logs) - for details on how to add restriction queries.' - name: Logs Restriction Queries -- description: "The metrics endpoint allows you to:\n\n- Post metrics data so it can - be graphed on Datadog\u2019s dashboards\n- Query metrics from any time period - (timeseries and scalar)\n- Modify tag configurations for metrics\n- View tags - and volumes for metrics\n\n**Note**: A graph can only contain a set number of - points\nand as the timeframe over which a metric is viewed increases,\naggregation - between points occurs to stay below that set number.\n\nThe Post, Patch, and Delete - `manage_tags` API methods can only be performed by\na user who has the `Manage - Tags for Metrics` permission.\n\nSee the [Metrics page](https://docs.datadoghq.com/metrics/) - for more information." - name: Metrics -- description: 'Configure your [Datadog Microsoft Teams integration](https://docs.datadoghq.com/integrations/microsoft_teams/) - - directly through the Datadog API. Note: These endpoints do not support legacy - connector handles.' - externalDocs: - description: For more information about the Datadog Microsoft Teams integration, - see the integration page. - url: https://docs.datadoghq.com/integrations/microsoft_teams/ - name: Microsoft Teams Integration -- description: '[Monitors](https://docs.datadoghq.com/monitors) allow you to watch - a metric or check that you care about and - - notifies your team when a defined threshold has exceeded. - - - For more information, see [Creating Monitors](https://docs.datadoghq.com/monitors/create/types/) - and - - [Tag Policies](https://docs.datadoghq.com/monitors/settings/).' - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/monitors/create/types/ - name: Monitors -- description: The Network Device Monitoring API allows you to fetch devices and interfaces - and their attributes. See the [Network Device Monitoring page](https://docs.datadoghq.com/network_monitoring/) - for more information. - name: Network Device Monitoring -- description: Auto-generated tag OCI Integration - name: OCI Integration -- description: Observability Pipelines allows you to collect and process logs within - your own infrastructure, and then route them to downstream integrations. - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/observability_pipelines/ - name: Observability Pipelines -- description: Configure your [Datadog Okta integration](https://docs.datadoghq.com/integrations/okta/) - directly through the Datadog API. - name: Okta Integration -- description: 'Configure your [Datadog On-Call](https://docs.datadoghq.com/service_management/on-call/) - - directly through the Datadog API.' - externalDocs: - url: https://docs.datadoghq.com/service_management/on-call/ - name: On-Call -- description: 'Trigger and manage [Datadog On-Call](https://docs.datadoghq.com/service_management/on-call/) - - pages directly through the Datadog API.' - externalDocs: - url: https://docs.datadoghq.com/service_management/on-call/ - name: On-Call Paging -- description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/) - - directly through the Datadog API.' - externalDocs: - url: https://docs.datadoghq.com/api/latest/opsgenie-integration - name: Opsgenie Integration -- description: Manage connections between organizations. Org connections allow for - controlled sharing of data between different Datadog organizations. See the [Cross-Organization - Visibiltiy](https://docs.datadoghq.com/account_management/org_settings/cross_org_visibility/) - page for more information. - name: Org Connections -- description: Create, edit, and manage your organizations. Read more about [multi-org - accounts](https://docs.datadoghq.com/account_management/multi_organization). - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/account_management/multi_organization - name: Organizations -- description: 'The Powerpack endpoints allow you to: - - - - Get a Powerpack - - - Create a Powerpack - - - Delete a Powerpack - - - Get a list of all Powerpacks - - - The Patch and Delete API methods can only be performed on a Powerpack by - - a user who has the powerpack create permission for that specific Powerpack. - - - Read [Scale Graphing Expertise with Powerpacks](https://docs.datadoghq.com/dashboards/guide/powerpacks-best-practices/) - for more information.' - name: Powerpack -- description: The processes API allows you to query processes data for your organization. - See the [Live Processes page](https://docs.datadoghq.com/infrastructure/process/) - for more information. - name: Processes -- description: 'Send server-side events to Product Analytics. Server-Side Events Ingestion - allows you to collect custom events - - from any server-side source, and retains events for 15 months. Server-side events - are helpful for understanding - - causes of a funnel drop-off which are external to the client-side (for example, - payment processing error). - - See the [Product Analytics page](https://docs.datadoghq.com/product_analytics/) - for more information.' - name: Product Analytics -- description: Manage your Real User Monitoring (RUM) applications, and search or - aggregate your RUM events over HTTP. See the [RUM & Session Replay page](https://docs.datadoghq.com/real_user_monitoring/) - for more information - name: RUM -- description: View and manage Reference Tables in your organization. - name: Reference Tables -- description: 'A restriction policy defines the access control rules for a resource, - mapping a set of relations - - (such as editor and viewer) to a set of allowed principals (such as roles, teams, - or users). - - The restriction policy determines who is authorized to perform what actions on - the resource.' - name: Restriction Policies -- description: 'The Roles API is used to create and manage Datadog roles, what - - [global permissions](https://docs.datadoghq.com/account_management/rbac/) - - they grant, and which users belong to them. - - - Permissions related to specific account assets can be granted to roles - - in the Datadog application without using this API. For example, granting - - read access on a specific log index to a role can be done in Datadog from the - - [Pipelines page](https://app.datadoghq.com/logs/pipelines). - - - Roles can also be managed in bulk through the Datadog UI, which provides - - the capability to assign a single permission to multiple roles simultaneously.' - name: Roles -- description: Auto-generated tag Rum Audience Management - name: Rum Audience Management -- description: Manage configuration of [rum-based metrics](https://app.datadoghq.com/rum/generate-metrics) - for your organization. - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/real_user_monitoring/platform/generate_metrics/ - name: Rum Metrics -- description: Manage heatmap snapshots for RUM replay sessions. Create, update, delete, - and retrieve snapshots to visualize user interactions on specific views. - name: Rum Replay Heatmaps -- description: Create and manage playlists of RUM replay sessions. Organize, categorize, - and share collections of replay sessions for analysis and collaboration. - name: Rum Replay Playlists -- description: Retrieve segments for RUM replay sessions. Access session replay data - stored in event platform or blob storage. - name: Rum Replay Sessions -- description: Track and manage RUM replay session viewership. Monitor who watches - replay sessions and maintain watch history for audit and analytics purposes. - name: Rum Replay Viewership -- description: Manage retention filters through [Manage Applications](https://app.datadoghq.com/rum/list) - of RUM for your organization. - name: Rum Retention Filters -- description: The seats API allows you to view, assign, and unassign seats for your - organization. - name: Seats -- description: Create and manage your security rules, signals, filters, and more. - See the [Datadog Security page](https://docs.datadoghq.com/security/) for more - information. - name: Security Monitoring -- description: Create, update, delete, and retrieve sensitive data scanner groups - and rules. See the [Sensitive Data Scanner page](https://docs.datadoghq.com/sensitive_data_scanner/) - for more information. - name: Sensitive Data Scanner -- description: Create, edit, and disable service accounts. See the [Service Accounts - page](https://docs.datadoghq.com/account_management/org_settings/service_accounts/) - for more information. - name: Service Accounts -- description: 'API to create, update, retrieve and delete service definitions. - - Note: Service Catalog [v3.0 schema](https://docs.datadoghq.com/service_catalog/service_definitions/v3-0/) - has new API endpoints documented under [Software Catalog](https://docs.datadoghq.com/api/latest/software-catalog/). - Use the following Service Definition endpoints for v2.2 and earlier.' - externalDocs: - url: https://docs.datadoghq.com/tracing/service_catalog/ - name: Service Definition -- description: '[Service Level Objectives](https://docs.datadoghq.com/monitors/service_level_objectives/#configuration) - - (SLOs) are a key part of the site reliability engineering toolkit. - - SLOs provide a framework for defining clear targets around application performance, - - which ultimately help teams provide a consistent customer experience, - - balance feature development with platform stability, - - and improve communication with internal and external users.' - name: Service Level Objectives -- description: 'API to create and update scorecard rules and outcomes. See [Service - Scorecards](https://docs.datadoghq.com/service_catalog/scorecards) for more information. - - - This feature is currently in BETA. If you have any feedback, contact [Datadog - support](https://docs.datadoghq.com/help/).' - name: Service Scorecards -- description: Manage your ServiceNow Integration. ServiceNow is a cloud-based platform - that helps organizations manage digital workflows for enterprise operations. - name: ServiceNow Integration -- description: API to create, update, retrieve, and delete Software Catalog entities. - externalDocs: - url: https://docs.datadoghq.com/service_catalog/service_definitions#metadata-schema-v30-beta - name: Software Catalog -- description: SPA (Spark Pod Autosizing) API. Provides resource recommendations and - cost insights to help optimize Spark job configurations. - name: Spa -- description: Search and aggregate your spans from your Datadog platform over HTTP. - name: Spans -- description: Manage configuration of [span-based metrics](https://app.datadoghq.com/apm/traces/generate-metrics) - for your organization. See [Generate Metrics from Spans](https://docs.datadoghq.com/tracing/trace_pipeline/generate_metrics/) - for more information. - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/tracing/metrics/metrics_namespace/ - name: Spans Metrics -- description: API for static analysis - name: Static Analysis -- description: Manage your status pages and communicate service disruptions to stakeholders - via Datadog's API. See the [Status Pages documentation](https://docs.datadoghq.com/incident_response/status_pages/) - for more information. - name: Status Pages -- description: 'Synthetic tests use simulated requests and actions so you can monitor - the availability and performance of systems and applications. Datadog supports - the following types of synthetic tests: - - - [API tests](https://docs.datadoghq.com/synthetics/api_tests/) - - - [Browser tests](https://docs.datadoghq.com/synthetics/browser_tests) - - - [Network Path tests](https://docs.datadoghq.com/synthetics/network_path_tests/) - - - [Mobile Application tests](https://docs.datadoghq.com/synthetics/mobile_app_testing) - - You can use the Datadog API to create, manage, and organize tests and test suites - programmatically. - - For more information, see the [Synthetic Monitoring documentation](https://docs.datadoghq.com/synthetics/).' - name: Synthetics -- description: View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/) - for more information. - name: Teams -- description: Search and manage flaky tests through Test Optimization. See the [Test - Optimization page](https://docs.datadoghq.com/tests/) for more information. - name: Test Optimization -- description: 'The usage metering API allows you to get hourly, daily, and - - monthly usage across multiple facets of Datadog. - - This API is available to all Pro and Enterprise customers. - - - **Note**: Usage data is delayed by up to 72 hours from when it was incurred. - - It is retained for 15 months. - - - You can retrieve up to 24 hours of hourly usage data for multiple organizations, - - and up to two months of hourly usage data for a single organization in one request. - - Learn more on the [usage details documentation](https://docs.datadoghq.com/account_management/billing/usage_details/).' - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/account_management/billing/usage_details/ - name: Usage Metering -- description: Create, edit, and disable users. - externalDocs: - url: https://docs.datadoghq.com/account_management/users - name: Users -- description: Datadog Workflow Automation allows you to automate your end-to-end - processes by connecting Datadog with the rest of your tech stack. Build workflows - to auto-remediate your alerts, streamline your incident and security processes, - and reduce manual toil. Workflow Automation supports over 1,000+ OOTB actions, - including AWS, JIRA, ServiceNow, GitHub, and OpenAI. Learn more in our Workflow - Automation docs [here](https://docs.datadoghq.com/service_management/workflows/). - externalDocs: - description: Find out more at - url: https://docs.datadoghq.com/service_management/workflows/ - name: Workflow Automation + - description: |- + Configure your API endpoints through the Datadog API. + name: API Management + - description: Observe, troubleshoot, and improve cloud-scale applications with all telemetry in context + name: APM + - description: |- + Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters) for your organization. You need an API and application key with Admin rights to interact with this endpoint. See [retention filters](https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/#retention-filters) on the Trace Retention page for more information. + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/ + name: APM Retention Filters + - description: |- + Configure your Datadog-AWS integration directly through the Datadog API. + For more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services). + name: AWS Integration + - description: |- + Configure your Datadog-AWS-Logs integration directly through Datadog API. + For more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection). + externalDocs: + url: https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection + name: AWS Logs Integration + - description: |- + Action connections extend your installed integrations and allow you to take action in your third-party systems + (e.g. AWS, GitLab, and Statuspage) with Datadog’s Workflow Automation and App Builder products. + + Datadog’s Integrations automatically provide authentication for Slack, Microsoft Teams, PagerDuty, Opsgenie, + JIRA, GitHub, and Statuspage. You do not need additional connections in order to access these tools within + Workflow Automation and App Builder. + + We offer granular access control for editing and resolving connections. + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/service_management/workflows/connections/ + name: Action Connection + - description: |- + Leverage the Actions Datastore API to create, modify, and delete + items in datastores owned by your organization. + externalDocs: + url: https://docs.datadoghq.com/actions/datastore + name: Actions Datastores + - description: |- + Datadog Agentless Scanning provides visibility into risks and vulnerabilities + within your hosts, running containers, and serverless functions—all without + requiring teams to install Agents on every host or where Agents cannot be installed. + Agentless offers also Sensitive Data Scanning capabilities on your storage. + Go to https://www.datadoghq.com/blog/agentless-scanning/ to learn more. + name: "Agentless Scanning" + - description: |- + Datadog App Builder provides a low-code solution to rapidly develop and integrate secure, customized applications into your monitoring stack that are built to accelerate remediation at scale. These API endpoints allow you to create, read, update, delete, and publish apps. + name: App Builder + - description: |- + [Datadog Application Security](https://docs.datadoghq.com/security/application_security/) provides protection against + application-level attacks that aim to exploit code-level vulnerabilities, + such as Server-Side-Request-Forgery (SSRF), SQL injection, Log4Shell, and + Reflected Cross-Site-Scripting (XSS). You can monitor and protect apps + hosted directly on a server, Docker, Kubernetes, Amazon ECS, and (for + supported languages) AWS Fargate. + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/security/application_security/ + name: "Application Security" + - description: |- + Search your Audit Logs events over HTTP. + name: Audit + - description: |- + [The AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example) + is used to automatically map groups of users to roles in Datadog using attributes + sent from Identity Providers. Use these endpoints to manage your AuthN Mappings. + name: AuthN Mappings + - description: |- + Search or aggregate your CI Visibility pipeline events and send them to your Datadog site over HTTP. See the [CI Pipeline Visibility in Datadog page](https://docs.datadoghq.com/continuous_integration/pipelines/) for more information. + name: CI Visibility Pipelines + - description: |- + Search or aggregate your CI Visibility test events over HTTP. See the [Test Visibility in Datadog page](https://docs.datadoghq.com/tests/) for more information. + name: CI Visibility Tests + - description: |- + Datadog Cloud Security Management (CSM) delivers real-time threat detection + and continuous configuration audits across your entire cloud infrastructure, + all in a unified view for seamless collaboration and faster remediation. + Go to https://docs.datadoghq.com/security/cloud_security_management to learn more + name: "CSM Agents" + - description: |- + Datadog Cloud Security Management (CSM) delivers real-time threat detection + and continuous configuration audits across your entire cloud infrastructure, + all in a unified view for seamless collaboration and faster remediation. + Go to https://docs.datadoghq.com/security/cloud_security_management to learn more. + name: "CSM Coverage Analysis" + - description: |- + Workload Protection monitors file, network, and process activity across your environment to detect real-time threats to your infrastructure. See [Workload Protection](https://docs.datadoghq.com/security/workload_protection/) for more information on setting up Workload Protection. + + **Note**: These endpoints are split based on whether you are using the US1-FED site or not. Please reference the specific resource for the site you are using. + name: "CSM Threats" + - description: View and manage cases and projects within Case Management. See the [Case Management page](https://docs.datadoghq.com/service_management/case_management/) for more information. + name: Case Management + - description: >- + View and configure custom attributes within Case Management. See the [Case Management page](https://docs.datadoghq.com/service_management/case_management/) for more information. + name: Case Management Attribute + - description: >- + View and configure case types within Case Management. See the [Case Management page](https://docs.datadoghq.com/service_management/case_management/) for more information. + name: Case Management Type + - description: >- + View and manage change requests within Change Management. See the [Case Management page](https://docs.datadoghq.com/service_management/case_management/) for more information. + name: Change Management + - description: |- + Configure AWS cloud authentication mappings for persona and intake authentication through the Datadog API. + name: Cloud Authentication + - description: |- + The Cloud Cost Management API allows you to set up, edit, and delete Cloud Cost Management accounts for AWS, Azure, and Google Cloud. You can query your cost data by using the [Metrics endpoint](https://docs.datadoghq.com/api/latest/metrics/#query-timeseries-data-across-multiple-products) and the `cloud_cost` data source. For more information, see the [Cloud Cost Management documentation](https://docs.datadoghq.com/cloud_cost_management/). + name: Cloud Cost Management + - description: |- + The Cloud Network Monitoring API allows you to fetch aggregated connections and DNS traffic with their attributes. See the [Cloud Network Monitoring page](https://docs.datadoghq.com/network_monitoring/cloud_network_monitoring/) and [DNS Monitoring page](https://docs.datadoghq.com/network_monitoring/dns/) for more information. + name: Cloud Network Monitoring + - description: |- + Manage your Datadog Cloudflare integration directly through the Datadog API. See the [Cloudflare integration page](https://docs.datadoghq.com/integrations/cloudflare/) for more information. + name: Cloudflare Integration + - description: |- + Retrieve and analyze code coverage data from Code Coverage. See the [Code Coverage page](https://docs.datadoghq.com/code_coverage/) for more information. + name: Code Coverage + - description: |- + Manage your Datadog Confluent Cloud integration accounts and account resources directly through the Datadog API. See the [Confluent Cloud page](https://docs.datadoghq.com/integrations/confluent_cloud/) for more information. + name: Confluent Cloud + - description: |- + The Container Images API allows you to query Container Image data for your organization. See the [Container Images View page](https://docs.datadoghq.com/infrastructure/containers/container_images/) for more information. + name: Container Images + - description: |- + The Containers API allows you to query container data for your organization. See the [Container Monitoring page](https://docs.datadoghq.com/containers/) for more information. + name: Containers + - description: |- + Search, send, or delete events for DORA Metrics to measure and improve your software delivery performance. See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/) for more information. + + **Note**: DORA Metrics are not available in the US1-FED site. + name: DORA Metrics + - description: |- + Interact with your dashboard lists through the API to + organize, find, and share all of your dashboards with your team and + organization. + name: Dashboard Lists + - description: |- + The Data Deletion API allows the user to target and delete data from the allowed products. It's currently enabled for Logs and RUM and depends on `logs_delete_data` and `rum_delete_data` permissions respectively. + name: Data Deletion + - description: |- + Data Access Controls in Datadog is a feature that allows administrators and access managers to regulate + access to sensitive data. By defining Restricted Datasets, you can ensure that only specific teams or roles can + view certain types of telemetry (for example, logs, traces, metrics, and RUM data). + name: Datasets + - description: |- + Manage Deployment Gates using this API to reduce the likelihood and impact of incidents caused by deployments. See the [Deployment Gates documentation](https://docs.datadoghq.com/deployment_gates/) for more information. + name: Deployment Gates + - description: |- + Configure your Datadog Email Domain Allowlist directly through the Datadog API. + The Email Domain Allowlist controls the domains that certain datadog emails can be sent to. + For more information, see the [Domain Allowlist docs page](https://docs.datadoghq.com/account_management/org_settings/domain_allowlist) + name: Domain Allowlist + - description: |- + **Note**: Downtime V2 is currently in private beta. To request access, contact [Datadog support](https://docs.datadoghq.com/help/). + + [Downtiming](https://docs.datadoghq.com/monitors/notify/downtimes) gives + you greater control over monitor notifications by allowing you to globally exclude + scopes from alerting. Downtime settings, which can be scheduled with start and + end times, prevent all alerting related to specified Datadog tags. + name: Downtimes + - description: Retrieves security risk scores for entities in your organization. + name: Entity Risk Scores + - description: View and manage issues within Error Tracking. See the [Error Tracking page](https://docs.datadoghq.com/error_tracking/) for more information. + name: Error Tracking + - description: |- + The Event Management API allows you to programmatically post events to the Events Explorer and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/) for more information. + + **Update to Datadog monitor events `aggregation_key` starting March 1, 2025:** The Datadog monitor events `aggregation_key` is unique to each Monitor ID. Starting March 1st, this key will also include Monitor Group, making it unique per *Monitor ID and Monitor Group*. If you're using monitor events `aggregation_key` in dashboard queries or the Event API, you must migrate to use `@monitor.id`. Reach out to [support](https://www.datadoghq.com/support/) if you have any question. + name: Events + - description: |- + Manage your Datadog Fastly integration accounts and services directly through the Datadog API. See the [Fastly integration page](https://docs.datadoghq.com/integrations/fastly/) for more information. + name: Fastly Integration + - description: |- + Manage automated deployments across your fleet of hosts. + + Fleet Automation provides two types of deployments: + + Configuration Deployments (`/configure`): + - Apply configuration file changes to target hosts + - Support merge-patch operations to update specific configuration fields + - Support delete operations to remove configuration files + - Useful for updating Datadog Agent settings, integration configs, and more + + Package Upgrade Deployments (`/upgrade`): + - Upgrade the Datadog Agent to specific versions + name: Fleet Automation + - description: |- + Configure your Datadog-Google Cloud Platform (GCP) integration directly + through the Datadog API. Read more about the [Datadog-Google Cloud Platform integration](https://docs.datadoghq.com/integrations/google_cloud_platform). + externalDocs: + url: https://docs.datadoghq.com/integrations/google_cloud_platform + name: GCP Integration + - description: |- + Configure your [Datadog Google Chat integration](https://docs.datadoghq.com/integrations/google-hangouts-chat/) + directly through the Datadog API. + externalDocs: + description: For more information about the Datadog Google Chat integration, see the integration page. + url: https://docs.datadoghq.com/integrations/google-hangouts-chat/ + name: Google Chat Integration + - description: |- + Configure High Availability Multi-Region (HAMR) connections between Datadog organizations. + HAMR provides disaster recovery capabilities by maintaining synchronized data between primary + and secondary organizations across different datacenters. + name: High Availability MultiRegion + - description: |- + The IP allowlist API is used to manage the IP addresses that + can access the Datadog API and web UI. It does not block + access to intake APIs or public dashboards. + + This is an enterprise-only feature. Request access by + contacting Datadog support, or see the [IP Allowlist page](https://docs.datadoghq.com/account_management/org_settings/ip_allowlist/) for more information. + name: IP Allowlist + - description: Create, update, delete, and retrieve services which can be associated with incidents. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/) for more information. + name: Incident Services + - description: The Incident Teams endpoints are deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/) to create, update, delete, and retrieve teams which can be associated with incidents. + name: Incident Teams + - description: Manage incident response, as well as associated attachments, metadata, and todos. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/) for more information. + name: Incidents + - description: |- + The Integrations API is used to list available integrations + and retrieve information about their installation status. + name: Integrations + - description: Manage your Jira Integration. Atlassian Jira is a project management and issue tracking tool for teams to coordinate work and handle tasks efficiently. + name: Jira Integration + - description: |- + Manage your Datadog API and application keys. You need an API key and an + application key for a user with the required permissions to interact with these endpoints. + + Consult the following pages to view and manage your keys: + + - [API Keys](https://app.datadoghq.com/organization-settings/api-keys) + - [Application Keys](https://app.datadoghq.com/personal-settings/application-keys) + externalDocs: + description: Find out more at + url: "https://docs.datadoghq.com/account_management/api-app-keys/" + name: Key Management + - description: Manage LLM Observability projects, datasets, dataset records, and experiments via the Experiments API. + name: LLM Observability + - description: |- + Search your logs and send them to your Datadog platform over HTTP. See the [Log Management page](https://docs.datadoghq.com/logs/) for more information. + name: Logs + - description: |- + Archives forward all the logs ingested to a cloud storage system. + + See the [Archives Page](https://app.datadoghq.com/logs/pipelines/archives) + for a list of the archives currently configured in Datadog. + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/logs/archives/ + name: Logs Archives + - description: |- + Custom Destinations forward all the logs ingested to an external destination. + + **Note**: Log forwarding is not available for the Government (US1-FED) site. Contact your account representative for more information. + + See the [Custom Destinations Page](https://app.datadoghq.com/logs/pipelines/log-forwarding/custom-destinations) + for a list of the custom destinations currently configured in web UI. + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/logs/log_configuration/forwarding_custom_destinations/ + name: Logs Custom Destinations + - description: |- + Manage configuration of [log-based metrics](https://app.datadoghq.com/logs/pipelines/generate-metrics) for your organization. + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/logs/logs_to_metrics/ + name: Logs Metrics + - description: |- + **Note: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).** + + A Restriction Query is a logs query that restricts which logs the `logs_read_data` permission grants read access to. + For users whose roles have Restriction Queries, any log query they make only returns those log events that also match + one of their Restriction Queries. This is true whether the user queries log events from any log-related feature, including + the log explorer, Live Tail, re-hydration, or a dashboard widget. + + Restriction Queries currently only support use of the following components of log events: + + - Reserved attributes + - The log message + - Tags + + To restrict read access on log data, add a team tag to log events to indicate which teams own them, and then scope Restriction Queries to the relevant values of the team tag. Tags can be applied to log events in many ways, and a log event can have multiple tags with the same key (like team) and different values. This means the same log event can be visible to roles whose restriction queries are scoped to different team values. + + See [How to Set Up RBAC for Logs](https://docs.datadoghq.com/logs/guide/logs-rbac/?tab=api#restrict-access-to-logs) for details on how to add restriction queries. + name: Logs Restriction Queries + - description: |- + The metrics endpoint allows you to: + + - Post metrics data so it can be graphed on Datadog’s dashboards + - Query metrics from any time period (timeseries and scalar) + - Modify tag configurations for metrics + - View tags and volumes for metrics + + **Note**: A graph can only contain a set number of points + and as the timeframe over which a metric is viewed increases, + aggregation between points occurs to stay below that set number. + + The Post, Patch, and Delete `manage_tags` API methods can only be performed by + a user who has the `Manage Tags for Metrics` permission. + + See the [Metrics page](https://docs.datadoghq.com/metrics/) for more information. + name: Metrics + - description: |- + Configure your [Datadog Microsoft Teams integration](https://docs.datadoghq.com/integrations/microsoft_teams/) + directly through the Datadog API. Note: These endpoints do not support legacy connector handles. + externalDocs: + description: For more information about the Datadog Microsoft Teams integration, see the integration page. + url: https://docs.datadoghq.com/integrations/microsoft_teams/ + name: Microsoft Teams Integration + - description: |- + [Monitors](https://docs.datadoghq.com/monitors) allow you to watch a metric or check that you care about and + notifies your team when a defined threshold has exceeded. + + For more information, see [Creating Monitors](https://docs.datadoghq.com/monitors/create/types/) and + [Tag Policies](https://docs.datadoghq.com/monitors/settings/). + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/monitors/create/types/ + name: Monitors + - description: |- + The Network Device Monitoring API allows you to fetch devices and interfaces and their attributes. See the [Network Device Monitoring page](https://docs.datadoghq.com/network_monitoring/) for more information. + name: Network Device Monitoring + - description: Auto-generated tag OCI Integration + name: OCI Integration + - description: |- + Observability Pipelines allows you to collect and process logs within your own infrastructure, and then route them to downstream integrations. + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/observability_pipelines/ + name: Observability Pipelines + - description: |- + Configure your [Datadog Okta integration](https://docs.datadoghq.com/integrations/okta/) directly through the Datadog API. + name: Okta Integration + - description: |- + Configure your [Datadog On-Call](https://docs.datadoghq.com/service_management/on-call/) + directly through the Datadog API. + externalDocs: + url: https://docs.datadoghq.com/service_management/on-call/ + name: On-Call + - description: |- + Trigger and manage [Datadog On-Call](https://docs.datadoghq.com/service_management/on-call/) + pages directly through the Datadog API. + externalDocs: + url: https://docs.datadoghq.com/service_management/on-call/ + name: On-Call Paging + - description: |- + Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/) + directly through the Datadog API. + externalDocs: + url: https://docs.datadoghq.com/api/latest/opsgenie-integration + name: Opsgenie Integration + - description: |- + Manage connections between organizations. Org connections allow for controlled sharing of data between different Datadog organizations. See the [Cross-Organization Visibiltiy](https://docs.datadoghq.com/account_management/org_settings/cross_org_visibility/) page for more information. + name: Org Connections + - description: Create, edit, and manage your organizations. Read more about [multi-org accounts](https://docs.datadoghq.com/account_management/multi_organization). + externalDocs: + description: Find out more at + url: "https://docs.datadoghq.com/account_management/multi_organization" + name: Organizations + - description: |- + The Powerpack endpoints allow you to: + + - Get a Powerpack + - Create a Powerpack + - Delete a Powerpack + - Get a list of all Powerpacks + + The Patch and Delete API methods can only be performed on a Powerpack by + a user who has the powerpack create permission for that specific Powerpack. + + Read [Scale Graphing Expertise with Powerpacks](https://docs.datadoghq.com/dashboards/guide/powerpacks-best-practices/) for more information. + name: Powerpack + - description: |- + The processes API allows you to query processes data for your organization. See the [Live Processes page](https://docs.datadoghq.com/infrastructure/process/) for more information. + name: Processes + - description: |- + Send server-side events to Product Analytics. Server-Side Events Ingestion allows you to collect custom events + from any server-side source, and retains events for 15 months. Server-side events are helpful for understanding + causes of a funnel drop-off which are external to the client-side (for example, payment processing error). + See the [Product Analytics page](https://docs.datadoghq.com/product_analytics/) for more information. + name: Product Analytics + - description: |- + Manage your Real User Monitoring (RUM) applications, and search or aggregate your RUM events over HTTP. See the [RUM & Session Replay page](https://docs.datadoghq.com/real_user_monitoring/) for more information + name: RUM + - description: View and manage Reference Tables in your organization. + name: Reference Tables + - description: |- + A restriction policy defines the access control rules for a resource, mapping a set of relations + (such as editor and viewer) to a set of allowed principals (such as roles, teams, or users). + The restriction policy determines who is authorized to perform what actions on the resource. + name: Restriction Policies + - description: |- + The Roles API is used to create and manage Datadog roles, what + [global permissions](https://docs.datadoghq.com/account_management/rbac/) + they grant, and which users belong to them. + + Permissions related to specific account assets can be granted to roles + in the Datadog application without using this API. For example, granting + read access on a specific log index to a role can be done in Datadog from the + [Pipelines page](https://app.datadoghq.com/logs/pipelines). + + Roles can also be managed in bulk through the Datadog UI, which provides + the capability to assign a single permission to multiple roles simultaneously. + name: Roles + - description: Auto-generated tag Rum Audience Management + name: Rum Audience Management + - description: |- + Manage configuration of [rum-based metrics](https://app.datadoghq.com/rum/generate-metrics) for your organization. + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/real_user_monitoring/platform/generate_metrics/ + name: Rum Metrics + - description: Manage heatmap snapshots for RUM replay sessions. Create, update, delete, and retrieve snapshots to visualize user interactions on specific views. + name: Rum Replay Heatmaps + - description: Create and manage playlists of RUM replay sessions. Organize, categorize, and share collections of replay sessions for analysis and collaboration. + name: Rum Replay Playlists + - description: Retrieve segments for RUM replay sessions. Access session replay data stored in event platform or blob storage. + name: Rum Replay Sessions + - description: Track and manage RUM replay session viewership. Monitor who watches replay sessions and maintain watch history for audit and analytics purposes. + name: Rum Replay Viewership + - description: |- + Manage retention filters through [Manage Applications](https://app.datadoghq.com/rum/list) of RUM for your organization. + name: Rum Retention Filters + - description: |- + The seats API allows you to view, assign, and unassign seats for your organization. + name: Seats + - description: |- + Create and manage your security rules, signals, filters, and more. See the [Datadog Security page](https://docs.datadoghq.com/security/) for more information. + name: "Security Monitoring" + - description: Create, update, delete, and retrieve sensitive data scanner groups and rules. See the [Sensitive Data Scanner page](https://docs.datadoghq.com/sensitive_data_scanner/) for more information. + name: Sensitive Data Scanner + - description: Create, edit, and disable service accounts. See the [Service Accounts page](https://docs.datadoghq.com/account_management/org_settings/service_accounts/) for more information. + name: Service Accounts + - description: |- + API to create, update, retrieve and delete service definitions. + Note: Service Catalog [v3.0 schema](https://docs.datadoghq.com/service_catalog/service_definitions/v3-0/) has new API endpoints documented under [Software Catalog](https://docs.datadoghq.com/api/latest/software-catalog/). Use the following Service Definition endpoints for v2.2 and earlier. + externalDocs: + url: https://docs.datadoghq.com/tracing/service_catalog/ + name: Service Definition + - description: |- + [Service Level Objectives](https://docs.datadoghq.com/monitors/service_level_objectives/#configuration) + (SLOs) are a key part of the site reliability engineering toolkit. + SLOs provide a framework for defining clear targets around application performance, + which ultimately help teams provide a consistent customer experience, + balance feature development with platform stability, + and improve communication with internal and external users. + name: Service Level Objectives + - description: |- + API to create and update scorecard rules and outcomes. See [Service Scorecards](https://docs.datadoghq.com/service_catalog/scorecards) for more information. + + This feature is currently in BETA. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + name: Service Scorecards + - description: Manage your ServiceNow Integration. ServiceNow is a cloud-based platform that helps organizations manage digital workflows for enterprise operations. + name: ServiceNow Integration + - description: |- + API to create, update, retrieve, and delete Software Catalog entities. + externalDocs: + url: https://docs.datadoghq.com/service_catalog/service_definitions#metadata-schema-v30-beta + name: Software Catalog + - description: SPA (Spark Pod Autosizing) API. Provides resource recommendations and cost insights to help optimize Spark job configurations. + name: Spa + - description: |- + Search and aggregate your spans from your Datadog platform over HTTP. + name: Spans + - description: |- + Manage configuration of [span-based metrics](https://app.datadoghq.com/apm/traces/generate-metrics) for your organization. See [Generate Metrics from Spans](https://docs.datadoghq.com/tracing/trace_pipeline/generate_metrics/) for more information. + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/tracing/metrics/metrics_namespace/ + name: Spans Metrics + - description: API for static analysis + name: Static Analysis + - description: Manage your status pages and communicate service disruptions to stakeholders via Datadog's API. See the [Status Pages documentation](https://docs.datadoghq.com/incident_response/status_pages/) for more information. + name: Status Pages + - description: |- + Synthetic tests use simulated requests and actions so you can monitor the availability and performance of systems and applications. Datadog supports the following types of synthetic tests: + - [API tests](https://docs.datadoghq.com/synthetics/api_tests/) + - [Browser tests](https://docs.datadoghq.com/synthetics/browser_tests) + - [Network Path tests](https://docs.datadoghq.com/synthetics/network_path_tests/) + - [Mobile Application tests](https://docs.datadoghq.com/synthetics/mobile_app_testing) + You can use the Datadog API to create, manage, and organize tests and test suites programmatically. + For more information, see the [Synthetic Monitoring documentation](https://docs.datadoghq.com/synthetics/). + name: Synthetics + - description: View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/) for more information. + name: Teams + - description: |- + Search and manage flaky tests through Test Optimization. See the [Test Optimization page](https://docs.datadoghq.com/tests/) for more information. + name: Test Optimization + - description: |- + The usage metering API allows you to get hourly, daily, and + monthly usage across multiple facets of Datadog. + This API is available to all Pro and Enterprise customers. + + **Note**: Usage data is delayed by up to 72 hours from when it was incurred. + It is retained for 15 months. + + You can retrieve up to 24 hours of hourly usage data for multiple organizations, + and up to two months of hourly usage data for a single organization in one request. + Learn more on the [usage details documentation](https://docs.datadoghq.com/account_management/billing/usage_details/). + externalDocs: + description: Find out more at + url: "https://docs.datadoghq.com/account_management/billing/usage_details/" + name: Usage Metering + - description: Create, edit, and disable users. + externalDocs: + url: https://docs.datadoghq.com/account_management/users + name: Users + - description: |- + Datadog Workflow Automation allows you to automate your end-to-end processes by connecting Datadog with the rest of your tech stack. Build workflows to auto-remediate your alerts, streamline your incident and security processes, and reduce manual toil. Workflow Automation supports over 1,000+ OOTB actions, including AWS, JIRA, ServiceNow, GitHub, and OpenAI. Learn more in our Workflow Automation docs [here](https://docs.datadoghq.com/service_management/workflows/). + externalDocs: + description: Find out more at + url: "https://docs.datadoghq.com/service_management/workflows/" + name: Workflow Automation x-group-parameters: true diff --git a/lib/datadog_api_client/v1/api/webhooks_integration_api.rb b/lib/datadog_api_client/v1/api/webhooks_integration_api.rb index 232295c3e9f1..e59e05e243cf 100644 --- a/lib/datadog_api_client/v1/api/webhooks_integration_api.rb +++ b/lib/datadog_api_client/v1/api/webhooks_integration_api.rb @@ -167,7 +167,7 @@ def delete_webhooks_integration(webhook_name, opts = {}) # Delete a webhook. # - # Deletes the endpoint with the name ``. + # Deletes the endpoint with the name ``. This action cannot be undone. # # @param webhook_name [String] The name of the webhook. # @param opts [Hash] the optional parameters diff --git a/lib/datadog_api_client/v2/api/metrics_api.rb b/lib/datadog_api_client/v2/api/metrics_api.rb index 639614c435be..fbb1d2e3c6a9 100644 --- a/lib/datadog_api_client/v2/api/metrics_api.rb +++ b/lib/datadog_api_client/v2/api/metrics_api.rb @@ -254,6 +254,7 @@ def delete_tag_configuration(metric_name, opts = {}) # # Deletes a metric's tag configuration. Can only be used with application # keys from users with the `Manage Tags for Metrics` permission. + # Note: This operation is irreversible. # # @param metric_name [String] The name of the metric. # @param opts [Hash] the optional parameters @@ -667,20 +668,23 @@ def list_tag_configurations(opts = {}) # Get a list of metrics. # - # Get a list of actively reporting metrics for your organization. Pagination is optional using the `page[cursor]` and `page[size]` query parameters. + # Returns all metrics for your organization that match the given filter parameters. + # Optionally, paginate by using the `page[cursor]` and/or `page[size]` query parameters. + # To 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. + # Once the `meta.pagination.next_cursor` value is null, all pages have been retrieved. # # @param opts [Hash] the optional parameters - # @option opts [Boolean] :filter_configured Only return custom metrics that have been configured with Metrics Without Limits. - # @option opts [String] :filter_tags_configured Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded). - # @option opts [MetricTagConfigurationMetricTypeCategory] :filter_metric_type Only return metrics of the given metric type. - # @option opts [Boolean] :filter_include_percentiles Only return distribution metrics that have percentile aggregations enabled (true) or disabled (false). - # @option opts [Boolean] :filter_queried Only return metrics that have been queried (true) or not queried (false) in the look back window. Set the window with `filter[queried][window][seconds]`; if omitted, a default window is used. - # @option opts [Integer] :filter_queried_window_seconds Only return metrics that have been queried or not queried in the specified window. Dependent on being sent with `filter[queried]`. - # @option opts [String] :filter_tags Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards (for example, service:web*). - # @option opts [Boolean] :filter_related_assets Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO. - # @option opts [Integer] :window_seconds Only return metrics that have been actively reporting in the specified window. - # @option opts [Integer] :page_size Maximum number of results per page. Use with `page[cursor]` for pagination. - # @option opts [String] :page_cursor Cursor for pagination. Use `page[size]` to opt-in to pagination and get the first page; for subsequent pages, use the value from `meta.pagination.next_cursor` in the response. Pagination is complete when `next_cursor` is null. + # @option opts [Boolean] :filter_configured Filter custom metrics that have configured tags. + # @option opts [String] :filter_tags_configured Filter tag configurations by configured tags. + # @option opts [MetricTagConfigurationMetricTypeCategory] :filter_metric_type Filter metrics by metric type. + # @option opts [Boolean] :filter_include_percentiles Filter distributions with additional percentile aggregations enabled or disabled. + # @option opts [Boolean] :filter_queried (Preview) Filter custom metrics that have or have not been queried in the specified window[seconds]. If no window is provided or the window is less than 2 hours, a default of 2 hours will be applied. + # @option opts [Integer] :filter_queried_window_seconds The number of seconds of look back (from now) used by the `filter[queried]` filter logic. Must be sent with `filter[queried]` and is only applied when `filter[queried]=true`. If `filter[queried]=false`, this parameter is ignored and default queried-window behavior applies. If `filter[queried]` is not provided, sending this parameter returns a 400. For example: `GET /api/v2/metrics?filter[queried]=true&filter[queried][window][seconds]=15552000`. + # @option opts [String] :filter_tags Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Can only be combined with the filter[queried] filter. + # @option opts [Boolean] :filter_related_assets (Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs. + # @option opts [Integer] :window_seconds The number of seconds of look back (from now) to apply to a filter[tag] query. Default value is 3600 (1 hour), maximum value is 5,184,000 (60 days). + # @option opts [Integer] :page_size Maximum number of results returned. + # @option opts [String] :page_cursor String to query the next page of results. This key is provided with each valid response from the API in `meta.pagination.next_cursor`. Once the `meta.pagination.next_cursor` key is null, all pages have been retrieved. # @return [Array<(MetricsAndMetricTagConfigurationsResponse, Integer, Hash)>] MetricsAndMetricTagConfigurationsResponse data, response status code and response headers def list_tag_configurations_with_http_info(opts = {}) @@ -694,14 +698,8 @@ def list_tag_configurations_with_http_info(opts = {}) if @api_client.config.client_side_validation && !opts[:'filter_queried_window_seconds'].nil? && opts[:'filter_queried_window_seconds'] > 15552000 fail ArgumentError, 'invalid value for "opts[:"filter_queried_window_seconds"]" when calling MetricsAPI.list_tag_configurations, must be smaller than or equal to 15552000.' end - if @api_client.config.client_side_validation && !opts[:'filter_queried_window_seconds'].nil? && opts[:'filter_queried_window_seconds'] < 1 - fail ArgumentError, 'invalid value for "opts[:"filter_queried_window_seconds"]" when calling MetricsAPI.list_tag_configurations, must be greater than or equal to 1.' - end - if @api_client.config.client_side_validation && !opts[:'window_seconds'].nil? && opts[:'window_seconds'] > 2592000 - fail ArgumentError, 'invalid value for "opts[:"window_seconds"]" when calling MetricsAPI.list_tag_configurations, must be smaller than or equal to 2592000.' - end - if @api_client.config.client_side_validation && !opts[:'window_seconds'].nil? && opts[:'window_seconds'] < 1 - fail ArgumentError, 'invalid value for "opts[:"window_seconds"]" when calling MetricsAPI.list_tag_configurations, must be greater than or equal to 1.' + if @api_client.config.client_side_validation && !opts[:'filter_queried_window_seconds'].nil? && opts[:'filter_queried_window_seconds'] < 0 + fail ArgumentError, 'invalid value for "opts[:"filter_queried_window_seconds"]" when calling MetricsAPI.list_tag_configurations, must be greater than or equal to 0.' end if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000 fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling MetricsAPI.list_tag_configurations, must be smaller than or equal to 10000.' diff --git a/lib/datadog_api_client/v2/models/observability_pipeline_datadog_agent_source.rb b/lib/datadog_api_client/v2/models/observability_pipeline_datadog_agent_source.rb index 5dab475c2f24..373c2592e31e 100644 --- a/lib/datadog_api_client/v2/models/observability_pipeline_datadog_agent_source.rb +++ b/lib/datadog_api_client/v2/models/observability_pipeline_datadog_agent_source.rb @@ -23,9 +23,6 @@ module DatadogAPIClient::V2 class ObservabilityPipelineDatadogAgentSource include BaseGenericModel - # Name of the environment variable or secret that holds the listen address for the Datadog Agent source. - attr_accessor :address_key - # The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components). attr_reader :id @@ -41,7 +38,6 @@ class ObservabilityPipelineDatadogAgentSource # @!visibility private def self.attribute_map { - :'address_key' => :'address_key', :'id' => :'id', :'tls' => :'tls', :'type' => :'type' @@ -52,7 +48,6 @@ def self.attribute_map # @!visibility private def self.openapi_types { - :'address_key' => :'String', :'id' => :'String', :'tls' => :'ObservabilityPipelineTls', :'type' => :'ObservabilityPipelineDatadogAgentSourceType' @@ -77,10 +72,6 @@ def initialize(attributes = {}) end } - if attributes.key?(:'address_key') - self.address_key = attributes[:'address_key'] - end - if attributes.key?(:'id') self.id = attributes[:'id'] end @@ -149,7 +140,6 @@ def to_hash def ==(o) return true if self.equal?(o) self.class == o.class && - address_key == o.address_key && id == o.id && tls == o.tls && type == o.type && @@ -160,7 +150,7 @@ def ==(o) # @return [Integer] Hash code # @!visibility private def hash - [address_key, id, tls, type, additional_properties].hash + [id, tls, type, additional_properties].hash end end end