.generator/schemas/v2/openapi.yaml in datadog_api_client-2.27.1 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.28.1

- old
+ new

@@ -201,11 +201,11 @@ name: custom_destination_id required: true schema: type: string EntityID: - description: UUID or Entity Ref + description: UUID or Entity Ref. in: path name: entity_id required: true schema: example: service:myservice @@ -230,61 +230,61 @@ name: file_id required: true schema: type: string FilterByExcludeSnapshot: - description: Filter entities by excluding snapshotted entities + description: Filter entities by excluding snapshotted entities. in: query - name: fitler[exclude_snapshot] + name: filter[exclude_snapshot] required: false schema: type: string FilterByID: - description: Filter entities by UUID + description: Filter entities by UUID. explode: true in: query - name: fitler[id] + name: filter[id] required: false schema: type: string FilterByKind: - description: Filter entities by kind + description: Filter entities by kind. explode: true in: query - name: fitler[kind] + name: filter[kind] required: false schema: type: string FilterByName: - description: Filter entities by name + description: Filter entities by name. explode: true in: query - name: fitler[name] + name: filter[name] required: false schema: type: string FilterByOwner: - description: Filter entities by owner + description: Filter entities by owner. explode: true in: query - name: fitler[owner] + name: filter[owner] required: false schema: type: string FilterByRef: description: Filter entities by reference explode: true in: query - name: fitler[ref] + name: filter[ref] required: false schema: type: string FilterByRelationType: - description: Filter entities by relation type + description: Filter entities by relation type. explode: true in: query - name: fitler[relation][type] + name: filter[relation][type] required: false schema: $ref: '#/components/schemas/RelationType' GCPSTSServiceAccountID: description: Your GCP STS enabled service account's unique ID. @@ -419,12 +419,26 @@ in: path name: todo_id required: true schema: type: string + IncidentTypeIDPathParameter: + description: The UUID of the incident type. + in: path + name: incident_type_id + required: true + schema: + type: string + IncidentTypeIncludeDeletedParameter: + description: Include deleted incident types in the response. + in: query + name: include_deleted + schema: + default: false + type: boolean Include: - description: include relationship data + description: Include relationship data. explode: true in: query name: include required: false schema: @@ -456,28 +470,28 @@ in: path name: channel_name required: true schema: type: string - MicrosoftTeamsHandleIDPathParameter: - description: Your handle id. - in: path - name: handle_id - required: true + MicrosoftTeamsHandleNameQueryParameter: + description: Your tenant-based handle name. + in: query + name: name + required: false schema: type: string - MicrosoftTeamsHandleNamePathParameter: - description: Your handle name. + MicrosoftTeamsTeamNamePathParameter: + description: Your team name. in: path - name: handle_name + name: team_name required: true schema: type: string - MicrosoftTeamsTeamNamePathParameter: - description: Your team name. + MicrosoftTeamsTenantBasedHandleIDPathParameter: + description: Your tenant-based handle id. in: path - name: team_name + name: handle_id required: true schema: type: string MicrosoftTeamsTenantIDQueryParameter: description: Your tenant id. @@ -581,10 +595,17 @@ in: path name: rule_id required: true schema: type: string + RumMetricIDParameter: + description: The name of the rum-based metric. + in: path + name: metric_id + required: true + schema: + type: string SchemaVersion: description: The schema version desired in the response. in: query name: schema_version required: false @@ -953,53 +974,10 @@ - api_keys example: api_keys type: string x-enum-varnames: - API_KEYS - AWSRelatedAccount: - description: AWS related account. - properties: - attributes: - $ref: '#/components/schemas/AWSRelatedAccountAttributes' - id: - description: The AWS account ID. - example: '123456789123' - type: string - type: - $ref: '#/components/schemas/AWSRelatedAccountType' - required: - - id - - type - type: object - AWSRelatedAccountAttributes: - description: Attributes for an AWS related account. - properties: - has_datadog_integration: - description: Whether or not the AWS account has a Datadog integration. - type: boolean - name: - description: The name of the AWS account. - type: string - type: object - AWSRelatedAccountType: - default: aws_account - description: Type of AWS related account. - enum: - - aws_account - example: aws_account - type: string - x-enum-varnames: - - AWS_ACCOUNT - AWSRelatedAccountsResponse: - description: List of AWS related accounts. - properties: - data: - description: An AWS related account. - items: - $ref: '#/components/schemas/AWSRelatedAccount' - type: array - type: object ActiveBillingDimensionsAttributes: description: List of active billing dimensions. properties: month: description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.' @@ -2163,10 +2141,78 @@ - export_name - export_path - storage_account - storage_container type: object + BillingDimensionsMappingBody: + description: Billing dimensions mapping data. + items: + $ref: '#/components/schemas/BillingDimensionsMappingBodyItem' + type: array + BillingDimensionsMappingBodyItem: + description: The mapping data for each billing dimension. + properties: + attributes: + $ref: '#/components/schemas/BillingDimensionsMappingBodyItemAttributes' + id: + description: ID of the billing dimension. + type: string + type: + $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. + items: + $ref: '#/components/schemas/BillingDimensionsMappingBodyItemAttributesEndpointsItems' + type: array + in_app_label: + 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]`.' + format: date-time + type: string + type: object + BillingDimensionsMappingBodyItemAttributesEndpointsItems: + description: An endpoint's keys mapped to the billing_dimension. + properties: + id: + description: The URL for the endpoint. + example: api/v1/usage/billable-summary + type: string + keys: + description: The billing dimension. + example: + - apm_host_top99p + - apm_host_sum + items: + example: apm_host_top99p + type: string + type: array + status: + $ref: '#/components/schemas/BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus' + type: object + BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus: + description: Denotes whether mapping keys were available for this endpoint. + enum: + - OK + - NOT_FOUND + type: string + x-enum-varnames: + - OK + - NOT_FOUND + BillingDimensionsMappingResponse: + description: Billing dimensions mapping response. + properties: + data: + $ref: '#/components/schemas/BillingDimensionsMappingBody' + type: object BulkMuteFindingsRequest: description: The new bulk mute finding request. properties: data: $ref: '#/components/schemas/BulkMuteFindingsRequestData' @@ -4504,14 +4550,17 @@ name: description: The name of the Cloudflare account. example: test-name type: string resources: - description: An allowlist of resources to restrict pulling metrics for. + 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. @@ -4552,14 +4601,17 @@ name: description: The name of the Cloudflare account. example: test-name type: string resources: - description: An allowlist of resources to restrict pulling metrics for. + 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. @@ -4619,14 +4671,17 @@ type: string name: description: The name of the Cloudflare account. type: string resources: - description: An allowlist of resources to restrict pulling metrics for. + 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. @@ -7099,10 +7154,85 @@ type: string type: description: The type of the resource. The value should always be device. type: string type: object + DomainAllowlist: + description: The email domain allowlist for an org. + properties: + attributes: + $ref: '#/components/schemas/DomainAllowlistAttributes' + id: + description: The unique identifier of the org. + nullable: true + type: string + type: + $ref: '#/components/schemas/DomainAllowlistType' + required: + - type + type: object + DomainAllowlistAttributes: + description: The details of the email domain allowlist. + properties: + domains: + description: The list of domains in the email domain allowlist. + items: + type: string + type: array + enabled: + description: Whether the email domain allowlist is enabled for the org. + type: boolean + type: object + DomainAllowlistRequest: + description: Request containing the desired email domain allowlist configuration. + properties: + data: + $ref: '#/components/schemas/DomainAllowlist' + required: + - data + type: object + DomainAllowlistResponse: + description: Response containing information about the email domain allowlist. + properties: + data: + $ref: '#/components/schemas/DomainAllowlistResponseData' + type: object + DomainAllowlistResponseData: + description: The email domain allowlist response for an org. + properties: + attributes: + $ref: '#/components/schemas/DomainAllowlistResponseDataAttributes' + id: + description: The unique identifier of the org. + nullable: true + type: string + type: + $ref: '#/components/schemas/DomainAllowlistType' + required: + - type + type: object + DomainAllowlistResponseDataAttributes: + description: The details of the email domain allowlist. + properties: + domains: + description: The list of domains in the email domain allowlist. + items: + type: string + type: array + enabled: + description: Whether the email domain allowlist is enabled for the org. + type: boolean + type: object + DomainAllowlistType: + default: domain_allowlist + description: Email domain allowlist allowlist type. + enum: + - domain_allowlist + example: domain_allowlist + type: string + x-enum-varnames: + - DOMAIN_ALLOWLIST DowntimeCreateRequest: description: Request for creating a downtime. properties: data: $ref: '#/components/schemas/DowntimeCreateRequestData' @@ -7678,11 +7808,11 @@ type: object EntityAttributes: description: Entity attributes. properties: apiVersion: - description: The api version. + description: The API version. type: string description: description: The description. type: string displayName: @@ -7710,11 +7840,11 @@ description: Entity data. properties: attributes: $ref: '#/components/schemas/EntityAttributes' id: - description: Entity id. + description: Entity ID. type: string meta: $ref: '#/components/schemas/EntityMeta' relationships: $ref: '#/components/schemas/EntityRelationships' @@ -7737,11 +7867,11 @@ origin: description: The origin. type: string type: object EntityRaw: - description: Entity definition in raw JSON/YAML representation. + description: Entity definition in raw JSON or YAML representation. example: "apiVersion: v3\nkind: service\nmetadata:\n name: myservice\n" type: string EntityRelationships: description: Entity relationships. properties: @@ -7765,11 +7895,11 @@ description: Included incident. properties: attributes: $ref: '#/components/schemas/EntityResponseIncludedRelatedIncidentAttributes' id: - description: Incident id. + description: Incident ID. type: string type: description: Incident description. type: string type: object @@ -7789,11 +7919,11 @@ description: Included raw schema. properties: attributes: $ref: '#/components/schemas/EntityResponseIncludedRawSchemaAttributes' id: - description: Raw schema id. + description: Raw schema ID. type: string type: description: Raw schema type. type: string type: object @@ -7880,11 +8010,11 @@ provider: description: Oncall provider. type: string type: object EntityResponseIncludedRelatedOncallEscalationItem: - description: Oncall escalation + description: Oncall escalation. properties: email: description: Oncall email. type: string escalationLevel: @@ -7894,21 +8024,21 @@ name: description: Oncall name. type: string type: object EntityResponseIncludedRelatedOncallEscalations: - description: Oncall escalations + description: Oncall escalations. items: $ref: '#/components/schemas/EntityResponseIncludedRelatedOncallEscalationItem' type: array EntityResponseIncludedSchema: description: Included detail entity schema. properties: attributes: $ref: '#/components/schemas/EntityResponseIncludedSchemaAttributes' id: - description: Entity id. + description: Entity ID. type: string type: description: Schema type. type: string type: object @@ -7967,124 +8097,124 @@ - $ref: '#/components/schemas/EntityV3Datastore' - $ref: '#/components/schemas/EntityV3Queue' - $ref: '#/components/schemas/EntityV3System' EntityV3APIVersion: description: The schema version of entity type. The field is known as schema-version - in the previous version + in the previous version. enum: - v3 example: v3 type: string x-enum-varnames: - V3 EntityV3DatadogCodeLocationItem: additionalProperties: false - description: code location item. + description: Code location item. properties: paths: - description: The paths (glob) to the source code of the service + description: The paths (glob) to the source code of the service. items: type: string type: array repositoryURL: - description: The repository path of the source code of the entity + description: The repository path of the source code of the entity. pattern: url type: string type: object EntityV3DatadogCodeLocations: additionalProperties: false - description: Schema for mapping source code locations to an entity + description: Schema for mapping source code locations to an entity. items: $ref: '#/components/schemas/EntityV3DatadogCodeLocationItem' type: array EntityV3DatadogEventItem: additionalProperties: false description: Events association item. properties: name: - description: The name of the query + description: The name of the query. type: string query: - description: The query to run + description: The query to run. type: string type: object EntityV3DatadogEvents: additionalProperties: false - description: Events associations + description: Events associations. items: $ref: '#/components/schemas/EntityV3DatadogEventItem' type: array EntityV3DatadogIntegrationOpsgenie: additionalProperties: false - description: An Opsgenie integration schema + description: An Opsgenie integration schema. properties: region: description: The region for the Opsgenie integration. minLength: 1 type: string serviceURL: - description: The service url for the Opsgenie integration. + description: The service URL for the Opsgenie integration. example: https://www.opsgenie.com/service/shopping-cart minLength: 1 type: string required: - serviceURL type: object EntityV3DatadogIntegrationPagerduty: additionalProperties: false - description: An PagerDuty integration schema + description: A PagerDuty integration schema. properties: serviceURL: - description: The service url for the PagerDuty integration. + description: The service URL for the PagerDuty integration. example: https://www.pagerduty.com/service-directory/Pshopping-cart minLength: 1 type: string required: - serviceURL type: object EntityV3DatadogLogItem: additionalProperties: false - description: log association item. + description: Log association item. properties: name: - description: The name of the query + description: The name of the query. type: string query: - description: The query to run + description: The query to run. type: string type: object EntityV3DatadogLogs: additionalProperties: false - description: Logs association + description: Logs association. items: $ref: '#/components/schemas/EntityV3DatadogLogItem' type: array EntityV3DatadogPerformance: additionalProperties: false - description: Performance stats association + description: Performance stats association. properties: tags: description: A list of APM entity tags that associates the APM Stats data - with the entity + with the entity. items: type: string type: array type: object EntityV3DatadogPipelines: additionalProperties: false - description: CI Pipelines association + description: CI Pipelines association. properties: fingerprints: description: A list of CI Fingerprints that associate CI Pipelines with - the entity + the entity. items: type: string type: array type: object EntityV3Datastore: additionalProperties: false - description: Schema for datastore entities + description: Schema for datastore entities. properties: apiVersion: $ref: '#/components/schemas/EntityV3APIVersion' datadog: $ref: '#/components/schemas/EntityV3DatastoreDatadog' @@ -8106,11 +8236,11 @@ - kind - metadata type: object EntityV3DatastoreDatadog: additionalProperties: false - description: Datadog product integrations for the datastore entity + description: Datadog product integrations for the datastore entity. properties: events: $ref: '#/components/schemas/EntityV3DatadogEvents' logs: $ref: '#/components/schemas/EntityV3DatadogLogs' @@ -8132,20 +8262,20 @@ lifecycle: description: The lifecycle state of the datastore. minLength: 1 type: string tier: - description: The importance of the datastore + description: The importance of the datastore. minLength: 1 type: string type: - description: The type of datastore + description: The type of datastore. type: string type: object EntityV3Integrations: additionalProperties: false - description: A base schema for defining third party integrations + description: A base schema for defining third-party integrations. properties: opsgenie: $ref: '#/components/schemas/EntityV3DatadogIntegrationOpsgenie' pagerduty: $ref: '#/components/schemas/EntityV3DatadogIntegrationPagerduty' @@ -8154,27 +8284,27 @@ additionalProperties: false description: The definition of Entity V3 Metadata object. properties: additionalOwners: additionalProperties: false - description: The additional owners of the entity, usually a team + description: The additional owners of the entity, usually a team. items: $ref: '#/components/schemas/EntityV3MetadataAdditionalOwnersItems' type: array contacts: additionalProperties: false - description: A list of contacts for the entity + description: A list of contacts for the entity. items: $ref: '#/components/schemas/EntityV3MetadataContactsItems' type: array description: description: Short description of the entity. The UI can leverage the description - for display + for display. type: string displayName: description: User friendly name of the entity. The UI can leverage the display - name for 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. example: 4b163705-23c0-4573-b2fb-f6cea2163fcb @@ -8184,34 +8314,34 @@ description: The entity reference from which to inherit metadata example: application:default/myapp type: string links: additionalProperties: false - description: A list of links for the entity + description: A list of links for the entity. items: $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. 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' + value of 'default'. example: default minLength: 1 type: string owner: $ref: '#/components/schemas/EntityV3MetadataOwner' tags: - description: A set of custom tags + description: A set of custom tags. example: - this:tag - that:tag items: type: string @@ -8221,28 +8351,28 @@ type: object EntityV3MetadataAdditionalOwnersItems: description: The definition of Entity V3 Metadata Additional Owners Items object. properties: name: - description: Team name + description: Team name. example: '' type: string type: - description: Team type + description: Team type. type: string required: - name EntityV3MetadataContactsItems: additionalProperties: false description: The definition of Entity V3 Metadata Contacts Items object. properties: contact: - description: Contact value + description: Contact value. example: https://slack/ type: string name: - description: Contact name + description: Contact name. minLength: 2 type: string type: description: Contact type. example: slack @@ -8254,11 +8384,11 @@ EntityV3MetadataLinksItems: additionalProperties: false description: The definition of Entity V3 Metadata Links Items object. properties: name: - description: Link name + description: Link name. example: mylink type: string provider: description: Link provider. type: string @@ -8266,37 +8396,37 @@ default: other description: Link type. example: link type: string url: - description: Link url + description: Link URL. example: https://mylink type: string required: - name - type - url type: object EntityV3MetadataOwner: additionalProperties: false - description: The owner of the entity, usually a team + description: The owner of the entity, usually a team. properties: name: - description: Team name + description: Team name. type: string EntityV3Queue: additionalProperties: false - description: Schema for queue entities + description: Schema for queue entities. properties: apiVersion: $ref: '#/components/schemas/EntityV3APIVersion' datadog: $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' kind: $ref: '#/components/schemas/EntityV3QueueKind' @@ -8309,11 +8439,11 @@ - kind - metadata type: object EntityV3QueueDatadog: additionalProperties: false - description: Datadog product integrations for the datastore entity + description: Datadog product integrations for the datastore entity. properties: events: $ref: '#/components/schemas/EntityV3DatadogEvents' logs: $ref: '#/components/schemas/EntityV3DatadogLogs' @@ -8335,29 +8465,29 @@ lifecycle: description: The lifecycle state of the queue. minLength: 1 type: string tier: - description: The importance of the queue + description: The importance of the queue. minLength: 1 type: string type: - description: The type of queue + description: The type of queue. type: string type: object EntityV3Service: additionalProperties: false - description: Schema for service entities + description: Schema for service entities. properties: apiVersion: $ref: '#/components/schemas/EntityV3APIVersion' datadog: $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' kind: $ref: '#/components/schemas/EntityV3ServiceKind' @@ -8370,11 +8500,11 @@ - kind - metadata type: object EntityV3ServiceDatadog: additionalProperties: false - description: Datadog product integrations for the service entity + description: Datadog product integrations for the service entity. properties: codeLocations: $ref: '#/components/schemas/EntityV3DatadogCodeLocations' events: $ref: '#/components/schemas/EntityV3DatadogEvents' @@ -8396,11 +8526,11 @@ EntityV3ServiceSpec: additionalProperties: false description: The definition of Entity V3 Service Spec object. properties: dependsOn: - description: A list of components the service depends on + description: A list of components the service depends on. items: type: string type: array languages: description: The service's programming language. @@ -8410,29 +8540,29 @@ lifecycle: description: The lifecycle state of the component. minLength: 1 type: string tier: - description: The importance of the component + description: The importance of the component. minLength: 1 type: string type: - description: The type of service + description: The type of service. type: string type: object EntityV3System: additionalProperties: false - description: Schema for system entities + description: Schema for system entities. properties: apiVersion: $ref: '#/components/schemas/EntityV3APIVersion' datadog: $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' kind: $ref: '#/components/schemas/EntityV3SystemKind' @@ -8445,11 +8575,11 @@ - kind - metadata type: object EntityV3SystemDatadog: additionalProperties: false - description: Datadog product integrations for the service entity + description: Datadog product integrations for the service entity. properties: events: $ref: '#/components/schemas/EntityV3DatadogEvents' logs: $ref: '#/components/schemas/EntityV3DatadogLogs' @@ -9228,10 +9358,12 @@ $ref: '#/components/schemas/FindingRule' status: $ref: '#/components/schemas/FindingStatus' tags: $ref: '#/components/schemas/FindingTags' + vulnerability_type: + $ref: '#/components/schemas/FindingVulnerabilityType' type: object FindingEvaluation: description: The evaluation of the finding. enum: - pass @@ -9361,10 +9493,24 @@ - finding example: finding type: string x-enum-varnames: - FINDING + FindingVulnerabilityType: + description: The vulnerability type of the finding. + enum: + - misconfiguration + - attack_path + - identity_risk + - api_security + example: misconfiguration + type: string + x-enum-varnames: + - MISCONFIGURATION + - ATTACK_PATH + - IDENTITY_RISK + - API_SECURITY 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.' @@ -9475,10 +9621,24 @@ description: Name of scope. type: string nullable: true type: array 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. + example: true + type: boolean + id: + description: The id of the GCP metric namespace. + example: aiplatform + type: string + type: object GCPSTSDelegateAccount: description: Datadog principal service account info. properties: attributes: $ref: '#/components/schemas/GCPSTSDelegateAccountAttributes' @@ -9564,17 +9724,31 @@ 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.' type: boolean + is_resource_change_collection_enabled: + default: false + 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.' example: true type: boolean + metric_namespace_configs: + description: Configurations for GCP metric namespaces. + example: + - disabled: true + id: aiplatform + items: + $ref: '#/components/schemas/GCPMetricNamespaceConfig' + type: array resource_collection_enabled: description: When enabled, Datadog scans for all resources in your GCP environment. type: boolean type: object GCPSTSServiceAccountCreateRequest: @@ -9893,11 +10067,10 @@ type: array type: object HTTPLogItem: additionalProperties: description: Additional log attributes. - type: string description: Logs that are sent over HTTP. properties: ddsource: description: 'The integration name associated with your log: the technology from which the log originated. @@ -10427,10 +10600,15 @@ 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 + type: string initial_cells: description: An array of initial timeline cells to be placed at the beginning of the incident timeline. items: $ref: '#/components/schemas/IncidentTimelineCellCreateAttributes' @@ -10638,10 +10816,11 @@ IncidentIntegrationMetadataMetadata: description: Incident integration metadata's metadata attribute. oneOf: - $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' @@ -10833,10 +11012,14 @@ 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 + type: string modified: description: Timestamp when the incident was last modified. format: date-time readOnly: true type: string @@ -10928,11 +11111,11 @@ - type type: object IncidentResponseIncludedItem: description: An object related to an incident that is included in the response. oneOf: - - $ref: '#/components/schemas/User' + - $ref: '#/components/schemas/IncidentUserData' - $ref: '#/components/schemas/IncidentAttachmentData' IncidentResponseMeta: description: The metadata object containing pagination metadata. properties: pagination: @@ -11778,10 +11961,192 @@ - incidents example: incidents type: string x-enum-varnames: - INCIDENTS + IncidentTypeAttributes: + description: Incident type's attributes. + properties: + createdAt: + description: Timestamp when the incident type was created. + format: date-time + readOnly: true + type: string + createdBy: + 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. + 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. + 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 + readOnly: true + type: string + modifiedAt: + description: Timestamp when the incident type was last modified. + format: date-time + readOnly: true + type: string + name: + description: The name of the incident type. + example: Security Incident + type: string + prefix: + description: The string that will be prepended to the incident title across + the Datadog app. + example: IR + readOnly: true + type: string + required: + - name + type: object + IncidentTypeCreateData: + description: Incident type data for a create request. + properties: + attributes: + $ref: '#/components/schemas/IncidentTypeAttributes' + type: + $ref: '#/components/schemas/IncidentTypeType' + required: + - type + - attributes + type: object + IncidentTypeCreateRequest: + description: Create request for an incident type. + properties: + data: + $ref: '#/components/schemas/IncidentTypeCreateData' + required: + - data + type: object + IncidentTypeListResponse: + description: Response with a list of incident types. + properties: + data: + description: An array of incident type objects. + items: + $ref: '#/components/schemas/IncidentTypeObject' + type: array + required: + - data + type: object + IncidentTypeObject: + description: Incident type response data. + properties: + attributes: + $ref: '#/components/schemas/IncidentTypeAttributes' + id: + description: The incident type's ID. + example: 00000000-0000-0000-0000-000000000000 + type: string + type: + $ref: '#/components/schemas/IncidentTypeType' + required: + - id + - type + type: object + IncidentTypePatchData: + description: Incident type data for a patch request. + properties: + attributes: + $ref: '#/components/schemas/IncidentTypeUpdateAttributes' + id: + description: The incident type's ID. + example: 00000000-0000-0000-0000-000000000000 + type: string + type: + $ref: '#/components/schemas/IncidentTypeType' + required: + - id + - type + - attributes + type: object + IncidentTypePatchRequest: + description: Patch request for an incident type. + properties: + data: + $ref: '#/components/schemas/IncidentTypePatchData' + required: + - data + type: object + IncidentTypeResponse: + description: Incident type response data. + properties: + data: + $ref: '#/components/schemas/IncidentTypeObject' + required: + - data + type: object + IncidentTypeType: + default: incident_types + description: Incident type resource type. + enum: + - incident_types + example: incident_types + type: string + x-enum-varnames: + - INCIDENT_TYPES + IncidentTypeUpdateAttributes: + description: Incident type's attributes for updates. + properties: + createdAt: + description: Timestamp when the incident type was created. + format: date-time + readOnly: true + type: string + createdBy: + 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.' + type: string + is_default: + 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 + readOnly: true + type: string + modifiedAt: + description: Timestamp when the incident type was last modified. + format: date-time + readOnly: true + type: string + name: + description: The name of the incident type. + example: Security Incident + type: string + prefix: + description: The string that will be prepended to the incident title across + the Datadog app. + example: IR + readOnly: true + type: string + type: object IncidentUpdateAttributes: description: The incident's attributes for an update request. properties: customer_impact_end: description: Timestamp when customers were no longer impacted by the incident. @@ -11867,10 +12232,41 @@ data: $ref: '#/components/schemas/IncidentUpdateData' required: - data type: object + IncidentUserAttributes: + description: Attributes of user object returned by the API. + properties: + email: + description: Email of the user. + type: string + handle: + description: Handle of the user. + type: string + icon: + description: URL of the user's icon. + type: string + name: + description: Name of the user. + nullable: true + type: string + uuid: + description: UUID of the user. + type: string + type: object + IncidentUserData: + description: User object returned by the API. + properties: + attributes: + $ref: '#/components/schemas/IncidentUserAttributes' + id: + description: ID of the user. + type: string + type: + $ref: '#/components/schemas/UsersType' + type: object IncidentUserDefinedFieldType: description: The incident user defined fields type. enum: - user_defined_field example: user_defined_field @@ -11890,10 +12286,11 @@ 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 @@ -11935,10 +12332,11 @@ 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 @@ -11984,11 +12382,11 @@ $ref: '#/components/schemas/IncidentResponseMeta' required: - data type: object IncludeType: - description: supported include types. + description: Supported include types. enum: - schema - raw_schema - oncall - incident @@ -12320,17 +12718,17 @@ - $ref: '#/components/schemas/EntityResponseIncludedIncident' ListEntityCatalogResponseLinks: description: List entity response links. properties: next: - description: next link. + description: Next link. type: string previous: - description: previous link. + description: Previous link. type: string self: - description: current link. + description: Current link. type: string type: object ListFindingsData: description: Array of findings. items: @@ -13601,10 +13999,47 @@ 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 type: string type: object + MSTeamsIntegrationMetadata: + description: Incident integration metadata for the Microsoft Teams integration. + properties: + teams: + description: Array of Microsoft Teams in this integration metadata. + example: [] + items: + $ref: '#/components/schemas/MSTeamsIntegrationMetadataTeamsItem' + type: array + required: + - teams + type: object + MSTeamsIntegrationMetadataTeamsItem: + description: Item in the Microsoft Teams integration metadata teams array. + properties: + ms_channel_id: + description: Microsoft Teams channel ID. + example: 19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2 + type: string + ms_channel_name: + description: Microsoft Teams channel name. + example: incident-0001-example + type: string + ms_tenant_id: + description: Microsoft Teams tenant ID. + example: 00000000-abcd-0005-0000-000000000000 + type: string + redirect_url: + description: URL redirecting to the Microsoft Teams channel. + 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 + type: object Metric: description: Object for a single metric tag configuration. example: id: metric.foo.bar type: metrics @@ -14807,20 +15242,76 @@ type: string required: - data_source - query type: object - MicrosoftTeamsApiHandleAttributes: - description: Handle attributes. + MicrosoftTeamsChannelInfoResponseAttributes: + description: Channel attributes. properties: + is_primary: + description: Indicates if this is the primary channel. + example: true + maxLength: 255 + type: boolean + team_id: + description: Team id. + example: 00000000-0000-0000-0000-000000000000 + maxLength: 255 + type: string + tenant_id: + description: Tenant id. + example: 00000000-0000-0000-0000-000000000001 + maxLength: 255 + type: string + type: object + MicrosoftTeamsChannelInfoResponseData: + description: Channel data from a response. + properties: + attributes: + $ref: '#/components/schemas/MicrosoftTeamsChannelInfoResponseAttributes' + id: + description: The ID of the channel. + example: 19:b41k24b14bn1nwffkernfkwrnfneubgkr@thread.tacv2 + maxLength: 255 + minLength: 1 + type: string + type: + $ref: '#/components/schemas/MicrosoftTeamsChannelInfoType' + type: object + MicrosoftTeamsChannelInfoType: + default: ms-teams-channel-info + description: Channel info resource type. + enum: + - ms-teams-channel-info + example: ms-teams-channel-info + type: string + x-enum-varnames: + - MS_TEAMS_CHANNEL_INFO + MicrosoftTeamsCreateTenantBasedHandleRequest: + description: Create tenant-based handle request. + properties: + data: + $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleRequestData' + required: + - data + type: object + MicrosoftTeamsGetChannelByNameResponse: + description: Response with channel, team, and tenant ID information. + properties: + data: + $ref: '#/components/schemas/MicrosoftTeamsChannelInfoResponseData' + type: object + MicrosoftTeamsTenantBasedHandleAttributes: + description: Tenant-based handle attributes. + properties: channel_id: description: Channel id. example: fake-channel-id maxLength: 255 type: string name: - description: Handle name. + description: Tenant-based handle name. example: fake-handle-name maxLength: 255 type: string team_id: description: Team id. @@ -14831,19 +15322,13 @@ description: Tenant id. example: 00000000-0000-0000-0000-000000000001 maxLength: 255 type: string type: object - MicrosoftTeamsApiHandleInfoResponse: - description: Response of a handle. + MicrosoftTeamsTenantBasedHandleInfoResponseAttributes: + description: Tenant-based handle attributes. properties: - data: - $ref: '#/components/schemas/MicrosoftTeamsApiHandleInfoResponseData' - type: object - MicrosoftTeamsApiHandleInfoResponseAttributes: - description: Handle attributes. - properties: channel_id: description: Channel id. example: fake-channel-id maxLength: 255 type: string @@ -14851,11 +15336,11 @@ description: Channel name. example: fake-channel-name maxLength: 255 type: string name: - description: Handle name. + description: Tenant-based handle name. example: fake-handle-name maxLength: 255 type: string team_id: description: Team id. @@ -14876,43 +15361,43 @@ description: Tenant name. example: fake-tenant-name maxLength: 255 type: string type: object - MicrosoftTeamsApiHandleInfoResponseData: - description: Handle data from a response. + MicrosoftTeamsTenantBasedHandleInfoResponseData: + description: Tenant-based handle data from a response. properties: attributes: - $ref: '#/components/schemas/MicrosoftTeamsApiHandleInfoResponseAttributes' + $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoResponseAttributes' id: - description: The ID of the handle. + description: The ID of the tenant-based handle. example: 596da4af-0563-4097-90ff-07230c3f9db3 maxLength: 100 minLength: 1 type: string type: - $ref: '#/components/schemas/MicrosoftTeamsApiHandleInfoType' + $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoType' type: object - MicrosoftTeamsApiHandleInfoType: - default: ms-teams-handle-info - description: Handle resource type. + MicrosoftTeamsTenantBasedHandleInfoType: + default: ms-teams-tenant-based-handle-info + description: Tenant-based handle resource type. enum: - - ms-teams-handle-info - example: ms-teams-handle-info + - ms-teams-tenant-based-handle-info + example: ms-teams-tenant-based-handle-info type: string x-enum-varnames: - - MS_TEAMS_HANDLE_INFO - MicrosoftTeamsApiHandleRequestAttributes: - description: Handle attributes. + - MS_TEAMS_TENANT_BASED_HANDLE_INFO + MicrosoftTeamsTenantBasedHandleRequestAttributes: + description: Tenant-based handle attributes. properties: channel_id: description: Channel id. example: fake-channel-id maxLength: 255 type: string name: - description: Handle name. + description: Tenant-based handle name. example: fake-handle-name maxLength: 255 type: string team_id: description: Team id. @@ -14928,155 +15413,99 @@ - name - channel_id - team_id - tenant_id type: object - MicrosoftTeamsApiHandleRequestData: - description: Handle data from a response. + MicrosoftTeamsTenantBasedHandleRequestData: + description: Tenant-based handle data from a response. properties: attributes: - $ref: '#/components/schemas/MicrosoftTeamsApiHandleRequestAttributes' + $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleRequestAttributes' type: - $ref: '#/components/schemas/MicrosoftTeamsApiHandleType' + $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleType' required: - type - attributes type: object - MicrosoftTeamsApiHandleResponseData: - description: Handle data from a response. + MicrosoftTeamsTenantBasedHandleResponse: + description: Response of a tenant-based handle. properties: + data: + $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleResponseData' + required: + - data + type: object + MicrosoftTeamsTenantBasedHandleResponseData: + description: Tenant-based handle data from a response. + properties: attributes: - $ref: '#/components/schemas/MicrosoftTeamsApiHandleAttributes' + $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleAttributes' id: - description: The ID of the handle. + description: The ID of the tenant-based handle. example: 596da4af-0563-4097-90ff-07230c3f9db3 maxLength: 100 minLength: 1 type: string type: - $ref: '#/components/schemas/MicrosoftTeamsApiHandleType' + $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleType' type: object - MicrosoftTeamsApiHandleType: - default: handle - description: Specifies the handle resource type. + MicrosoftTeamsTenantBasedHandleType: + default: tenant-based-handle + description: Specifies the tenant-based handle resource type. enum: - - handle - example: handle + - tenant-based-handle + example: tenant-based-handle type: string x-enum-varnames: - - HANDLE - MicrosoftTeamsApiHandlesResponse: - description: Response with a list of handles. + - TENANT_BASED_HANDLE + MicrosoftTeamsTenantBasedHandlesResponse: + description: Response with a list of tenant-based handles. properties: data: - description: An array of handles. + 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-handle-info + 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-handle-info + type: ms-teams-tenant-based-handle-info items: - $ref: '#/components/schemas/MicrosoftTeamsApiHandleInfoResponseData' + $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoResponseData' type: array required: - data type: object - MicrosoftTeamsChannelInfoResponseAttributes: - description: Channel attributes. + MicrosoftTeamsUpdateTenantBasedHandleRequest: + description: Update tenant-based handle request. properties: - is_primary: - description: Indicates if this is the primary channel. - example: true - maxLength: 255 - type: boolean - team_id: - description: Team id. - example: 00000000-0000-0000-0000-000000000000 - maxLength: 255 - type: string - tenant_id: - description: Tenant id. - example: 00000000-0000-0000-0000-000000000001 - maxLength: 255 - type: string - type: object - MicrosoftTeamsChannelInfoResponseData: - description: Channel data from a response. - properties: - attributes: - $ref: '#/components/schemas/MicrosoftTeamsChannelInfoResponseAttributes' - id: - description: The ID of the channel. - example: 19:b41k24b14bn1nwffkernfkwrnfneubgkr@thread.tacv2 - maxLength: 255 - minLength: 1 - type: string - type: - $ref: '#/components/schemas/MicrosoftTeamsChannelInfoType' - type: object - MicrosoftTeamsChannelInfoType: - default: ms-teams-channel-info - description: Channel info resource type. - enum: - - ms-teams-channel-info - example: ms-teams-channel-info - type: string - x-enum-varnames: - - MS_TEAMS_CHANNEL_INFO - MicrosoftTeamsCreateApiHandleRequest: - description: Create handle request. - properties: data: - $ref: '#/components/schemas/MicrosoftTeamsApiHandleRequestData' + $ref: '#/components/schemas/MicrosoftTeamsUpdateTenantBasedHandleRequestData' required: - data type: object - MicrosoftTeamsCreateApiHandleResponse: - description: Response of a handle. + MicrosoftTeamsUpdateTenantBasedHandleRequestData: + description: Tenant-based handle data from a response. properties: - data: - $ref: '#/components/schemas/MicrosoftTeamsApiHandleResponseData' - required: - - data - type: object - MicrosoftTeamsGetChannelByNameResponse: - description: Response with channel, team, and tenant ID information. - properties: - data: - $ref: '#/components/schemas/MicrosoftTeamsChannelInfoResponseData' - type: object - MicrosoftTeamsUpdateApiHandleRequest: - description: Update handle request. - properties: - data: - $ref: '#/components/schemas/MicrosoftTeamsUpdateApiHandleRequestData' - required: - - data - type: object - MicrosoftTeamsUpdateApiHandleRequestData: - description: Handle data from a response. - properties: attributes: - $ref: '#/components/schemas/MicrosoftTeamsApiHandleAttributes' + $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleAttributes' type: - $ref: '#/components/schemas/MicrosoftTeamsApiHandleType' + $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleType' required: - type - attributes type: object MonitorConfigPolicyAttributeCreateRequest: @@ -17705,11 +18134,11 @@ example: One or several indexes are missing or invalid, results hold data from the other indexes type: string type: object RelationType: - description: supported relation types + description: Supported relation types. enum: - RelationTypeOwns - RelationTypeOwnedBy - RelationTypeDependsOn - RelationTypeDependencyOf @@ -17738,11 +18167,11 @@ type: array RelationshipItem: description: Relationship entry. properties: id: - description: Associated data id. + description: Associated data ID. type: string type: description: Relationship type. type: string type: object @@ -18885,10 +19314,294 @@ - rule example: rule type: string x-enum-varnames: - RULE + RumMetricCompute: + description: The compute rule to compute the rum-based metric. + properties: + aggregation_type: + $ref: '#/components/schemas/RumMetricComputeAggregationType' + include_percentiles: + $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' + type: string + required: + - aggregation_type + type: object + RumMetricComputeAggregationType: + description: The type of aggregation to use. + enum: + - count + - distribution + example: distribution + type: string + x-enum-varnames: + - COUNT + - DISTRIBUTION + RumMetricComputeIncludePercentiles: + 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' + event_type: + $ref: '#/components/schemas/RumMetricEventType' + filter: + $ref: '#/components/schemas/RumMetricFilter' + group_by: + description: The rules for the group by. + items: + $ref: '#/components/schemas/RumMetricGroupBy' + type: array + uniqueness: + $ref: '#/components/schemas/RumMetricUniqueness' + required: + - event_type + - compute + type: object + RumMetricCreateData: + description: The new rum-based metric properties. + properties: + attributes: + $ref: '#/components/schemas/RumMetricCreateAttributes' + id: + $ref: '#/components/schemas/RumMetricID' + type: + $ref: '#/components/schemas/RumMetricType' + required: + - id + - type + - attributes + type: object + RumMetricCreateRequest: + description: The new rum-based metric body. + properties: + data: + $ref: '#/components/schemas/RumMetricCreateData' + required: + - 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 + RumMetricFilter: + description: The rum-based metric filter. Events matching this filter will be + aggregated in this metric. + properties: + query: + default: '*' + description: The search query - following the RUM search syntax. + example: '@service:web-ui: ' + type: string + required: + - 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' + 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 + type: string + required: + - path + type: object + RumMetricID: + description: The name of the rum-based metric. + example: rum.sessions.webui.count + type: string + RumMetricResponse: + description: The rum-based metric object. + properties: + data: + $ref: '#/components/schemas/RumMetricResponseData' + type: object + RumMetricResponseAttributes: + description: The object describing a Datadog rum-based metric. + properties: + compute: + $ref: '#/components/schemas/RumMetricResponseCompute' + event_type: + $ref: '#/components/schemas/RumMetricEventType' + filter: + $ref: '#/components/schemas/RumMetricResponseFilter' + group_by: + description: The rules for the group by. + items: + $ref: '#/components/schemas/RumMetricResponseGroupBy' + type: array + uniqueness: + $ref: '#/components/schemas/RumMetricResponseUniqueness' + type: object + RumMetricResponseCompute: + description: The compute rule to compute the rum-based metric. + properties: + aggregation_type: + $ref: '#/components/schemas/RumMetricComputeAggregationType' + include_percentiles: + $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' + type: string + type: object + RumMetricResponseData: + description: The rum-based metric properties. + properties: + attributes: + $ref: '#/components/schemas/RumMetricResponseAttributes' + id: + $ref: '#/components/schemas/RumMetricID' + type: + $ref: '#/components/schemas/RumMetricType' + type: object + RumMetricResponseFilter: + 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] + 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' + 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 + type: string + type: object + RumMetricResponseUniqueness: + description: The rule to count updatable events. Is only set if `event_type` + is `session` or `view`. + properties: + when: + $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 + example: rum_metrics + type: string + x-enum-varnames: + - RUM_METRICS + RumMetricUniqueness: + description: The rule to count updatable events. Is only set if `event_type` + is `sessions` or `views`. + properties: + when: + $ref: '#/components/schemas/RumMetricUniquenessWhen' + required: + - 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 + type: string + x-enum-varnames: + - WHEN_MATCH + - WHEN_END + RumMetricUpdateAttributes: + description: The rum-based metric properties that will be updated. + properties: + compute: + $ref: '#/components/schemas/RumMetricUpdateCompute' + filter: + $ref: '#/components/schemas/RumMetricFilter' + group_by: + description: The rules for the group by. + items: + $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' + type: object + RumMetricUpdateData: + description: The new rum-based metric properties. + properties: + attributes: + $ref: '#/components/schemas/RumMetricUpdateAttributes' + id: + $ref: '#/components/schemas/RumMetricID' + type: + $ref: '#/components/schemas/RumMetricType' + required: + - type + - attributes + type: object + RumMetricUpdateRequest: + description: The new rum-based metric body. + properties: + data: + $ref: '#/components/schemas/RumMetricUpdateData' + required: + - data + type: object + RumMetricsResponse: + description: All the available rum-based metric objects. + properties: + data: + description: A list of rum-based metric objects. + items: + $ref: '#/components/schemas/RumMetricResponseData' + type: array + type: object SAMLAssertionAttribute: description: SAML assertion attribute. properties: attributes: $ref: '#/components/schemas/SAMLAssertionAttributeAttributes' @@ -21577,10 +22290,17 @@ - credit card - cc 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.' + type: boolean required: - keywords - character_count type: object SensitiveDataScannerMeta: @@ -21593,15 +22313,19 @@ group_count_limit: description: Maximum number of scanning groups allowed for the org. format: int64 type: integer has_highlight_enabled: - description: Whether or not scanned events are highlighted in Logs or RUM - for the org. + default: true + deprecated: true + description: (Deprecated) Whether or not scanned events are highlighted + in Logs or RUM for the org. type: boolean has_multi_pass_enabled: - description: Whether or not scanned events have multi-pass enabled. + deprecated: true + 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. type: boolean @@ -24785,11 +25509,11 @@ $ref: '#/components/schemas/RelationshipToRule' type: $ref: '#/components/schemas/RuleType' type: object UpsertCatalogEntityRequest: - description: Create / Update entity request. + description: Create or update entity request. oneOf: - $ref: '#/components/schemas/EntityV3' - $ref: '#/components/schemas/EntityRaw' UpsertCatalogEntityResponse: description: Upsert entity response. @@ -25565,10 +26289,11 @@ events_read: Read Events data. hosts_read: List hosts and their attributes. incident_notification_settings_write: Configure Incidents Notification 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 @@ -27453,11 +28178,11 @@ requestBody: content: application/json: schema: $ref: '#/components/schemas/UpsertCatalogEntityRequest' - description: Entity YAML/JSON. + description: Entity YAML or JSON. required: true responses: '202': content: application/json: @@ -28229,57 +28954,10 @@ - Cloud Cost Management x-permission: operator: OR permissions: - cloud_cost_management_write - /api/v2/cost/aws_related_accounts: - get: - deprecated: true - description: List the AWS accounts in an organization by calling 'organizations:ListAccounts' - from the specified management account. - operationId: ListAWSRelatedAccounts - parameters: - - description: The ID of the management account to filter by. - example: '123456789123' - in: query - name: filter[management_account_id] - required: true - schema: - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AWSRelatedAccountsResponse' - description: OK - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/APIErrorResponse' - description: Bad Request - '403': - content: - application/json: - schema: - $ref: '#/components/schemas/APIErrorResponse' - description: Forbidden - '429': - $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - cloud_cost_management_read - summary: List related AWS accounts - tags: - - Cloud Cost Management - x-permission: - operator: OR - permissions: - - cloud_cost_management_read /api/v2/cost/azure_uc_config: get: description: List the Azure configs. operationId: ListCostAzureUCConfigs responses: @@ -28542,10 +29220,11 @@ summary: Get Custom Costs file tags: - Cloud Cost Management /api/v2/cost/enabled: get: + deprecated: true description: Get the Cloud Cost Management activity. operationId: GetCloudCostActivity responses: '200': content: @@ -28643,11 +29322,11 @@ 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: true + required: false schema: format: date-time type: string - description: 'Comma-separated list specifying cost types (e.g., `<billing_dimension>_on_demand_cost`, `<billing_dimension>_committed_cost`, `<billing_dimension>_total_cost`) @@ -29128,10 +29807,65 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Update items of a dashboard list tags: - Dashboard Lists x-codegen-request-body-name: body + /api/v2/domain_allowlist: + get: + description: Get the domain allowlist for an organization. + operationId: GetDomainAllowlist + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DomainAllowlistResponse' + description: OK + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management + summary: Get Domain Allowlist + tags: + - Domain Allowlist + x-permission: + operator: OR + permissions: + - org_management + patch: + description: Update the domain allowlist for an organization. + operationId: PatchDomainAllowlist + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DomainAllowlistRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DomainAllowlistResponse' + description: OK + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management + summary: Sets Domain Allowlist + tags: + - Domain Allowlist + x-permission: + operator: OR + permissions: + - org_management /api/v2/dora/deployment: post: description: 'Use this API endpoint to provide data about deployments for DORA metrics. @@ -29705,10 +30439,210 @@ 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/).' + /api/v2/incidents/config/types: + get: + description: Get all incident types. + operationId: ListIncidentTypes + parameters: + - $ref: '#/components/parameters/IncidentTypeIncludeDeletedParameter' + responses: + '200': + content: + application/json: + schema: + $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' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_read + - incident_read + summary: Get a list of incident types + tags: + - 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/).' + post: + description: Create an incident type. + operationId: CreateIncidentType + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IncidentTypeCreateRequest' + description: Incident type payload. + required: true + responses: + '201': + content: + application/json: + schema: + $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 + summary: Create an incident type + tags: + - Incidents + x-codegen-request-body-name: body + 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/).' + /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 + summary: Delete an incident type + tags: + - Incidents + x-codegen-request-body-name: body + 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/).' + get: + description: Get incident type details. + operationId: GetIncidentType + parameters: + - $ref: '#/components/parameters/IncidentTypeIDPathParameter' + responses: + '200': + content: + application/json: + schema: + $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' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_read + - incident_read + summary: Get incident type details + tags: + - 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/).' + patch: + description: Update an incident type. + operationId: UpdateIncidentType + parameters: + - $ref: '#/components/parameters/IncidentTypeIDPathParameter' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IncidentTypePatchRequest' + description: Incident type payload. + required: true + responses: + '200': + content: + application/json: + schema: + $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' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - incident_settings_write + summary: Update an incident type + tags: + - Incidents + x-codegen-request-body-name: body + 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/).' /api/v2/incidents/search: get: description: Search for incidents matching a certain query. operationId: SearchIncidents parameters: @@ -30541,20 +31475,22 @@ summary: Get channel information by name tags: - Microsoft Teams Integration /api/v2/integration/ms-teams/configuration/tenant-based-handles: get: - description: Get a list of all handles from the Datadog Microsoft Teams integration. - operationId: ListApiHandles + 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' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsApiHandlesResponse' + $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandlesResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/ForbiddenResponse' @@ -30562,29 +31498,29 @@ $ref: '#/components/responses/NotFoundResponse' '412': $ref: '#/components/responses/PreconditionFailedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Get all handles + summary: Get all tenant-based handles tags: - Microsoft Teams Integration post: - description: Create a handle in the Datadog Microsoft Teams integration. - operationId: CreateApiHandle + description: Create a tenant-based handle in the Datadog Microsoft Teams integration. + operationId: CreateTenantBasedHandle requestBody: content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsCreateApiHandleRequest' - description: Handle payload. + $ref: '#/components/schemas/MicrosoftTeamsCreateTenantBasedHandleRequest' + description: Tenant-based handle payload. required: true responses: '201': content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsCreateApiHandleResponse' + $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse' description: CREATED '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/ForbiddenResponse' @@ -30594,47 +31530,20 @@ $ref: '#/components/responses/ConflictResponse' '412': $ref: '#/components/responses/PreconditionFailedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Create handle + summary: Create tenant-based handle tags: - Microsoft Teams Integration x-codegen-request-body-name: body - /api/v2/integration/ms-teams/configuration/tenant-based-handles/name/{handle_name}: - get: - description: Get the tenant, team, and channel information of a handle by name - from the Datadog Microsoft Teams integration. - operationId: GetApiHandleByName - parameters: - - $ref: '#/components/parameters/MicrosoftTeamsHandleNamePathParameter' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/MicrosoftTeamsApiHandleInfoResponse' - 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' - summary: Get handle information by name - tags: - - Microsoft Teams Integration /api/v2/integration/ms-teams/configuration/tenant-based-handles/{handle_id}: delete: - description: Delete a handle from the Datadog Microsoft Teams integration. - operationId: DeleteApiHandle + description: Delete a tenant-based handle from the Datadog Microsoft Teams integration. + operationId: DeleteTenantBasedHandle parameters: - - $ref: '#/components/parameters/MicrosoftTeamsHandleIDPathParameter' + - $ref: '#/components/parameters/MicrosoftTeamsTenantBasedHandleIDPathParameter' responses: '204': description: OK '400': $ref: '#/components/responses/BadRequestResponse' @@ -30642,25 +31551,25 @@ $ref: '#/components/responses/ForbiddenResponse' '412': $ref: '#/components/responses/PreconditionFailedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Delete handle + summary: Delete tenant-based handle tags: - Microsoft Teams Integration get: - description: Get the tenant, team, and channel information of a handle from - the Datadog Microsoft Teams integration. - operationId: GetApiHandle + 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/MicrosoftTeamsHandleIDPathParameter' + - $ref: '#/components/parameters/MicrosoftTeamsTenantBasedHandleIDPathParameter' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsApiHandleInfoResponse' + $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/ForbiddenResponse' @@ -30668,31 +31577,31 @@ $ref: '#/components/responses/NotFoundResponse' '412': $ref: '#/components/responses/PreconditionFailedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Get handle information + summary: Get tenant-based handle information tags: - Microsoft Teams Integration patch: - description: Update a handle from the Datadog Microsoft Teams integration. - operationId: UpdateApiHandle + description: Update a tenant-based handle from the Datadog Microsoft Teams integration. + operationId: UpdateTenantBasedHandle parameters: - - $ref: '#/components/parameters/MicrosoftTeamsHandleIDPathParameter' + - $ref: '#/components/parameters/MicrosoftTeamsTenantBasedHandleIDPathParameter' requestBody: content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsUpdateApiHandleRequest' - description: Opsgenie service payload. + $ref: '#/components/schemas/MicrosoftTeamsUpdateTenantBasedHandleRequest' + description: Tenant-based handle payload. required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/MicrosoftTeamsApiHandleInfoResponse' + $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/ForbiddenResponse' @@ -30702,11 +31611,11 @@ $ref: '#/components/responses/ConflictResponse' '412': $ref: '#/components/responses/PreconditionFailedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Update handle + summary: Update tenant-based handle tags: - Microsoft Teams Integration x-codegen-request-body-name: body /api/v2/integration/opsgenie/services: get: @@ -33232,11 +34141,12 @@ operator: OR permissions: - metrics_read /api/v2/metrics/{metric_name}/all-tags: get: - description: View indexed tag key-value pairs for a given metric name. + description: View indexed tag key-value pairs for a given metric name over the + previous hour. operationId: ListTagsByMetricName parameters: - $ref: '#/components/parameters/MetricName' responses: '200': @@ -34331,10 +35241,21 @@ 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 responses: '200': content: application/json: schema: @@ -34798,16 +35719,10 @@ x-codegen-request-body-name: body x-permission: operator: OR permissions: - timeseries_query - x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring - (RUM), Cloud Cost Management, and Log Management data sources. - - We are gradually onboarding support for more sources. If you have any - - feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).' /api/v2/query/timeseries: post: description: 'Query timeseries data across various data sources and process the data by applying formulas and functions.' @@ -34844,16 +35759,10 @@ x-codegen-request-body-name: body x-permission: operator: OR permissions: - timeseries_query - x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring - (RUM), Cloud Cost Management, and Log Management data sources. - - We are gradually onboarding support for more sources. If you have any - - feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).' /api/v2/remote_config/products/cws/agent_rules: get: description: Get the list of Cloud Security Management Threats Agent rules. operationId: ListCSMThreatsAgentRules responses: @@ -35895,10 +36804,135 @@ x-codegen-request-body-name: body x-permission: operator: OR permissions: - 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': + content: + application/json: + schema: + $ref: '#/components/schemas/RumMetricsResponse' + description: OK + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get all rum-based metrics + tags: + - 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.' + operationId: CreateRumMetric + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RumMetricCreateRequest' + description: The definition of the new rum-based metric. + required: true + responses: + '201': + content: + application/json: + schema: + $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' + summary: Create a rum-based metric + tags: + - 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' + responses: + '204': + description: No Content + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Delete a rum-based metric + tags: + - Rum Metrics + get: + description: Get a specific rum-based metric from your organization. + operationId: GetRumMetric + parameters: + - $ref: '#/components/parameters/RumMetricIDParameter' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RumMetricResponse' + description: OK + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get a rum-based metric + tags: + - 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.' + operationId: UpdateRumMetric + parameters: + - $ref: '#/components/parameters/RumMetricIDParameter' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RumMetricUpdateRequest' + description: New definition of the rum-based metric. + required: true + responses: + '200': + content: + application/json: + schema: + $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' + summary: Update a rum-based metric + tags: + - Rum Metrics + x-codegen-request-body-name: body /api/v2/rum/events: get: description: 'List endpoint returns events that match a RUM search query. [Results are paginated][1]. @@ -39993,10 +41027,74 @@ - Usage Metering x-permission: operator: OR permissions: - 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. + + 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/).' + 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 + responses: + '200': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/BillingDimensionsMappingResponse' + description: OK + '400': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Forbidden - User is not authorized + '429': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Too many requests + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read + summary: Get billing dimension mapping for usage endpoints + tags: + - Usage Metering + x-unstable: '**Note**: This endpoint is in Preview. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/usage/cost_by_org: get: deprecated: true description: 'Get cost across multi-org account. @@ -40286,11 +41384,11 @@ `lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `network_monitoring`, `observability_pipelines`, `online_archive`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`, - `sds`, `snmp`, + `sds`, `snmp`, `software_delivery`, `synthetics_api`, `synthetics_browser`, `synthetics_mobile`, `synthetics_parallel_testing`, `timeseries`, `vuln_management`, and `workflow_executions`. @@ -41294,10 +42392,18 @@ organize, find, and share all of your dashboards with your team and organization.' name: Dashboard Lists +- 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 @@ -41494,10 +42600,16 @@ 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).' name: Roles +- 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: 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 @@ -41529,10 +42641,10 @@ This feature is currently in BETA. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' name: Service Scorecards -- description: API to create, update, retrieve and delete Software Catalog entities. +- 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: Search and aggregate your spans from your Datadog platform over HTTP. name: Spans