.generator/schemas/v2/openapi.yaml in datadog_api_client-2.2.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.3.0
- old
+ new
@@ -143,10 +143,24 @@
in: path
name: agent_rule_id
required: true
schema:
type: string
+ ConfluentAccountID:
+ description: Confluent Account id.
+ in: path
+ name: account_id
+ required: true
+ schema:
+ type: string
+ ConfluentResourceID:
+ description: Confluent Account Resource ID.
+ in: path
+ name: resource_id
+ required: true
+ schema:
+ type: string
IncidentAttachmentFilterQueryParameter:
description: Specifies which types of attachments are included in the response.
explode: false
in: query
name: filter[attachment_type]
@@ -308,10 +322,18 @@
name: service_account_id
required: true
schema:
example: 00000000-0000-1234-0000-000000000000
type: string
+ ServiceName:
+ description: The name of the service.
+ in: path
+ name: service_name
+ required: true
+ schema:
+ example: my-service
+ type: string
SignalID:
description: The ID of the signal.
in: path
name: signal_id
required: true
@@ -1285,10 +1307,291 @@
description: A list of Agent rules objects.
items:
$ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleData'
type: array
type: object
+ ConfluentAccountCreateRequest:
+ description: Payload schema when adding a Confluent account.
+ properties:
+ data:
+ $ref: '#/components/schemas/ConfluentAccountCreateRequestData'
+ required:
+ - 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
+ type: string
+ api_secret:
+ description: The API secret associated with your Confluent account.
+ example: test-api-secret-123
+ type: string
+ resources:
+ description: A list of Confluent resources associated with the Confluent
+ account.
+ items:
+ $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.
+ example:
+ - myTag
+ - myTag2:myValue
+ items:
+ type: string
+ type: array
+ required:
+ - api_key
+ - api_secret
+ type: object
+ ConfluentAccountCreateRequestData:
+ description: The data body for adding a Confluent account.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/ConfluentAccountCreateRequestAttributes'
+ type:
+ $ref: '#/components/schemas/ConfluentAccountType'
+ required:
+ - attributes
+ - type
+ type: object
+ ConfluentAccountResourceAttributes:
+ description: Attributes object for updating a Confluent resource.
+ properties:
+ id:
+ description: The ID associated with a Confluent resource.
+ example: resource-id-123
+ type: string
+ resource_type:
+ 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.
+ example:
+ - myTag
+ - myTag2:myValue
+ items:
+ type: string
+ type: array
+ type: object
+ ConfluentAccountResponse:
+ description: The expected response schema when getting a Confluent account.
+ properties:
+ data:
+ $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
+ type: string
+ resources:
+ description: A list of Confluent resources associated with the Confluent
+ account.
+ items:
+ $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.
+ example:
+ - myTag
+ - myTag2:myValue
+ items:
+ type: string
+ type: array
+ required:
+ - api_key
+ type: object
+ ConfluentAccountResponseData:
+ description: An API key and API secret pair that represents a Confluent account.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/ConfluentAccountResponseAttributes'
+ id:
+ description: A randomly generated ID associated with a Confluent account.
+ example: account_id_abc123
+ type: string
+ type:
+ $ref: '#/components/schemas/ConfluentAccountType'
+ required:
+ - 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
+ example: confluent-cloud-accounts
+ type: string
+ x-enum-varnames:
+ - CONFLUENT_CLOUD_ACCOUNTS
+ ConfluentAccountUpdateRequest:
+ description: The JSON:API request for updating a Confluent account.
+ properties:
+ data:
+ $ref: '#/components/schemas/ConfluentAccountUpdateRequestData'
+ required:
+ - 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
+ type: string
+ api_secret:
+ description: The API secret associated with your Confluent account.
+ 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.
+ example:
+ - myTag
+ - myTag2:myValue
+ items:
+ type: string
+ type: array
+ required:
+ - api_key
+ - api_secret
+ type: object
+ ConfluentAccountUpdateRequestData:
+ description: Data object for updating a Confluent account.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/ConfluentAccountUpdateRequestAttributes'
+ type:
+ $ref: '#/components/schemas/ConfluentAccountType'
+ required:
+ - attributes
+ - type
+ type: object
+ ConfluentAccountsResponse:
+ description: Confluent account returned by the API.
+ properties:
+ data:
+ description: The Confluent account.
+ items:
+ $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'
+ required:
+ - data
+ type: object
+ ConfluentResourceRequestAttributes:
+ description: Attributes object for updating a Confluent resource.
+ properties:
+ resource_type:
+ 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.
+ example:
+ - myTag
+ - myTag2:myValue
+ items:
+ type: string
+ type: array
+ type: object
+ ConfluentResourceRequestData:
+ description: JSON:API request for updating a Confluent resource.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/ConfluentResourceRequestAttributes'
+ id:
+ description: The ID associated with a Confluent resource.
+ example: resource-id-123
+ type: string
+ type:
+ $ref: '#/components/schemas/ConfluentResourceType'
+ required:
+ - attributes
+ - type
+ - id
+ type: object
+ ConfluentResourceResponse:
+ description: Response schema when interacting with a Confluent resource.
+ properties:
+ data:
+ $ref: '#/components/schemas/ConfluentResourceResponseData'
+ type: object
+ ConfluentResourceResponseAttributes:
+ description: Model representation of a Confluent Cloud resource.
+ properties:
+ resource_type:
+ 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.
+ example:
+ - myTag
+ - myTag2:myValue
+ items:
+ type: string
+ type: array
+ required:
+ - resource_type
+ type: object
+ ConfluentResourceResponseData:
+ description: Confluent Cloud resource data.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/ConfluentResourceResponseAttributes'
+ id:
+ description: The ID associated with the Confluent resource.
+ example: resource_id_abc123
+ type: string
+ type:
+ $ref: '#/components/schemas/ConfluentResourceType'
+ required:
+ - 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
+ type: string
+ x-enum-varnames:
+ - 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'
+ type: array
+ type: object
ContentEncoding:
description: HTTP header used to compress the media-type.
enum:
- identity
- gzip
@@ -1543,10 +1846,11 @@
description: The event name.
type: string
source_id:
description: Event source ID.
example: 36
+ format: int64
type: integer
type:
description: Event type.
example: error_tracking_alert
type: string
@@ -1593,16 +1897,18 @@
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.
+ format: int64
nullable: true
type: integer
priority:
$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
type: string
@@ -1999,11 +2305,11 @@
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).'
+ See [reserved attributes](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes).'
example: nginx
type: string
ddtags:
description: Tags associated with your logs.
example: env:staging,version:5.1
@@ -2011,11 +2317,11 @@
hostname:
description: The name of the originating host of the log.
example: i-012345678
type: string
message:
- description: 'The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes)
+ 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
@@ -2027,11 +2333,11 @@
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).'
+ See [reserved attributes](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes).'
example: payment
type: string
required:
- message
type: object
@@ -2618,11 +2924,12 @@
description: The monotonically increasing integer ID for the incident.
example: 1
format: int64
type: integer
resolved:
- description: Timestamp when the incident's state was set to resolved.
+ 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
time_to_detect:
description: 'The amount of time in seconds to detect the incident.
@@ -3127,15 +3434,10 @@
description: Notification handles that will be notified of the incident
during update.
items:
$ref: '#/components/schemas/IncidentNotificationHandle'
type: array
- resolved:
- description: Timestamp when the incident's state was set to resolved.
- format: date-time
- nullable: true
- type: string
title:
description: The title of the incident, which summarizes what happened.
example: A test incident title
type: string
type: object
@@ -5236,28 +5538,33 @@
nullable: true
properties:
created_at:
description: The POSIX timestamp of the monitor's creation in nanoseconds.
example: 1646318692000
+ format: int64
type: integer
group_status:
description: Monitor group status used when there is no `result_groups`.
+ format: int32
+ maximum: 2147483647
type: integer
groups:
description: Groups to which the monitor belongs.
items:
description: A group.
type: string
type: array
id:
description: The monitor ID.
+ format: int64
type: integer
message:
description: The monitor message.
type: string
modified:
description: The monitor's last-modified timestamp.
+ format: int64
type: integer
name:
description: The monitor name.
type: string
query:
@@ -5955,10 +6262,11 @@
type: string
org_id:
description: Org ID of the RUM application.
example: 999
format: int32
+ maximum: 2147483647
type: integer
type:
description: Type of the RUM application. Supported values are `browser`,
`ios`, `android`, `react-native`, `flutter`.
example: browser
@@ -7848,11 +8156,11 @@
- options
- cases
- message
type: object
SecurityMonitoringSignalRuleQuery:
- description: Query for matching rule on signals
+ description: Query for matching rule on signals.
properties:
aggregation:
$ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
correlatedByFields:
description: Fields to group by.
@@ -7864,22 +8172,21 @@
description: Index of the rule query used to retrieve the correlated field.
format: int32
maximum: 9
type: integer
metrics:
- description: Group of target fields to aggregate over when using the new
- value aggregations.
+ description: Group of target fields to aggregate over.
items:
description: Field.
type: string
type: array
name:
description: Name of the query.
type: string
ruleId:
description: Rule ID to match on signals.
- example: d3f-ru1-e1d
+ example: org-ru1-e1d
type: string
required:
- ruleId
type: object
SecurityMonitoringSignalRuleResponse:
@@ -7929,11 +8236,11 @@
options:
$ref: '#/components/schemas/SecurityMonitoringRuleOptions'
queries:
description: Queries for selecting logs which are part of the rule.
items:
- $ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery'
+ $ref: '#/components/schemas/SecurityMonitoringSignalRuleResponseQuery'
type: array
tags:
description: Tags for generated signals.
items:
description: Tag.
@@ -7947,10 +8254,44 @@
type: integer
version:
description: The version of the rule.
format: int64
type: integer
+ SecurityMonitoringSignalRuleResponseQuery:
+ description: Query for matching rule on signals.
+ properties:
+ aggregation:
+ $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
+ correlatedByFields:
+ description: Fields to group by.
+ items:
+ description: Field.
+ type: string
+ type: array
+ correlatedQueryIndex:
+ description: Index of the rule query used to retrieve the correlated field.
+ format: int32
+ maximum: 9
+ type: integer
+ defaultRuleId:
+ description: Default Rule ID to match on signals.
+ example: d3f-ru1-e1d
+ type: string
+ metrics:
+ description: Group of target fields to aggregate over.
+ items:
+ description: Field.
+ type: string
+ type: array
+ name:
+ description: Name of the query.
+ type: string
+ ruleId:
+ description: Rule ID to match on signals.
+ example: org-ru1-e1d
+ type: string
+ type: object
SecurityMonitoringSignalRuleType:
description: The rule type.
enum:
- signal_correlation
type: string
@@ -7960,10 +8301,11 @@
description: The new triage state of the signal.
enum:
- open
- archived
- under_review
+ example: open
type: string
x-enum-varnames:
- OPEN
- ARCHIVED
- UNDER_REVIEW
@@ -8187,17 +8529,21 @@
items:
description: Field.
type: string
type: array
metric:
- description: 'The target field to aggregate over when using the sum or max
+ deprecated: true
+ description: '(Deprecated) The target field to aggregate over when using
+ the sum or max
- aggregations.'
+ aggregations. `metrics` field should be used instead.'
type: string
metrics:
- description: Group of target fields to aggregate over when using the new
- value aggregations.
+ 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
type: array
name:
@@ -8337,10 +8683,472 @@
data:
$ref: '#/components/schemas/ServiceAccountCreateData'
required:
- data
type: object
+ ServiceDefinitionCreateResponse:
+ description: Create service definitions response.
+ properties:
+ data:
+ description: Create service definitions response payload.
+ items:
+ $ref: '#/components/schemas/ServiceDefinitionData'
+ type: array
+ type: object
+ ServiceDefinitionData:
+ description: Service definition data.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/ServiceDefinitionDataAttributes'
+ type:
+ description: Service definition type.
+ type: string
+ type: object
+ ServiceDefinitionDataAttributes:
+ description: Service definition attributes.
+ properties:
+ meta:
+ $ref: '#/components/schemas/ServiceDefinitionMeta'
+ schema:
+ $ref: '#/components/schemas/ServiceDefinitionSchema'
+ type: object
+ ServiceDefinitionGetResponse:
+ description: Get service definition response.
+ properties:
+ data:
+ $ref: '#/components/schemas/ServiceDefinitionData'
+ type: object
+ ServiceDefinitionMeta:
+ description: Metadata about a service definition.
+ properties:
+ github-html-url:
+ description: GitHub HTML URL.
+ type: string
+ ingested-schema-version:
+ description: Ingestion schema version.
+ type: string
+ ingestion-source:
+ description: Ingestion source of the service definition.
+ type: string
+ last-modified-time:
+ description: Last modified time of the service definition.
+ type: string
+ type: object
+ ServiceDefinitionRaw:
+ description: Service Definition in raw JSON/YAML representation.
+ example: '---
+
+ schema-version: v2
+
+ dd-service: my-service
+
+ '
+ type: string
+ ServiceDefinitionSchema:
+ description: Service definition schema.
+ oneOf:
+ - $ref: '#/components/schemas/ServiceDefinitionV1'
+ - $ref: '#/components/schemas/ServiceDefinitionV2'
+ type: object
+ ServiceDefinitionV1:
+ deprecated: true
+ description: Deprecated - Service definition V1 for providing additional service
+ metadata and integrations.
+ properties:
+ contact:
+ $ref: '#/components/schemas/ServiceDefinitionV1Contact'
+ extensions:
+ additionalProperties: {}
+ description: Extensions to V1 schema.
+ example:
+ myorg/extension: extensionValue
+ type: object
+ external-resources:
+ description: A list of external links related to the services.
+ items:
+ $ref: '#/components/schemas/ServiceDefinitionV1Resource'
+ type: array
+ info:
+ $ref: '#/components/schemas/ServiceDefinitionV1Info'
+ integrations:
+ $ref: '#/components/schemas/ServiceDefinitionV1Integrations'
+ org:
+ $ref: '#/components/schemas/ServiceDefinitionV1Org'
+ schema-version:
+ $ref: '#/components/schemas/ServiceDefinitionV1Version'
+ tags:
+ description: A set of custom tags.
+ example:
+ - my:tag
+ - service:tag
+ items:
+ type: string
+ type: array
+ required:
+ - schema-version
+ - info
+ type: object
+ ServiceDefinitionV1Contact:
+ description: Contact information about the service.
+ properties:
+ email:
+ description: "Service owner\u2019s email."
+ example: contact@datadoghq.com
+ format: email
+ type: string
+ slack:
+ description: "Service owner\u2019s Slack channel."
+ example: https://yourcompany.slack.com/archives/channel123
+ type: string
+ ServiceDefinitionV1Info:
+ 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.
+ example: myservice
+ type: string
+ description:
+ description: A short description of the service.
+ example: A shopping cart service
+ type: string
+ display-name:
+ description: A friendly name of the service.
+ example: My Service
+ type: string
+ service-tier:
+ description: Service tier.
+ example: Tier 1
+ type: string
+ required:
+ - dd-service
+ type: object
+ ServiceDefinitionV1Integrations:
+ description: Third party integrations that Datadog supports.
+ properties:
+ pagerduty:
+ $ref: '#/components/schemas/ServiceDefinitionV1Pagerduty'
+ type: object
+ ServiceDefinitionV1Org:
+ description: Org related information about the service.
+ properties:
+ application:
+ description: App feature this service supports.
+ example: E-Commerce
+ type: string
+ team:
+ description: Team that owns the service.
+ example: my-team
+ type: string
+ type: object
+ ServiceDefinitionV1Pagerduty:
+ description: PagerDuty service URL for the service.
+ example: https://my-org.pagerduty.com/service-directory/PMyService
+ type: string
+ ServiceDefinitionV1Resource:
+ description: Service's external links.
+ properties:
+ name:
+ description: Link name.
+ example: Runbook
+ type: string
+ type:
+ $ref: '#/components/schemas/ServiceDefinitionV1ResourceType'
+ url:
+ description: Link URL.
+ example: https://my-runbook
+ type: string
+ required:
+ - name
+ - type
+ - url
+ type: object
+ ServiceDefinitionV1ResourceType:
+ description: Link type.
+ enum:
+ - 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
+ ServiceDefinitionV1Version:
+ default: v1
+ description: Schema version being used.
+ enum:
+ - v1
+ example: v1
+ type: string
+ x-enum-varnames:
+ - 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'
+ 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.
+ example: my-service
+ type: string
+ dd-team:
+ 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'
+ type: array
+ extensions:
+ additionalProperties: {}
+ description: Extensions to V2 schema.
+ example:
+ myorg/extension: extensionValue
+ type: object
+ integrations:
+ $ref: '#/components/schemas/ServiceDefinitionV2Integrations'
+ links:
+ description: A list of links related to the services.
+ items:
+ $ref: '#/components/schemas/ServiceDefinitionV2Link'
+ type: array
+ repos:
+ description: A list of code repositories related to the services.
+ items:
+ $ref: '#/components/schemas/ServiceDefinitionV2Repo'
+ type: array
+ schema-version:
+ $ref: '#/components/schemas/ServiceDefinitionV2Version'
+ tags:
+ description: A set of custom tags.
+ example:
+ - my:tag
+ - service:tag
+ items:
+ type: string
+ type: array
+ team:
+ description: Team that owns the service.
+ example: my-team
+ type: string
+ required:
+ - schema-version
+ - dd-service
+ type: object
+ ServiceDefinitionV2Contact:
+ description: Service owner's contacts information.
+ oneOf:
+ - $ref: '#/components/schemas/ServiceDefinitionV2Email'
+ - $ref: '#/components/schemas/ServiceDefinitionV2Slack'
+ ServiceDefinitionV2Doc:
+ description: Service documents.
+ properties:
+ name:
+ description: Document name.
+ example: Architecture
+ type: string
+ provider:
+ description: Document provider.
+ example: google drive
+ type: string
+ url:
+ description: Document URL.
+ example: https://gdrive/mydoc
+ type: string
+ required:
+ - name
+ - url
+ type: object
+ ServiceDefinitionV2Email:
+ description: Service owner's email.
+ properties:
+ contact:
+ description: Contact value.
+ example: contact@datadoghq.com
+ format: email
+ type: string
+ name:
+ description: Contact email.
+ example: Team Email
+ type: string
+ type:
+ $ref: '#/components/schemas/ServiceDefinitionV2EmailType'
+ required:
+ - type
+ - contact
+ type: object
+ ServiceDefinitionV2EmailType:
+ description: Contact type.
+ enum:
+ - email
+ example: email
+ type: string
+ x-enum-varnames:
+ - EMAIL
+ ServiceDefinitionV2Integrations:
+ description: Third party integrations that Datadog supports.
+ properties:
+ opsgenie:
+ $ref: '#/components/schemas/ServiceDefinitionV2Opsgenie'
+ pagerduty:
+ $ref: '#/components/schemas/ServiceDefinitionV2Pagerduty'
+ type: object
+ ServiceDefinitionV2Link:
+ description: Service's external links.
+ properties:
+ name:
+ description: Link name.
+ example: Runbook
+ type: string
+ type:
+ $ref: '#/components/schemas/ServiceDefinitionV2LinkType'
+ url:
+ description: Link URL.
+ example: https://my-runbook
+ type: string
+ required:
+ - name
+ - type
+ - url
+ type: object
+ ServiceDefinitionV2LinkType:
+ description: Link type.
+ enum:
+ - 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
+ ServiceDefinitionV2Opsgenie:
+ description: Opsgenie integration for the service.
+ properties:
+ region:
+ $ref: '#/components/schemas/ServiceDefinitionV2OpsgenieRegion'
+ service-id:
+ description: Opsgenie service id.
+ example: 123e4567-e89b-12d3-a456-426614174000
+ type: string
+ required:
+ - service-id
+ type: object
+ ServiceDefinitionV2OpsgenieRegion:
+ description: Opsgenie instance region.
+ enum:
+ - US
+ - EU
+ example: US
+ type: string
+ x-enum-varnames:
+ - US
+ - EU
+ ServiceDefinitionV2Pagerduty:
+ description: PagerDuty service URL for the service.
+ example: https://my-org.pagerduty.com/service-directory/PMyService
+ type: string
+ ServiceDefinitionV2Repo:
+ description: Service code repositories.
+ properties:
+ name:
+ description: Repository name.
+ example: Source Code
+ type: string
+ provider:
+ description: Repository provider.
+ example: GitHub
+ type: string
+ url:
+ description: Repository URL.
+ example: https://github.com/DataDog/schema
+ type: string
+ required:
+ - name
+ - url
+ type: object
+ ServiceDefinitionV2Slack:
+ description: Service owner's Slack channel.
+ properties:
+ contact:
+ description: Slack Channel.
+ example: https://yourcompany.slack.com/archives/channel123
+ type: string
+ name:
+ description: Contact Slack.
+ example: Team Slack
+ type: string
+ type:
+ $ref: '#/components/schemas/ServiceDefinitionV2SlackType'
+ required:
+ - type
+ - contact
+ type: object
+ ServiceDefinitionV2SlackType:
+ description: Contact type.
+ enum:
+ - slack
+ example: slack
+ type: string
+ x-enum-varnames:
+ - SLACK
+ ServiceDefinitionV2Version:
+ default: v2
+ description: Schema version being used.
+ enum:
+ - v2
+ example: v2
+ type: string
+ x-enum-varnames:
+ - V2
+ ServiceDefinitionsCreateRequest:
+ description: Create service definitions request.
+ oneOf:
+ - $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'
+ type: array
+ type: object
UsageApplicationSecurityMonitoringResponse:
description: Application Security Monitoring usage response.
properties:
data:
description: Response containing Application Security Monitoring usage.
@@ -10263,10 +11071,306 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update a single service object
tags:
- Opsgenie Integration
x-codegen-request-body-name: body
+ /api/v2/integrations/confluent-cloud/accounts:
+ get:
+ description: List Confluent accounts.
+ operationId: ListConfluentAccount
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $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'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ summary: List Confluent accounts
+ tags:
+ - Confluent Cloud
+ post:
+ description: Create a Confluent account.
+ operationId: CreateConfluentAccount
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ConfluentAccountCreateRequest'
+ description: Confluent payload
+ required: true
+ responses:
+ '201':
+ content:
+ application/json:
+ schema:
+ $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'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ summary: Add Confluent account
+ tags:
+ - Confluent Cloud
+ x-codegen-request-body-name: body
+ /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'
+ responses:
+ '204':
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
+ '404':
+ $ref: '#/components/responses/NotFoundResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ summary: Delete Confluent account
+ tags:
+ - Confluent Cloud
+ get:
+ description: Get the Confluent account with the provided account ID.
+ operationId: GetConfluentAccount
+ parameters:
+ - $ref: '#/components/parameters/ConfluentAccountID'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $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'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ summary: Get Confluent account
+ tags:
+ - Confluent Cloud
+ patch:
+ description: Update the Confluent account with the provided account ID.
+ operationId: UpdateConfluentAccount
+ parameters:
+ - $ref: '#/components/parameters/ConfluentAccountID'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ConfluentAccountUpdateRequest'
+ description: Confluent payload
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $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'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ summary: Update Confluent account
+ tags:
+ - Confluent Cloud
+ x-codegen-request-body-name: body
+ /api/v2/integrations/confluent-cloud/accounts/{account_id}/resources:
+ get:
+ description: Get a Confluent resource for the account associated with the provided
+ ID.
+ operationId: ListConfluentResource
+ parameters:
+ - $ref: '#/components/parameters/ConfluentAccountID'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $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'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ summary: List Confluent Account resources
+ tags:
+ - Confluent Cloud
+ post:
+ description: Create a Confluent resource for the account associated with the
+ provided ID.
+ operationId: CreateConfluentResource
+ parameters:
+ - $ref: '#/components/parameters/ConfluentAccountID'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ConfluentResourceRequest'
+ description: Confluent payload
+ required: true
+ responses:
+ '201':
+ content:
+ application/json:
+ schema:
+ $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'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ summary: Add resource to Confluent account
+ tags:
+ - Confluent Cloud
+ x-codegen-request-body-name: body
+ /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.
+ operationId: DeleteConfluentResource
+ parameters:
+ - $ref: '#/components/parameters/ConfluentAccountID'
+ - $ref: '#/components/parameters/ConfluentResourceID'
+ responses:
+ '204':
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
+ '404':
+ $ref: '#/components/responses/NotFoundResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ summary: Delete resource from Confluent account
+ tags:
+ - Confluent Cloud
+ get:
+ 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'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $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'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ summary: Get resource from Confluent account
+ tags:
+ - Confluent Cloud
+ patch:
+ 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'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ConfluentResourceRequest'
+ description: Confluent payload
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $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'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ summary: Update resource in Confluent account
+ tags:
+ - Confluent Cloud
+ x-codegen-request-body-name: body
+ x-permission:
+ operator: OR
+ permissions:
+ - STANDARD
/api/v2/logs:
post:
description: 'Send your logs to your Datadog platform over HTTP. Limits per
HTTP request are:
@@ -11170,11 +12274,13 @@
cursorPath: meta.page.after
limitParam: body.page.limit
resultsPath: data
/api/v2/metrics:
get:
- description: Returns all metrics (matching additional filters if specified).
+ description: "Returns all metrics that can be configured in the Metrics Summary
+ page or with Metrics without Limits\u2122 (matching additional filters if
+ specified)."
operationId: ListTagConfigurations
parameters:
- description: Filter custom metrics that have configured tags.
example: true
in: query
@@ -11504,18 +12610,22 @@
example: 49
in: query
name: filter[hours_ago]
required: false
schema:
+ format: int32
+ maximum: 2147483647
type: integer
- description: The number of aggregations that a `count`, `rate`, or `gauge`
metric is configured to use. Max number of aggregation combos is 9.
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
@@ -11528,10 +12638,12 @@
example: 6
in: query
name: filter[timespan_h]
required: false
schema:
+ format: int32
+ maximum: 2147483647
type: integer
responses:
'200':
content:
application/json:
@@ -13884,10 +14996,103 @@
- Incident Services
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/).'
+ /api/v2/services/definitions:
+ get:
+ description: Get a list of all service definitions from the Datadog Service
+ Catalog.
+ operationId: ListServiceDefinitions
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ServiceDefinitionsListResponse'
+ description: OK
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Get all service definitions
+ tags:
+ - Service Definition
+ post:
+ description: Create or update service definition in the Datadog Service Catalog.
+ operationId: CreateOrUpdateServiceDefinitions
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ServiceDefinitionsCreateRequest'
+ description: Service Definition YAML/JSON.
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $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'
+ summary: Create or update service definition
+ tags:
+ - Service Definition
+ x-codegen-request-body-name: body
+ /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'
+ responses:
+ '204':
+ description: OK
+ '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 definition
+ tags:
+ - Service Definition
+ get:
+ description: Get a single service definition from the Datadog Service Catalog.
+ operationId: GetServiceDefinition
+ parameters:
+ - $ref: '#/components/parameters/ServiceName'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $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'
+ summary: Get a single service definition
+ tags:
+ - Service Definition
/api/v2/services/{service_id}:
delete:
description: Deletes an existing incident service.
operationId: DeleteIncidentService
parameters:
@@ -15123,10 +16328,13 @@
sent from Identity Providers.'
name: AuthN Mappings
- description: Workload activity security rules for generating events using the Datadog
security Agent.
name: Cloud Workload Security
+- description: Configure your Datadog Confluent Cloud integration directly through
+ the Datadog API.
+ name: Confluent Cloud
- description: 'Interact with your dashboard lists through the API to
organize, find, and share all of your dashboards with your team and
organization.'
@@ -15222,9 +16430,13 @@
signals.'
name: Security Monitoring
- description: Create, edit, and disable service accounts.
name: Service Accounts
+- description: API to create, update, retrieve and delete service definitions.
+ externalDocs:
+ url: https://docs.datadoghq.com/tracing/service_catalog/
+ name: Service Definition
- 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.