.generator/schemas/v2/openapi.yaml in datadog_api_client-2.16.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.17.0
- old
+ new
@@ -2,10 +2,17 @@
callbacks: {}
examples: {}
headers: {}
links: {}
parameters:
+ APIKeyCategoryParameter:
+ description: Filter API keys by category.
+ in: query
+ name: filter[category]
+ required: false
+ schema:
+ type: string
APIKeyFilterCreatedAtEndParameter:
description: Only include API keys created on or before the specified date.
in: query
name: filter[created_at][end]
required: false
@@ -57,10 +64,17 @@
name: include
required: false
schema:
example: created_by,modified_by
type: string
+ APIKeyReadConfigReadEnabledParameter:
+ description: Filter API keys by remote config read enabled status.
+ in: query
+ name: filter[remote_config_read_enabled]
+ required: false
+ schema:
+ type: boolean
APIKeysSortParameter:
description: 'API key attribute used to sort results. Sort order is ascending
by default. In order to specify a descending sort, prefix the
@@ -381,10 +395,17 @@
in: path
name: role_id
required: true
schema:
type: string
+ RuleId:
+ description: The ID of the rule/scorecard.
+ in: path
+ name: rule_id
+ required: true
+ schema:
+ type: string
SchemaVersion:
description: The schema version desired in the response.
in: query
name: schema_version
required: false
@@ -1267,10 +1288,108 @@
- authn_mappings
example: authn_mappings
type: string
x-enum-varnames:
- AUTHN_MAPPINGS
+ BulkMuteFindingsRequest:
+ description: The new bulk mute finding request.
+ properties:
+ data:
+ $ref: '#/components/schemas/BulkMuteFindingsRequestData'
+ required:
+ - data
+ type: object
+ BulkMuteFindingsRequestAttributes:
+ additionalProperties: false
+ description: The mute properties to be updated.
+ properties:
+ mute:
+ $ref: '#/components/schemas/BulkMuteFindingsRequestProperties'
+ required:
+ - mute
+ type: object
+ BulkMuteFindingsRequestData:
+ description: Data object containing the new bulk mute properties of the finding.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/BulkMuteFindingsRequestAttributes'
+ id:
+ description: UUID to identify the request
+ example: dbe5f567-192b-4404-b908-29b70e1c9f76
+ type: string
+ meta:
+ $ref: '#/components/schemas/BulkMuteFindingsRequestMeta'
+ type:
+ $ref: '#/components/schemas/FindingType'
+ required:
+ - id
+ - type
+ - attributes
+ - meta
+ type: object
+ BulkMuteFindingsRequestMeta:
+ description: Meta object containing the findings to be updated.
+ properties:
+ findings:
+ description: Array of findings.
+ items:
+ $ref: '#/components/schemas/BulkMuteFindingsRequestMetaFindings'
+ type: array
+ type: object
+ BulkMuteFindingsRequestMetaFindings:
+ description: Finding object containing the finding information.
+ properties:
+ finding_id:
+ $ref: '#/components/schemas/FindingID'
+ type: object
+ BulkMuteFindingsRequestProperties:
+ additionalProperties: false
+ description: Object containing the new mute properties of the findings.
+ properties:
+ description:
+ description: Additional information about the reason why those findings
+ are muted or unmuted. This field has a maximum limit of 280 characters.
+ type: string
+ expiration_date:
+ description: 'The expiration date of the mute or unmute action (Unix ms).
+ It must be set to a value greater than the current timestamp.
+
+ If this field is not provided, the finding will be muted or unmuted indefinitely,
+ which is equivalent to setting the expiration date to 9999999999999.
+
+ '
+ example: 1778721573794
+ format: int64
+ type: integer
+ muted:
+ description: Whether those findings should be muted or unmuted.
+ example: true
+ type: boolean
+ reason:
+ $ref: '#/components/schemas/FindingMuteReason'
+ required:
+ - muted
+ - reason
+ type: object
+ BulkMuteFindingsResponse:
+ description: The expected response schema.
+ properties:
+ data:
+ $ref: '#/components/schemas/BulkMuteFindingsResponseData'
+ required:
+ - data
+ type: object
+ BulkMuteFindingsResponseData:
+ description: Data object containing the ID of the request that was updated.
+ properties:
+ id:
+ description: UUID used to identify the request
+ example: 93bfeb70-af47-424d-908a-948d3f08e37f
+ type: string
+ type:
+ $ref: '#/components/schemas/FindingType'
+ type: object
CIAppAggregateBucketValue:
description: A bucket value, can either be a timeseries or a single value.
oneOf:
- $ref: '#/components/schemas/CIAppAggregateBucketValueSingleString'
- $ref: '#/components/schemas/CIAppAggregateBucketValueSingleNumber'
@@ -3439,10 +3558,121 @@
description: The JSON:API data attribute.
items:
$ref: '#/components/schemas/ConfluentResourceResponseData'
type: array
type: object
+ Container:
+ description: Container object.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/ContainerAttributes'
+ id:
+ description: Container ID.
+ type: string
+ type:
+ $ref: '#/components/schemas/ContainerType'
+ type: object
+ ContainerAttributes:
+ description: Attributes for a container.
+ properties:
+ container_id:
+ description: The ID of the container.
+ type: string
+ created_at:
+ description: Time the container was created.
+ type: string
+ host:
+ description: Hostname of the host running the container.
+ type: string
+ image_digest:
+ description: Digest of the compressed image manifest.
+ nullable: true
+ type: string
+ image_name:
+ description: Name of the associated container image.
+ type: string
+ image_tags:
+ description: List of image tags associated with the container image.
+ items:
+ type: string
+ nullable: true
+ type: array
+ name:
+ description: Name of the container.
+ type: string
+ started_at:
+ description: Time the container was started.
+ type: string
+ state:
+ description: State of the container. This depends on the container runtime.
+ type: string
+ tags:
+ description: List of tags associated with the container.
+ items:
+ type: string
+ type: array
+ type: object
+ ContainerGroup:
+ description: Container group object.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/ContainerGroupAttributes'
+ id:
+ description: Container Group ID.
+ type: string
+ relationships:
+ $ref: '#/components/schemas/ContainerGroupRelationships'
+ type:
+ $ref: '#/components/schemas/ContainerGroupType'
+ type: object
+ ContainerGroupAttributes:
+ description: Attributes for a container group.
+ properties:
+ count:
+ description: Number of containers in the group.
+ format: int64
+ type: integer
+ tags:
+ description: Tags from the group name parsed in key/value format.
+ type: object
+ type: object
+ ContainerGroupRelationships:
+ description: Relationships to containers inside a container group.
+ properties:
+ containers:
+ $ref: '#/components/schemas/ContainerGroupRelationshipsLink'
+ type: object
+ ContainerGroupRelationshipsData:
+ description: Links data.
+ items:
+ description: A link data.
+ type: string
+ type: array
+ ContainerGroupRelationshipsLink:
+ description: Relationships to Containers inside a Container Group.
+ properties:
+ data:
+ $ref: '#/components/schemas/ContainerGroupRelationshipsData'
+ links:
+ $ref: '#/components/schemas/ContainerGroupRelationshipsLinks'
+ type: object
+ ContainerGroupRelationshipsLinks:
+ description: Links attributes.
+ properties:
+ related:
+ description: Link to related containers.
+ type: string
+ type: object
+ ContainerGroupType:
+ default: container_group
+ description: Type of container group.
+ enum:
+ - container_group
+ example: container_group
+ type: string
+ x-enum-varnames:
+ - CONTAINER_GROUP
ContainerImage:
description: Container Image object.
properties:
attributes:
$ref: '#/components/schemas/ContainerImageAttributes'
@@ -3749,10 +3979,100 @@
type: string
self:
description: Link to current page.
type: string
type: object
+ ContainerItem:
+ description: Possible Container models.
+ oneOf:
+ - $ref: '#/components/schemas/Container'
+ - $ref: '#/components/schemas/ContainerGroup'
+ ContainerMeta:
+ description: Response metadata object.
+ properties:
+ pagination:
+ $ref: '#/components/schemas/ContainerMetaPage'
+ type: object
+ ContainerMetaPage:
+ description: Paging attributes.
+ properties:
+ cursor:
+ description: The cursor used to get the current results, if any.
+ type: string
+ limit:
+ description: Number of results returned
+ format: int32
+ maximum: 10000
+ minimum: 0
+ type: integer
+ next_cursor:
+ description: The cursor used to get the next results, if any.
+ type: string
+ prev_cursor:
+ description: The cursor used to get the previous results, if any.
+ nullable: true
+ type: string
+ total:
+ description: Total number of records that match the query.
+ format: int64
+ type: integer
+ type:
+ $ref: '#/components/schemas/ContainerMetaPageType'
+ type: object
+ ContainerMetaPageType:
+ default: cursor_limit
+ description: Type of Container pagination.
+ enum:
+ - cursor_limit
+ example: cursor_limit
+ type: string
+ x-enum-varnames:
+ - CURSOR_LIMIT
+ ContainerType:
+ default: container
+ description: Type of container.
+ enum:
+ - container
+ example: container
+ type: string
+ x-enum-varnames:
+ - CONTAINER
+ ContainersResponse:
+ description: List of containers.
+ properties:
+ data:
+ description: Array of Container objects.
+ items:
+ $ref: '#/components/schemas/ContainerItem'
+ type: array
+ links:
+ $ref: '#/components/schemas/ContainersResponseLinks'
+ meta:
+ $ref: '#/components/schemas/ContainerMeta'
+ type: object
+ ContainersResponseLinks:
+ description: Pagination links.
+ properties:
+ first:
+ description: Link to the first page.
+ type: string
+ last:
+ description: Link to the last page.
+ nullable: true
+ type: string
+ next:
+ description: Link to the next page.
+ nullable: true
+ type: string
+ prev:
+ description: Link to previous page.
+ nullable: true
+ type: string
+ self:
+ description: Link to current page.
+ type: string
+ type: object
ContentEncoding:
description: HTTP header used to compress the media-type.
enum:
- identity
- gzip
@@ -3816,10 +4136,42 @@
- cost_by_org
example: cost_by_org
type: string
x-enum-varnames:
- COST_BY_ORG
+ CreateRuleRequest:
+ description: Scorecard create rule request.
+ properties:
+ data:
+ $ref: '#/components/schemas/CreateRuleRequestData'
+ type: object
+ CreateRuleRequestData:
+ description: Scorecard create rule request data.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/RuleAttributes'
+ type:
+ $ref: '#/components/schemas/RuleType'
+ type: object
+ CreateRuleResponse:
+ description: Created rule in response.
+ properties:
+ data:
+ $ref: '#/components/schemas/CreateRuleResponseData'
+ type: object
+ CreateRuleResponseData:
+ description: Create rule response data.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/RuleAttributes'
+ id:
+ $ref: '#/components/schemas/RuleId'
+ relationships:
+ $ref: '#/components/schemas/RelationshipToRule'
+ type:
+ $ref: '#/components/schemas/RuleType'
+ type: object
Creator:
description: Creator of the object.
properties:
email:
description: Email of the creator.
@@ -5429,11 +5781,11 @@
format: int64
minimum: 1
type: integer
FindingID:
description: The unique ID for this finding.
- example: AQAAAYbb1i0gijTHEQAAAABBWWJiMWkwZ0FBQ2FuNzBJVGZXZ3B3QUE
+ example: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==
type: string
FindingMute:
additionalProperties: false
description: Information about the mute status of this finding.
properties:
@@ -7985,10 +8337,43 @@
links:
$ref: '#/components/schemas/PowerpackResponseLinks'
meta:
$ref: '#/components/schemas/PowerpacksResponseMeta'
type: object
+ ListRulesResponse:
+ description: Scorecard rules response.
+ properties:
+ data:
+ $ref: '#/components/schemas/ListRulesResponseData'
+ links:
+ $ref: '#/components/schemas/ListRulesResponseLinks'
+ type: object
+ ListRulesResponseData:
+ description: Array of rule details.
+ items:
+ $ref: '#/components/schemas/ListRulesResponseDataItem'
+ type: array
+ ListRulesResponseDataItem:
+ description: Rule details.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/RuleAttributes'
+ id:
+ $ref: '#/components/schemas/RuleId'
+ relationships:
+ $ref: '#/components/schemas/RelationshipToRule'
+ type:
+ $ref: '#/components/schemas/RuleType'
+ type: object
+ ListRulesResponseLinks:
+ description: Links attributes.
+ properties:
+ next:
+ description: Link for the next set of rules.
+ example: /api/v2/scorecard/rules?page%5Blimit%5D=2&page%5Boffset%5D=2&page%5Bsize%5D=2
+ type: string
+ type: object
ListTeamsInclude:
description: Included related resources optionally requested.
enum:
- team_links
- user_team_permissions
@@ -9215,10 +9600,19 @@
MetricBulkTagConfigCreateAttributes:
description: Optional parameters for bulk creating metric tag configurations.
properties:
emails:
$ref: '#/components/schemas/MetricBulkTagConfigEmailList'
+ exclude_tags_mode:
+ description: 'When set to true, the configuration will exclude the configured
+ tags and include any other submitted tags.
+
+ When set to false, the configuration will include the configured tags
+ and exclude any other submitted tags.
+
+ Defaults to false.'
+ type: boolean
tags:
$ref: '#/components/schemas/MetricBulkTagConfigTagNameList'
type: object
MetricBulkTagConfigCreateRequest:
description: Wrapper object for a single bulk tag configuration request.
@@ -9295,10 +9689,17 @@
description: Optional attributes for the status of a bulk tag configuration
request.
properties:
emails:
$ref: '#/components/schemas/MetricBulkTagConfigEmailList'
+ exclude_tags_mode:
+ description: 'When set to true, the configuration will exclude the configured
+ tags and include any other submitted tags.
+
+ When set to false, the configuration will include the configured tags
+ and exclude any other submitted tags.'
+ type: boolean
status:
description: The status of the request.
example: Accepted
type: string
tags:
@@ -9759,10 +10160,19 @@
created_at:
description: Timestamp when the tag configuration was created.
example: '2020-03-25T09:48:37.463835Z'
format: date-time
type: string
+ exclude_tags_mode:
+ description: 'When set to true, the configuration will exclude the configured
+ tags and include any other submitted tags.
+
+ When set to false, the configuration will include the configured tags
+ and exclude any other submitted tags.
+
+ Defaults to false. Requires `tags` property.'
+ type: boolean
include_percentiles:
description: 'Toggle to include or exclude percentile aggregations for distribution
metrics.
Only present when the `metric_type` is `distribution`.'
@@ -9789,10 +10199,19 @@
description: Object containing the definition of a metric tag configuration
to be created.
properties:
aggregations:
$ref: '#/components/schemas/MetricCustomAggregations'
+ exclude_tags_mode:
+ description: 'When set to true, the configuration will exclude the configured
+ tags and include any other submitted tags.
+
+ When set to false, the configuration will include the configured tags
+ and exclude any other submitted tags.
+
+ Defaults to false. Requires `tags` property.'
+ type: boolean
include_percentiles:
description: 'Toggle to include/exclude percentiles for a distribution metric.
Defaults to false. Can only be applied to metrics that have a `metric_type`
of `distribution`.'
@@ -9880,10 +10299,19 @@
description: Object containing the definition of a metric tag configuration
to be updated.
properties:
aggregations:
$ref: '#/components/schemas/MetricCustomAggregations'
+ exclude_tags_mode:
+ description: 'When set to true, the configuration will exclude the configured
+ tags and include any other submitted tags.
+
+ When set to false, the configuration will include the configured tags
+ and exclude any other submitted tags.
+
+ Defaults to false. Requires `tags` property.'
+ type: boolean
include_percentiles:
description: 'Toggle to include/exclude percentiles for a distribution metric.
Defaults to false. Can only be applied to metrics that have a `metric_type`
of `distribution`.'
@@ -10323,143 +10751,10 @@
type: string
type:
description: The monitor type.
type: string
type: object
- MuteFindingRequest:
- description: The new mute finding request.
- properties:
- data:
- $ref: '#/components/schemas/MuteFindingRequestData'
- required:
- - data
- type: object
- MuteFindingRequestAttributes:
- additionalProperties: false
- description: The mute properties to be updated.
- properties:
- mute:
- $ref: '#/components/schemas/MuteFindingRequestProperties'
- required:
- - mute
- type: object
- MuteFindingRequestData:
- description: Data object containing the new mute properties of the finding.
- properties:
- attributes:
- $ref: '#/components/schemas/MuteFindingRequestAttributes'
- id:
- $ref: '#/components/schemas/FindingID'
- type:
- $ref: '#/components/schemas/FindingType'
- required:
- - id
- - type
- - attributes
- type: object
- MuteFindingRequestProperties:
- additionalProperties: false
- description: Object containing the new mute properties of the finding.
- properties:
- description:
- description: Additional information about the reason why this finding is
- muted or unmuted. This field has a maximum limit of 280 characters.
- example: To be resolved later
- type: string
- expiration_date:
- description: 'The expiration date of the mute or unmute action (Unix ms).
- It must be set to a value greater than the current timestamp.
-
- If this field is not provided, the finding will be muted or unmuted indefinitely,
- which is equivalent to setting the expiration date to 9999999999999.
-
- '
- example: 1778721573794
- format: int64
- type: integer
- muted:
- description: Whether this finding is muted or unmuted.
- example: true
- type: boolean
- reason:
- $ref: '#/components/schemas/FindingMuteReason'
- required:
- - muted
- - reason
- type: object
- MuteFindingResponse:
- description: The expected response schema.
- properties:
- data:
- $ref: '#/components/schemas/MuteFindingResponseData'
- required:
- - data
- type: object
- MuteFindingResponseAttributes:
- description: The JSON:API attributes of the finding.
- properties:
- evaluation:
- $ref: '#/components/schemas/FindingEvaluation'
- evaluation_changed_at:
- $ref: '#/components/schemas/FindingEvaluationChangedAt'
- mute:
- $ref: '#/components/schemas/MuteFindingResponseProperties'
- resource:
- $ref: '#/components/schemas/FindingResource'
- resource_discovery_date:
- $ref: '#/components/schemas/FindingResourceDiscoveryDate'
- resource_type:
- $ref: '#/components/schemas/FindingResourceType'
- rule:
- $ref: '#/components/schemas/FindingRule'
- status:
- $ref: '#/components/schemas/FindingStatus'
- tags:
- $ref: '#/components/schemas/FindingTags'
- type: object
- MuteFindingResponseData:
- description: Data object containing the updated finding.
- properties:
- attributes:
- $ref: '#/components/schemas/MuteFindingResponseAttributes'
- id:
- $ref: '#/components/schemas/FindingID'
- type:
- $ref: '#/components/schemas/FindingType'
- type: object
- MuteFindingResponseProperties:
- additionalProperties: false
- description: Information about the mute status of this finding.
- properties:
- description:
- description: 'Additional information about the reason why this finding is
- muted or unmuted.
-
- This attribute will not be included in the response if the description
- is not provided in the request body.
-
- '
- example: To be resolved later
- type: string
- expiration_date:
- description: 'The expiration date of the mute or unmute action.
-
- If the expiration date is not provided in the request body, this attribute
- will not be included in the response and the finding will be muted or
- unmuted indefinitely.
-
- '
- example: 1778721573794
- format: int64
- type: integer
- muted:
- description: Whether this finding is muted or unmuted.
- example: true
- type: boolean
- reason:
- $ref: '#/components/schemas/FindingMuteReason'
- type: object
NullableRelationshipToUser:
description: Relationship to user.
properties:
data:
$ref: '#/components/schemas/NullableRelationshipToUserData'
@@ -10727,10 +11022,189 @@
- orgs
example: orgs
type: string
x-enum-varnames:
- ORGS
+ OutcomeType:
+ default: outcome
+ description: The JSON:API type for an outcome.
+ enum:
+ - outcome
+ example: outcome
+ type: string
+ x-enum-varnames:
+ - OUTCOME
+ OutcomesBatchAttributes:
+ description: The JSON:API attributes for a batched set of scorecard outcomes.
+ properties:
+ results:
+ description: Set of scorecard outcomes to update.
+ items:
+ $ref: '#/components/schemas/OutcomesBatchRequestItem'
+ type: array
+ type: object
+ OutcomesBatchRequest:
+ description: Scorecard outcomes batch request.
+ properties:
+ data:
+ $ref: '#/components/schemas/OutcomesBatchRequestData'
+ type: object
+ OutcomesBatchRequestData:
+ description: Scorecard outcomes batch request data.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/OutcomesBatchAttributes'
+ type:
+ $ref: '#/components/schemas/OutcomesBatchType'
+ type: object
+ OutcomesBatchRequestItem:
+ description: Scorecard outcome for a specific rule, for a given service within
+ a batched update.
+ properties:
+ remarks:
+ description: Any remarks regarding the scorecard rule's evaluation, and
+ supports HTML hyperlinks.
+ example: 'See: <a href="https://app.datadoghq.com/services">Services</a>'
+ type: string
+ rule_id:
+ $ref: '#/components/schemas/RuleId'
+ service_name:
+ description: The unique name for a service in the catalog.
+ example: my-service
+ type: string
+ state:
+ $ref: '#/components/schemas/State'
+ required:
+ - rule_id
+ - service_name
+ - state
+ type: object
+ OutcomesBatchResponse:
+ description: Scorecard outcomes batch response.
+ properties:
+ data:
+ $ref: '#/components/schemas/OutcomesBatchResponseData'
+ meta:
+ $ref: '#/components/schemas/OutcomesBatchResponseMeta'
+ required:
+ - data
+ - meta
+ type: object
+ OutcomesBatchResponseAttributes:
+ description: The JSON:API attributes for an outcome.
+ properties:
+ created_at:
+ description: Creation time of the rule outcome.
+ format: date-time
+ type: string
+ modified_at:
+ description: Time of last rule outcome modification.
+ format: date-time
+ type: string
+ remarks:
+ description: Any remarks regarding the scorecard rule's evaluation, and
+ supports HTML hyperlinks.
+ example: 'See: <a href="https://app.datadoghq.com/services">Services</a>'
+ type: string
+ service_name:
+ description: The unique name for a service in the catalog.
+ example: my-service
+ type: string
+ state:
+ $ref: '#/components/schemas/State'
+ type: object
+ OutcomesBatchResponseData:
+ description: List of rule outcomes which were affected during the bulk operation.
+ items:
+ $ref: '#/components/schemas/OutcomesResponseDataItem'
+ type: array
+ OutcomesBatchResponseMeta:
+ description: Metadata pertaining to the bulk operation.
+ properties:
+ total_received:
+ description: Total number of scorecard results received during the bulk
+ operation.
+ format: int64
+ type: integer
+ total_updated:
+ description: Total number of scorecard results modified during the bulk
+ operation.
+ format: int64
+ type: integer
+ type: object
+ OutcomesBatchType:
+ default: batched-outcome
+ description: The JSON:API type for scorecard outcomes.
+ enum:
+ - batched-outcome
+ example: batched-outcome
+ type: string
+ x-enum-varnames:
+ - BATCHED_OUTCOME
+ OutcomesResponse:
+ description: Scorecard outcomes - the result of a rule for a service.
+ properties:
+ data:
+ $ref: '#/components/schemas/OutcomesResponseData'
+ included:
+ $ref: '#/components/schemas/OutcomesResponseIncluded'
+ links:
+ $ref: '#/components/schemas/OutcomesResponseLinks'
+ type: object
+ OutcomesResponseData:
+ description: List of rule outcomes.
+ items:
+ $ref: '#/components/schemas/OutcomesResponseDataItem'
+ type: array
+ OutcomesResponseDataItem:
+ description: A single rule outcome.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/OutcomesBatchResponseAttributes'
+ id:
+ description: The unique ID for a rule outcome.
+ type: string
+ relationships:
+ $ref: '#/components/schemas/RuleOutcomeRelationships'
+ type:
+ $ref: '#/components/schemas/OutcomeType'
+ type: object
+ OutcomesResponseIncluded:
+ description: Array of rule details.
+ items:
+ $ref: '#/components/schemas/OutcomesResponseIncludedItem'
+ type: array
+ OutcomesResponseIncludedItem:
+ description: Attributes of the included rule.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/OutcomesResponseIncludedRuleAttributes'
+ id:
+ $ref: '#/components/schemas/RuleId'
+ type:
+ $ref: '#/components/schemas/RuleType'
+ type: object
+ OutcomesResponseIncludedRuleAttributes:
+ description: Details of a rule.
+ properties:
+ name:
+ description: Name of the rule.
+ example: Team Defined
+ type: string
+ scorecard_name:
+ description: The scorecard name to which this rule must belong.
+ example: Observability Best Practices
+ type: string
+ type: object
+ OutcomesResponseLinks:
+ description: Links attributes.
+ properties:
+ next:
+ description: Link for the next set of results.
+ example: /api/v2/scorecard/outcomes?include=rule&page%5Blimit%5D=100&page%5Boffset%5D=100
+ type: string
+ type: object
Pagination:
description: Pagination object.
properties:
total_count:
description: Total count.
@@ -10953,10 +11427,12 @@
properties:
definition:
$ref: '#/components/schemas/PowerpackGroupWidgetDefinition'
layout:
$ref: '#/components/schemas/PowerpackGroupWidgetLayout'
+ live_span:
+ $ref: '#/components/schemas/WidgetLiveSpan'
required:
- definition
type: object
PowerpackGroupWidgetDefinition:
description: Powerpack group widget object.
@@ -12180,10 +12656,25 @@
$ref: '#/components/schemas/RelationshipToOrganizationData'
type: array
required:
- data
type: object
+ RelationshipToOutcome:
+ description: The JSON:API relationship to a scorecard outcome.
+ properties:
+ data:
+ $ref: '#/components/schemas/RelationshipToOutcomeData'
+ type: object
+ RelationshipToOutcomeData:
+ description: The JSON:API relationship to an outcome, which returns the related
+ rule id.
+ properties:
+ id:
+ $ref: '#/components/schemas/RuleId'
+ type:
+ $ref: '#/components/schemas/RuleType'
+ type: object
RelationshipToPermission:
description: Relationship to a permissions object.
properties:
data:
$ref: '#/components/schemas/RelationshipToPermissionData'
@@ -12229,10 +12720,32 @@
description: An array containing type and the unique identifier of a role.
items:
$ref: '#/components/schemas/RelationshipToRoleData'
type: array
type: object
+ RelationshipToRule:
+ description: Scorecard create rule response relationship.
+ properties:
+ scorecard:
+ $ref: '#/components/schemas/RelationshipToRuleData'
+ type: object
+ RelationshipToRuleData:
+ description: Relationship data for a rule.
+ properties:
+ data:
+ $ref: '#/components/schemas/RelationshipToRuleDataObject'
+ type: object
+ RelationshipToRuleDataObject:
+ description: Rule relationship data.
+ properties:
+ id:
+ description: The unique ID for a scorecard.
+ example: 00000000-0000-beef-0000-000000000000
+ type: string
+ type:
+ $ref: '#/components/schemas/ScorecardType'
+ type: object
RelationshipToSAMLAssertionAttribute:
description: AuthN Mapping relationship to SAML Assertion Attribute.
properties:
data:
$ref: '#/components/schemas/RelationshipToSAMLAssertionAttributeData'
@@ -12955,10 +13468,66 @@
- roles
example: roles
type: string
x-enum-varnames:
- ROLES
+ RuleAttributes:
+ description: Details of a rule.
+ properties:
+ category:
+ deprecated: true
+ description: The scorecard name to which this rule must belong.
+ type: string
+ created_at:
+ description: Creation time of the rule outcome.
+ format: date-time
+ type: string
+ custom:
+ description: Defines if the rule is a custom rule.
+ type: boolean
+ description:
+ description: Explanation of the rule.
+ type: string
+ enabled:
+ description: If enabled, the rule is calculated as part of the score.
+ example: true
+ type: boolean
+ modified_at:
+ description: Time of the last rule outcome modification.
+ format: date-time
+ type: string
+ name:
+ description: Name of the rule.
+ example: Team Defined
+ type: string
+ owner:
+ description: Owner of the rule.
+ type: string
+ scorecard_name:
+ description: The scorecard name to which this rule must belong.
+ example: Deployments automated via Deployment Trains
+ type: string
+ type: object
+ RuleId:
+ description: The unique ID for a scorecard rule.
+ example: 00000000-0000-beef-0000-000000000000
+ type: string
+ RuleOutcomeRelationships:
+ description: The JSON:API relationship to a scorecard rule.
+ properties:
+ rule:
+ $ref: '#/components/schemas/RelationshipToOutcome'
+ type: object
+ RuleType:
+ default: rule
+ description: The JSON:API type for scorecard rules.
+ enum:
+ - rule
+ example: rule
+ type: string
+ x-enum-varnames:
+ - RULE
SAMLAssertionAttribute:
description: SAML assertion attribute.
properties:
attributes:
$ref: '#/components/schemas/SAMLAssertionAttributeAttributes'
@@ -13140,10 +13709,19 @@
attributes:
$ref: '#/components/schemas/ScalarFormulaResponseAtrributes'
type:
$ref: '#/components/schemas/ScalarFormulaResponseType'
type: object
+ ScorecardType:
+ default: scorecard
+ description: The JSON:API type for scorecard.
+ enum:
+ - scorecard
+ example: scorecard
+ type: string
+ x-enum-varnames:
+ - SCORECARD
SecurityFilter:
description: The security filter's properties.
properties:
attributes:
$ref: '#/components/schemas/SecurityFilterAttributes'
@@ -13853,11 +14431,11 @@
additionalProperties: {}
description: 'The object containing all signal attributes and their
associated values.'
properties:
- attributes:
+ custom:
additionalProperties: {}
description: A JSON object of attributes in the security signal.
example:
workflow:
first_seen: '2020-06-23T14:46:01.000Z'
@@ -14439,10 +15017,17 @@
description: Fields to group by.
items:
description: Field.
type: string
type: array
+ hasOptionalGroupByFields:
+ description: When false, events without a group-by value are ignored by
+ the rule. When true, events with missing group-by fields are processed
+ with `N/A`, replacing the missing values.
+ example: false
+ readOnly: true
+ type: boolean
metric:
deprecated: true
description: '(Deprecated) The target field to aggregate over when using
the sum or max
@@ -15807,11 +16392,11 @@
example:
myorg/extension: extensionValue
type: object
integrations:
$ref: '#/components/schemas/ServiceDefinitionV2Dot2Integrations'
- langauges:
+ languages:
description: 'The service''s programming language. Datadog recognizes the
following languages: `dotnet`, `go`, `java`, `js`, `php`, `python`, `ruby`,
and `c++`.'
example:
- dotnet
@@ -17066,10 +17651,22 @@
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
+ State:
+ description: The state of the rule evaluation.
+ enum:
+ - pass
+ - fail
+ - skip
+ example: pass
+ type: string
+ x-enum-varnames:
+ - PASS
+ - FAIL
+ - SKIP
TagsEventAttribute:
description: Array of tags associated with your event.
example:
- team:A
items:
@@ -17541,10 +18138,45 @@
data:
$ref: '#/components/schemas/TeamUpdate'
required:
- data
type: object
+ TeamsField:
+ description: Supported teams field.
+ enum:
+ - id
+ - name
+ - handle
+ - summary
+ - description
+ - avatar
+ - banner
+ - visible_modules
+ - hidden_modules
+ - created_at
+ - modified_at
+ - user_count
+ - link_count
+ - team_links
+ - user_team_permissions
+ type: string
+ x-enum-varnames:
+ - ID
+ - NAME
+ - HANDLE
+ - SUMMARY
+ - DESCRIPTION
+ - AVATAR
+ - BANNER
+ - VISIBLE_MODULES
+ - HIDDEN_MODULES
+ - CREATED_AT
+ - MODIFIED_AT
+ - USER_COUNT
+ - LINK_COUNT
+ - TEAM_LINKS
+ - USER_TEAM_PERMISSIONS
TeamsResponse:
description: Response with multiple teams
properties:
data:
description: Teams response data
@@ -18175,12 +18807,12 @@
type: object
UserTeamPermissionAttributes:
description: User team permission attributes
properties:
permissions:
- description: Object of team permission actions and boolean values indicating
- of the currently logged in user can perform them on this team
+ description: Object of team permission actions and boolean values that a
+ logged in user can perform on this team.
readOnly: true
type: object
type: object
UserTeamPermissionType:
default: user_team_permissions
@@ -18329,10 +18961,46 @@
- users
example: users
type: string
x-enum-varnames:
- USERS
+ WidgetLiveSpan:
+ description: The available timeframes depend on the widget you are using.
+ enum:
+ - 1m
+ - 5m
+ - 10m
+ - 15m
+ - 30m
+ - 1h
+ - 4h
+ - 1d
+ - 2d
+ - 1w
+ - 1mo
+ - 3mo
+ - 6mo
+ - 1y
+ - alert
+ example: 5m
+ type: string
+ x-enum-varnames:
+ - PAST_ONE_MINUTE
+ - PAST_FIVE_MINUTES
+ - PAST_TEN_MINUTES
+ - PAST_FIFTEEN_MINUTES
+ - PAST_THIRTY_MINUTES
+ - PAST_ONE_HOUR
+ - PAST_FOUR_HOURS
+ - PAST_ONE_DAY
+ - PAST_TWO_DAYS
+ - PAST_ONE_WEEK
+ - PAST_ONE_MONTH
+ - PAST_THREE_MONTHS
+ - PAST_SIX_MONTHS
+ - PAST_ONE_YEAR
+ - ALERT
securitySchemes:
AuthZ:
description: This API uses OAuth 2 with the implicit grant flow.
flows:
authorizationCode:
@@ -18431,10 +19099,12 @@
- $ref: '#/components/parameters/APIKeyFilterCreatedAtStartParameter'
- $ref: '#/components/parameters/APIKeyFilterCreatedAtEndParameter'
- $ref: '#/components/parameters/APIKeyFilterModifiedAtStartParameter'
- $ref: '#/components/parameters/APIKeyFilterModifiedAtEndParameter'
- $ref: '#/components/parameters/APIKeyIncludeParameter'
+ - $ref: '#/components/parameters/APIKeyReadConfigReadEnabledParameter'
+ - $ref: '#/components/parameters/APIKeyCategoryParameter'
responses:
'200':
content:
application/json:
schema:
@@ -18864,10 +19534,11 @@
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/ApplicationKeysSortParameter'
- $ref: '#/components/parameters/ApplicationKeyFilterParameter'
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter'
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter'
+ - $ref: '#/components/parameters/ApplicationKeyIncludeParameter'
responses:
'200':
content:
application/json:
schema:
@@ -19412,10 +20083,13 @@
- apiKeyAuth: []
summary: Send pipeline event
tags:
- CI Visibility Pipelines
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/ci/pipelines/analytics/aggregate:
post:
description: Use this API endpoint to aggregate CI Visibility pipeline events
into buckets of computed metrics and timeseries.
operationId: AggregateCIAppPipelineEvents
@@ -19812,10 +20486,90 @@
limitParam: page[size]
resultsPath: data
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+ /api/v2/containers:
+ get:
+ description: Get all containers for your organization.
+ operationId: ListContainers
+ parameters:
+ - description: Comma-separated list of tags to filter containers by.
+ example: env:prod,short_image:cassandra
+ in: query
+ name: filter[tags]
+ required: false
+ schema:
+ type: string
+ - description: Comma-separated list of tags to group containers by.
+ example: datacenter,cluster
+ in: query
+ name: group_by
+ required: false
+ schema:
+ type: string
+ - description: Attribute to sort containers by.
+ example: started_at
+ in: query
+ name: sort
+ required: false
+ schema:
+ type: string
+ - description: Maximum number of results returned.
+ in: query
+ name: page[size]
+ required: false
+ schema:
+ default: 1000
+ format: int32
+ maximum: 10000
+ minimum: 1
+ type: integer
+ - description: 'String to query the next page of results.
+
+ This key is provided with each valid response from the API in `meta.pagination.next_cursor`.'
+ in: query
+ name: page[cursor]
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ContainersResponse'
+ description: OK
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Bad Request
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Authentication Error
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ: []
+ summary: Get All Containers
+ tags:
+ - Containers
+ x-pagination:
+ cursorParam: page[cursor]
+ cursorPath: meta.pagination.next_cursor
+ limitParam: page[size]
+ resultsPath: data
+ x-unstable: '**Note**: This endpoint is in public beta.
+
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/current_user/application_keys:
get:
description: List all application keys available for current user
operationId: ListCurrentUserApplicationKeys
parameters:
@@ -19823,10 +20577,11 @@
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/ApplicationKeysSortParameter'
- $ref: '#/components/parameters/ApplicationKeyFilterParameter'
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtStartParameter'
- $ref: '#/components/parameters/ApplicationKeyFilterCreatedAtEndParameter'
+ - $ref: '#/components/parameters/ApplicationKeyIncludeParameter'
responses:
'200':
content:
application/json:
schema:
@@ -20359,11 +21114,11 @@
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- - monitors_read
+ - monitors_downtime
summary: Get a downtime
tags:
- Downtimes
patch:
description: Update a downtime by `downtime_id`.
@@ -23279,12 +24034,16 @@
operation in the Datadog web app.
If multiple calls include the same metric, the last configuration applied
(not by submit order) is used, do not
- expect deterministic ordering of concurrent calls.
+ expect deterministic ordering of concurrent calls. The `exclude_tags_mode`
+ value will set all metrics that match the prefix to
+ the same exclusion state, metric tag configurations do not support mixed inclusion
+ and exclusion for tags on the same metric.
+
Can only be used with application keys of users with the `Manage Tags for
Metrics` permission.'
operationId: CreateBulkTagsMetricsConfiguration
requestBody:
content:
@@ -23605,12 +24364,16 @@
- Metrics
patch:
description: 'Update the tag configuration of a metric or percentile aggregations
of a distribution metric or custom aggregations
- of a count, rate, or gauge metric.
+ of a count, rate, or gauge metric. By setting `exclude_tags_mode` to true
+ the behavior is changed
+ from an allow-list to a deny-list, and tags in the defined list will not be
+ queryable.
+
Can only be used with application keys from users with the `Manage Tags for
Metrics` permission.'
operationId: UpdateTagConfiguration
parameters:
- $ref: '#/components/parameters/MetricName'
@@ -23660,12 +24423,16 @@
count/gauge/rate/distribution metric.
Optionally, include percentile aggregations on any distribution metric or
configure custom aggregations
- on any count, rate, or gauge metric.
+ on any count, rate, or gauge metric. By setting `exclude_tags_mode` to true
+ the behavior is changed
+ from an allow-list to a deny-list, and tags in the defined list will not be
+ queryable.
+
Can only be used with application keys of users with the `Manage Tags for
Metrics` permission.'
operationId: CreateTagConfiguration
parameters:
- $ref: '#/components/parameters/MetricName'
@@ -24160,120 +24927,101 @@
limitParam: page[limit]
resultsPath: data
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
- /api/v2/posture_management/findings/{finding_id}:
- get:
- description: Returns a single finding with message and resource configuration.
- operationId: GetFinding
- parameters:
- - description: The ID of the finding.
- in: path
- name: finding_id
+ patch:
+ description: Mute or unmute findings.
+ operationId: MuteFindings
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/BulkMuteFindingsRequest'
+ description: "### Attributes\n\nAll findings are updated with the same attributes.
+ The request body must include at least two attributes: `muted` and `reason`.\nThe
+ allowed reasons depend on whether the finding is being muted or unmuted:\n
+ \ - To mute a finding: `PENDING_FIX`, `FALSE_POSITIVE`, `ACCEPTED_RISK`,
+ `OTHER`.\n - To unmute a finding : `NO_PENDING_FIX`, `HUMAN_ERROR`, `NO_LONGER_ACCEPTED_RISK`,
+ `OTHER`.\n\n### Meta\n\nThe request body must include a list of the finding
+ IDs to be updated.\n"
required: true
- schema:
- type: string
- - description: Return the finding for a given snapshot of time (Unix ms).
- example: 1678721573794
- in: query
- name: snapshot_timestamp
- required: false
- schema:
- format: int64
- minimum: 1
- type: integer
responses:
'200':
content:
application/json:
schema:
- $ref: '#/components/schemas/GetFindingResponse'
+ $ref: '#/components/schemas/BulkMuteFindingsResponse'
description: OK
'400':
$ref: '#/components/responses/FindingsBadRequestResponse'
'403':
$ref: '#/components/responses/FindingsForbiddenResponse'
'404':
$ref: '#/components/responses/FindingsNotFoundResponse'
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
+ description: 'Invalid Request: The server understands the request syntax
+ but cannot process it due to invalid data.'
'429':
$ref: '#/components/responses/FindingsTooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- - AuthZ:
- - security_monitoring_findings_read
- summary: Get a finding
+ summary: Mute or unmute a batch of findings
tags:
- Security Monitoring
+ 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/).'
- patch:
- description: 'Mute or unmute a specific finding.
-
- The API returns the updated finding object when the request is successful.'
- operationId: UpdateFinding
+ /api/v2/posture_management/findings/{finding_id}:
+ get:
+ description: Returns a single finding with message and resource configuration.
+ operationId: GetFinding
parameters:
- description: The ID of the finding.
in: path
name: finding_id
required: true
schema:
type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/MuteFindingRequest'
- description: 'To mute or unmute a finding, the request body should include
- at least two attributes: `muted` and `reason`. The allowed reasons depend
- on whether the finding is being muted or unmuted:
-
- - To mute a finding: `PENDING_FIX`, `FALSE_POSITIVE`, `ACCEPTED_RISK`, `OTHER`.
-
- - To unmute a finding : `NO_PENDING_FIX`, `HUMAN_ERROR`, `NO_LONGER_ACCEPTED_RISK`,
- `OTHER`.
-
- '
- required: true
+ - description: Return the finding for a given snapshot of time (Unix ms).
+ example: 1678721573794
+ in: query
+ name: snapshot_timestamp
+ required: false
+ schema:
+ format: int64
+ minimum: 1
+ type: integer
responses:
'200':
content:
application/json:
schema:
- $ref: '#/components/schemas/MuteFindingResponse'
+ $ref: '#/components/schemas/GetFindingResponse'
description: OK
'400':
$ref: '#/components/responses/FindingsBadRequestResponse'
'403':
$ref: '#/components/responses/FindingsForbiddenResponse'
'404':
$ref: '#/components/responses/FindingsNotFoundResponse'
- '409':
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/JSONAPIErrorResponse'
- description: 'Resource Conflict: The finding has already been muted or unmuted
- within the last 60 seconds.'
- '422':
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/JSONAPIErrorResponse'
- description: 'Invalid Request: The server understands the request syntax
- but cannot process it due to invalid data.'
'429':
$ref: '#/components/responses/FindingsTooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- summary: Mute or unmute a finding
+ - AuthZ:
+ - security_monitoring_findings_read
+ summary: Get a finding
tags:
- Security Monitoring
- 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/powerpacks:
get:
@@ -24772,10 +25520,16 @@
in: query
name: filter
required: false
schema:
type: string
+ - description: Filter all roles by the given list of role IDs.
+ in: query
+ name: filter[id]
+ required: false
+ schema:
+ type: string
responses:
'200':
content:
application/json:
schema:
@@ -25610,10 +26364,295 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Upload IdP metadata
tags:
- Organizations
x-codegen-request-body-name: body
+ /api/v2/scorecard/outcomes:
+ get:
+ description: Fetches all rule outcomes.
+ operationId: ListScorecardOutcomes
+ parameters:
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/PageOffset'
+ - description: Include related rule details in the response.
+ in: query
+ name: include
+ required: false
+ schema:
+ example: rule
+ type: string
+ - description: Return only specified values in the outcome attributes.
+ in: query
+ name: fields[outcome]
+ required: false
+ schema:
+ example: state, service_name
+ type: string
+ - description: Return only specified values in the included rule details.
+ in: query
+ name: fields[rule]
+ required: false
+ schema:
+ example: name
+ type: string
+ - description: Filter the outcomes on a specific service name.
+ in: query
+ name: filter[outcome][service_name]
+ required: false
+ schema:
+ example: web-store
+ type: string
+ - description: Filter the outcomes by a specific state.
+ in: query
+ name: filter[outcome][state]
+ required: false
+ schema:
+ example: fail
+ type: string
+ - description: Filter outcomes on whether a rule is enabled/disabled.
+ in: query
+ name: filter[rule][enabled]
+ required: false
+ schema:
+ example: true
+ type: boolean
+ - description: Filter outcomes based on rule ID.
+ in: query
+ name: filter[rule][id]
+ required: false
+ schema:
+ example: f4485c79-0762-449c-96cf-c31e54a659f6
+ type: string
+ - description: Filter outcomes based on rule name.
+ in: query
+ name: filter[rule][name]
+ required: false
+ schema:
+ example: SLOs Defined
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OutcomesResponse'
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - apm_service_catalog_read
+ summary: List all rule outcomes
+ tags:
+ - Service Scorecards
+ x-pagination:
+ limitParam: page[size]
+ pageOffsetParam: page[offset]
+ resultsPath: data
+ x-unstable: '**Note**: This endpoint is in public beta.
+
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+ /api/v2/scorecard/outcomes/batch:
+ post:
+ description: Sets multiple service-rule outcomes in a single batched request.
+ operationId: CreateScorecardOutcomesBatch
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OutcomesBatchRequest'
+ description: Set of scorecard outcomes.
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OutcomesBatchResponse'
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - apm_service_catalog_write
+ summary: Create outcomes batch
+ tags:
+ - Service Scorecards
+ x-codegen-request-body-name: body
+ x-unstable: '**Note**: This endpoint is in private beta. To request access,
+ fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
+
+ and we will be in touch. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+ /api/v2/scorecard/rules:
+ get:
+ description: Fetch all rules.
+ operationId: ListScorecardRules
+ parameters:
+ - $ref: '#/components/parameters/PageSize'
+ - $ref: '#/components/parameters/PageOffset'
+ - description: Include related scorecard details in the response.
+ in: query
+ name: include
+ required: false
+ schema:
+ example: scorecard
+ type: string
+ - description: Filter the rules on a rule ID.
+ in: query
+ name: filter[rule][id]
+ required: false
+ schema:
+ example: 37d2f990-c885-4972-949b-8b798213a166
+ type: string
+ - description: Filter for enabled rules only.
+ in: query
+ name: filter[rule][enabled]
+ required: false
+ schema:
+ example: true
+ type: boolean
+ - description: Filter for custom rules only.
+ in: query
+ name: filter[rule][custom]
+ required: false
+ schema:
+ example: true
+ type: boolean
+ - description: Filter rules on the rule name.
+ in: query
+ name: filter[rule][name]
+ required: false
+ schema:
+ example: Code Repos Defined
+ type: string
+ - description: Filter rules on the rule description.
+ in: query
+ name: filter[rule][description]
+ required: false
+ schema:
+ example: Identifying
+ type: string
+ - description: Return only specific fields in the response for rule attributes.
+ in: query
+ name: fields[rule]
+ required: false
+ schema:
+ example: name, description
+ type: string
+ - description: Return only specific fields in the included response for scorecard
+ attributes.
+ in: query
+ name: fields[scorecard]
+ required: false
+ schema:
+ example: name
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListRulesResponse'
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - apm_service_catalog_read
+ summary: List all rules
+ tags:
+ - Service Scorecards
+ x-pagination:
+ limitParam: page[size]
+ pageOffsetParam: page[offset]
+ resultsPath: data
+ x-unstable: '**Note**: This endpoint is in public beta.
+
+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+ post:
+ description: Creates a new rule.
+ operationId: CreateScorecardRule
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateRuleRequest'
+ description: Rule attributes.
+ required: true
+ responses:
+ '201':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateRuleResponse'
+ description: Created
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - apm_service_catalog_write
+ summary: Create a new rule
+ tags:
+ - Service Scorecards
+ x-codegen-request-body-name: body
+ x-unstable: '**Note**: This endpoint is in private beta. To request access,
+ fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
+
+ and we will be in touch. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+ /api/v2/scorecard/rules/{rule_id}:
+ delete:
+ description: Deletes a single rule.
+ operationId: DeleteScorecardRule
+ parameters:
+ - $ref: '#/components/parameters/RuleId'
+ 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: []
+ - AuthZ:
+ - apm_service_catalog_write
+ summary: Delete a rule
+ tags:
+ - Service Scorecards
+ x-unstable: '**Note**: This endpoint is in private beta. To request access,
+ fill out this [sign-up form](https://forms.gle/CcEyp1uJmZpxRv8U8),
+
+ and we will be in touch. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/security/cloud_workload/policy/download:
get:
description: 'The download endpoint generates a Cloud Workload Security policy
file from your currently active
@@ -27492,31 +28531,44 @@
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/PageSize'
- description: Specifies the order of the returned teams
in: query
name: sort
+ required: false
schema:
$ref: '#/components/schemas/ListTeamsSort'
- description: 'Included related resources optionally requested. Allowed enum
values: `team_links, user_team_permissions`'
in: query
name: include
+ required: false
schema:
items:
$ref: '#/components/schemas/ListTeamsInclude'
type: array
- description: Search query. Can be team name, team handle, or email of team
member
in: query
name: filter[keyword]
+ required: false
schema:
type: string
- description: When true, only returns teams the current user belongs to
in: query
name: filter[me]
+ required: false
schema:
type: boolean
+ - description: List of fields that need to be fetched.
+ explode: false
+ in: query
+ name: fields[team]
+ required: false
+ schema:
+ items:
+ $ref: '#/components/schemas/TeamsField'
+ type: array
responses:
'200':
content:
application/json:
schema:
@@ -27927,15 +28979,17 @@
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- description: Specifies the order of returned team memberships
in: query
name: sort
+ required: false
schema:
$ref: '#/components/schemas/GetTeamMembershipsSort'
- description: Search query, can be user email or name
in: query
name: filter[keyword]
+ required: false
schema:
type: string
responses:
'200':
content:
@@ -29126,11 +30180,11 @@
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserResponse'
- description: OK for get user
+ description: OK
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
@@ -29382,10 +30436,12 @@
the Datadog API.
name: Confluent Cloud
- description: The Container Images API allows you to query Container Image data for
your organization.
name: Container Images
+- description: The Containers API allows you to query container data for your organization.
+ name: Containers
- description: 'Interact with your dashboard lists through the API to
organize, find, and share all of your dashboards with your team and
organization.'
@@ -29560,9 +30616,15 @@
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: 'API to create, update scorecard rules and outcomes.
+
+
+ This feature is currently in BETA. If you have any feedback, contact [Datadog
+ support](https://docs.datadoghq.com/help/).'
+ name: Service Scorecards
- description: Search and aggregate your spans from your Datadog platform over HTTP.
name: Spans
- description: Manage configuration of [span-based metrics](https://app.datadoghq.com/apm/traces/generate-metrics)
for your organization.
externalDocs: