.generator/schemas/v2/openapi.yaml in datadog_api_client-2.17.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.18.0

- old
+ new

@@ -687,11 +687,31 @@ included: description: Array of objects related to the API key. items: $ref: '#/components/schemas/APIKeyResponseIncludedItem' type: array + meta: + $ref: '#/components/schemas/APIKeysResponseMeta' type: object + APIKeysResponseMeta: + description: Additional information related to api keys response. + properties: + max_allowed: + description: Max allowed number of API keys. + format: int64 + type: integer + page: + $ref: '#/components/schemas/APIKeysResponseMetaPage' + type: object + APIKeysResponseMetaPage: + description: Additional information related to the API keys response. + properties: + total_filtered_count: + description: Total filtered application key count. + format: int64 + type: integer + type: object APIKeysSort: default: name description: Sorting options enum: - created_at @@ -719,10 +739,51 @@ - api_keys example: api_keys type: string x-enum-varnames: - API_KEYS + ActiveBillingDimensionsAttributes: + description: List of active billing dimensions. + properties: + month: + description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.' + format: date-time + type: string + values: + description: 'List of active billing dimensions. Example: `[infra_host, + apm_host, serverless_infra]`.' + items: + description: A given billing dimension in a list. + example: infra_host + type: string + type: array + type: object + ActiveBillingDimensionsBody: + description: Active billing dimensions data. + properties: + attributes: + $ref: '#/components/schemas/ActiveBillingDimensionsAttributes' + id: + description: Unique ID of the response. + type: string + type: + $ref: '#/components/schemas/ActiveBillingDimensionsType' + type: object + ActiveBillingDimensionsResponse: + description: Active billing dimensions response. + properties: + data: + $ref: '#/components/schemas/ActiveBillingDimensionsBody' + type: object + ActiveBillingDimensionsType: + default: billing_dimensions + description: Type of active billing dimensions data. + enum: + - billing_dimensions + type: string + x-enum-varnames: + - BILLING_DIMENSIONS ApmRetentionFilterType: default: apm_retention_filter description: The type of the resource. enum: - apm_retention_filter @@ -790,10 +851,28 @@ ApplicationKeyResponseIncludedItem: description: An object related to an application key. oneOf: - $ref: '#/components/schemas/User' - $ref: '#/components/schemas/Role' + ApplicationKeyResponseMeta: + description: Additional information related to the application key response. + properties: + max_allowed_per_user: + description: Max allowed number of application keys per user. + format: int64 + type: integer + page: + $ref: '#/components/schemas/ApplicationKeyResponseMetaPage' + type: object + ApplicationKeyResponseMetaPage: + description: Additional information related to the application key response. + properties: + total_filtered_count: + description: Total filtered application key count. + format: int64 + type: integer + type: object ApplicationKeyUpdateAttributes: description: Attributes used to update an application Key. properties: name: description: Name of the application key. @@ -2961,10 +3040,15 @@ type: boolean expression: description: The SECL expression of the Agent rule. example: exec.file.name == \"sh\" type: string + filters: + description: The platforms the Agent rule is supported on. + items: + type: string + type: array name: description: The name of the Agent rule. example: my_agent_rule type: string updateAuthorUuId: @@ -4080,10 +4164,67 @@ type: string x-enum-varnames: - IDENTITY - GZIP - DEFLATE + CostAttributionAggregates: + description: An array of available aggregates. + items: + $ref: '#/components/schemas/CostAttributionAggregatesBody' + type: array + CostAttributionAggregatesBody: + description: The object containing the aggregates. + properties: + agg_type: + description: The aggregate type. + example: sum + type: string + field: + description: The field. + example: infra_host_committed_cost + type: string + value: + description: The value for a given field. + format: double + type: number + type: object + CostAttributionTagNames: + additionalProperties: + description: 'A list of values that are associated with each tag key. + + - An empty list means the resource use wasn''t tagged with the respective + tag. + + - Multiple values means the respective tag was applied multiple times on + the resource. + + - An `<empty>` value means the resource was tagged with the respective tag + but did not have a value.' + items: + description: A given tag in a list. + example: datadog-integrations-lab + type: string + type: array + description: 'Tag keys and values. + + A `null` value here means that the requested tag breakdown cannot be applied + because it does not match the [tags + + configured for usage attribution](https://docs.datadoghq.com/account_management/billing/usage_attribution/#getting-started). + + In this scenario the API returns the total cost, not broken down by tags.' + nullable: true + type: object + CostAttributionType: + default: cost_by_tag + description: Type of cost attribution data. + enum: + - cost_by_tag + example: cost_by_tag + type: string + x-enum-varnames: + - COST_BY_TAG CostByOrg: description: Cost data. properties: attributes: $ref: '#/components/schemas/CostByOrgAttributes' @@ -4182,10 +4323,182 @@ name: description: Name of the creator. nullable: true type: string type: object + DORADeploymentRequest: + description: Request to create a DORA deployment event. + properties: + data: + $ref: '#/components/schemas/DORADeploymentRequestData' + required: + - data + type: object + DORADeploymentRequestAttributes: + description: Attributes to create a DORA deployment event. + properties: + finished_at: + description: Unix timestamp in nanoseconds when the deployment finished. + It should not be older than 3 hours. + example: 1693491984000000000 + format: int64 + type: integer + git: + $ref: '#/components/schemas/DORAGitInfo' + id: + description: Deployment ID. + type: string + service: + description: Service name from a service available in the Service Catalog. + example: shopist + type: string + started_at: + description: Unix timestamp in nanoseconds when the deployment started. + example: 1693491974000000000 + format: int64 + type: integer + version: + description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/). + example: v1.12.07 + type: string + required: + - service + - started_at + - finished_at + type: object + DORADeploymentRequestData: + description: The JSON:API data. + properties: + attributes: + $ref: '#/components/schemas/DORADeploymentRequestAttributes' + required: + - attributes + type: object + DORADeploymentResponse: + description: Response after receiving a DORA deployment event. + properties: + data: + $ref: '#/components/schemas/DORADeploymentResponseData' + required: + - data + type: object + DORADeploymentResponseData: + description: The JSON:API data. + properties: + id: + description: The ID of the received DORA deployment event. + example: 4242fcdd31586083 + type: string + type: + $ref: '#/components/schemas/DORADeploymentType' + required: + - id + type: object + DORADeploymentType: + default: dora_deployment + description: JSON:API type for DORA deployment events. + enum: + - dora_deployment + example: dora_deployment + type: string + x-enum-varnames: + - DORA_DEPLOYMENT + DORAGitInfo: + description: Git info for DORA Metrics events. + properties: + commit_sha: + $ref: '#/components/schemas/GitCommitSHA' + repository_url: + $ref: '#/components/schemas/GitRepositoryURL' + required: + - repository_url + - commit_sha + type: object + DORAIncidentRequest: + description: Request to create a DORA incident event. + properties: + data: + $ref: '#/components/schemas/DORAIncidentRequestData' + required: + - data + type: object + DORAIncidentRequestAttributes: + description: Attributes to create a DORA incident event. + properties: + finished_at: + description: Unix timestamp in nanoseconds when the incident finished. It + should not be older than 3 hours. + example: 1693491984000000000 + format: int64 + type: integer + git: + $ref: '#/components/schemas/DORAGitInfo' + id: + description: Incident ID + type: string + name: + description: Incident name. + example: Webserver is down failing all requests + type: string + service: + description: Service name from a service available in the Service Catalog. + example: shopist + type: string + severity: + description: Incident severity. + example: High + type: string + started_at: + description: Unix timestamp in nanoseconds when the incident started. + example: 1693491974000000000 + format: int64 + type: integer + version: + description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/). + example: v1.12.07 + type: string + required: + - service + - started_at + type: object + DORAIncidentRequestData: + description: The JSON:API data. + properties: + attributes: + $ref: '#/components/schemas/DORAIncidentRequestAttributes' + required: + - attributes + type: object + DORAIncidentResponse: + description: Response after receiving a DORA incident event. + properties: + data: + $ref: '#/components/schemas/DORAIncidentResponseData' + required: + - data + type: object + DORAIncidentResponseData: + description: Response after receiving a DORA incident event. + properties: + id: + description: The ID of the received DORA incident event. + example: 4242fcdd31586083 + type: string + type: + $ref: '#/components/schemas/DORAIncidentType' + required: + - id + type: object + DORAIncidentType: + default: dora_incident + description: JSON:API type for DORA incident events. + enum: + - dora_incident + example: dora_incident + type: string + x-enum-varnames: + - DORA_INCIDENT DashboardListAddItemsRequest: description: Request containing a list of dashboards to add. properties: dashboards: description: List of dashboards to add the dashboard list. @@ -5925,10 +6238,13 @@ $ref: '#/components/schemas/APIKeysType' type: object FullAPIKeyAttributes: description: Attributes of a full API key. properties: + category: + description: The category of the API key. + type: string created_at: description: Creation date of the API key. example: '2020-11-23T10:00:00.000Z' readOnly: true type: string @@ -5950,10 +6266,13 @@ type: string name: description: Name of the API key. example: API Key for submitting metrics type: string + remote_config_read_enabled: + description: The remote config read enabled status. + type: boolean type: object FullApplicationKey: description: Datadog application key. properties: attributes: @@ -6171,10 +6490,19 @@ - _NAME - HANDLE - _HANDLE - EMAIL - _EMAIL + GitCommitSHA: + description: Git Commit SHA. + example: 66adc9350f2cc9b250b69abddab733dd55e1a588 + pattern: ^[a-fA-F0-9]{40,}$ + type: string + GitRepositoryURL: + description: Git Repository URL + example: https://github.com/organization/example-repository + type: string GroupScalarColumn: description: A column containing the tag keys and values in a group. properties: name: description: The name of the tag key or group. @@ -6564,10 +6892,15 @@ properties: attachment: $ref: '#/components/schemas/IncidentAttachmentLinkAttributesAttachmentObject' attachment_type: $ref: '#/components/schemas/IncidentAttachmentLinkAttachmentType' + modified: + description: Timestamp when the incident attachment link was last modified. + format: date-time + readOnly: true + type: string required: - attachment_type - attachment type: object IncidentAttachmentLinkAttributesAttachmentObject: @@ -6869,13 +7202,26 @@ x-enum-varnames: - MULTISELECT - TEXTARRAY - METRICTAG - AUTOCOMPLETE + IncidentImpactsType: + description: The incident impacts type. + enum: + - incident_impacts + example: incident_impacts + type: string + x-enum-varnames: + - INCIDENT_IMPACTS IncidentIntegrationMetadataAttributes: description: Incident integration metadata's attributes for a create request. properties: + created: + description: Timestamp when the incident todo was created. + format: date-time + readOnly: true + type: string incident_id: description: UUID of the incident this integration metadata is connected to. example: 00000000-aaaa-0000-0000-000000000000 type: string @@ -6888,10 +7234,15 @@ format: int32 maximum: 9 type: integer metadata: $ref: '#/components/schemas/IncidentIntegrationMetadataMetadata' + modified: + description: Timestamp when the incident todo was last modified. + format: date-time + readOnly: true + type: string status: description: 'A number indicating the status of this integration metadata. 0 indicates unknown; 1 indicates pending; 2 indicates complete; 3 indicates manually created; @@ -6987,10 +7338,12 @@ $ref: '#/components/schemas/IncidentIntegrationMetadataAttributes' id: description: The incident integration metadata's ID. example: 00000000-0000-0000-1234-000000000000 type: string + relationships: + $ref: '#/components/schemas/IncidentIntegrationRelationships' type: $ref: '#/components/schemas/IncidentIntegrationMetadataType' required: - id - type @@ -7007,10 +7360,29 @@ - incident_integrations example: incident_integrations type: string x-enum-varnames: - INCIDENT_INTEGRATIONS + IncidentIntegrationRelationships: + description: The incident's integration relationships from a response. + properties: + created_by_user: + $ref: '#/components/schemas/RelationshipToUser' + last_modified_by_user: + $ref: '#/components/schemas/RelationshipToUser' + type: object + IncidentNonDatadogCreator: + description: Incident's non Datadog creator. + nullable: true + properties: + image_48_px: + description: Non Datadog creator `48px` image. + type: string + name: + description: Non Datadog creator name. + type: string + type: object IncidentNotificationHandle: description: A notification handle that will be notified at incident creation. properties: display_name: description: The name of the notified handle. @@ -7037,10 +7409,18 @@ - attachments type: string x-enum-varnames: - USERS - ATTACHMENTS + IncidentRespondersType: + description: The incident responders type. + enum: + - incident_responders + example: incident_responders + type: string + x-enum-varnames: + - INCIDENT_RESPONDERS IncidentResponse: description: Response with an incident. properties: data: $ref: '#/components/schemas/IncidentResponseData' @@ -7054,10 +7434,21 @@ - data type: object IncidentResponseAttributes: description: The incident's attributes from a response. properties: + archived: + description: Timestamp of when the incident was archived. + format: date-time + nullable: true + readOnly: true + type: string + case_id: + description: The incident case id. + format: int64 + nullable: true + type: integer created: description: Timestamp when the incident was created. format: date-time readOnly: true type: string @@ -7104,10 +7495,12 @@ modified: description: Timestamp when the incident was last modified. format: date-time readOnly: true type: string + non_datadog_creator: + $ref: '#/components/schemas/IncidentNonDatadogCreator' notification_handles: description: Notification handles that will be notified of the incident during update. items: $ref: '#/components/schemas/IncidentNotificationHandle' @@ -7122,10 +7515,16 @@ description: Timestamp when the incident's state was last changed from active or stable to resolved or completed. format: date-time nullable: true type: string + severity: + $ref: '#/components/schemas/IncidentSeverity' + state: + description: The state incident. + nullable: true + type: string time_to_detect: description: 'The amount of time in seconds to detect the incident. Equals the difference between `customer_impact_start` and `detected`.' format: int64 @@ -7152,10 +7551,14 @@ type: integer title: description: The title of the incident, which summarizes what happened. example: A test incident title type: string + visibility: + description: The incident visibility status. + nullable: true + type: string required: - title type: object IncidentResponseData: description: Incident data from a response. @@ -7213,14 +7616,20 @@ $ref: '#/components/schemas/RelationshipToIncidentAttachment' commander_user: $ref: '#/components/schemas/NullableRelationshipToUser' created_by_user: $ref: '#/components/schemas/RelationshipToUser' + impacts: + $ref: '#/components/schemas/RelationshipToIncidentImpacts' integrations: $ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas' last_modified_by_user: $ref: '#/components/schemas/RelationshipToUser' + responders: + $ref: '#/components/schemas/RelationshipToIncidentResponders' + user_defined_fields: + $ref: '#/components/schemas/RelationshipToIncidentUserDefinedFields' type: object IncidentSearchResponse: description: Response with incidents and facets. properties: data: @@ -7599,10 +8008,28 @@ meta: $ref: '#/components/schemas/IncidentResponseMeta' required: - data type: object + IncidentSeverity: + description: The incident severity. + enum: + - UNKNOWN + - SEV-1 + - SEV-2 + - SEV-3 + - SEV-4 + - SEV-5 + example: UNKNOWN + type: string + x-enum-varnames: + - UNKNOWN + - SEV_1 + - SEV_2 + - SEV_3 + - SEV_4 + - SEV_5 IncidentTeamCreateAttributes: description: The incident team's attributes for a create request. properties: name: description: Name of the incident team. @@ -7858,19 +8285,29 @@ type: string content: description: The follow-up task's content. example: Restore lost data. type: string + created: + description: Timestamp when the incident todo was created. + format: date-time + readOnly: true + type: string due_date: description: Timestamp when the todo should be completed by. example: '2023-07-10T05:00:00.000000+00:00' nullable: true type: string incident_id: description: UUID of the incident this todo is connected to. example: 00000000-aaaa-0000-0000-000000000000 type: string + modified: + description: Timestamp when the incident todo was last modified. + format: date-time + readOnly: true + type: string required: - content - assignees type: object IncidentTodoCreateData: @@ -7928,10 +8365,18 @@ data: $ref: '#/components/schemas/IncidentTodoPatchData' required: - data type: object + IncidentTodoRelationships: + description: The incident's relationships from a response. + properties: + created_by_user: + $ref: '#/components/schemas/RelationshipToUser' + last_modified_by_user: + $ref: '#/components/schemas/RelationshipToUser' + type: object IncidentTodoResponse: description: Response with an incident todo. properties: data: $ref: '#/components/schemas/IncidentTodoResponseData' @@ -7951,10 +8396,12 @@ $ref: '#/components/schemas/IncidentTodoAttributes' id: description: The incident todo's ID. example: 00000000-0000-0000-1234-000000000000 type: string + relationships: + $ref: '#/components/schemas/IncidentTodoRelationships' type: $ref: '#/components/schemas/IncidentTodoType' required: - id - type @@ -8061,10 +8508,18 @@ data: $ref: '#/components/schemas/IncidentUpdateData' required: - data type: object + IncidentUserDefinedFieldType: + description: The incident user defined fields type. + enum: + - user_defined_field + example: user_defined_field + type: string + x-enum-varnames: + - USER_DEFINED_FIELD IncidentsResponse: description: Response with a list of incidents. properties: data: description: An array of incidents. @@ -8259,10 +8714,12 @@ included: description: Array of objects related to the application key. items: $ref: '#/components/schemas/ApplicationKeyResponseIncludedItem' type: array + meta: + $ref: '#/components/schemas/ApplicationKeyResponseMeta' type: object ListDowntimesResponse: description: Response for retrieving all downtimes. properties: data: @@ -10751,12 +11208,82 @@ type: string type: description: The monitor type. type: string type: object + MonthlyCostAttributionAttributes: + description: Cost Attribution by Tag for a given organization. + properties: + month: + description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.' + format: date-time + type: string + org_name: + description: The name of the organization. + type: string + public_id: + description: The organization public ID. + type: string + tag_config_source: + description: The source of the cost attribution tag configuration and the + selected tags in the format `<source_org_name>:::<selected tag 1>///<selected + tag 2>///<selected tag 3>`. + type: string + tags: + $ref: '#/components/schemas/CostAttributionTagNames' + updated_at: + description: Shows the most recent hour in the current months for all organizations + for which all costs were calculated. + type: string + values: + description: 'Fields in Cost Attribution by tag(s). Example: `infra_host_on_demand_cost`, + `infra_host_committed_cost`, `infra_host_total_cost`, `infra_host_percentage_in_org`, + `infra_host_percentage_in_account`.' + type: object + type: object + MonthlyCostAttributionBody: + description: Cost data. + properties: + attributes: + $ref: '#/components/schemas/MonthlyCostAttributionAttributes' + id: + description: Unique ID of the response. + type: string + type: + $ref: '#/components/schemas/CostAttributionType' + type: object + MonthlyCostAttributionMeta: + description: The object containing document metadata. + properties: + aggregates: + $ref: '#/components/schemas/CostAttributionAggregates' + pagination: + $ref: '#/components/schemas/MonthlyCostAttributionPagination' + type: object + MonthlyCostAttributionPagination: + description: The metadata for the current pagination. + properties: + next_record_id: + description: The cursor to use to get the next results, if any. To make + the next request, use the same parameters with the addition of the `next_record_id`. + nullable: true + type: string + type: object + MonthlyCostAttributionResponse: + description: Response containing the monthly cost attribution by tag(s). + properties: + data: + description: Response containing cost attribution. + items: + $ref: '#/components/schemas/MonthlyCostAttributionBody' + type: array + meta: + $ref: '#/components/schemas/MonthlyCostAttributionMeta' + type: object NullableRelationshipToUser: description: Relationship to user. + nullable: true properties: data: $ref: '#/components/schemas/NullableRelationshipToUserData' required: - data @@ -10773,10 +11300,145 @@ $ref: '#/components/schemas/UsersType' required: - id - type type: object + OktaAccount: + description: Schema for an Okta account. + properties: + attributes: + $ref: '#/components/schemas/OktaAccountAttributes' + id: + description: The ID of the Okta account, a UUID hash of the account name. + example: f749daaf-682e-4208-a38d-c9b43162c609 + type: string + type: + $ref: '#/components/schemas/OktaAccountType' + required: + - attributes + - type + type: object + OktaAccountAttributes: + description: Attributes object for an Okta account. + properties: + api_key: + description: The API key of the Okta account. + type: string + writeOnly: true + auth_method: + description: The authorization method for an Okta account. + example: oauth + type: string + client_id: + description: The Client ID of an Okta app integration. + type: string + client_secret: + description: The client secret of an Okta app integration. + type: string + writeOnly: true + domain: + description: The domain of the Okta account. + example: https://example.okta.com/ + type: string + name: + description: The name of the Okta account. + example: Okta-Prod + type: string + required: + - auth_method + - domain + - name + type: object + OktaAccountRequest: + description: Request object for an Okta account. + properties: + data: + $ref: '#/components/schemas/OktaAccount' + required: + - data + type: object + OktaAccountResponse: + description: Response object for an Okta account. + properties: + data: + $ref: '#/components/schemas/OktaAccount' + type: object + OktaAccountResponseData: + description: Data object of an Okta account + properties: + attributes: + $ref: '#/components/schemas/OktaAccountAttributes' + id: + description: The ID of the Okta account, a UUID hash of the account name. + example: f749daaf-682e-4208-a38d-c9b43162c609 + type: string + type: + $ref: '#/components/schemas/OktaAccountType' + required: + - attributes + - id + - type + type: object + OktaAccountType: + default: okta-accounts + description: Account type for an Okta account. + enum: + - okta-accounts + example: okta-accounts + type: string + x-enum-varnames: + - OKTA_ACCOUNTS + OktaAccountUpdateRequest: + description: Payload schema when updating an Okta account. + properties: + data: + $ref: '#/components/schemas/OktaAccountUpdateRequestData' + required: + - data + type: object + OktaAccountUpdateRequestAttributes: + description: Attributes object for updating an Okta account. + properties: + api_key: + description: The API key of the Okta account. + type: string + writeOnly: true + auth_method: + description: The authorization method for an Okta account. + example: oauth + type: string + client_id: + description: The Client ID of an Okta app integration. + type: string + client_secret: + description: The client secret of an Okta app integration. + type: string + writeOnly: true + domain: + description: The domain associated with an Okta account. + example: https://dev-test.okta.com/ + type: string + required: + - auth_method + - domain + type: object + OktaAccountUpdateRequestData: + description: Data object for updating an Okta account. + properties: + attributes: + $ref: '#/components/schemas/OktaAccountUpdateRequestAttributes' + type: + $ref: '#/components/schemas/OktaAccountType' + OktaAccountsResponse: + description: The expected response schema when getting Okta accounts. + properties: + data: + description: List of Okta accounts. + items: + $ref: '#/components/schemas/OktaAccountResponseData' + type: array + type: object OnDemandConcurrencyCap: description: On-demand concurrency cap. properties: attributes: $ref: '#/components/schemas/OnDemandConcurrencyCapAttributes' @@ -11229,10 +11891,13 @@ $ref: '#/components/schemas/APIKeysType' type: object PartialAPIKeyAttributes: description: Attributes of a partial API key. properties: + category: + description: The category of the API key. + type: string created_at: description: Creation date of the API key. example: '2020-11-23T10:00:00.000Z' readOnly: true type: string @@ -11250,10 +11915,13 @@ type: string name: description: Name of the API key. example: API Key for submitting metrics type: string + remote_config_read_enabled: + description: The remote config read enabled status. + type: boolean type: object PartialApplicationKey: description: Partial Datadog application key. properties: attributes: @@ -11561,11 +12229,11 @@ type: object PowerpackRelationships: description: Powerpack relationship object. properties: author: - $ref: '#/components/schemas/Creator' + $ref: '#/components/schemas/RelationshipToUser' type: object PowerpackResponse: description: Response object which includes a single powerpack configuration. properties: data: @@ -11633,10 +12301,11 @@ format: int64 type: integer last_offset: description: The last offset. format: int64 + nullable: true type: integer limit: description: Pagination limit. format: int64 type: integer @@ -11745,10 +12414,66 @@ - process example: process type: string x-enum-varnames: - PROCESS + ProjectedCost: + description: Projected Cost data. + properties: + attributes: + $ref: '#/components/schemas/ProjectedCostAttributes' + id: + description: Unique ID of the response. + type: string + type: + $ref: '#/components/schemas/ProjectedCostType' + type: object + ProjectedCostAttributes: + description: Projected Cost attributes data. + properties: + charges: + description: List of charges data reported for the requested month. + items: + $ref: '#/components/schemas/ChargebackBreakdown' + type: array + date: + description: The month requested. + format: date-time + type: string + org_name: + description: The organization name. + type: string + projected_total_cost: + description: The total projected cost of products for the month. + format: double + type: number + public_id: + description: The organization public ID. + type: string + region: + description: The region of the Datadog instance that the organization belongs + to. + type: string + type: object + ProjectedCostResponse: + description: Projected Cost response. + properties: + data: + description: Response containing Projected Cost. + items: + $ref: '#/components/schemas/ProjectedCost' + type: array + type: object + ProjectedCostType: + default: projected_cost + description: Type of cost data. + enum: + - projected_cost + example: projected_cost + type: string + x-enum-varnames: + - PROJECt_COST QueryFormula: description: A formula for calculation based on one or more queries. properties: formula: description: Formula string, referencing one or more queries with their @@ -12557,10 +13282,34 @@ $ref: '#/components/schemas/IncidentAttachmentType' required: - id - type type: object + RelationshipToIncidentImpactData: + description: Relationship to impact object. + properties: + id: + description: A unique identifier that represents the impact. + example: 00000000-0000-0000-2345-000000000000 + type: string + type: + $ref: '#/components/schemas/IncidentImpactsType' + required: + - id + - type + type: object + RelationshipToIncidentImpacts: + description: Relationship to impacts. + properties: + data: + description: An array of incident impacts. + items: + $ref: '#/components/schemas/RelationshipToIncidentImpactData' + type: array + required: + - data + type: object RelationshipToIncidentIntegrationMetadataData: description: A relationship reference for an integration metadata object. example: id: 00000000-abcd-0002-0000-000000000000 type: incident_integrations @@ -12623,10 +13372,58 @@ $ref: '#/components/schemas/IncidentPostmortemType' required: - id - type type: object + RelationshipToIncidentResponderData: + description: Relationship to impact object. + properties: + id: + description: A unique identifier that represents the responder. + example: 00000000-0000-0000-2345-000000000000 + type: string + type: + $ref: '#/components/schemas/IncidentRespondersType' + required: + - id + - type + type: object + RelationshipToIncidentResponders: + description: Relationship to incident responders. + properties: + data: + description: An array of incident responders. + items: + $ref: '#/components/schemas/RelationshipToIncidentResponderData' + type: array + required: + - data + type: object + RelationshipToIncidentUserDefinedFieldData: + description: Relationship to impact object. + properties: + id: + description: A unique identifier that represents the responder. + example: 00000000-0000-0000-2345-000000000000 + type: string + type: + $ref: '#/components/schemas/IncidentUserDefinedFieldType' + required: + - id + - type + type: object + RelationshipToIncidentUserDefinedFields: + description: Relationship to incident user defined fields. + properties: + data: + description: An array of user defined fields. + items: + $ref: '#/components/schemas/RelationshipToIncidentUserDefinedFieldData' + type: array + required: + - data + type: object RelationshipToOrganization: description: Relationship to an organization. properties: data: $ref: '#/components/schemas/RelationshipToOrganizationData' @@ -14297,14 +15094,16 @@ - HIGH - CRITICAL SecurityMonitoringRuleTypeCreate: description: The rule type. enum: + - application_security - log_detection - workload_security type: string x-enum-varnames: + - APPLICATION_SECURITY - LOG_DETECTION - WORKLOAD_SECURITY SecurityMonitoringRuleTypeRead: description: The rule type. enum: @@ -15663,10 +16462,15 @@ description: Attributes of the Sensitive Data Scanner standard pattern. properties: description: description: Description of the standard pattern. type: string + included_keywords: + description: List of included keywords. + items: + type: string + type: array name: description: Name of the standard pattern. type: string pattern: description: Regex to match. @@ -16786,10 +17590,20 @@ required: - channel_id - channel_name - redirect_url type: object + SortDirection: + default: desc + description: The direction to sort by. + enum: + - desc + - asc + type: string + x-enum-varnames: + - DESC + - ASC Span: description: Object description of a spans after being processed and stored by Datadog. properties: attributes: @@ -19026,11 +19840,11 @@ metrics_read: View custom metrics. monitors_downtime: Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute hosts. The ability to write monitors is not required to set downtimes. monitors_read: View monitors. - monitors_write: Edit, mute, and delete individual monitors. + monitors_write: Edit and delete individual monitors. security_monitoring_filters_read: Read Security Filters. security_monitoring_filters_write: Create, edit, and delete Security Filters. security_monitoring_findings_read: View CSPM Findings. security_monitoring_rules_read: Read Detection Rules. security_monitoring_rules_write: Create and edit Detection Rules. @@ -20483,13 +21297,10 @@ 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/containers: get: description: Get all containers for your organization. operationId: ListContainers parameters: @@ -20563,13 +21374,171 @@ x-pagination: cursorParam: page[cursor] cursorPath: meta.pagination.next_cursor limitParam: page[size] resultsPath: data + /api/v2/cost_by_tag/active_billing_dimensions: + get: + description: Get active billing dimensions for cost attribution. Cost data for + a given month becomes available no later than the 17th of the following month. + operationId: GetActiveBillingDimensions + responses: + '200': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/ActiveBillingDimensionsResponse' + description: OK + '400': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Forbidden - User is not authorized + '429': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Too many requests + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Get active billing dimensions for cost attribution + tags: + - Usage Metering x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + /api/v2/cost_by_tag/monthly_cost_attribution: + get: + description: "Get monthly cost attribution by tag across multi-org and single + root-org accounts.\nCost Attribution data for a given month becomes available + no later than the 17th of the following month.\nThis API endpoint is paginated. + To make sure you receive all records, check if the value of `next_record_id` + is\nset in the response. If it is, make another request and pass `next_record_id` + as a parameter.\nPseudo code example:\n```\nresponse := GetMonthlyCostAttribution(start_month, + end_month)\ncursor := response.metadata.pagination.next_record_id\nWHILE cursor + != null BEGIN\n sleep(5 seconds) # Avoid running into rate limit\n response + := GetMonthlyCostAttribution(start_month, end_month, next_record_id=cursor)\n + \ cursor := response.metadata.pagination.next_record_id\nEND\n```" + operationId: GetMonthlyCostAttribution + parameters: + - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` + for cost beginning in this month.' + in: query + name: start_month + required: true + schema: + format: date-time + type: string + - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` + for cost ending this month.' + in: query + name: end_month + required: true + schema: + format: date-time + type: string + - description: 'Comma-separated list specifying cost types (e.g., `<billing_dimension>_on_demand_cost`, + `<billing_dimension>_committed_cost`, `<billing_dimension>_total_cost`) + and the + + proportions (`<billing_dimension>_percentage_in_org`, `<billing_dimension>_percentage_in_account`). + Use `*` to retrieve all fields. + + Example: `infra_host_on_demand_cost,infra_host_percentage_in_account` + + To obtain the complete list of active billing dimensions that can be used + to replace + + `<billing_dimension>` in the field names, make a request to the [Get active + billing dimensions API](https://docs.datadoghq.com/api/latest/usage-metering/#get-active-billing-dimensions-for-cost-attribution).' + in: query + name: fields + required: true + schema: + type: string + - description: 'The direction to sort by: `[desc, asc]`.' + in: query + name: sort_direction + required: false + schema: + $ref: '#/components/schemas/SortDirection' + - description: 'The billing dimension to sort by. Always sorted by total cost. + Example: `infra_host`.' + in: query + name: sort_name + required: false + schema: + type: string + - description: 'Comma separated list of tag keys used to group cost. If no value + is provided the cost will not be broken down by tags. + + To see which tags are available, look for the value of `tag_config_source` + in the API response.' + in: query + name: tag_breakdown_keys + required: false + schema: + type: string + - description: List following results with a next_record_id provided in the + previous query. + in: query + name: next_record_id + required: false + schema: + type: string + - description: Include child org cost in the response. Defaults to `true`. + in: query + name: include_descendants + required: false + schema: + default: true + type: boolean + responses: + '200': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/MonthlyCostAttributionResponse' + description: OK + '400': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Forbidden - User is not authorized + '429': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Too many requests + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Get Monthly Cost Attribution + tags: + - Usage Metering + 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: @@ -20927,10 +21896,114 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Update items of a dashboard list tags: - Dashboard Lists x-codegen-request-body-name: body + /api/v2/dora/deployment: + post: + description: 'Use this API endpoint to provide data about deployments for DORA + metrics. + + + This is necessary for: + + - Deployment Frequency + + - Change Lead Time + + - Change Failure Rate' + operationId: CreateDORADeployment + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DORADeploymentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DORADeploymentResponse' + description: OK + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/DORADeploymentResponse' + description: OK - but delayed due to incident + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Bad Request + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + summary: Send a deployment event for DORA Metrics + tags: + - DORA Metrics + x-codegen-request-body-name: body + x-unstable: '**Note**: This endpoint is in private beta for CI Pipeline Visibility + customers. + + If you want to request access, complete the [form](https://forms.gle/Eqq6uXfGjYxmqpjDA).' + /api/v2/dora/incident: + post: + description: 'Use this API endpoint to provide data about incidents for DORA + metrics. + + + This is necessary for: + + - Change Failure Rate + + - Time to Restore' + operationId: CreateDORAIncident + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DORAIncidentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DORAIncidentResponse' + description: OK + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/DORAIncidentResponse' + description: OK - but delayed due to incident + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/JSONAPIErrorResponse' + description: Bad Request + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + summary: Send an incident event for DORA Metrics + tags: + - DORA Metrics + x-codegen-request-body-name: body + x-unstable: '**Note**: This endpoint is in private beta for CI Pipeline Visibility + customers. + + If you want to request access, complete the [form](https://forms.gle/Eqq6uXfGjYxmqpjDA).' /api/v2/downtime: get: description: Get all scheduled downtimes. operationId: ListDowntimes parameters: @@ -21250,13 +22323,10 @@ x-pagination: cursorParam: page[cursor] cursorPath: meta.page.after limitParam: page[limit] resultsPath: data - x-unstable: '**Note**: This endpoint is in beta. - - For access, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/events/search: post: description: 'List endpoint returns events that match an events search query. [Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination). @@ -21295,13 +22365,10 @@ x-pagination: cursorParam: body.page.cursor cursorPath: meta.page.after limitParam: body.page.limit resultsPath: data - x-unstable: '**Note**: This endpoint is in beta. - - For access, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/incidents: get: description: Get all incidents for the user's organization. operationId: ListIncidents parameters: @@ -22895,10 +23962,148 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Update Fastly service tags: - Fastly Integration x-codegen-request-body-name: body + /api/v2/integrations/okta/accounts: + get: + description: List Okta accounts. + operationId: ListOktaAccounts + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OktaAccountsResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: List Okta accounts + tags: + - Okta Integration + post: + description: Create an Okta account. + operationId: CreateOktaAccount + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OktaAccountRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/OktaAccountResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Add Okta account + tags: + - Okta Integration + x-codegen-request-body-name: body + /api/v2/integrations/okta/accounts/{account_id}: + delete: + description: Delete an Okta account. + operationId: DeleteOktaAccount + parameters: + - description: None + in: path + name: account_id + required: true + schema: + type: string + responses: + '204': + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Delete Okta account + tags: + - Okta Integration + get: + description: Get an Okta account. + operationId: GetOktaAccount + parameters: + - description: None + in: path + name: account_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OktaAccountResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get Okta account + tags: + - Okta Integration + patch: + description: Update an Okta account. + operationId: UpdateOktaAccount + parameters: + - description: None + in: path + name: account_id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OktaAccountUpdateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OktaAccountResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Update Okta account + tags: + - Okta Integration + x-codegen-request-body-name: body /api/v2/ip_allowlist: get: description: Returns the IP allowlist and its enabled or disabled state. operationId: GetIPAllowlist responses: @@ -29933,10 +31138,61 @@ - AuthZ: - usage_read summary: Get hourly usage for observability pipelines tags: - Usage Metering + /api/v2/usage/projected_cost: + get: + description: 'Get projected cost across multi-org and single root-org accounts. + + Projected cost data is only available for the current month and becomes available + around the 12th of the month. + + This endpoint requires the usage_read authorization scope.' + operationId: GetProjectedCost + parameters: + - description: String to specify whether cost is broken down at a parent-org + level or at the sub-org level. Available views are `summary` and `sub-org`. + Defaults to `summary`. + in: query + name: view + required: false + schema: + type: string + responses: + '200': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/ProjectedCostResponse' + description: OK + '400': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Forbidden - User is not authorized + '429': + content: + application/json;datetime-format=rfc3339: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Too many requests + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - usage_read + summary: Get projected cost across your account + tags: + - Usage Metering /api/v2/user_invitations: post: description: Sends emails to one or more users inviting them to join the organization. operationId: SendInvitations requestBody: @@ -30438,10 +31694,12 @@ - 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: Send events for DORA Metrics to measure and improve software delivery. + name: DORA Metrics - description: 'Interact with your dashboard lists through the API to organize, find, and share all of your dashboards with your team and organization.' @@ -30547,9 +31805,12 @@ [Tag Policies](https://docs.datadoghq.com/monitors/settings/).' externalDocs: description: Find out more at url: https://docs.datadoghq.com/monitors/create/types/ name: Monitors +- description: Configure your Datadog Okta integration directly through the Datadog + API. + name: Okta Integration - description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/) directly through the Datadog API.' externalDocs: url: https://docs.datadoghq.com/api/latest/opsgenie-integration