.generator/schemas/v2/openapi.yaml in datadog_api_client-2.15.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.16.0
- old
+ new
@@ -232,25 +232,17 @@
name: include
required: false
schema:
$ref: '#/components/schemas/IncidentRelatedObject'
IncidentSearchQueryQueryParameter:
- description: 'Specifies which incidents should be returned. After entering a
- search query in your [Incidents page][1],
+ description: 'Specifies which incidents should be returned. The query can contain
+ any number of incident facets
- use the query parameter value in the URL of the page as the value for this
- parameter.
+ joined by `ANDs`, along with multiple values for each of those facets joined
+ by `OR`s. For
-
- The query can contain any number of incident facets joined by `ANDs`, along
- with multiple values for each of
-
- those facets joined by `OR`s, for instance: `query="state:active AND severity:(SEV-2
- OR SEV-1)"`.
-
-
- [1]: https://app.datadoghq.com/incidents'
+ example: `state:active AND severity:(SEV-2 OR SEV-1)`.'
explode: false
in: query
name: query
required: true
schema:
@@ -375,10 +367,17 @@
in: path
name: resource_id
required: true
schema:
type: string
+ RetentionFilterIdParam:
+ description: The ID of the retention filter.
+ in: path
+ name: filter_id
+ required: true
+ schema:
+ type: string
RoleID:
description: The unique identifier of the role.
in: path
name: role_id
required: true
@@ -699,10 +698,19 @@
- api_keys
example: api_keys
type: string
x-enum-varnames:
- API_KEYS
+ ApmRetentionFilterType:
+ default: apm_retention_filter
+ description: The type of the resource.
+ enum:
+ - apm_retention_filter
+ example: apm_retention_filter
+ type: string
+ x-enum-varnames:
+ - apm_retention_filter
ApplicationKeyCreateAttributes:
description: Attributes used to create an application Key.
properties:
name:
description: Name of the application key.
@@ -1758,11 +1766,10 @@
- pipeline_name
- start
- end
- status
- url
- - git
type: object
CIAppPipelineEventJobLevel:
default: job
description: Used to distinguish between pipelines, stages, jobs, and steps.
enum:
@@ -1911,11 +1918,10 @@
- url
- start
- end
- status
- partial_retry
- - git
type: object
CIAppPipelineEventPipelineLevel:
default: pipeline
description: Used to distinguish between pipelines, stages, jobs, and steps.
enum:
@@ -2027,11 +2033,10 @@
- pipeline_unique_id
- pipeline_name
- start
- end
- status
- - git
type: object
CIAppPipelineEventStageLevel:
default: stage
description: Used to distinguish between pipelines, stages, jobs and steps.
enum:
@@ -2127,11 +2132,10 @@
- pipeline_unique_id
- pipeline_name
- start
- end
- status
- - git
type: object
CIAppPipelineEventStepLevel:
default: step
description: Used to distinguish between pipelines, stages, jobs and steps.
enum:
@@ -3435,10 +3439,320 @@
description: The JSON:API data attribute.
items:
$ref: '#/components/schemas/ConfluentResourceResponseData'
type: array
type: object
+ ContainerImage:
+ description: Container Image object.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/ContainerImageAttributes'
+ id:
+ description: Container Image ID.
+ type: string
+ type:
+ $ref: '#/components/schemas/ContainerImageType'
+ type: object
+ ContainerImageAttributes:
+ description: Attributes for a Container Image.
+ properties:
+ container_count:
+ description: Number of containers running the image.
+ format: int64
+ type: integer
+ image_flavors:
+ description: 'List of platform-specific images associated with the image
+ record.
+
+ The list contains more than 1 entry for multi-architecture images.'
+ items:
+ $ref: '#/components/schemas/ContainerImageFlavor'
+ type: array
+ image_tags:
+ description: List of image tags associated with the Container Image.
+ items:
+ description: An image tag associated with the Container Image.
+ type: string
+ type: array
+ images_built_at:
+ description: 'List of build times associated with the Container Image.
+
+ The list contains more than 1 entry for multi-architecture images.'
+ items:
+ description: Time the platform-specific Container Image was built.
+ type: string
+ type: array
+ name:
+ description: Name of the Container Image.
+ type: string
+ os_architectures:
+ description: List of Operating System architectures supported by the Container
+ Image.
+ items:
+ description: Operating System architecture supported by the Container
+ Image.
+ example: amd64
+ type: string
+ type: array
+ os_names:
+ description: List of Operating System names supported by the Container Image.
+ items:
+ description: Operating System supported by the Container Image.
+ example: linux
+ type: string
+ type: array
+ os_versions:
+ description: List of Operating System versions supported by the Container
+ Image.
+ items:
+ description: Operating System version supported by the Container Image.
+ type: string
+ type: array
+ published_at:
+ description: Time the image was pushed to the container registry.
+ type: string
+ registry:
+ description: Registry the Container Image was pushed to.
+ type: string
+ repo_digest:
+ description: Digest of the compressed image manifest.
+ type: string
+ repository:
+ description: Repository where the Container Image is stored in.
+ type: string
+ short_image:
+ description: Short version of the Container Image name.
+ type: string
+ sizes:
+ description: 'List of size for each platform-specific image associated with
+ the image record.
+
+ The list contains more than 1 entry for multi-architecture images.'
+ items:
+ description: Size of the platform-specific Container Image.
+ format: int64
+ type: integer
+ type: array
+ sources:
+ description: List of sources where the Container Image was collected from.
+ items:
+ description: Source where the Container Image was collected from.
+ type: string
+ type: array
+ tags:
+ description: List of tags associated with the Container Image.
+ items:
+ description: A tag associated with the Container Image.
+ type: string
+ type: array
+ vulnerability_count:
+ $ref: '#/components/schemas/ContainerImageVulnerabilities'
+ type: object
+ ContainerImageFlavor:
+ description: Container Image breakdown by supported platform.
+ properties:
+ built_at:
+ description: Time the platform-specific Container Image was built.
+ type: string
+ os_architecture:
+ description: Operating System architecture supported by the Container Image.
+ type: string
+ os_name:
+ description: Operating System name supported by the Container Image.
+ type: string
+ os_version:
+ description: Operating System version supported by the Container Image.
+ type: string
+ size:
+ description: Size of the platform-specific Container Image.
+ format: int64
+ type: integer
+ type: object
+ ContainerImageGroup:
+ description: Container Image Group object.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/ContainerImageGroupAttributes'
+ id:
+ description: Container Image Group ID.
+ type: string
+ relationships:
+ $ref: '#/components/schemas/ContainerImageGroupRelationships'
+ type:
+ $ref: '#/components/schemas/ContainerImageGroupType'
+ type: object
+ ContainerImageGroupAttributes:
+ description: Attributes for a Container Image Group.
+ properties:
+ count:
+ description: Number of Container Images in the group.
+ format: int64
+ type: integer
+ name:
+ description: Name of the Container Image group.
+ type: string
+ tags:
+ description: Tags from the group name parsed in key/value format.
+ type: object
+ type: object
+ ContainerImageGroupImagesRelationshipsLink:
+ description: Relationships to Container Images inside a Container Image Group.
+ properties:
+ data:
+ $ref: '#/components/schemas/ContainerImageGroupRelationshipsData'
+ links:
+ $ref: '#/components/schemas/ContainerImageGroupRelationshipsLinks'
+ type: object
+ ContainerImageGroupRelationships:
+ description: Relationships inside a Container Image Group.
+ properties:
+ container_images:
+ $ref: '#/components/schemas/ContainerImageGroupImagesRelationshipsLink'
+ type: object
+ ContainerImageGroupRelationshipsData:
+ description: Links data.
+ items:
+ description: A link data.
+ type: string
+ type: array
+ ContainerImageGroupRelationshipsLinks:
+ description: Links attributes.
+ properties:
+ related:
+ description: Link to related Container Images.
+ type: string
+ type: object
+ ContainerImageGroupType:
+ default: container_image_group
+ description: Type of Container Image Group.
+ enum:
+ - container_image_group
+ example: container_image_group
+ type: string
+ x-enum-varnames:
+ - CONTAINER_IMAGE_GROUP
+ ContainerImageItem:
+ description: Possible Container Image models.
+ oneOf:
+ - $ref: '#/components/schemas/ContainerImage'
+ - $ref: '#/components/schemas/ContainerImageGroup'
+ ContainerImageMeta:
+ description: Response metadata object.
+ properties:
+ pagination:
+ $ref: '#/components/schemas/ContainerImageMetaPage'
+ type: object
+ ContainerImageMetaPage:
+ 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/ContainerImageMetaPageType'
+ type: object
+ ContainerImageMetaPageType:
+ default: cursor_limit
+ description: Type of Container Image pagination.
+ enum:
+ - cursor_limit
+ example: cursor_limit
+ type: string
+ x-enum-varnames:
+ - CURSOR_LIMIT
+ ContainerImageType:
+ default: container_image
+ description: Type of Container Image.
+ enum:
+ - container_image
+ example: container_image
+ type: string
+ x-enum-varnames:
+ - CONTAINER_IMAGE
+ ContainerImageVulnerabilities:
+ description: Vulnerability counts associated with the Container Image.
+ properties:
+ asset_id:
+ description: ID of the Container Image.
+ type: string
+ critical:
+ description: Number of vulnerabilities with CVSS Critical severity.
+ format: int64
+ type: integer
+ high:
+ description: Number of vulnerabilities with CVSS High severity.
+ format: int64
+ type: integer
+ low:
+ description: Number of vulnerabilities with CVSS Low severity.
+ format: int64
+ type: integer
+ medium:
+ description: Number of vulnerabilities with CVSS Medium severity.
+ format: int64
+ type: integer
+ none:
+ description: Number of vulnerabilities with CVSS None severity.
+ format: int64
+ type: integer
+ unknown:
+ description: Number of vulnerabilities with an unknown CVSS severity.
+ format: int64
+ type: integer
+ type: object
+ ContainerImagesResponse:
+ description: List of Container Images.
+ properties:
+ data:
+ description: Array of Container Image objects.
+ items:
+ $ref: '#/components/schemas/ContainerImageItem'
+ type: array
+ links:
+ $ref: '#/components/schemas/ContainerImagesResponseLinks'
+ meta:
+ $ref: '#/components/schemas/ContainerImageMeta'
+ type: object
+ ContainerImagesResponseLinks:
+ 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
@@ -3710,21 +4024,20 @@
name:
description: The name referencing the formula or query for this column.
example: a
type: string
type:
- description: The type of column present.
- example: number
- type: string
+ $ref: '#/components/schemas/ScalarColumnTypeNumber'
values:
description: The array of numerical values for one formula or query.
example:
- 0.5
items:
description: An individual value for a given column and group-by.
example: 0.5
format: double
+ nullable: true
type: number
type: array
type: object
DetailedFinding:
description: A single finding with with message and resource configuration.
@@ -5386,10 +5699,17 @@
$ref: '#/components/schemas/GCPServiceAccountType'
type: object
GCPSTSServiceAccountAttributes:
description: Attributes associated with your service account.
properties:
+ account_tags:
+ description: Tags to be associated with GCP metrics and service checks from
+ your account.
+ items:
+ description: Account Level Tag
+ type: string
+ type: array
automute:
description: Silence monitors for expected GCE instance shutdowns.
type: boolean
client_email:
description: Your service account email address.
@@ -5507,13 +5827,11 @@
name:
description: The name of the tag key or group.
example: env
type: string
type:
- description: The type of column present.
- example: group
- type: string
+ $ref: '#/components/schemas/ScalarColumnTypeGroup'
values:
description: The array of tag values for each group found for the results
of the formulas or queries.
example:
- - production
@@ -7649,10 +7967,28 @@
$ref: '#/components/schemas/ListFindingsMeta'
required:
- data
- meta
type: object
+ ListPowerpacksResponse:
+ description: Response object which includes all powerpack configurations.
+ properties:
+ data:
+ description: List of powerpack definitions.
+ items:
+ $ref: '#/components/schemas/PowerpackData'
+ type: array
+ included:
+ description: Array of objects related to the users.
+ items:
+ $ref: '#/components/schemas/User'
+ type: array
+ links:
+ $ref: '#/components/schemas/PowerpackResponseLinks'
+ meta:
+ $ref: '#/components/schemas/PowerpacksResponseMeta'
+ type: object
ListTeamsInclude:
description: Included related resources optionally requested.
enum:
- team_links
- user_team_permissions
@@ -10553,10 +10889,303 @@
- permissions
example: permissions
type: string
x-enum-varnames:
- PERMISSIONS
+ Powerpack:
+ description: Powerpacks are templated groups of dashboard widgets you can save
+ from an existing dashboard and turn into reusable packs in the widget tray.
+ properties:
+ data:
+ $ref: '#/components/schemas/PowerpackData'
+ type: object
+ PowerpackAttributes:
+ description: Powerpack attribute object.
+ properties:
+ description:
+ description: Description of this powerpack.
+ example: Powerpack for ABC
+ type: string
+ group_widget:
+ $ref: '#/components/schemas/PowerpackGroupWidget'
+ name:
+ description: Name of the powerpack.
+ example: Sample Powerpack
+ type: string
+ tags:
+ description: List of tags to identify this powerpack.
+ example:
+ - tag:foo1
+ items:
+ maxLength: 80
+ type: string
+ maxItems: 8
+ type: array
+ template_variables:
+ description: List of template variables for this powerpack.
+ example:
+ - defaults:
+ - '*'
+ name: test
+ items:
+ $ref: '#/components/schemas/PowerpackTemplateVariable'
+ type: array
+ required:
+ - group_widget
+ - name
+ type: object
+ PowerpackData:
+ description: Powerpack data object.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/PowerpackAttributes'
+ id:
+ description: ID of the powerpack.
+ type: string
+ relationships:
+ $ref: '#/components/schemas/PowerpackRelationships'
+ type:
+ description: Type of widget, must be powerpack.
+ example: powerpack
+ type: string
+ type: object
+ PowerpackGroupWidget:
+ description: Powerpack group widget definition object.
+ properties:
+ definition:
+ $ref: '#/components/schemas/PowerpackGroupWidgetDefinition'
+ layout:
+ $ref: '#/components/schemas/PowerpackGroupWidgetLayout'
+ required:
+ - definition
+ type: object
+ PowerpackGroupWidgetDefinition:
+ description: Powerpack group widget object.
+ properties:
+ layout_type:
+ description: Layout type of widgets.
+ example: ordered
+ type: string
+ show_title:
+ description: Boolean indicating whether powerpack group title should be
+ visible or not.
+ example: true
+ type: boolean
+ title:
+ description: Name for the group widget.
+ example: Sample Powerpack
+ type: string
+ type:
+ description: Type of widget, must be group.
+ example: group
+ type: string
+ widgets:
+ description: Widgets inside the powerpack.
+ example:
+ - definition:
+ content: example
+ type: note
+ layout:
+ height: 5
+ width: 10
+ x: 0
+ y: 0
+ items:
+ $ref: '#/components/schemas/PowerpackInnerWidgets'
+ type: array
+ required:
+ - widgets
+ - layout_type
+ - type
+ type: object
+ PowerpackGroupWidgetLayout:
+ description: Powerpack group widget layout.
+ properties:
+ height:
+ description: The height of the widget. Should be a non-negative integer.
+ example: 0
+ format: int64
+ minimum: 0
+ type: integer
+ width:
+ description: The width of the widget. Should be a non-negative integer.
+ example: 0
+ format: int64
+ minimum: 0
+ type: integer
+ x:
+ description: The position of the widget on the x (horizontal) axis. Should
+ be a non-negative integer.
+ example: 0
+ format: int64
+ minimum: 0
+ type: integer
+ y:
+ description: The position of the widget on the y (vertical) axis. Should
+ be a non-negative integer.
+ example: 0
+ format: int64
+ minimum: 0
+ type: integer
+ required:
+ - x
+ - y
+ - width
+ - height
+ type: object
+ PowerpackInnerWidgetLayout:
+ description: Powerpack inner widget layout.
+ properties:
+ height:
+ description: The height of the widget. Should be a non-negative integer.
+ example: 0
+ format: int64
+ minimum: 0
+ type: integer
+ width:
+ description: The width of the widget. Should be a non-negative integer.
+ example: 0
+ format: int64
+ minimum: 0
+ type: integer
+ x:
+ description: The position of the widget on the x (horizontal) axis. Should
+ be a non-negative integer.
+ example: 0
+ format: int64
+ minimum: 0
+ type: integer
+ y:
+ description: The position of the widget on the y (vertical) axis. Should
+ be a non-negative integer.
+ example: 0
+ format: int64
+ minimum: 0
+ type: integer
+ required:
+ - x
+ - y
+ - width
+ - height
+ type: object
+ PowerpackInnerWidgets:
+ description: Powerpack group widget definition of individual widgets.
+ properties:
+ definition:
+ additionalProperties: {}
+ description: Information about widget.
+ example:
+ definition:
+ content: example
+ type: note
+ type: object
+ layout:
+ $ref: '#/components/schemas/PowerpackInnerWidgetLayout'
+ required:
+ - definition
+ type: object
+ PowerpackRelationships:
+ description: Powerpack relationship object.
+ properties:
+ author:
+ $ref: '#/components/schemas/Creator'
+ type: object
+ PowerpackResponse:
+ description: Response object which includes a single powerpack configuration.
+ properties:
+ data:
+ $ref: '#/components/schemas/PowerpackData'
+ included:
+ description: Array of objects related to the users.
+ items:
+ $ref: '#/components/schemas/User'
+ type: array
+ readOnly: true
+ type: object
+ PowerpackResponseLinks:
+ description: Links attributes.
+ properties:
+ first:
+ description: Link to last page.
+ type: string
+ last:
+ description: Link to first page.
+ example: https://app.datadoghq.com/api/v2/powerpacks?page[offset]=0&page[limit]=25
+ nullable: true
+ type: string
+ next:
+ description: Link for the next set of results.
+ example: https://app.datadoghq.com/api/v2/powerpacks?page[offset]=25&page[limit]=25
+ type: string
+ prev:
+ description: Link for the previous set of results.
+ nullable: true
+ type: string
+ self:
+ description: Link to current page.
+ example: https://app.datadoghq.com/api/v2/powerpacks
+ type: string
+ type: object
+ PowerpackTemplateVariable:
+ description: Powerpack template variables.
+ properties:
+ defaults:
+ description: One or many template variable default values within the saved
+ view, which are unioned together using `OR` if more than one is specified.
+ items:
+ description: One or many default values of the template variable.
+ minLength: 1
+ type: string
+ type: array
+ name:
+ description: The name of the variable.
+ example: datacenter
+ type: string
+ required:
+ - name
+ type: object
+ PowerpacksResponseMeta:
+ description: Powerpack response metadata.
+ properties:
+ pagination:
+ $ref: '#/components/schemas/PowerpacksResponseMetaPagination'
+ type: object
+ PowerpacksResponseMetaPagination:
+ description: Powerpack response pagination metadata.
+ properties:
+ first_offset:
+ description: The first offset.
+ format: int64
+ type: integer
+ last_offset:
+ description: The last offset.
+ format: int64
+ type: integer
+ limit:
+ description: Pagination limit.
+ format: int64
+ type: integer
+ next_offset:
+ description: The next offset.
+ format: int64
+ type: integer
+ offset:
+ description: The offset.
+ format: int64
+ type: integer
+ prev_offset:
+ description: The previous offset.
+ format: int64
+ type: integer
+ total:
+ description: Total results.
+ format: int64
+ type: integer
+ type:
+ description: Offset type.
+ type: string
+ type: object
ProcessSummariesMeta:
description: Response metadata object.
properties:
page:
$ref: '#/components/schemas/ProcessSummariesMetaPage'
@@ -11720,10 +12349,21 @@
$ref: '#/components/schemas/RelationshipToUserData'
type: array
required:
- data
type: object
+ ReorderRetentionFiltersRequest:
+ description: A list of retention filters to reorder.
+ properties:
+ data:
+ description: A list of retention filters objects.
+ items:
+ $ref: '#/components/schemas/RetentionFilterWithoutAttributes'
+ type: array
+ required:
+ - data
+ type: object
ResponseMetaAttributes:
description: Object describing meta attributes of response.
properties:
page:
$ref: '#/components/schemas/Pagination'
@@ -11763,23 +12403,23 @@
properties:
principals:
description: 'An array of principals. A principal is a subject or group
of subjects.
- Each principal is formatted as `type:id`. Supported types: `role`, `team`
- (beta), `user` (beta), and `org`.
+ Each principal is formatted as `type:id`. Supported types: `role`, `team`,
+ `user`, and `org`.
The org ID can be obtained through the api/v2/current_user API.
The user principal type accepts service account IDs.'
example:
- role:00000000-0000-1111-0000-000000000000
items:
description: 'Subject or group of subjects. Each principal is formatted
as `type:id`.
- Supported types: `role`, `team` (beta), `user` (beta), and `org`.
+ Supported types: `role`, `team`, `user`, and `org`.
The org ID can be obtained through the api/v2/current_user API.
The user principal type accepts service account IDs.'
type: string
@@ -11815,10 +12455,259 @@
data:
$ref: '#/components/schemas/RestrictionPolicy'
required:
- data
type: object
+ RetentionFilter:
+ description: The definition of the retention filter.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/RetentionFilterAttributes'
+ id:
+ description: The ID of the retention filter.
+ example: 7RBOb7dLSYWI01yc3pIH8w
+ type: string
+ type:
+ $ref: '#/components/schemas/ApmRetentionFilterType'
+ required:
+ - id
+ - type
+ - attributes
+ type: object
+ RetentionFilterAll:
+ description: The definition of the retention filter.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/RetentionFilterAllAttributes'
+ id:
+ description: The ID of the retention filter.
+ example: 7RBOb7dLSYWI01yc3pIH8w
+ type: string
+ type:
+ $ref: '#/components/schemas/ApmRetentionFilterType'
+ required:
+ - id
+ - type
+ - attributes
+ type: object
+ RetentionFilterAllAttributes:
+ description: The attributes of the retention filter.
+ properties:
+ created_at:
+ description: The creation timestamp of the retention filter.
+ format: int64
+ type: integer
+ created_by:
+ description: The creator of the retention filter.
+ type: string
+ editable:
+ description: Shows whether the filter can be edited.
+ example: true
+ type: boolean
+ enabled:
+ description: The status of the retention filter (Enabled/Disabled).
+ example: true
+ type: boolean
+ execution_order:
+ description: The execution order of the retention filter.
+ format: int64
+ type: integer
+ filter:
+ $ref: '#/components/schemas/SpansFilter'
+ filter_type:
+ $ref: '#/components/schemas/RetentionFilterAllType'
+ modified_at:
+ description: The modification timestamp of the retention filter.
+ format: int64
+ type: integer
+ modified_by:
+ description: The modifier of the retention filter.
+ type: string
+ name:
+ description: The name of the retention filter.
+ example: my retention filter
+ type: string
+ rate:
+ description: 'Sample rate to apply to spans going through this retention
+ filter,
+
+ a value of 1.0 keeps all spans matching the query.'
+ example: 1.0
+ format: double
+ type: number
+ type: object
+ RetentionFilterAllType:
+ default: spans-sampling-processor
+ description: The type of retention filter.
+ enum:
+ - spans-sampling-processor
+ - spans-errors-sampling-processor
+ - spans-appsec-sampling-processor
+ type: string
+ x-enum-varnames:
+ - SPANS_SAMPLING_PROCESSOR
+ - SPANS_ERRORS_SAMPLING_PROCESSOR
+ - SPANS_APPSEC_SAMPLING_PROCESSOR
+ RetentionFilterAttributes:
+ description: The attributes of the retention filter.
+ properties:
+ created_at:
+ description: The creation timestamp of the retention filter.
+ format: int64
+ type: integer
+ created_by:
+ description: The creator of the retention filter.
+ type: string
+ editable:
+ description: Shows whether the filter can be edited.
+ example: true
+ type: boolean
+ enabled:
+ description: The status of the retention filter (Enabled/Disabled).
+ example: true
+ type: boolean
+ execution_order:
+ description: The execution order of the retention filter.
+ format: int64
+ type: integer
+ filter:
+ $ref: '#/components/schemas/SpansFilter'
+ filter_type:
+ $ref: '#/components/schemas/RetentionFilterType'
+ modified_at:
+ description: The modification timestamp of the retention filter.
+ format: int64
+ type: integer
+ modified_by:
+ description: The modifier of the retention filter.
+ type: string
+ name:
+ description: The name of the retention filter.
+ example: my retention filter
+ type: string
+ rate:
+ description: 'Sample rate to apply to spans going through this retention
+ filter,
+
+ a value of 1.0 keeps all spans matching the query.'
+ example: 1.0
+ format: double
+ type: number
+ type: object
+ RetentionFilterCreateAttributes:
+ description: The object describing the configuration of the retention filter
+ to create/update.
+ properties:
+ enabled:
+ description: Enable/Disable the retention filter.
+ example: true
+ type: boolean
+ filter:
+ $ref: '#/components/schemas/SpansFilterCreate'
+ filter_type:
+ $ref: '#/components/schemas/RetentionFilterType'
+ name:
+ description: The name of the retention filter.
+ example: my retention filter
+ type: string
+ rate:
+ description: 'Sample rate to apply to spans going through this retention
+ filter,
+
+ a value of 1.0 keeps all spans matching the query.'
+ example: 1.0
+ format: double
+ type: number
+ required:
+ - name
+ - filter
+ - enabled
+ - filter_type
+ - rate
+ type: object
+ RetentionFilterCreateData:
+ description: The body of the retention filter to be created.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/RetentionFilterCreateAttributes'
+ type:
+ $ref: '#/components/schemas/ApmRetentionFilterType'
+ required:
+ - attributes
+ - type
+ type: object
+ RetentionFilterCreateRequest:
+ description: The body of the retention filter to be created.
+ properties:
+ data:
+ $ref: '#/components/schemas/RetentionFilterCreateData'
+ required:
+ - data
+ type: object
+ RetentionFilterResponse:
+ description: The retention filters definition.
+ properties:
+ data:
+ $ref: '#/components/schemas/RetentionFilter'
+ type: object
+ RetentionFilterType:
+ default: spans-sampling-processor
+ description: The type of retention filter. The value should always be spans-sampling-processor.
+ enum:
+ - spans-sampling-processor
+ example: spans-sampling-processor
+ type: string
+ x-enum-varnames:
+ - SPANS_SAMPLING_PROCESSOR
+ RetentionFilterUpdateData:
+ description: The body of the retention filter to be updated.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/RetentionFilterCreateAttributes'
+ id:
+ description: The ID of the retention filter.
+ example: retention-filter-id
+ type: string
+ type:
+ $ref: '#/components/schemas/ApmRetentionFilterType'
+ required:
+ - id
+ - attributes
+ - type
+ type: object
+ RetentionFilterUpdateRequest:
+ description: The body of the retention filter to be updated.
+ properties:
+ data:
+ $ref: '#/components/schemas/RetentionFilterUpdateData'
+ required:
+ - data
+ type: object
+ RetentionFilterWithoutAttributes:
+ description: The retention filter object .
+ properties:
+ id:
+ description: The ID of the retention filter.
+ example: 7RBOb7dLSYWI01yc3pIH8w
+ type: string
+ type:
+ $ref: '#/components/schemas/ApmRetentionFilterType'
+ required:
+ - id
+ - type
+ type: object
+ RetentionFiltersResponse:
+ description: An ordered list of retention filters.
+ properties:
+ data:
+ description: A list of retention filters objects.
+ items:
+ $ref: '#/components/schemas/RetentionFilterAll'
+ type: array
+ required:
+ - data
+ type: object
Role:
description: Role object returned by the API.
properties:
attributes:
$ref: '#/components/schemas/RoleAttributes'
@@ -12109,10 +12998,28 @@
ScalarColumn:
description: A single column in a scalar query response.
oneOf:
- $ref: '#/components/schemas/GroupScalarColumn'
- $ref: '#/components/schemas/DataScalarColumn'
+ ScalarColumnTypeGroup:
+ default: group
+ description: The type of column present for groups.
+ enum:
+ - group
+ example: group
+ type: string
+ x-enum-varnames:
+ - GROUP
+ ScalarColumnTypeNumber:
+ default: number
+ description: The type of column present for numbers.
+ enum:
+ - number
+ example: number
+ type: string
+ x-enum-varnames:
+ - NUMBER
ScalarFormulaQueryRequest:
description: A wrapper request around one scalar query to be executed.
properties:
data:
$ref: '#/components/schemas/ScalarFormulaRequest'
@@ -12213,10 +13120,11 @@
`bytes per second`).
If the second element is not present, the API returns null.'
items:
$ref: '#/components/schemas/Unit'
+ nullable: true
type: array
type: object
ScalarQuery:
description: An individual scalar query to one of the basic Datadog data sources.
example:
@@ -14394,22 +15302,25 @@
description: Service definition schema.
oneOf:
- $ref: '#/components/schemas/ServiceDefinitionV1'
- $ref: '#/components/schemas/ServiceDefinitionV2'
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1'
+ - $ref: '#/components/schemas/ServiceDefinitionV2Dot2'
type: object
ServiceDefinitionSchemaVersions:
description: Schema versions
enum:
- v1
- v2
- v2.1
+ - v2.2
type: string
x-enum-varnames:
- V1
- V2
- V2_1
+ - V2_2
ServiceDefinitionV1:
deprecated: true
description: Deprecated - Service definition V1 for providing additional service
metadata and integrations.
properties:
@@ -14866,10 +15777,202 @@
- v2.1
example: v2.1
type: string
x-enum-varnames:
- V2_1
+ ServiceDefinitionV2Dot2:
+ description: Service definition v2.2 for providing service metadata and integrations.
+ properties:
+ application:
+ description: Identifier for a group of related services serving a product
+ feature, which the service is a part of.
+ example: my-app
+ type: string
+ contacts:
+ description: A list of contacts related to the services.
+ items:
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot2Contact'
+ type: array
+ dd-service:
+ description: Unique identifier of the service. Must be unique across all
+ services and is used to match with a service in Datadog.
+ example: my-service
+ type: string
+ description:
+ description: A short description of the service.
+ example: My service description
+ type: string
+ extensions:
+ additionalProperties: {}
+ description: Extensions to v2.2 schema.
+ example:
+ myorg/extension: extensionValue
+ type: object
+ integrations:
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot2Integrations'
+ langauges:
+ description: 'The service''s programming language. Datadog recognizes the
+ following languages: `dotnet`, `go`, `java`, `js`, `php`, `python`, `ruby`,
+ and `c++`.'
+ example:
+ - dotnet
+ - go
+ - java
+ - js
+ - php
+ - python
+ - ruby
+ - c++
+ items:
+ type: string
+ type: array
+ lifecycle:
+ description: The current life cycle phase of the service.
+ example: sandbox
+ type: string
+ links:
+ description: A list of links related to the services.
+ items:
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot2Link'
+ type: array
+ schema-version:
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot2Version'
+ tags:
+ description: A set of custom tags.
+ example:
+ - my:tag
+ - service:tag
+ items:
+ type: string
+ type: array
+ team:
+ description: Team that owns the service. It is used to locate a team defined
+ in Datadog Teams if it exists.
+ example: my-team
+ type: string
+ tier:
+ description: Importance of the service.
+ example: High
+ type: string
+ type:
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot2Type'
+ required:
+ - schema-version
+ - dd-service
+ type: object
+ ServiceDefinitionV2Dot2Contact:
+ description: Service owner's contacts information.
+ properties:
+ contact:
+ description: Contact value.
+ example: https://teams.microsoft.com/myteam
+ type: string
+ name:
+ description: Contact Name.
+ example: My team channel
+ type: string
+ type:
+ description: 'Contact type. Datadog recognizes the following types: `email`,
+ `slack`, and `microsoft-teams`.'
+ example: slack
+ type: string
+ required:
+ - type
+ - contact
+ type: object
+ ServiceDefinitionV2Dot2Integrations:
+ description: Third party integrations that Datadog supports.
+ properties:
+ opsgenie:
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot2Opsgenie'
+ pagerduty:
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot2Pagerduty'
+ type: object
+ ServiceDefinitionV2Dot2Link:
+ description: Service's external links.
+ properties:
+ name:
+ description: Link name.
+ example: Runbook
+ type: string
+ provider:
+ description: Link provider.
+ example: Github
+ type: string
+ type:
+ description: 'Link type. Datadog recognizes the following types: `runbook`,
+ `doc`, `repo`, `dashboard`, and `other`.'
+ example: runbook
+ type: string
+ url:
+ description: Link URL.
+ example: https://my-runbook
+ type: string
+ required:
+ - name
+ - type
+ - url
+ type: object
+ ServiceDefinitionV2Dot2Opsgenie:
+ description: Opsgenie integration for the service.
+ properties:
+ region:
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot2OpsgenieRegion'
+ service-url:
+ description: Opsgenie service url.
+ example: https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000
+ type: string
+ required:
+ - service-url
+ type: object
+ ServiceDefinitionV2Dot2OpsgenieRegion:
+ description: Opsgenie instance region.
+ enum:
+ - US
+ - EU
+ example: US
+ type: string
+ x-enum-varnames:
+ - US
+ - EU
+ ServiceDefinitionV2Dot2Pagerduty:
+ description: PagerDuty integration for the service.
+ properties:
+ service-url:
+ description: PagerDuty service url.
+ example: https://my-org.pagerduty.com/service-directory/PMyService
+ type: string
+ type: object
+ ServiceDefinitionV2Dot2Type:
+ description: The type of service.
+ enum:
+ - web
+ - db
+ - cache
+ - function
+ - browser
+ - mobile
+ - custom
+ example: web
+ type: string
+ x-enum-varnames:
+ - WEB
+ - DB
+ - CACHE
+ - FUNCTION
+ - BROSWER
+ - MOBILE
+ - CUSTOM
+ ServiceDefinitionV2Dot2Version:
+ default: v2.2
+ description: Schema version being used.
+ enum:
+ - v2.2
+ example: v2.2
+ type: string
+ x-enum-varnames:
+ - V2_2
ServiceDefinitionV2Email:
description: Service owner's email.
properties:
contact:
description: Contact value.
@@ -15049,10 +16152,11 @@
x-enum-varnames:
- V2
ServiceDefinitionsCreateRequest:
description: Create service definitions request.
oneOf:
+ - $ref: '#/components/schemas/ServiceDefinitionV2Dot2'
- $ref: '#/components/schemas/ServiceDefinitionV2Dot1'
- $ref: '#/components/schemas/ServiceDefinitionV2'
- $ref: '#/components/schemas/ServiceDefinitionRaw'
ServiceDefinitionsListResponse:
description: Create service definitions response.
@@ -15444,10 +16548,29 @@
- total
type: string
x-enum-varnames:
- TIMESERIES
- TOTAL
+ SpansFilter:
+ description: The spans filter used to index spans.
+ properties:
+ query:
+ description: The search query - following the [span search syntax](https://docs.datadoghq.com/tracing/trace_explorer/query_syntax/).
+ example: '@http.status_code:200 service:my-service'
+ type: string
+ type: object
+ SpansFilterCreate:
+ description: The spans filter. Spans matching this filter will be indexed and
+ stored.
+ properties:
+ query:
+ description: The search query - following the [span search syntax](https://docs.datadoghq.com/tracing/trace_explorer/query_syntax/).
+ example: '@http.status_code:200 service:my-service'
+ type: string
+ required:
+ - query
+ type: object
SpansGroupBy:
description: A group by rule.
properties:
facet:
description: The name of the facet to use (required).
@@ -17216,10 +18339,13 @@
authorizationUrl: /oauth2/v1/authorize
scopes:
apm_service_catalog_read: View service catalog and service definitions.
apm_service_catalog_write: Add, modify, and delete service catalog definitions
when those definitions are maintained by Datadog.
+ ci_visibility_pipelines_write: Create CI Visibility pipeline spans using
+ the API.
+ ci_visibility_read: View CI Visibility.
create_webhooks: Create webhooks integrations.
dashboards_public_share: Generate public and authenticated links to share
dashboards or embeddable graphs externally.
dashboards_read: View dashboards.
dashboards_write: Create and change dashboards.
@@ -17584,10 +18710,153 @@
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Update a span-based metric
tags:
- Spans Metrics
x-codegen-request-body-name: body
+ /api/v2/apm/config/retention-filters:
+ get:
+ description: Get the list of APM retention filters.
+ operationId: ListApmRetentionFilters
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RetentionFiltersResponse'
+ description: OK
+ '403':
+ $ref: '#/components/responses/NotAuthorizedResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: List all APM retention filters
+ tags:
+ - APM Retention Filters
+ post:
+ description: 'Create a retention filter to index spans in your organization.
+
+ Returns the retention filter definition when the request is successful.'
+ operationId: CreateApmRetentionFilter
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RetentionFilterCreateRequest'
+ description: The definition of the new retention filter.
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RetentionFilterResponse'
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/NotAuthorizedResponse'
+ '409':
+ $ref: '#/components/responses/ConflictResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Create a retention filter
+ tags:
+ - APM Retention Filters
+ x-codegen-request-body-name: body
+ /api/v2/apm/config/retention-filters-execution-order:
+ put:
+ description: Re-order the execution order of retention filters.
+ operationId: ReorderApmRetentionFilters
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ReorderRetentionFiltersRequest'
+ description: The list of retention filters in the new order.
+ required: true
+ responses:
+ '200':
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/NotAuthorizedResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Re-order retention filters
+ tags:
+ - APM Retention Filters
+ x-codegen-request-body-name: body
+ /api/v2/apm/config/retention-filters/{filter_id}:
+ delete:
+ description: Delete a specific retention filter from your organization.
+ operationId: DeleteApmRetentionFilter
+ parameters:
+ - $ref: '#/components/parameters/RetentionFilterIdParam'
+ responses:
+ '200':
+ description: OK
+ '403':
+ $ref: '#/components/responses/NotAuthorizedResponse'
+ '404':
+ $ref: '#/components/responses/NotFoundResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Delete a retention filter
+ tags:
+ - APM Retention Filters
+ get:
+ description: Get an APM retention filter.
+ operationId: GetApmRetentionFilter
+ parameters:
+ - $ref: '#/components/parameters/RetentionFilterIdParam'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RetentionFilterResponse'
+ description: OK
+ '403':
+ $ref: '#/components/responses/NotAuthorizedResponse'
+ '404':
+ $ref: '#/components/responses/NotFoundResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Get a given APM retention filter
+ tags:
+ - APM Retention Filters
+ put:
+ description: Update a retention filter from your organization.
+ operationId: UpdateApmRetentionFilter
+ parameters:
+ - $ref: '#/components/parameters/RetentionFilterIdParam'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RetentionFilterUpdateRequest'
+ description: The updated definition of the retention filter.
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RetentionFilterResponse'
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/NotAuthorizedResponse'
+ '404':
+ $ref: '#/components/responses/NotFoundResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Update a retention filter
+ tags:
+ - APM Retention Filters
+ x-codegen-request-body-name: body
/api/v2/application_keys:
get:
description: List all application keys available for your org
operationId: ListApplicationKeys
parameters:
@@ -18137,16 +19406,16 @@
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPCIAppErrors'
description: Service Unavailable
+ security:
+ - apiKeyAuth: []
summary: Send pipeline event
tags:
- CI Visibility Pipelines
x-codegen-request-body-name: body
- x-unstable: '**Note**: This API endpoint is in private beta. Request access
- [here](https://docs.google.com/forms/d/e/1FAIpQLSdNejCvhMbdBW5nnGly1yvmYMn2Wpj4JOI0zKIiEx6O6I2dbQ/viewform).'
/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
@@ -18167,10 +19436,15 @@
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - ci_visibility_read
summary: Aggregate pipelines events
tags:
- CI Visibility Pipelines
x-codegen-request-body-name: body
/api/v2/ci/pipelines/events:
@@ -18242,10 +19516,15 @@
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - ci_visibility_read
summary: Get a list of pipelines events
tags:
- CI Visibility Pipelines
x-pagination:
cursorParam: page[cursor]
@@ -18279,10 +19558,15 @@
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - ci_visibility_read
summary: Search pipelines events
tags:
- CI Visibility Pipelines
x-codegen-request-body-name: body
x-pagination:
@@ -18312,10 +19596,15 @@
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - ci_visibility_read
summary: Aggregate tests events
tags:
- CI Visibility Tests
x-codegen-request-body-name: body
/api/v2/ci/tests/events:
@@ -18387,10 +19676,15 @@
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - ci_visibility_read
summary: Get a list of tests events
tags:
- CI Visibility Tests
x-pagination:
cursorParam: page[cursor]
@@ -18424,19 +19718,104 @@
$ref: '#/components/responses/BadRequestResponse'
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - ci_visibility_read
summary: Search tests events
tags:
- CI Visibility Tests
x-codegen-request-body-name: body
x-pagination:
cursorParam: body.page.cursor
cursorPath: meta.page.after
limitParam: body.page.limit
resultsPath: data
+ /api/v2/container_images:
+ get:
+ description: Get all Container Images for your organization.
+ operationId: ListContainerImages
+ parameters:
+ - description: Comma-separated list of tags to filter Container Images by.
+ example: short_image:redis,status:running
+ in: query
+ name: filter[tags]
+ required: false
+ schema:
+ type: string
+ - description: Comma-separated list of tags to group Container Images by.
+ example: registry,image_tags
+ in: query
+ name: group_by
+ required: false
+ schema:
+ type: string
+ - description: Attribute to sort Container Images by.
+ example: container_count
+ in: query
+ name: sort
+ required: false
+ schema:
+ type: string
+ - description: Maximum number of results returned.
+ in: query
+ name: page[size]
+ required: false
+ schema:
+ default: 1000
+ format: int32
+ maximum: 10000
+ minimum: 1
+ type: integer
+ - description: 'String to query the next page of results.
+
+ This key is provided with each valid response from the API in `meta.pagination.next_cursor`.'
+ in: query
+ name: page[cursor]
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ContainerImagesResponse'
+ 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 Container Images
+ tags:
+ - Container Images
+ 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:
@@ -22894,10 +24273,191 @@
- 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:
+ description: Get a list of all powerpacks.
+ operationId: ListPowerpacks
+ parameters:
+ - description: Maximum number of powerpacks in the response.
+ example: 25
+ in: query
+ name: page[limit]
+ required: false
+ schema:
+ default: 25
+ format: int64
+ maximum: 1000
+ type: integer
+ - $ref: '#/components/parameters/PageOffset'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListPowerpacksResponse'
+ description: OK
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - dashboards_read
+ summary: Get all powerpacks
+ tags:
+ - Powerpack
+ x-pagination:
+ limitParam: page[limit]
+ pageOffsetParam: page[offset]
+ resultsPath: data
+ post:
+ description: Create a powerpack.
+ operationId: CreatePowerpack
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Powerpack'
+ description: Create a powerpack request body.
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PowerpackResponse'
+ description: OK
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Bad Request
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - dashboards_write
+ summary: Create a new powerpack
+ tags:
+ - Powerpack
+ x-codegen-request-body-name: body
+ /api/v2/powerpacks/{powerpack_id}:
+ delete:
+ description: Delete a powerpack.
+ operationId: DeletePowerpack
+ parameters:
+ - description: Powerpack id
+ in: path
+ name: powerpack_id
+ required: true
+ schema:
+ type: string
+ responses:
+ '204':
+ description: OK
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Powerpack Not Found
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - dashboards_write
+ summary: Delete a powerpack
+ tags:
+ - Powerpack
+ get:
+ description: Get a powerpack.
+ operationId: GetPowerpack
+ parameters:
+ - description: ID of the powerpack.
+ in: path
+ name: powerpack_id
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PowerpackResponse'
+ description: OK
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Powerpack Not Found.
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - dashboards_read
+ summary: Get a Powerpack
+ tags:
+ - Powerpack
+ patch:
+ description: Update a powerpack.
+ operationId: UpdatePowerpack
+ parameters:
+ - description: ID of the powerpack.
+ in: path
+ name: powerpack_id
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Powerpack'
+ description: Update a powerpack request body.
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PowerpackResponse'
+ description: OK
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Bad Request
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Powerpack Not Found
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ:
+ - dashboards_write
+ summary: Update a powerpack
+ tags:
+ - Powerpack
+ x-codegen-request-body-name: body
/api/v2/processes:
get:
description: Get all processes for your organization.
operationId: ListProcesses
parameters:
@@ -25960,10 +27520,12 @@
content:
application/json:
schema:
$ref: '#/components/schemas/TeamsResponse'
description: OK
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
@@ -25992,10 +27554,12 @@
content:
application/json:
schema:
$ref: '#/components/schemas/TeamResponse'
description: CREATED
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
@@ -26024,10 +27588,12 @@
schema:
type: string
responses:
'204':
description: No Content
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
@@ -26058,10 +27624,12 @@
content:
application/json:
schema:
$ref: '#/components/schemas/TeamResponse'
description: OK
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
@@ -26107,10 +27675,12 @@
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: API error response.
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
@@ -26148,10 +27718,12 @@
content:
application/json:
schema:
$ref: '#/components/schemas/TeamLinksResponse'
description: OK
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
@@ -26187,10 +27759,12 @@
content:
application/json:
schema:
$ref: '#/components/schemas/TeamLinkResponse'
description: OK
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
@@ -26230,10 +27804,12 @@
schema:
type: string
responses:
'204':
description: No Content
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
@@ -26269,10 +27845,12 @@
content:
application/json:
schema:
$ref: '#/components/schemas/TeamLinkResponse'
description: OK
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
@@ -26314,10 +27892,12 @@
content:
application/json:
schema:
$ref: '#/components/schemas/TeamLinkResponse'
description: OK
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
@@ -26361,10 +27941,12 @@
content:
application/json:
schema:
$ref: '#/components/schemas/UserTeamsResponse'
description: Represents a user's association to a team
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
@@ -26400,10 +27982,12 @@
content:
application/json:
schema:
$ref: '#/components/schemas/UserTeamResponse'
description: Represents a user's association to a team
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
@@ -26443,10 +28027,12 @@
schema:
type: string
responses:
'204':
description: No Content
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
@@ -26488,10 +28074,12 @@
content:
application/json:
schema:
$ref: '#/components/schemas/UserTeamResponse'
description: Represents a user's association to a team
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
@@ -26523,10 +28111,12 @@
content:
application/json:
schema:
$ref: '#/components/schemas/TeamPermissionSettingsResponse'
description: OK
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
@@ -26569,10 +28159,12 @@
content:
application/json:
schema:
$ref: '#/components/schemas/TeamPermissionSettingResponse'
description: OK
+ '403':
+ $ref: '#/components/responses/ForbiddenResponse'
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
@@ -27070,16 +28662,18 @@
- description: 'Comma separated list of product families to retrieve. Available
families are `all`, `analyzed_logs`,
`application_security`, `audit_trail`, `serverless`, `ci_app`, `cloud_cost_management`,
- `cspm`, `custom_events`, `cws`, `dbm`, `fargate`,
+ `csm_container_enterprise`, `csm_host_enterprise`, `cspm`, `custom_events`,
+ `cws`, `dbm`, `fargate`,
`infra_hosts`, `incident_management`, `indexed_logs`, `indexed_spans`, `ingested_spans`,
`iot`,
- `lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `observability_pipelines`,
+ `lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `netflow_monitoring`,
+ `observability_pipelines`,
`online_archive`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`,
`sds`, `snmp`,
`synthetics_api`, `synthetics_browser`, `synthetics_mobile`, `synthetics_parallel_testing`,
@@ -27756,10 +29350,17 @@
description: Any Datadog deployment.
subdomain:
default: api
description: The subdomain where the API is deployed.
tags:
+- description: Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters)
+ for your organization. You need an API and application key with Admin rights to
+ interact with this endpoint.
+ externalDocs:
+ description: Find out more at
+ url: https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/
+ name: APM Retention Filters
- description: Search your Audit Logs events over HTTP.
name: Audit
- description: '[AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)
is used to automatically map group of users to roles in Datadog using attributes
@@ -27778,10 +29379,13 @@
Datadog API.
name: Cloudflare Integration
- description: Configure your Datadog Confluent Cloud integration directly through
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: 'Interact with your dashboard lists through the API to
organize, find, and share all of your dashboards with your team and
organization.'
@@ -27899,18 +29503,34 @@
accounts](https://docs.datadoghq.com/account_management/multi_organization).
externalDocs:
description: Find out more at
url: https://docs.datadoghq.com/account_management/multi_organization
name: Organizations
+- description: 'The powerpack endpoints allow you to:
+
+
+ - Get a powerpack
+
+ - Create a powerpack
+
+ - Delete a powerpack
+
+ - Get a list of all powerpacks
+
+
+ The Patch and Delete API methods can only be performed on a powerpack by
+
+ a user who has the powerpack create permission for that specific powerpack.'
+ name: Powerpack
- description: The processes API allows you to query processes data for your organization.
name: Processes
- description: Search or aggregate your RUM events over HTTP.
name: RUM
- description: 'A restriction policy defines the access control rules for a resource,
mapping a set of relations
- (such as editor and viewer) to a set of allowed principals (such as roles, teams
- (beta), or users (beta)).
+ (such as editor and viewer) to a set of allowed principals (such as roles, teams,
+ or users).
The restriction policy determines who is authorized to perform what actions on
the resource.'
name: Restriction Policies
- description: 'The Roles API is used to create and manage Datadog roles, what