datadog_api_client 2.17.0 → 2.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.apigentools-info +4 -4
- data/.generator/schemas/v1/openapi.yaml +145 -5
- data/.generator/schemas/v2/openapi.yaml +1306 -45
- data/.generator/src/generator/cli.py +5 -0
- data/.generator/src/generator/templates/datadog_api_client.j2 +19 -0
- data/.pre-commit-config.yaml +1 -1
- data/CHANGELOG.md +25 -0
- data/examples/v1/aws-integration/CreateAWSAccount.rb +2 -2
- data/examples/v1/aws-integration/DeleteAWSAccount.rb +1 -1
- data/examples/v1/aws-integration/UpdateAWSAccount.rb +6 -6
- data/examples/v1/azure-integration/CreateAzureIntegration.rb +1 -0
- data/examples/v1/azure-integration/DeleteAzureIntegration.rb +1 -0
- data/examples/v1/azure-integration/UpdateAzureHostFilters.rb +1 -0
- data/examples/v1/azure-integration/UpdateAzureIntegration.rb +1 -0
- data/examples/v1/dashboards/CreateDashboard_1284514532.rb +3 -0
- data/examples/v1/synthetics/PatchTest.rb +22 -0
- data/examples/v2/container-images/ListContainerImages.rb +0 -3
- data/examples/v2/container-images/ListContainerImages_3088586393.rb +0 -3
- data/examples/v2/container-images/ListContainerImages_3974828736.rb +0 -3
- data/examples/v2/containers/ListContainers.rb +0 -3
- data/examples/v2/containers/ListContainers_2175733917.rb +0 -3
- data/examples/v2/containers/ListContainers_931009654.rb +0 -3
- data/examples/v2/dora-metrics/CreateDORADeployment.rb +23 -0
- data/examples/v2/dora-metrics/CreateDORAIncident.rb +25 -0
- data/examples/v2/events/ListEvents.rb +0 -3
- data/examples/v2/events/ListEvents_1527584014.rb +0 -3
- data/examples/v2/events/ListEvents_2663715109.rb +0 -3
- data/examples/v2/events/SearchEvents.rb +0 -3
- data/examples/v2/events/SearchEvents_3856995058.rb +0 -3
- data/examples/v2/okta-integration/CreateOktaAccount.rb +19 -0
- data/examples/v2/okta-integration/DeleteOktaAccount.rb +5 -0
- data/examples/v2/okta-integration/GetOktaAccount.rb +8 -0
- data/examples/v2/okta-integration/ListOktaAccounts.rb +5 -0
- data/examples/v2/okta-integration/UpdateOktaAccount.rb +20 -0
- data/examples/v2/usage-metering/GetActiveBillingDimensions.rb +8 -0
- data/examples/v2/usage-metering/GetMonthlyCostAttribution.rb +8 -0
- data/examples/v2/usage-metering/GetProjectedCost.rb +8 -0
- data/lib/datadog_api_client/configuration.rb +4 -4
- data/lib/datadog_api_client/inflector.rb +61 -0
- data/lib/datadog_api_client/v1/api/hosts_api.rb +1 -1
- data/lib/datadog_api_client/v1/api/synthetics_api.rb +73 -1
- data/lib/datadog_api_client/v1/models/azure_account.rb +13 -2
- data/lib/datadog_api_client/v1/models/synthetics_patch_test_body.rb +82 -0
- data/lib/datadog_api_client/v1/models/synthetics_patch_test_operation.rb +100 -0
- data/lib/datadog_api_client/v1/models/synthetics_patch_test_operation_name.rb +31 -0
- data/lib/datadog_api_client/v1/models/usage_summary_date_org.rb +21 -1
- data/lib/datadog_api_client/v1/models/usage_summary_response.rb +21 -1
- data/lib/datadog_api_client/v1/models/widget_live_span.rb +2 -0
- data/lib/datadog_api_client/v2/api/container_images_api.rb +0 -6
- data/lib/datadog_api_client/v2/api/containers_api.rb +0 -6
- data/lib/datadog_api_client/v2/api/dora_metrics_api.rb +181 -0
- data/lib/datadog_api_client/v2/api/events_api.rb +0 -12
- data/lib/datadog_api_client/v2/api/okta_integration_api.rb +355 -0
- data/lib/datadog_api_client/v2/api/usage_metering_api.rb +241 -0
- data/lib/datadog_api_client/v2/models/active_billing_dimensions_attributes.rb +92 -0
- data/lib/datadog_api_client/v2/models/active_billing_dimensions_body.rb +100 -0
- data/lib/datadog_api_client/v2/models/active_billing_dimensions_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/active_billing_dimensions_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/api_keys_response.rb +14 -4
- data/lib/datadog_api_client/v2/models/api_keys_response_meta.rb +90 -0
- data/lib/datadog_api_client/v2/models/api_keys_response_meta_page.rb +80 -0
- data/lib/datadog_api_client/v2/models/application_key_response_meta.rb +90 -0
- data/lib/datadog_api_client/v2/models/application_key_response_meta_page.rb +80 -0
- data/lib/datadog_api_client/v2/models/cloud_workload_security_agent_rule_attributes.rb +13 -1
- data/lib/datadog_api_client/v2/models/cost_attribution_aggregates_body.rb +100 -0
- data/lib/datadog_api_client/v2/models/cost_attribution_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_request_attributes.rb +170 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_request_data.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_response.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_response_data.rb +108 -0
- data/lib/datadog_api_client/v2/models/dora_deployment_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/dora_git_info.rb +125 -0
- data/lib/datadog_api_client/v2/models/dora_incident_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_incident_request_attributes.rb +179 -0
- data/lib/datadog_api_client/v2/models/dora_incident_request_data.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_incident_response.rb +98 -0
- data/lib/datadog_api_client/v2/models/dora_incident_response_data.rb +108 -0
- data/lib/datadog_api_client/v2/models/dora_incident_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/full_api_key_attributes.rb +24 -4
- data/lib/datadog_api_client/v2/models/incident_attachment_link_attributes.rb +14 -4
- data/lib/datadog_api_client/v2/models/incident_create_relationships.rb +9 -19
- data/lib/datadog_api_client/v2/models/incident_impacts_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/incident_integration_metadata_attributes.rb +21 -1
- data/lib/datadog_api_client/v2/models/incident_integration_metadata_response_data.rb +11 -1
- data/lib/datadog_api_client/v2/models/incident_integration_relationships.rb +90 -0
- data/lib/datadog_api_client/v2/models/incident_non_datadog_creator.rb +90 -0
- data/lib/datadog_api_client/v2/models/incident_responders_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/incident_response_attributes.rb +69 -4
- data/lib/datadog_api_client/v2/models/incident_response_relationships.rb +42 -4
- data/lib/datadog_api_client/v2/models/incident_severity.rb +31 -0
- data/lib/datadog_api_client/v2/models/incident_todo_attributes.rb +24 -4
- data/lib/datadog_api_client/v2/models/incident_todo_relationships.rb +90 -0
- data/lib/datadog_api_client/v2/models/incident_todo_response_data.rb +11 -1
- data/lib/datadog_api_client/v2/models/incident_update_relationships.rb +8 -0
- data/lib/datadog_api_client/v2/models/incident_user_defined_field_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/list_application_keys_response.rb +14 -4
- data/lib/datadog_api_client/v2/models/monthly_cost_attribution_attributes.rb +151 -0
- data/lib/datadog_api_client/v2/models/monthly_cost_attribution_body.rb +100 -0
- data/lib/datadog_api_client/v2/models/monthly_cost_attribution_meta.rb +92 -0
- data/lib/datadog_api_client/v2/models/monthly_cost_attribution_pagination.rb +88 -0
- data/lib/datadog_api_client/v2/models/monthly_cost_attribution_response.rb +92 -0
- data/lib/datadog_api_client/v2/models/okta_account.rb +129 -0
- data/lib/datadog_api_client/v2/models/okta_account_attributes.rb +170 -0
- data/lib/datadog_api_client/v2/models/okta_account_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/okta_account_response.rb +80 -0
- data/lib/datadog_api_client/v2/models/okta_account_response_data.rb +140 -0
- data/lib/datadog_api_client/v2/models/okta_account_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/okta_account_update_request.rb +98 -0
- data/lib/datadog_api_client/v2/models/okta_account_update_request_attributes.rb +149 -0
- data/lib/datadog_api_client/v2/models/okta_account_update_request_data.rb +90 -0
- data/lib/datadog_api_client/v2/models/okta_accounts_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/partial_api_key_attributes.rb +24 -4
- data/lib/datadog_api_client/v2/models/powerpack_relationships.rb +2 -2
- data/lib/datadog_api_client/v2/models/powerpacks_response_meta_pagination.rb +8 -0
- data/lib/datadog_api_client/v2/models/projected_cost.rb +100 -0
- data/lib/datadog_api_client/v2/models/projected_cost_attributes.rb +132 -0
- data/lib/datadog_api_client/v2/models/projected_cost_response.rb +82 -0
- data/lib/datadog_api_client/v2/models/projected_cost_type.rb +26 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_impact_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_impacts.rb +100 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_responder_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_responders.rb +100 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_user_defined_field_data.rb +119 -0
- data/lib/datadog_api_client/v2/models/relationship_to_incident_user_defined_fields.rb +100 -0
- data/lib/datadog_api_client/v2/models/security_monitoring_rule_type_create.rb +1 -0
- data/lib/datadog_api_client/v2/models/sensitive_data_scanner_standard_pattern_attributes.rb +13 -1
- data/lib/datadog_api_client/v2/models/sort_direction.rb +27 -0
- data/lib/datadog_api_client/version.rb +1 -1
- data/lib/datadog_api_client.rb +16 -1
- metadata +75 -2
|
@@ -689,6 +689,26 @@ components:
|
|
|
689
689
|
items:
|
|
690
690
|
$ref: '#/components/schemas/APIKeyResponseIncludedItem'
|
|
691
691
|
type: array
|
|
692
|
+
meta:
|
|
693
|
+
$ref: '#/components/schemas/APIKeysResponseMeta'
|
|
694
|
+
type: object
|
|
695
|
+
APIKeysResponseMeta:
|
|
696
|
+
description: Additional information related to api keys response.
|
|
697
|
+
properties:
|
|
698
|
+
max_allowed:
|
|
699
|
+
description: Max allowed number of API keys.
|
|
700
|
+
format: int64
|
|
701
|
+
type: integer
|
|
702
|
+
page:
|
|
703
|
+
$ref: '#/components/schemas/APIKeysResponseMetaPage'
|
|
704
|
+
type: object
|
|
705
|
+
APIKeysResponseMetaPage:
|
|
706
|
+
description: Additional information related to the API keys response.
|
|
707
|
+
properties:
|
|
708
|
+
total_filtered_count:
|
|
709
|
+
description: Total filtered application key count.
|
|
710
|
+
format: int64
|
|
711
|
+
type: integer
|
|
692
712
|
type: object
|
|
693
713
|
APIKeysSort:
|
|
694
714
|
default: name
|
|
@@ -721,6 +741,47 @@ components:
|
|
|
721
741
|
type: string
|
|
722
742
|
x-enum-varnames:
|
|
723
743
|
- API_KEYS
|
|
744
|
+
ActiveBillingDimensionsAttributes:
|
|
745
|
+
description: List of active billing dimensions.
|
|
746
|
+
properties:
|
|
747
|
+
month:
|
|
748
|
+
description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.'
|
|
749
|
+
format: date-time
|
|
750
|
+
type: string
|
|
751
|
+
values:
|
|
752
|
+
description: 'List of active billing dimensions. Example: `[infra_host,
|
|
753
|
+
apm_host, serverless_infra]`.'
|
|
754
|
+
items:
|
|
755
|
+
description: A given billing dimension in a list.
|
|
756
|
+
example: infra_host
|
|
757
|
+
type: string
|
|
758
|
+
type: array
|
|
759
|
+
type: object
|
|
760
|
+
ActiveBillingDimensionsBody:
|
|
761
|
+
description: Active billing dimensions data.
|
|
762
|
+
properties:
|
|
763
|
+
attributes:
|
|
764
|
+
$ref: '#/components/schemas/ActiveBillingDimensionsAttributes'
|
|
765
|
+
id:
|
|
766
|
+
description: Unique ID of the response.
|
|
767
|
+
type: string
|
|
768
|
+
type:
|
|
769
|
+
$ref: '#/components/schemas/ActiveBillingDimensionsType'
|
|
770
|
+
type: object
|
|
771
|
+
ActiveBillingDimensionsResponse:
|
|
772
|
+
description: Active billing dimensions response.
|
|
773
|
+
properties:
|
|
774
|
+
data:
|
|
775
|
+
$ref: '#/components/schemas/ActiveBillingDimensionsBody'
|
|
776
|
+
type: object
|
|
777
|
+
ActiveBillingDimensionsType:
|
|
778
|
+
default: billing_dimensions
|
|
779
|
+
description: Type of active billing dimensions data.
|
|
780
|
+
enum:
|
|
781
|
+
- billing_dimensions
|
|
782
|
+
type: string
|
|
783
|
+
x-enum-varnames:
|
|
784
|
+
- BILLING_DIMENSIONS
|
|
724
785
|
ApmRetentionFilterType:
|
|
725
786
|
default: apm_retention_filter
|
|
726
787
|
description: The type of the resource.
|
|
@@ -792,6 +853,24 @@ components:
|
|
|
792
853
|
oneOf:
|
|
793
854
|
- $ref: '#/components/schemas/User'
|
|
794
855
|
- $ref: '#/components/schemas/Role'
|
|
856
|
+
ApplicationKeyResponseMeta:
|
|
857
|
+
description: Additional information related to the application key response.
|
|
858
|
+
properties:
|
|
859
|
+
max_allowed_per_user:
|
|
860
|
+
description: Max allowed number of application keys per user.
|
|
861
|
+
format: int64
|
|
862
|
+
type: integer
|
|
863
|
+
page:
|
|
864
|
+
$ref: '#/components/schemas/ApplicationKeyResponseMetaPage'
|
|
865
|
+
type: object
|
|
866
|
+
ApplicationKeyResponseMetaPage:
|
|
867
|
+
description: Additional information related to the application key response.
|
|
868
|
+
properties:
|
|
869
|
+
total_filtered_count:
|
|
870
|
+
description: Total filtered application key count.
|
|
871
|
+
format: int64
|
|
872
|
+
type: integer
|
|
873
|
+
type: object
|
|
795
874
|
ApplicationKeyUpdateAttributes:
|
|
796
875
|
description: Attributes used to update an application Key.
|
|
797
876
|
properties:
|
|
@@ -2963,6 +3042,11 @@ components:
|
|
|
2963
3042
|
description: The SECL expression of the Agent rule.
|
|
2964
3043
|
example: exec.file.name == \"sh\"
|
|
2965
3044
|
type: string
|
|
3045
|
+
filters:
|
|
3046
|
+
description: The platforms the Agent rule is supported on.
|
|
3047
|
+
items:
|
|
3048
|
+
type: string
|
|
3049
|
+
type: array
|
|
2966
3050
|
name:
|
|
2967
3051
|
description: The name of the Agent rule.
|
|
2968
3052
|
example: my_agent_rule
|
|
@@ -4082,6 +4166,63 @@ components:
|
|
|
4082
4166
|
- IDENTITY
|
|
4083
4167
|
- GZIP
|
|
4084
4168
|
- DEFLATE
|
|
4169
|
+
CostAttributionAggregates:
|
|
4170
|
+
description: An array of available aggregates.
|
|
4171
|
+
items:
|
|
4172
|
+
$ref: '#/components/schemas/CostAttributionAggregatesBody'
|
|
4173
|
+
type: array
|
|
4174
|
+
CostAttributionAggregatesBody:
|
|
4175
|
+
description: The object containing the aggregates.
|
|
4176
|
+
properties:
|
|
4177
|
+
agg_type:
|
|
4178
|
+
description: The aggregate type.
|
|
4179
|
+
example: sum
|
|
4180
|
+
type: string
|
|
4181
|
+
field:
|
|
4182
|
+
description: The field.
|
|
4183
|
+
example: infra_host_committed_cost
|
|
4184
|
+
type: string
|
|
4185
|
+
value:
|
|
4186
|
+
description: The value for a given field.
|
|
4187
|
+
format: double
|
|
4188
|
+
type: number
|
|
4189
|
+
type: object
|
|
4190
|
+
CostAttributionTagNames:
|
|
4191
|
+
additionalProperties:
|
|
4192
|
+
description: 'A list of values that are associated with each tag key.
|
|
4193
|
+
|
|
4194
|
+
- An empty list means the resource use wasn''t tagged with the respective
|
|
4195
|
+
tag.
|
|
4196
|
+
|
|
4197
|
+
- Multiple values means the respective tag was applied multiple times on
|
|
4198
|
+
the resource.
|
|
4199
|
+
|
|
4200
|
+
- An `<empty>` value means the resource was tagged with the respective tag
|
|
4201
|
+
but did not have a value.'
|
|
4202
|
+
items:
|
|
4203
|
+
description: A given tag in a list.
|
|
4204
|
+
example: datadog-integrations-lab
|
|
4205
|
+
type: string
|
|
4206
|
+
type: array
|
|
4207
|
+
description: 'Tag keys and values.
|
|
4208
|
+
|
|
4209
|
+
A `null` value here means that the requested tag breakdown cannot be applied
|
|
4210
|
+
because it does not match the [tags
|
|
4211
|
+
|
|
4212
|
+
configured for usage attribution](https://docs.datadoghq.com/account_management/billing/usage_attribution/#getting-started).
|
|
4213
|
+
|
|
4214
|
+
In this scenario the API returns the total cost, not broken down by tags.'
|
|
4215
|
+
nullable: true
|
|
4216
|
+
type: object
|
|
4217
|
+
CostAttributionType:
|
|
4218
|
+
default: cost_by_tag
|
|
4219
|
+
description: Type of cost attribution data.
|
|
4220
|
+
enum:
|
|
4221
|
+
- cost_by_tag
|
|
4222
|
+
example: cost_by_tag
|
|
4223
|
+
type: string
|
|
4224
|
+
x-enum-varnames:
|
|
4225
|
+
- COST_BY_TAG
|
|
4085
4226
|
CostByOrg:
|
|
4086
4227
|
description: Cost data.
|
|
4087
4228
|
properties:
|
|
@@ -4184,6 +4325,178 @@ components:
|
|
|
4184
4325
|
nullable: true
|
|
4185
4326
|
type: string
|
|
4186
4327
|
type: object
|
|
4328
|
+
DORADeploymentRequest:
|
|
4329
|
+
description: Request to create a DORA deployment event.
|
|
4330
|
+
properties:
|
|
4331
|
+
data:
|
|
4332
|
+
$ref: '#/components/schemas/DORADeploymentRequestData'
|
|
4333
|
+
required:
|
|
4334
|
+
- data
|
|
4335
|
+
type: object
|
|
4336
|
+
DORADeploymentRequestAttributes:
|
|
4337
|
+
description: Attributes to create a DORA deployment event.
|
|
4338
|
+
properties:
|
|
4339
|
+
finished_at:
|
|
4340
|
+
description: Unix timestamp in nanoseconds when the deployment finished.
|
|
4341
|
+
It should not be older than 3 hours.
|
|
4342
|
+
example: 1693491984000000000
|
|
4343
|
+
format: int64
|
|
4344
|
+
type: integer
|
|
4345
|
+
git:
|
|
4346
|
+
$ref: '#/components/schemas/DORAGitInfo'
|
|
4347
|
+
id:
|
|
4348
|
+
description: Deployment ID.
|
|
4349
|
+
type: string
|
|
4350
|
+
service:
|
|
4351
|
+
description: Service name from a service available in the Service Catalog.
|
|
4352
|
+
example: shopist
|
|
4353
|
+
type: string
|
|
4354
|
+
started_at:
|
|
4355
|
+
description: Unix timestamp in nanoseconds when the deployment started.
|
|
4356
|
+
example: 1693491974000000000
|
|
4357
|
+
format: int64
|
|
4358
|
+
type: integer
|
|
4359
|
+
version:
|
|
4360
|
+
description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/).
|
|
4361
|
+
example: v1.12.07
|
|
4362
|
+
type: string
|
|
4363
|
+
required:
|
|
4364
|
+
- service
|
|
4365
|
+
- started_at
|
|
4366
|
+
- finished_at
|
|
4367
|
+
type: object
|
|
4368
|
+
DORADeploymentRequestData:
|
|
4369
|
+
description: The JSON:API data.
|
|
4370
|
+
properties:
|
|
4371
|
+
attributes:
|
|
4372
|
+
$ref: '#/components/schemas/DORADeploymentRequestAttributes'
|
|
4373
|
+
required:
|
|
4374
|
+
- attributes
|
|
4375
|
+
type: object
|
|
4376
|
+
DORADeploymentResponse:
|
|
4377
|
+
description: Response after receiving a DORA deployment event.
|
|
4378
|
+
properties:
|
|
4379
|
+
data:
|
|
4380
|
+
$ref: '#/components/schemas/DORADeploymentResponseData'
|
|
4381
|
+
required:
|
|
4382
|
+
- data
|
|
4383
|
+
type: object
|
|
4384
|
+
DORADeploymentResponseData:
|
|
4385
|
+
description: The JSON:API data.
|
|
4386
|
+
properties:
|
|
4387
|
+
id:
|
|
4388
|
+
description: The ID of the received DORA deployment event.
|
|
4389
|
+
example: 4242fcdd31586083
|
|
4390
|
+
type: string
|
|
4391
|
+
type:
|
|
4392
|
+
$ref: '#/components/schemas/DORADeploymentType'
|
|
4393
|
+
required:
|
|
4394
|
+
- id
|
|
4395
|
+
type: object
|
|
4396
|
+
DORADeploymentType:
|
|
4397
|
+
default: dora_deployment
|
|
4398
|
+
description: JSON:API type for DORA deployment events.
|
|
4399
|
+
enum:
|
|
4400
|
+
- dora_deployment
|
|
4401
|
+
example: dora_deployment
|
|
4402
|
+
type: string
|
|
4403
|
+
x-enum-varnames:
|
|
4404
|
+
- DORA_DEPLOYMENT
|
|
4405
|
+
DORAGitInfo:
|
|
4406
|
+
description: Git info for DORA Metrics events.
|
|
4407
|
+
properties:
|
|
4408
|
+
commit_sha:
|
|
4409
|
+
$ref: '#/components/schemas/GitCommitSHA'
|
|
4410
|
+
repository_url:
|
|
4411
|
+
$ref: '#/components/schemas/GitRepositoryURL'
|
|
4412
|
+
required:
|
|
4413
|
+
- repository_url
|
|
4414
|
+
- commit_sha
|
|
4415
|
+
type: object
|
|
4416
|
+
DORAIncidentRequest:
|
|
4417
|
+
description: Request to create a DORA incident event.
|
|
4418
|
+
properties:
|
|
4419
|
+
data:
|
|
4420
|
+
$ref: '#/components/schemas/DORAIncidentRequestData'
|
|
4421
|
+
required:
|
|
4422
|
+
- data
|
|
4423
|
+
type: object
|
|
4424
|
+
DORAIncidentRequestAttributes:
|
|
4425
|
+
description: Attributes to create a DORA incident event.
|
|
4426
|
+
properties:
|
|
4427
|
+
finished_at:
|
|
4428
|
+
description: Unix timestamp in nanoseconds when the incident finished. It
|
|
4429
|
+
should not be older than 3 hours.
|
|
4430
|
+
example: 1693491984000000000
|
|
4431
|
+
format: int64
|
|
4432
|
+
type: integer
|
|
4433
|
+
git:
|
|
4434
|
+
$ref: '#/components/schemas/DORAGitInfo'
|
|
4435
|
+
id:
|
|
4436
|
+
description: Incident ID
|
|
4437
|
+
type: string
|
|
4438
|
+
name:
|
|
4439
|
+
description: Incident name.
|
|
4440
|
+
example: Webserver is down failing all requests
|
|
4441
|
+
type: string
|
|
4442
|
+
service:
|
|
4443
|
+
description: Service name from a service available in the Service Catalog.
|
|
4444
|
+
example: shopist
|
|
4445
|
+
type: string
|
|
4446
|
+
severity:
|
|
4447
|
+
description: Incident severity.
|
|
4448
|
+
example: High
|
|
4449
|
+
type: string
|
|
4450
|
+
started_at:
|
|
4451
|
+
description: Unix timestamp in nanoseconds when the incident started.
|
|
4452
|
+
example: 1693491974000000000
|
|
4453
|
+
format: int64
|
|
4454
|
+
type: integer
|
|
4455
|
+
version:
|
|
4456
|
+
description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/).
|
|
4457
|
+
example: v1.12.07
|
|
4458
|
+
type: string
|
|
4459
|
+
required:
|
|
4460
|
+
- service
|
|
4461
|
+
- started_at
|
|
4462
|
+
type: object
|
|
4463
|
+
DORAIncidentRequestData:
|
|
4464
|
+
description: The JSON:API data.
|
|
4465
|
+
properties:
|
|
4466
|
+
attributes:
|
|
4467
|
+
$ref: '#/components/schemas/DORAIncidentRequestAttributes'
|
|
4468
|
+
required:
|
|
4469
|
+
- attributes
|
|
4470
|
+
type: object
|
|
4471
|
+
DORAIncidentResponse:
|
|
4472
|
+
description: Response after receiving a DORA incident event.
|
|
4473
|
+
properties:
|
|
4474
|
+
data:
|
|
4475
|
+
$ref: '#/components/schemas/DORAIncidentResponseData'
|
|
4476
|
+
required:
|
|
4477
|
+
- data
|
|
4478
|
+
type: object
|
|
4479
|
+
DORAIncidentResponseData:
|
|
4480
|
+
description: Response after receiving a DORA incident event.
|
|
4481
|
+
properties:
|
|
4482
|
+
id:
|
|
4483
|
+
description: The ID of the received DORA incident event.
|
|
4484
|
+
example: 4242fcdd31586083
|
|
4485
|
+
type: string
|
|
4486
|
+
type:
|
|
4487
|
+
$ref: '#/components/schemas/DORAIncidentType'
|
|
4488
|
+
required:
|
|
4489
|
+
- id
|
|
4490
|
+
type: object
|
|
4491
|
+
DORAIncidentType:
|
|
4492
|
+
default: dora_incident
|
|
4493
|
+
description: JSON:API type for DORA incident events.
|
|
4494
|
+
enum:
|
|
4495
|
+
- dora_incident
|
|
4496
|
+
example: dora_incident
|
|
4497
|
+
type: string
|
|
4498
|
+
x-enum-varnames:
|
|
4499
|
+
- DORA_INCIDENT
|
|
4187
4500
|
DashboardListAddItemsRequest:
|
|
4188
4501
|
description: Request containing a list of dashboards to add.
|
|
4189
4502
|
properties:
|
|
@@ -5927,6 +6240,9 @@ components:
|
|
|
5927
6240
|
FullAPIKeyAttributes:
|
|
5928
6241
|
description: Attributes of a full API key.
|
|
5929
6242
|
properties:
|
|
6243
|
+
category:
|
|
6244
|
+
description: The category of the API key.
|
|
6245
|
+
type: string
|
|
5930
6246
|
created_at:
|
|
5931
6247
|
description: Creation date of the API key.
|
|
5932
6248
|
example: '2020-11-23T10:00:00.000Z'
|
|
@@ -5952,6 +6268,9 @@ components:
|
|
|
5952
6268
|
description: Name of the API key.
|
|
5953
6269
|
example: API Key for submitting metrics
|
|
5954
6270
|
type: string
|
|
6271
|
+
remote_config_read_enabled:
|
|
6272
|
+
description: The remote config read enabled status.
|
|
6273
|
+
type: boolean
|
|
5955
6274
|
type: object
|
|
5956
6275
|
FullApplicationKey:
|
|
5957
6276
|
description: Datadog application key.
|
|
@@ -6173,6 +6492,15 @@ components:
|
|
|
6173
6492
|
- _HANDLE
|
|
6174
6493
|
- EMAIL
|
|
6175
6494
|
- _EMAIL
|
|
6495
|
+
GitCommitSHA:
|
|
6496
|
+
description: Git Commit SHA.
|
|
6497
|
+
example: 66adc9350f2cc9b250b69abddab733dd55e1a588
|
|
6498
|
+
pattern: ^[a-fA-F0-9]{40,}$
|
|
6499
|
+
type: string
|
|
6500
|
+
GitRepositoryURL:
|
|
6501
|
+
description: Git Repository URL
|
|
6502
|
+
example: https://github.com/organization/example-repository
|
|
6503
|
+
type: string
|
|
6176
6504
|
GroupScalarColumn:
|
|
6177
6505
|
description: A column containing the tag keys and values in a group.
|
|
6178
6506
|
properties:
|
|
@@ -6566,6 +6894,11 @@ components:
|
|
|
6566
6894
|
$ref: '#/components/schemas/IncidentAttachmentLinkAttributesAttachmentObject'
|
|
6567
6895
|
attachment_type:
|
|
6568
6896
|
$ref: '#/components/schemas/IncidentAttachmentLinkAttachmentType'
|
|
6897
|
+
modified:
|
|
6898
|
+
description: Timestamp when the incident attachment link was last modified.
|
|
6899
|
+
format: date-time
|
|
6900
|
+
readOnly: true
|
|
6901
|
+
type: string
|
|
6569
6902
|
required:
|
|
6570
6903
|
- attachment_type
|
|
6571
6904
|
- attachment
|
|
@@ -6871,9 +7204,22 @@ components:
|
|
|
6871
7204
|
- TEXTARRAY
|
|
6872
7205
|
- METRICTAG
|
|
6873
7206
|
- AUTOCOMPLETE
|
|
7207
|
+
IncidentImpactsType:
|
|
7208
|
+
description: The incident impacts type.
|
|
7209
|
+
enum:
|
|
7210
|
+
- incident_impacts
|
|
7211
|
+
example: incident_impacts
|
|
7212
|
+
type: string
|
|
7213
|
+
x-enum-varnames:
|
|
7214
|
+
- INCIDENT_IMPACTS
|
|
6874
7215
|
IncidentIntegrationMetadataAttributes:
|
|
6875
7216
|
description: Incident integration metadata's attributes for a create request.
|
|
6876
7217
|
properties:
|
|
7218
|
+
created:
|
|
7219
|
+
description: Timestamp when the incident todo was created.
|
|
7220
|
+
format: date-time
|
|
7221
|
+
readOnly: true
|
|
7222
|
+
type: string
|
|
6877
7223
|
incident_id:
|
|
6878
7224
|
description: UUID of the incident this integration metadata is connected
|
|
6879
7225
|
to.
|
|
@@ -6890,6 +7236,11 @@ components:
|
|
|
6890
7236
|
type: integer
|
|
6891
7237
|
metadata:
|
|
6892
7238
|
$ref: '#/components/schemas/IncidentIntegrationMetadataMetadata'
|
|
7239
|
+
modified:
|
|
7240
|
+
description: Timestamp when the incident todo was last modified.
|
|
7241
|
+
format: date-time
|
|
7242
|
+
readOnly: true
|
|
7243
|
+
type: string
|
|
6893
7244
|
status:
|
|
6894
7245
|
description: 'A number indicating the status of this integration metadata.
|
|
6895
7246
|
0 indicates unknown;
|
|
@@ -6989,6 +7340,8 @@ components:
|
|
|
6989
7340
|
description: The incident integration metadata's ID.
|
|
6990
7341
|
example: 00000000-0000-0000-1234-000000000000
|
|
6991
7342
|
type: string
|
|
7343
|
+
relationships:
|
|
7344
|
+
$ref: '#/components/schemas/IncidentIntegrationRelationships'
|
|
6992
7345
|
type:
|
|
6993
7346
|
$ref: '#/components/schemas/IncidentIntegrationMetadataType'
|
|
6994
7347
|
required:
|
|
@@ -7009,6 +7362,25 @@ components:
|
|
|
7009
7362
|
type: string
|
|
7010
7363
|
x-enum-varnames:
|
|
7011
7364
|
- INCIDENT_INTEGRATIONS
|
|
7365
|
+
IncidentIntegrationRelationships:
|
|
7366
|
+
description: The incident's integration relationships from a response.
|
|
7367
|
+
properties:
|
|
7368
|
+
created_by_user:
|
|
7369
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
|
7370
|
+
last_modified_by_user:
|
|
7371
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
|
7372
|
+
type: object
|
|
7373
|
+
IncidentNonDatadogCreator:
|
|
7374
|
+
description: Incident's non Datadog creator.
|
|
7375
|
+
nullable: true
|
|
7376
|
+
properties:
|
|
7377
|
+
image_48_px:
|
|
7378
|
+
description: Non Datadog creator `48px` image.
|
|
7379
|
+
type: string
|
|
7380
|
+
name:
|
|
7381
|
+
description: Non Datadog creator name.
|
|
7382
|
+
type: string
|
|
7383
|
+
type: object
|
|
7012
7384
|
IncidentNotificationHandle:
|
|
7013
7385
|
description: A notification handle that will be notified at incident creation.
|
|
7014
7386
|
properties:
|
|
@@ -7039,6 +7411,14 @@ components:
|
|
|
7039
7411
|
x-enum-varnames:
|
|
7040
7412
|
- USERS
|
|
7041
7413
|
- ATTACHMENTS
|
|
7414
|
+
IncidentRespondersType:
|
|
7415
|
+
description: The incident responders type.
|
|
7416
|
+
enum:
|
|
7417
|
+
- incident_responders
|
|
7418
|
+
example: incident_responders
|
|
7419
|
+
type: string
|
|
7420
|
+
x-enum-varnames:
|
|
7421
|
+
- INCIDENT_RESPONDERS
|
|
7042
7422
|
IncidentResponse:
|
|
7043
7423
|
description: Response with an incident.
|
|
7044
7424
|
properties:
|
|
@@ -7056,6 +7436,17 @@ components:
|
|
|
7056
7436
|
IncidentResponseAttributes:
|
|
7057
7437
|
description: The incident's attributes from a response.
|
|
7058
7438
|
properties:
|
|
7439
|
+
archived:
|
|
7440
|
+
description: Timestamp of when the incident was archived.
|
|
7441
|
+
format: date-time
|
|
7442
|
+
nullable: true
|
|
7443
|
+
readOnly: true
|
|
7444
|
+
type: string
|
|
7445
|
+
case_id:
|
|
7446
|
+
description: The incident case id.
|
|
7447
|
+
format: int64
|
|
7448
|
+
nullable: true
|
|
7449
|
+
type: integer
|
|
7059
7450
|
created:
|
|
7060
7451
|
description: Timestamp when the incident was created.
|
|
7061
7452
|
format: date-time
|
|
@@ -7106,6 +7497,8 @@ components:
|
|
|
7106
7497
|
format: date-time
|
|
7107
7498
|
readOnly: true
|
|
7108
7499
|
type: string
|
|
7500
|
+
non_datadog_creator:
|
|
7501
|
+
$ref: '#/components/schemas/IncidentNonDatadogCreator'
|
|
7109
7502
|
notification_handles:
|
|
7110
7503
|
description: Notification handles that will be notified of the incident
|
|
7111
7504
|
during update.
|
|
@@ -7124,6 +7517,12 @@ components:
|
|
|
7124
7517
|
format: date-time
|
|
7125
7518
|
nullable: true
|
|
7126
7519
|
type: string
|
|
7520
|
+
severity:
|
|
7521
|
+
$ref: '#/components/schemas/IncidentSeverity'
|
|
7522
|
+
state:
|
|
7523
|
+
description: The state incident.
|
|
7524
|
+
nullable: true
|
|
7525
|
+
type: string
|
|
7127
7526
|
time_to_detect:
|
|
7128
7527
|
description: 'The amount of time in seconds to detect the incident.
|
|
7129
7528
|
|
|
@@ -7154,6 +7553,10 @@ components:
|
|
|
7154
7553
|
description: The title of the incident, which summarizes what happened.
|
|
7155
7554
|
example: A test incident title
|
|
7156
7555
|
type: string
|
|
7556
|
+
visibility:
|
|
7557
|
+
description: The incident visibility status.
|
|
7558
|
+
nullable: true
|
|
7559
|
+
type: string
|
|
7157
7560
|
required:
|
|
7158
7561
|
- title
|
|
7159
7562
|
type: object
|
|
@@ -7215,10 +7618,16 @@ components:
|
|
|
7215
7618
|
$ref: '#/components/schemas/NullableRelationshipToUser'
|
|
7216
7619
|
created_by_user:
|
|
7217
7620
|
$ref: '#/components/schemas/RelationshipToUser'
|
|
7621
|
+
impacts:
|
|
7622
|
+
$ref: '#/components/schemas/RelationshipToIncidentImpacts'
|
|
7218
7623
|
integrations:
|
|
7219
7624
|
$ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas'
|
|
7220
7625
|
last_modified_by_user:
|
|
7221
7626
|
$ref: '#/components/schemas/RelationshipToUser'
|
|
7627
|
+
responders:
|
|
7628
|
+
$ref: '#/components/schemas/RelationshipToIncidentResponders'
|
|
7629
|
+
user_defined_fields:
|
|
7630
|
+
$ref: '#/components/schemas/RelationshipToIncidentUserDefinedFields'
|
|
7222
7631
|
type: object
|
|
7223
7632
|
IncidentSearchResponse:
|
|
7224
7633
|
description: Response with incidents and facets.
|
|
@@ -7601,6 +8010,24 @@ components:
|
|
|
7601
8010
|
required:
|
|
7602
8011
|
- data
|
|
7603
8012
|
type: object
|
|
8013
|
+
IncidentSeverity:
|
|
8014
|
+
description: The incident severity.
|
|
8015
|
+
enum:
|
|
8016
|
+
- UNKNOWN
|
|
8017
|
+
- SEV-1
|
|
8018
|
+
- SEV-2
|
|
8019
|
+
- SEV-3
|
|
8020
|
+
- SEV-4
|
|
8021
|
+
- SEV-5
|
|
8022
|
+
example: UNKNOWN
|
|
8023
|
+
type: string
|
|
8024
|
+
x-enum-varnames:
|
|
8025
|
+
- UNKNOWN
|
|
8026
|
+
- SEV_1
|
|
8027
|
+
- SEV_2
|
|
8028
|
+
- SEV_3
|
|
8029
|
+
- SEV_4
|
|
8030
|
+
- SEV_5
|
|
7604
8031
|
IncidentTeamCreateAttributes:
|
|
7605
8032
|
description: The incident team's attributes for a create request.
|
|
7606
8033
|
properties:
|
|
@@ -7860,6 +8287,11 @@ components:
|
|
|
7860
8287
|
description: The follow-up task's content.
|
|
7861
8288
|
example: Restore lost data.
|
|
7862
8289
|
type: string
|
|
8290
|
+
created:
|
|
8291
|
+
description: Timestamp when the incident todo was created.
|
|
8292
|
+
format: date-time
|
|
8293
|
+
readOnly: true
|
|
8294
|
+
type: string
|
|
7863
8295
|
due_date:
|
|
7864
8296
|
description: Timestamp when the todo should be completed by.
|
|
7865
8297
|
example: '2023-07-10T05:00:00.000000+00:00'
|
|
@@ -7869,6 +8301,11 @@ components:
|
|
|
7869
8301
|
description: UUID of the incident this todo is connected to.
|
|
7870
8302
|
example: 00000000-aaaa-0000-0000-000000000000
|
|
7871
8303
|
type: string
|
|
8304
|
+
modified:
|
|
8305
|
+
description: Timestamp when the incident todo was last modified.
|
|
8306
|
+
format: date-time
|
|
8307
|
+
readOnly: true
|
|
8308
|
+
type: string
|
|
7872
8309
|
required:
|
|
7873
8310
|
- content
|
|
7874
8311
|
- assignees
|
|
@@ -7930,6 +8367,14 @@ components:
|
|
|
7930
8367
|
required:
|
|
7931
8368
|
- data
|
|
7932
8369
|
type: object
|
|
8370
|
+
IncidentTodoRelationships:
|
|
8371
|
+
description: The incident's relationships from a response.
|
|
8372
|
+
properties:
|
|
8373
|
+
created_by_user:
|
|
8374
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
|
8375
|
+
last_modified_by_user:
|
|
8376
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
|
8377
|
+
type: object
|
|
7933
8378
|
IncidentTodoResponse:
|
|
7934
8379
|
description: Response with an incident todo.
|
|
7935
8380
|
properties:
|
|
@@ -7953,6 +8398,8 @@ components:
|
|
|
7953
8398
|
description: The incident todo's ID.
|
|
7954
8399
|
example: 00000000-0000-0000-1234-000000000000
|
|
7955
8400
|
type: string
|
|
8401
|
+
relationships:
|
|
8402
|
+
$ref: '#/components/schemas/IncidentTodoRelationships'
|
|
7956
8403
|
type:
|
|
7957
8404
|
$ref: '#/components/schemas/IncidentTodoType'
|
|
7958
8405
|
required:
|
|
@@ -8063,6 +8510,14 @@ components:
|
|
|
8063
8510
|
required:
|
|
8064
8511
|
- data
|
|
8065
8512
|
type: object
|
|
8513
|
+
IncidentUserDefinedFieldType:
|
|
8514
|
+
description: The incident user defined fields type.
|
|
8515
|
+
enum:
|
|
8516
|
+
- user_defined_field
|
|
8517
|
+
example: user_defined_field
|
|
8518
|
+
type: string
|
|
8519
|
+
x-enum-varnames:
|
|
8520
|
+
- USER_DEFINED_FIELD
|
|
8066
8521
|
IncidentsResponse:
|
|
8067
8522
|
description: Response with a list of incidents.
|
|
8068
8523
|
properties:
|
|
@@ -8261,6 +8716,8 @@ components:
|
|
|
8261
8716
|
items:
|
|
8262
8717
|
$ref: '#/components/schemas/ApplicationKeyResponseIncludedItem'
|
|
8263
8718
|
type: array
|
|
8719
|
+
meta:
|
|
8720
|
+
$ref: '#/components/schemas/ApplicationKeyResponseMeta'
|
|
8264
8721
|
type: object
|
|
8265
8722
|
ListDowntimesResponse:
|
|
8266
8723
|
description: Response for retrieving all downtimes.
|
|
@@ -10753,29 +11210,234 @@ components:
|
|
|
10753
11210
|
description: The monitor type.
|
|
10754
11211
|
type: string
|
|
10755
11212
|
type: object
|
|
10756
|
-
|
|
10757
|
-
description:
|
|
10758
|
-
properties:
|
|
10759
|
-
data:
|
|
10760
|
-
$ref: '#/components/schemas/NullableRelationshipToUserData'
|
|
10761
|
-
required:
|
|
10762
|
-
- data
|
|
10763
|
-
type: object
|
|
10764
|
-
NullableRelationshipToUserData:
|
|
10765
|
-
description: Relationship to user object.
|
|
10766
|
-
nullable: true
|
|
11213
|
+
MonthlyCostAttributionAttributes:
|
|
11214
|
+
description: Cost Attribution by Tag for a given organization.
|
|
10767
11215
|
properties:
|
|
10768
|
-
|
|
10769
|
-
description:
|
|
10770
|
-
|
|
11216
|
+
month:
|
|
11217
|
+
description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.'
|
|
11218
|
+
format: date-time
|
|
10771
11219
|
type: string
|
|
10772
|
-
|
|
10773
|
-
|
|
10774
|
-
|
|
10775
|
-
|
|
10776
|
-
|
|
10777
|
-
|
|
10778
|
-
|
|
11220
|
+
org_name:
|
|
11221
|
+
description: The name of the organization.
|
|
11222
|
+
type: string
|
|
11223
|
+
public_id:
|
|
11224
|
+
description: The organization public ID.
|
|
11225
|
+
type: string
|
|
11226
|
+
tag_config_source:
|
|
11227
|
+
description: The source of the cost attribution tag configuration and the
|
|
11228
|
+
selected tags in the format `<source_org_name>:::<selected tag 1>///<selected
|
|
11229
|
+
tag 2>///<selected tag 3>`.
|
|
11230
|
+
type: string
|
|
11231
|
+
tags:
|
|
11232
|
+
$ref: '#/components/schemas/CostAttributionTagNames'
|
|
11233
|
+
updated_at:
|
|
11234
|
+
description: Shows the most recent hour in the current months for all organizations
|
|
11235
|
+
for which all costs were calculated.
|
|
11236
|
+
type: string
|
|
11237
|
+
values:
|
|
11238
|
+
description: 'Fields in Cost Attribution by tag(s). Example: `infra_host_on_demand_cost`,
|
|
11239
|
+
`infra_host_committed_cost`, `infra_host_total_cost`, `infra_host_percentage_in_org`,
|
|
11240
|
+
`infra_host_percentage_in_account`.'
|
|
11241
|
+
type: object
|
|
11242
|
+
type: object
|
|
11243
|
+
MonthlyCostAttributionBody:
|
|
11244
|
+
description: Cost data.
|
|
11245
|
+
properties:
|
|
11246
|
+
attributes:
|
|
11247
|
+
$ref: '#/components/schemas/MonthlyCostAttributionAttributes'
|
|
11248
|
+
id:
|
|
11249
|
+
description: Unique ID of the response.
|
|
11250
|
+
type: string
|
|
11251
|
+
type:
|
|
11252
|
+
$ref: '#/components/schemas/CostAttributionType'
|
|
11253
|
+
type: object
|
|
11254
|
+
MonthlyCostAttributionMeta:
|
|
11255
|
+
description: The object containing document metadata.
|
|
11256
|
+
properties:
|
|
11257
|
+
aggregates:
|
|
11258
|
+
$ref: '#/components/schemas/CostAttributionAggregates'
|
|
11259
|
+
pagination:
|
|
11260
|
+
$ref: '#/components/schemas/MonthlyCostAttributionPagination'
|
|
11261
|
+
type: object
|
|
11262
|
+
MonthlyCostAttributionPagination:
|
|
11263
|
+
description: The metadata for the current pagination.
|
|
11264
|
+
properties:
|
|
11265
|
+
next_record_id:
|
|
11266
|
+
description: The cursor to use to get the next results, if any. To make
|
|
11267
|
+
the next request, use the same parameters with the addition of the `next_record_id`.
|
|
11268
|
+
nullable: true
|
|
11269
|
+
type: string
|
|
11270
|
+
type: object
|
|
11271
|
+
MonthlyCostAttributionResponse:
|
|
11272
|
+
description: Response containing the monthly cost attribution by tag(s).
|
|
11273
|
+
properties:
|
|
11274
|
+
data:
|
|
11275
|
+
description: Response containing cost attribution.
|
|
11276
|
+
items:
|
|
11277
|
+
$ref: '#/components/schemas/MonthlyCostAttributionBody'
|
|
11278
|
+
type: array
|
|
11279
|
+
meta:
|
|
11280
|
+
$ref: '#/components/schemas/MonthlyCostAttributionMeta'
|
|
11281
|
+
type: object
|
|
11282
|
+
NullableRelationshipToUser:
|
|
11283
|
+
description: Relationship to user.
|
|
11284
|
+
nullable: true
|
|
11285
|
+
properties:
|
|
11286
|
+
data:
|
|
11287
|
+
$ref: '#/components/schemas/NullableRelationshipToUserData'
|
|
11288
|
+
required:
|
|
11289
|
+
- data
|
|
11290
|
+
type: object
|
|
11291
|
+
NullableRelationshipToUserData:
|
|
11292
|
+
description: Relationship to user object.
|
|
11293
|
+
nullable: true
|
|
11294
|
+
properties:
|
|
11295
|
+
id:
|
|
11296
|
+
description: A unique identifier that represents the user.
|
|
11297
|
+
example: 00000000-0000-0000-0000-000000000000
|
|
11298
|
+
type: string
|
|
11299
|
+
type:
|
|
11300
|
+
$ref: '#/components/schemas/UsersType'
|
|
11301
|
+
required:
|
|
11302
|
+
- id
|
|
11303
|
+
- type
|
|
11304
|
+
type: object
|
|
11305
|
+
OktaAccount:
|
|
11306
|
+
description: Schema for an Okta account.
|
|
11307
|
+
properties:
|
|
11308
|
+
attributes:
|
|
11309
|
+
$ref: '#/components/schemas/OktaAccountAttributes'
|
|
11310
|
+
id:
|
|
11311
|
+
description: The ID of the Okta account, a UUID hash of the account name.
|
|
11312
|
+
example: f749daaf-682e-4208-a38d-c9b43162c609
|
|
11313
|
+
type: string
|
|
11314
|
+
type:
|
|
11315
|
+
$ref: '#/components/schemas/OktaAccountType'
|
|
11316
|
+
required:
|
|
11317
|
+
- attributes
|
|
11318
|
+
- type
|
|
11319
|
+
type: object
|
|
11320
|
+
OktaAccountAttributes:
|
|
11321
|
+
description: Attributes object for an Okta account.
|
|
11322
|
+
properties:
|
|
11323
|
+
api_key:
|
|
11324
|
+
description: The API key of the Okta account.
|
|
11325
|
+
type: string
|
|
11326
|
+
writeOnly: true
|
|
11327
|
+
auth_method:
|
|
11328
|
+
description: The authorization method for an Okta account.
|
|
11329
|
+
example: oauth
|
|
11330
|
+
type: string
|
|
11331
|
+
client_id:
|
|
11332
|
+
description: The Client ID of an Okta app integration.
|
|
11333
|
+
type: string
|
|
11334
|
+
client_secret:
|
|
11335
|
+
description: The client secret of an Okta app integration.
|
|
11336
|
+
type: string
|
|
11337
|
+
writeOnly: true
|
|
11338
|
+
domain:
|
|
11339
|
+
description: The domain of the Okta account.
|
|
11340
|
+
example: https://example.okta.com/
|
|
11341
|
+
type: string
|
|
11342
|
+
name:
|
|
11343
|
+
description: The name of the Okta account.
|
|
11344
|
+
example: Okta-Prod
|
|
11345
|
+
type: string
|
|
11346
|
+
required:
|
|
11347
|
+
- auth_method
|
|
11348
|
+
- domain
|
|
11349
|
+
- name
|
|
11350
|
+
type: object
|
|
11351
|
+
OktaAccountRequest:
|
|
11352
|
+
description: Request object for an Okta account.
|
|
11353
|
+
properties:
|
|
11354
|
+
data:
|
|
11355
|
+
$ref: '#/components/schemas/OktaAccount'
|
|
11356
|
+
required:
|
|
11357
|
+
- data
|
|
11358
|
+
type: object
|
|
11359
|
+
OktaAccountResponse:
|
|
11360
|
+
description: Response object for an Okta account.
|
|
11361
|
+
properties:
|
|
11362
|
+
data:
|
|
11363
|
+
$ref: '#/components/schemas/OktaAccount'
|
|
11364
|
+
type: object
|
|
11365
|
+
OktaAccountResponseData:
|
|
11366
|
+
description: Data object of an Okta account
|
|
11367
|
+
properties:
|
|
11368
|
+
attributes:
|
|
11369
|
+
$ref: '#/components/schemas/OktaAccountAttributes'
|
|
11370
|
+
id:
|
|
11371
|
+
description: The ID of the Okta account, a UUID hash of the account name.
|
|
11372
|
+
example: f749daaf-682e-4208-a38d-c9b43162c609
|
|
11373
|
+
type: string
|
|
11374
|
+
type:
|
|
11375
|
+
$ref: '#/components/schemas/OktaAccountType'
|
|
11376
|
+
required:
|
|
11377
|
+
- attributes
|
|
11378
|
+
- id
|
|
11379
|
+
- type
|
|
11380
|
+
type: object
|
|
11381
|
+
OktaAccountType:
|
|
11382
|
+
default: okta-accounts
|
|
11383
|
+
description: Account type for an Okta account.
|
|
11384
|
+
enum:
|
|
11385
|
+
- okta-accounts
|
|
11386
|
+
example: okta-accounts
|
|
11387
|
+
type: string
|
|
11388
|
+
x-enum-varnames:
|
|
11389
|
+
- OKTA_ACCOUNTS
|
|
11390
|
+
OktaAccountUpdateRequest:
|
|
11391
|
+
description: Payload schema when updating an Okta account.
|
|
11392
|
+
properties:
|
|
11393
|
+
data:
|
|
11394
|
+
$ref: '#/components/schemas/OktaAccountUpdateRequestData'
|
|
11395
|
+
required:
|
|
11396
|
+
- data
|
|
11397
|
+
type: object
|
|
11398
|
+
OktaAccountUpdateRequestAttributes:
|
|
11399
|
+
description: Attributes object for updating an Okta account.
|
|
11400
|
+
properties:
|
|
11401
|
+
api_key:
|
|
11402
|
+
description: The API key of the Okta account.
|
|
11403
|
+
type: string
|
|
11404
|
+
writeOnly: true
|
|
11405
|
+
auth_method:
|
|
11406
|
+
description: The authorization method for an Okta account.
|
|
11407
|
+
example: oauth
|
|
11408
|
+
type: string
|
|
11409
|
+
client_id:
|
|
11410
|
+
description: The Client ID of an Okta app integration.
|
|
11411
|
+
type: string
|
|
11412
|
+
client_secret:
|
|
11413
|
+
description: The client secret of an Okta app integration.
|
|
11414
|
+
type: string
|
|
11415
|
+
writeOnly: true
|
|
11416
|
+
domain:
|
|
11417
|
+
description: The domain associated with an Okta account.
|
|
11418
|
+
example: https://dev-test.okta.com/
|
|
11419
|
+
type: string
|
|
11420
|
+
required:
|
|
11421
|
+
- auth_method
|
|
11422
|
+
- domain
|
|
11423
|
+
type: object
|
|
11424
|
+
OktaAccountUpdateRequestData:
|
|
11425
|
+
description: Data object for updating an Okta account.
|
|
11426
|
+
properties:
|
|
11427
|
+
attributes:
|
|
11428
|
+
$ref: '#/components/schemas/OktaAccountUpdateRequestAttributes'
|
|
11429
|
+
type:
|
|
11430
|
+
$ref: '#/components/schemas/OktaAccountType'
|
|
11431
|
+
OktaAccountsResponse:
|
|
11432
|
+
description: The expected response schema when getting Okta accounts.
|
|
11433
|
+
properties:
|
|
11434
|
+
data:
|
|
11435
|
+
description: List of Okta accounts.
|
|
11436
|
+
items:
|
|
11437
|
+
$ref: '#/components/schemas/OktaAccountResponseData'
|
|
11438
|
+
type: array
|
|
11439
|
+
type: object
|
|
11440
|
+
OnDemandConcurrencyCap:
|
|
10779
11441
|
description: On-demand concurrency cap.
|
|
10780
11442
|
properties:
|
|
10781
11443
|
attributes:
|
|
@@ -11231,6 +11893,9 @@ components:
|
|
|
11231
11893
|
PartialAPIKeyAttributes:
|
|
11232
11894
|
description: Attributes of a partial API key.
|
|
11233
11895
|
properties:
|
|
11896
|
+
category:
|
|
11897
|
+
description: The category of the API key.
|
|
11898
|
+
type: string
|
|
11234
11899
|
created_at:
|
|
11235
11900
|
description: Creation date of the API key.
|
|
11236
11901
|
example: '2020-11-23T10:00:00.000Z'
|
|
@@ -11252,6 +11917,9 @@ components:
|
|
|
11252
11917
|
description: Name of the API key.
|
|
11253
11918
|
example: API Key for submitting metrics
|
|
11254
11919
|
type: string
|
|
11920
|
+
remote_config_read_enabled:
|
|
11921
|
+
description: The remote config read enabled status.
|
|
11922
|
+
type: boolean
|
|
11255
11923
|
type: object
|
|
11256
11924
|
PartialApplicationKey:
|
|
11257
11925
|
description: Partial Datadog application key.
|
|
@@ -11563,7 +12231,7 @@ components:
|
|
|
11563
12231
|
description: Powerpack relationship object.
|
|
11564
12232
|
properties:
|
|
11565
12233
|
author:
|
|
11566
|
-
$ref: '#/components/schemas/
|
|
12234
|
+
$ref: '#/components/schemas/RelationshipToUser'
|
|
11567
12235
|
type: object
|
|
11568
12236
|
PowerpackResponse:
|
|
11569
12237
|
description: Response object which includes a single powerpack configuration.
|
|
@@ -11635,6 +12303,7 @@ components:
|
|
|
11635
12303
|
last_offset:
|
|
11636
12304
|
description: The last offset.
|
|
11637
12305
|
format: int64
|
|
12306
|
+
nullable: true
|
|
11638
12307
|
type: integer
|
|
11639
12308
|
limit:
|
|
11640
12309
|
description: Pagination limit.
|
|
@@ -11747,6 +12416,62 @@ components:
|
|
|
11747
12416
|
type: string
|
|
11748
12417
|
x-enum-varnames:
|
|
11749
12418
|
- PROCESS
|
|
12419
|
+
ProjectedCost:
|
|
12420
|
+
description: Projected Cost data.
|
|
12421
|
+
properties:
|
|
12422
|
+
attributes:
|
|
12423
|
+
$ref: '#/components/schemas/ProjectedCostAttributes'
|
|
12424
|
+
id:
|
|
12425
|
+
description: Unique ID of the response.
|
|
12426
|
+
type: string
|
|
12427
|
+
type:
|
|
12428
|
+
$ref: '#/components/schemas/ProjectedCostType'
|
|
12429
|
+
type: object
|
|
12430
|
+
ProjectedCostAttributes:
|
|
12431
|
+
description: Projected Cost attributes data.
|
|
12432
|
+
properties:
|
|
12433
|
+
charges:
|
|
12434
|
+
description: List of charges data reported for the requested month.
|
|
12435
|
+
items:
|
|
12436
|
+
$ref: '#/components/schemas/ChargebackBreakdown'
|
|
12437
|
+
type: array
|
|
12438
|
+
date:
|
|
12439
|
+
description: The month requested.
|
|
12440
|
+
format: date-time
|
|
12441
|
+
type: string
|
|
12442
|
+
org_name:
|
|
12443
|
+
description: The organization name.
|
|
12444
|
+
type: string
|
|
12445
|
+
projected_total_cost:
|
|
12446
|
+
description: The total projected cost of products for the month.
|
|
12447
|
+
format: double
|
|
12448
|
+
type: number
|
|
12449
|
+
public_id:
|
|
12450
|
+
description: The organization public ID.
|
|
12451
|
+
type: string
|
|
12452
|
+
region:
|
|
12453
|
+
description: The region of the Datadog instance that the organization belongs
|
|
12454
|
+
to.
|
|
12455
|
+
type: string
|
|
12456
|
+
type: object
|
|
12457
|
+
ProjectedCostResponse:
|
|
12458
|
+
description: Projected Cost response.
|
|
12459
|
+
properties:
|
|
12460
|
+
data:
|
|
12461
|
+
description: Response containing Projected Cost.
|
|
12462
|
+
items:
|
|
12463
|
+
$ref: '#/components/schemas/ProjectedCost'
|
|
12464
|
+
type: array
|
|
12465
|
+
type: object
|
|
12466
|
+
ProjectedCostType:
|
|
12467
|
+
default: projected_cost
|
|
12468
|
+
description: Type of cost data.
|
|
12469
|
+
enum:
|
|
12470
|
+
- projected_cost
|
|
12471
|
+
example: projected_cost
|
|
12472
|
+
type: string
|
|
12473
|
+
x-enum-varnames:
|
|
12474
|
+
- PROJECt_COST
|
|
11750
12475
|
QueryFormula:
|
|
11751
12476
|
description: A formula for calculation based on one or more queries.
|
|
11752
12477
|
properties:
|
|
@@ -12559,6 +13284,30 @@ components:
|
|
|
12559
13284
|
- id
|
|
12560
13285
|
- type
|
|
12561
13286
|
type: object
|
|
13287
|
+
RelationshipToIncidentImpactData:
|
|
13288
|
+
description: Relationship to impact object.
|
|
13289
|
+
properties:
|
|
13290
|
+
id:
|
|
13291
|
+
description: A unique identifier that represents the impact.
|
|
13292
|
+
example: 00000000-0000-0000-2345-000000000000
|
|
13293
|
+
type: string
|
|
13294
|
+
type:
|
|
13295
|
+
$ref: '#/components/schemas/IncidentImpactsType'
|
|
13296
|
+
required:
|
|
13297
|
+
- id
|
|
13298
|
+
- type
|
|
13299
|
+
type: object
|
|
13300
|
+
RelationshipToIncidentImpacts:
|
|
13301
|
+
description: Relationship to impacts.
|
|
13302
|
+
properties:
|
|
13303
|
+
data:
|
|
13304
|
+
description: An array of incident impacts.
|
|
13305
|
+
items:
|
|
13306
|
+
$ref: '#/components/schemas/RelationshipToIncidentImpactData'
|
|
13307
|
+
type: array
|
|
13308
|
+
required:
|
|
13309
|
+
- data
|
|
13310
|
+
type: object
|
|
12562
13311
|
RelationshipToIncidentIntegrationMetadataData:
|
|
12563
13312
|
description: A relationship reference for an integration metadata object.
|
|
12564
13313
|
example:
|
|
@@ -12625,6 +13374,54 @@ components:
|
|
|
12625
13374
|
- id
|
|
12626
13375
|
- type
|
|
12627
13376
|
type: object
|
|
13377
|
+
RelationshipToIncidentResponderData:
|
|
13378
|
+
description: Relationship to impact object.
|
|
13379
|
+
properties:
|
|
13380
|
+
id:
|
|
13381
|
+
description: A unique identifier that represents the responder.
|
|
13382
|
+
example: 00000000-0000-0000-2345-000000000000
|
|
13383
|
+
type: string
|
|
13384
|
+
type:
|
|
13385
|
+
$ref: '#/components/schemas/IncidentRespondersType'
|
|
13386
|
+
required:
|
|
13387
|
+
- id
|
|
13388
|
+
- type
|
|
13389
|
+
type: object
|
|
13390
|
+
RelationshipToIncidentResponders:
|
|
13391
|
+
description: Relationship to incident responders.
|
|
13392
|
+
properties:
|
|
13393
|
+
data:
|
|
13394
|
+
description: An array of incident responders.
|
|
13395
|
+
items:
|
|
13396
|
+
$ref: '#/components/schemas/RelationshipToIncidentResponderData'
|
|
13397
|
+
type: array
|
|
13398
|
+
required:
|
|
13399
|
+
- data
|
|
13400
|
+
type: object
|
|
13401
|
+
RelationshipToIncidentUserDefinedFieldData:
|
|
13402
|
+
description: Relationship to impact object.
|
|
13403
|
+
properties:
|
|
13404
|
+
id:
|
|
13405
|
+
description: A unique identifier that represents the responder.
|
|
13406
|
+
example: 00000000-0000-0000-2345-000000000000
|
|
13407
|
+
type: string
|
|
13408
|
+
type:
|
|
13409
|
+
$ref: '#/components/schemas/IncidentUserDefinedFieldType'
|
|
13410
|
+
required:
|
|
13411
|
+
- id
|
|
13412
|
+
- type
|
|
13413
|
+
type: object
|
|
13414
|
+
RelationshipToIncidentUserDefinedFields:
|
|
13415
|
+
description: Relationship to incident user defined fields.
|
|
13416
|
+
properties:
|
|
13417
|
+
data:
|
|
13418
|
+
description: An array of user defined fields.
|
|
13419
|
+
items:
|
|
13420
|
+
$ref: '#/components/schemas/RelationshipToIncidentUserDefinedFieldData'
|
|
13421
|
+
type: array
|
|
13422
|
+
required:
|
|
13423
|
+
- data
|
|
13424
|
+
type: object
|
|
12628
13425
|
RelationshipToOrganization:
|
|
12629
13426
|
description: Relationship to an organization.
|
|
12630
13427
|
properties:
|
|
@@ -14299,10 +15096,12 @@ components:
|
|
|
14299
15096
|
SecurityMonitoringRuleTypeCreate:
|
|
14300
15097
|
description: The rule type.
|
|
14301
15098
|
enum:
|
|
15099
|
+
- application_security
|
|
14302
15100
|
- log_detection
|
|
14303
15101
|
- workload_security
|
|
14304
15102
|
type: string
|
|
14305
15103
|
x-enum-varnames:
|
|
15104
|
+
- APPLICATION_SECURITY
|
|
14306
15105
|
- LOG_DETECTION
|
|
14307
15106
|
- WORKLOAD_SECURITY
|
|
14308
15107
|
SecurityMonitoringRuleTypeRead:
|
|
@@ -15665,6 +16464,11 @@ components:
|
|
|
15665
16464
|
description:
|
|
15666
16465
|
description: Description of the standard pattern.
|
|
15667
16466
|
type: string
|
|
16467
|
+
included_keywords:
|
|
16468
|
+
description: List of included keywords.
|
|
16469
|
+
items:
|
|
16470
|
+
type: string
|
|
16471
|
+
type: array
|
|
15668
16472
|
name:
|
|
15669
16473
|
description: Name of the standard pattern.
|
|
15670
16474
|
type: string
|
|
@@ -16788,6 +17592,16 @@ components:
|
|
|
16788
17592
|
- channel_name
|
|
16789
17593
|
- redirect_url
|
|
16790
17594
|
type: object
|
|
17595
|
+
SortDirection:
|
|
17596
|
+
default: desc
|
|
17597
|
+
description: The direction to sort by.
|
|
17598
|
+
enum:
|
|
17599
|
+
- desc
|
|
17600
|
+
- asc
|
|
17601
|
+
type: string
|
|
17602
|
+
x-enum-varnames:
|
|
17603
|
+
- DESC
|
|
17604
|
+
- ASC
|
|
16791
17605
|
Span:
|
|
16792
17606
|
description: Object description of a spans after being processed and stored
|
|
16793
17607
|
by Datadog.
|
|
@@ -19028,7 +19842,7 @@ components:
|
|
|
19028
19842
|
an organization. Mute and unmute hosts. The ability to write monitors
|
|
19029
19843
|
is not required to set downtimes.
|
|
19030
19844
|
monitors_read: View monitors.
|
|
19031
|
-
monitors_write: Edit
|
|
19845
|
+
monitors_write: Edit and delete individual monitors.
|
|
19032
19846
|
security_monitoring_filters_read: Read Security Filters.
|
|
19033
19847
|
security_monitoring_filters_write: Create, edit, and delete Security Filters.
|
|
19034
19848
|
security_monitoring_findings_read: View CSPM Findings.
|
|
@@ -20485,9 +21299,6 @@ paths:
|
|
|
20485
21299
|
cursorPath: meta.pagination.next_cursor
|
|
20486
21300
|
limitParam: page[size]
|
|
20487
21301
|
resultsPath: data
|
|
20488
|
-
x-unstable: '**Note**: This endpoint is in public beta.
|
|
20489
|
-
|
|
20490
|
-
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
20491
21302
|
/api/v2/containers:
|
|
20492
21303
|
get:
|
|
20493
21304
|
description: Get all containers for your organization.
|
|
@@ -20535,36 +21346,194 @@ paths:
|
|
|
20535
21346
|
responses:
|
|
20536
21347
|
'200':
|
|
20537
21348
|
content:
|
|
20538
|
-
application/json:
|
|
21349
|
+
application/json:
|
|
21350
|
+
schema:
|
|
21351
|
+
$ref: '#/components/schemas/ContainersResponse'
|
|
21352
|
+
description: OK
|
|
21353
|
+
'400':
|
|
21354
|
+
content:
|
|
21355
|
+
application/json:
|
|
21356
|
+
schema:
|
|
21357
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
21358
|
+
description: Bad Request
|
|
21359
|
+
'403':
|
|
21360
|
+
content:
|
|
21361
|
+
application/json:
|
|
21362
|
+
schema:
|
|
21363
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
21364
|
+
description: Authentication Error
|
|
21365
|
+
'429':
|
|
21366
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
21367
|
+
security:
|
|
21368
|
+
- apiKeyAuth: []
|
|
21369
|
+
appKeyAuth: []
|
|
21370
|
+
- AuthZ: []
|
|
21371
|
+
summary: Get All Containers
|
|
21372
|
+
tags:
|
|
21373
|
+
- Containers
|
|
21374
|
+
x-pagination:
|
|
21375
|
+
cursorParam: page[cursor]
|
|
21376
|
+
cursorPath: meta.pagination.next_cursor
|
|
21377
|
+
limitParam: page[size]
|
|
21378
|
+
resultsPath: data
|
|
21379
|
+
/api/v2/cost_by_tag/active_billing_dimensions:
|
|
21380
|
+
get:
|
|
21381
|
+
description: Get active billing dimensions for cost attribution. Cost data for
|
|
21382
|
+
a given month becomes available no later than the 17th of the following month.
|
|
21383
|
+
operationId: GetActiveBillingDimensions
|
|
21384
|
+
responses:
|
|
21385
|
+
'200':
|
|
21386
|
+
content:
|
|
21387
|
+
application/json;datetime-format=rfc3339:
|
|
21388
|
+
schema:
|
|
21389
|
+
$ref: '#/components/schemas/ActiveBillingDimensionsResponse'
|
|
21390
|
+
description: OK
|
|
21391
|
+
'400':
|
|
21392
|
+
content:
|
|
21393
|
+
application/json;datetime-format=rfc3339:
|
|
21394
|
+
schema:
|
|
21395
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
21396
|
+
description: Bad Request
|
|
21397
|
+
'403':
|
|
21398
|
+
content:
|
|
21399
|
+
application/json;datetime-format=rfc3339:
|
|
21400
|
+
schema:
|
|
21401
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
21402
|
+
description: Forbidden - User is not authorized
|
|
21403
|
+
'429':
|
|
21404
|
+
content:
|
|
21405
|
+
application/json;datetime-format=rfc3339:
|
|
21406
|
+
schema:
|
|
21407
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
21408
|
+
description: Too many requests
|
|
21409
|
+
security:
|
|
21410
|
+
- apiKeyAuth: []
|
|
21411
|
+
appKeyAuth: []
|
|
21412
|
+
- AuthZ: []
|
|
21413
|
+
summary: Get active billing dimensions for cost attribution
|
|
21414
|
+
tags:
|
|
21415
|
+
- Usage Metering
|
|
21416
|
+
x-unstable: '**Note**: This endpoint is in public beta.
|
|
21417
|
+
|
|
21418
|
+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
21419
|
+
/api/v2/cost_by_tag/monthly_cost_attribution:
|
|
21420
|
+
get:
|
|
21421
|
+
description: "Get monthly cost attribution by tag across multi-org and single
|
|
21422
|
+
root-org accounts.\nCost Attribution data for a given month becomes available
|
|
21423
|
+
no later than the 17th of the following month.\nThis API endpoint is paginated.
|
|
21424
|
+
To make sure you receive all records, check if the value of `next_record_id`
|
|
21425
|
+
is\nset in the response. If it is, make another request and pass `next_record_id`
|
|
21426
|
+
as a parameter.\nPseudo code example:\n```\nresponse := GetMonthlyCostAttribution(start_month,
|
|
21427
|
+
end_month)\ncursor := response.metadata.pagination.next_record_id\nWHILE cursor
|
|
21428
|
+
!= null BEGIN\n sleep(5 seconds) # Avoid running into rate limit\n response
|
|
21429
|
+
:= GetMonthlyCostAttribution(start_month, end_month, next_record_id=cursor)\n
|
|
21430
|
+
\ cursor := response.metadata.pagination.next_record_id\nEND\n```"
|
|
21431
|
+
operationId: GetMonthlyCostAttribution
|
|
21432
|
+
parameters:
|
|
21433
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
|
|
21434
|
+
for cost beginning in this month.'
|
|
21435
|
+
in: query
|
|
21436
|
+
name: start_month
|
|
21437
|
+
required: true
|
|
21438
|
+
schema:
|
|
21439
|
+
format: date-time
|
|
21440
|
+
type: string
|
|
21441
|
+
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
|
|
21442
|
+
for cost ending this month.'
|
|
21443
|
+
in: query
|
|
21444
|
+
name: end_month
|
|
21445
|
+
required: true
|
|
21446
|
+
schema:
|
|
21447
|
+
format: date-time
|
|
21448
|
+
type: string
|
|
21449
|
+
- description: 'Comma-separated list specifying cost types (e.g., `<billing_dimension>_on_demand_cost`,
|
|
21450
|
+
`<billing_dimension>_committed_cost`, `<billing_dimension>_total_cost`)
|
|
21451
|
+
and the
|
|
21452
|
+
|
|
21453
|
+
proportions (`<billing_dimension>_percentage_in_org`, `<billing_dimension>_percentage_in_account`).
|
|
21454
|
+
Use `*` to retrieve all fields.
|
|
21455
|
+
|
|
21456
|
+
Example: `infra_host_on_demand_cost,infra_host_percentage_in_account`
|
|
21457
|
+
|
|
21458
|
+
To obtain the complete list of active billing dimensions that can be used
|
|
21459
|
+
to replace
|
|
21460
|
+
|
|
21461
|
+
`<billing_dimension>` in the field names, make a request to the [Get active
|
|
21462
|
+
billing dimensions API](https://docs.datadoghq.com/api/latest/usage-metering/#get-active-billing-dimensions-for-cost-attribution).'
|
|
21463
|
+
in: query
|
|
21464
|
+
name: fields
|
|
21465
|
+
required: true
|
|
21466
|
+
schema:
|
|
21467
|
+
type: string
|
|
21468
|
+
- description: 'The direction to sort by: `[desc, asc]`.'
|
|
21469
|
+
in: query
|
|
21470
|
+
name: sort_direction
|
|
21471
|
+
required: false
|
|
21472
|
+
schema:
|
|
21473
|
+
$ref: '#/components/schemas/SortDirection'
|
|
21474
|
+
- description: 'The billing dimension to sort by. Always sorted by total cost.
|
|
21475
|
+
Example: `infra_host`.'
|
|
21476
|
+
in: query
|
|
21477
|
+
name: sort_name
|
|
21478
|
+
required: false
|
|
21479
|
+
schema:
|
|
21480
|
+
type: string
|
|
21481
|
+
- description: 'Comma separated list of tag keys used to group cost. If no value
|
|
21482
|
+
is provided the cost will not be broken down by tags.
|
|
21483
|
+
|
|
21484
|
+
To see which tags are available, look for the value of `tag_config_source`
|
|
21485
|
+
in the API response.'
|
|
21486
|
+
in: query
|
|
21487
|
+
name: tag_breakdown_keys
|
|
21488
|
+
required: false
|
|
21489
|
+
schema:
|
|
21490
|
+
type: string
|
|
21491
|
+
- description: List following results with a next_record_id provided in the
|
|
21492
|
+
previous query.
|
|
21493
|
+
in: query
|
|
21494
|
+
name: next_record_id
|
|
21495
|
+
required: false
|
|
21496
|
+
schema:
|
|
21497
|
+
type: string
|
|
21498
|
+
- description: Include child org cost in the response. Defaults to `true`.
|
|
21499
|
+
in: query
|
|
21500
|
+
name: include_descendants
|
|
21501
|
+
required: false
|
|
21502
|
+
schema:
|
|
21503
|
+
default: true
|
|
21504
|
+
type: boolean
|
|
21505
|
+
responses:
|
|
21506
|
+
'200':
|
|
21507
|
+
content:
|
|
21508
|
+
application/json;datetime-format=rfc3339:
|
|
20539
21509
|
schema:
|
|
20540
|
-
$ref: '#/components/schemas/
|
|
21510
|
+
$ref: '#/components/schemas/MonthlyCostAttributionResponse'
|
|
20541
21511
|
description: OK
|
|
20542
21512
|
'400':
|
|
20543
21513
|
content:
|
|
20544
|
-
application/json:
|
|
21514
|
+
application/json;datetime-format=rfc3339:
|
|
20545
21515
|
schema:
|
|
20546
21516
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
20547
21517
|
description: Bad Request
|
|
20548
21518
|
'403':
|
|
20549
21519
|
content:
|
|
20550
|
-
application/json:
|
|
21520
|
+
application/json;datetime-format=rfc3339:
|
|
20551
21521
|
schema:
|
|
20552
21522
|
$ref: '#/components/schemas/APIErrorResponse'
|
|
20553
|
-
description:
|
|
21523
|
+
description: Forbidden - User is not authorized
|
|
20554
21524
|
'429':
|
|
20555
|
-
|
|
21525
|
+
content:
|
|
21526
|
+
application/json;datetime-format=rfc3339:
|
|
21527
|
+
schema:
|
|
21528
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
21529
|
+
description: Too many requests
|
|
20556
21530
|
security:
|
|
20557
21531
|
- apiKeyAuth: []
|
|
20558
21532
|
appKeyAuth: []
|
|
20559
21533
|
- AuthZ: []
|
|
20560
|
-
summary: Get
|
|
21534
|
+
summary: Get Monthly Cost Attribution
|
|
20561
21535
|
tags:
|
|
20562
|
-
-
|
|
20563
|
-
x-pagination:
|
|
20564
|
-
cursorParam: page[cursor]
|
|
20565
|
-
cursorPath: meta.pagination.next_cursor
|
|
20566
|
-
limitParam: page[size]
|
|
20567
|
-
resultsPath: data
|
|
21536
|
+
- Usage Metering
|
|
20568
21537
|
x-unstable: '**Note**: This endpoint is in public beta.
|
|
20569
21538
|
|
|
20570
21539
|
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
@@ -20929,6 +21898,110 @@ paths:
|
|
|
20929
21898
|
tags:
|
|
20930
21899
|
- Dashboard Lists
|
|
20931
21900
|
x-codegen-request-body-name: body
|
|
21901
|
+
/api/v2/dora/deployment:
|
|
21902
|
+
post:
|
|
21903
|
+
description: 'Use this API endpoint to provide data about deployments for DORA
|
|
21904
|
+
metrics.
|
|
21905
|
+
|
|
21906
|
+
|
|
21907
|
+
This is necessary for:
|
|
21908
|
+
|
|
21909
|
+
- Deployment Frequency
|
|
21910
|
+
|
|
21911
|
+
- Change Lead Time
|
|
21912
|
+
|
|
21913
|
+
- Change Failure Rate'
|
|
21914
|
+
operationId: CreateDORADeployment
|
|
21915
|
+
requestBody:
|
|
21916
|
+
content:
|
|
21917
|
+
application/json:
|
|
21918
|
+
schema:
|
|
21919
|
+
$ref: '#/components/schemas/DORADeploymentRequest'
|
|
21920
|
+
required: true
|
|
21921
|
+
responses:
|
|
21922
|
+
'200':
|
|
21923
|
+
content:
|
|
21924
|
+
application/json:
|
|
21925
|
+
schema:
|
|
21926
|
+
$ref: '#/components/schemas/DORADeploymentResponse'
|
|
21927
|
+
description: OK
|
|
21928
|
+
'202':
|
|
21929
|
+
content:
|
|
21930
|
+
application/json:
|
|
21931
|
+
schema:
|
|
21932
|
+
$ref: '#/components/schemas/DORADeploymentResponse'
|
|
21933
|
+
description: OK - but delayed due to incident
|
|
21934
|
+
'400':
|
|
21935
|
+
content:
|
|
21936
|
+
application/json:
|
|
21937
|
+
schema:
|
|
21938
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
21939
|
+
description: Bad Request
|
|
21940
|
+
'403':
|
|
21941
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
21942
|
+
'429':
|
|
21943
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
21944
|
+
security:
|
|
21945
|
+
- apiKeyAuth: []
|
|
21946
|
+
summary: Send a deployment event for DORA Metrics
|
|
21947
|
+
tags:
|
|
21948
|
+
- DORA Metrics
|
|
21949
|
+
x-codegen-request-body-name: body
|
|
21950
|
+
x-unstable: '**Note**: This endpoint is in private beta for CI Pipeline Visibility
|
|
21951
|
+
customers.
|
|
21952
|
+
|
|
21953
|
+
If you want to request access, complete the [form](https://forms.gle/Eqq6uXfGjYxmqpjDA).'
|
|
21954
|
+
/api/v2/dora/incident:
|
|
21955
|
+
post:
|
|
21956
|
+
description: 'Use this API endpoint to provide data about incidents for DORA
|
|
21957
|
+
metrics.
|
|
21958
|
+
|
|
21959
|
+
|
|
21960
|
+
This is necessary for:
|
|
21961
|
+
|
|
21962
|
+
- Change Failure Rate
|
|
21963
|
+
|
|
21964
|
+
- Time to Restore'
|
|
21965
|
+
operationId: CreateDORAIncident
|
|
21966
|
+
requestBody:
|
|
21967
|
+
content:
|
|
21968
|
+
application/json:
|
|
21969
|
+
schema:
|
|
21970
|
+
$ref: '#/components/schemas/DORAIncidentRequest'
|
|
21971
|
+
required: true
|
|
21972
|
+
responses:
|
|
21973
|
+
'200':
|
|
21974
|
+
content:
|
|
21975
|
+
application/json:
|
|
21976
|
+
schema:
|
|
21977
|
+
$ref: '#/components/schemas/DORAIncidentResponse'
|
|
21978
|
+
description: OK
|
|
21979
|
+
'202':
|
|
21980
|
+
content:
|
|
21981
|
+
application/json:
|
|
21982
|
+
schema:
|
|
21983
|
+
$ref: '#/components/schemas/DORAIncidentResponse'
|
|
21984
|
+
description: OK - but delayed due to incident
|
|
21985
|
+
'400':
|
|
21986
|
+
content:
|
|
21987
|
+
application/json:
|
|
21988
|
+
schema:
|
|
21989
|
+
$ref: '#/components/schemas/JSONAPIErrorResponse'
|
|
21990
|
+
description: Bad Request
|
|
21991
|
+
'403':
|
|
21992
|
+
$ref: '#/components/responses/NotAuthorizedResponse'
|
|
21993
|
+
'429':
|
|
21994
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
21995
|
+
security:
|
|
21996
|
+
- apiKeyAuth: []
|
|
21997
|
+
summary: Send an incident event for DORA Metrics
|
|
21998
|
+
tags:
|
|
21999
|
+
- DORA Metrics
|
|
22000
|
+
x-codegen-request-body-name: body
|
|
22001
|
+
x-unstable: '**Note**: This endpoint is in private beta for CI Pipeline Visibility
|
|
22002
|
+
customers.
|
|
22003
|
+
|
|
22004
|
+
If you want to request access, complete the [form](https://forms.gle/Eqq6uXfGjYxmqpjDA).'
|
|
20932
22005
|
/api/v2/downtime:
|
|
20933
22006
|
get:
|
|
20934
22007
|
description: Get all scheduled downtimes.
|
|
@@ -21252,9 +22325,6 @@ paths:
|
|
|
21252
22325
|
cursorPath: meta.page.after
|
|
21253
22326
|
limitParam: page[limit]
|
|
21254
22327
|
resultsPath: data
|
|
21255
|
-
x-unstable: '**Note**: This endpoint is in beta.
|
|
21256
|
-
|
|
21257
|
-
For access, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
21258
22328
|
/api/v2/events/search:
|
|
21259
22329
|
post:
|
|
21260
22330
|
description: 'List endpoint returns events that match an events search query.
|
|
@@ -21297,9 +22367,6 @@ paths:
|
|
|
21297
22367
|
cursorPath: meta.page.after
|
|
21298
22368
|
limitParam: body.page.limit
|
|
21299
22369
|
resultsPath: data
|
|
21300
|
-
x-unstable: '**Note**: This endpoint is in beta.
|
|
21301
|
-
|
|
21302
|
-
For access, contact [Datadog support](https://docs.datadoghq.com/help/).'
|
|
21303
22370
|
/api/v2/incidents:
|
|
21304
22371
|
get:
|
|
21305
22372
|
description: Get all incidents for the user's organization.
|
|
@@ -22897,6 +23964,144 @@ paths:
|
|
|
22897
23964
|
tags:
|
|
22898
23965
|
- Fastly Integration
|
|
22899
23966
|
x-codegen-request-body-name: body
|
|
23967
|
+
/api/v2/integrations/okta/accounts:
|
|
23968
|
+
get:
|
|
23969
|
+
description: List Okta accounts.
|
|
23970
|
+
operationId: ListOktaAccounts
|
|
23971
|
+
responses:
|
|
23972
|
+
'200':
|
|
23973
|
+
content:
|
|
23974
|
+
application/json:
|
|
23975
|
+
schema:
|
|
23976
|
+
$ref: '#/components/schemas/OktaAccountsResponse'
|
|
23977
|
+
description: OK
|
|
23978
|
+
'400':
|
|
23979
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
23980
|
+
'403':
|
|
23981
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
23982
|
+
'404':
|
|
23983
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
23984
|
+
'429':
|
|
23985
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
23986
|
+
summary: List Okta accounts
|
|
23987
|
+
tags:
|
|
23988
|
+
- Okta Integration
|
|
23989
|
+
post:
|
|
23990
|
+
description: Create an Okta account.
|
|
23991
|
+
operationId: CreateOktaAccount
|
|
23992
|
+
requestBody:
|
|
23993
|
+
content:
|
|
23994
|
+
application/json:
|
|
23995
|
+
schema:
|
|
23996
|
+
$ref: '#/components/schemas/OktaAccountRequest'
|
|
23997
|
+
required: true
|
|
23998
|
+
responses:
|
|
23999
|
+
'201':
|
|
24000
|
+
content:
|
|
24001
|
+
application/json:
|
|
24002
|
+
schema:
|
|
24003
|
+
$ref: '#/components/schemas/OktaAccountResponse'
|
|
24004
|
+
description: OK
|
|
24005
|
+
'400':
|
|
24006
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24007
|
+
'403':
|
|
24008
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24009
|
+
'404':
|
|
24010
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24011
|
+
'429':
|
|
24012
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24013
|
+
summary: Add Okta account
|
|
24014
|
+
tags:
|
|
24015
|
+
- Okta Integration
|
|
24016
|
+
x-codegen-request-body-name: body
|
|
24017
|
+
/api/v2/integrations/okta/accounts/{account_id}:
|
|
24018
|
+
delete:
|
|
24019
|
+
description: Delete an Okta account.
|
|
24020
|
+
operationId: DeleteOktaAccount
|
|
24021
|
+
parameters:
|
|
24022
|
+
- description: None
|
|
24023
|
+
in: path
|
|
24024
|
+
name: account_id
|
|
24025
|
+
required: true
|
|
24026
|
+
schema:
|
|
24027
|
+
type: string
|
|
24028
|
+
responses:
|
|
24029
|
+
'204':
|
|
24030
|
+
description: OK
|
|
24031
|
+
'400':
|
|
24032
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24033
|
+
'403':
|
|
24034
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24035
|
+
'404':
|
|
24036
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24037
|
+
'429':
|
|
24038
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24039
|
+
summary: Delete Okta account
|
|
24040
|
+
tags:
|
|
24041
|
+
- Okta Integration
|
|
24042
|
+
get:
|
|
24043
|
+
description: Get an Okta account.
|
|
24044
|
+
operationId: GetOktaAccount
|
|
24045
|
+
parameters:
|
|
24046
|
+
- description: None
|
|
24047
|
+
in: path
|
|
24048
|
+
name: account_id
|
|
24049
|
+
required: true
|
|
24050
|
+
schema:
|
|
24051
|
+
type: string
|
|
24052
|
+
responses:
|
|
24053
|
+
'200':
|
|
24054
|
+
content:
|
|
24055
|
+
application/json:
|
|
24056
|
+
schema:
|
|
24057
|
+
$ref: '#/components/schemas/OktaAccountResponse'
|
|
24058
|
+
description: OK
|
|
24059
|
+
'400':
|
|
24060
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24061
|
+
'403':
|
|
24062
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24063
|
+
'404':
|
|
24064
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24065
|
+
'429':
|
|
24066
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24067
|
+
summary: Get Okta account
|
|
24068
|
+
tags:
|
|
24069
|
+
- Okta Integration
|
|
24070
|
+
patch:
|
|
24071
|
+
description: Update an Okta account.
|
|
24072
|
+
operationId: UpdateOktaAccount
|
|
24073
|
+
parameters:
|
|
24074
|
+
- description: None
|
|
24075
|
+
in: path
|
|
24076
|
+
name: account_id
|
|
24077
|
+
required: true
|
|
24078
|
+
schema:
|
|
24079
|
+
type: string
|
|
24080
|
+
requestBody:
|
|
24081
|
+
content:
|
|
24082
|
+
application/json:
|
|
24083
|
+
schema:
|
|
24084
|
+
$ref: '#/components/schemas/OktaAccountUpdateRequest'
|
|
24085
|
+
required: true
|
|
24086
|
+
responses:
|
|
24087
|
+
'200':
|
|
24088
|
+
content:
|
|
24089
|
+
application/json:
|
|
24090
|
+
schema:
|
|
24091
|
+
$ref: '#/components/schemas/OktaAccountResponse'
|
|
24092
|
+
description: OK
|
|
24093
|
+
'400':
|
|
24094
|
+
$ref: '#/components/responses/BadRequestResponse'
|
|
24095
|
+
'403':
|
|
24096
|
+
$ref: '#/components/responses/ForbiddenResponse'
|
|
24097
|
+
'404':
|
|
24098
|
+
$ref: '#/components/responses/NotFoundResponse'
|
|
24099
|
+
'429':
|
|
24100
|
+
$ref: '#/components/responses/TooManyRequestsResponse'
|
|
24101
|
+
summary: Update Okta account
|
|
24102
|
+
tags:
|
|
24103
|
+
- Okta Integration
|
|
24104
|
+
x-codegen-request-body-name: body
|
|
22900
24105
|
/api/v2/ip_allowlist:
|
|
22901
24106
|
get:
|
|
22902
24107
|
description: Returns the IP allowlist and its enabled or disabled state.
|
|
@@ -29935,6 +31140,57 @@ paths:
|
|
|
29935
31140
|
summary: Get hourly usage for observability pipelines
|
|
29936
31141
|
tags:
|
|
29937
31142
|
- Usage Metering
|
|
31143
|
+
/api/v2/usage/projected_cost:
|
|
31144
|
+
get:
|
|
31145
|
+
description: 'Get projected cost across multi-org and single root-org accounts.
|
|
31146
|
+
|
|
31147
|
+
Projected cost data is only available for the current month and becomes available
|
|
31148
|
+
around the 12th of the month.
|
|
31149
|
+
|
|
31150
|
+
This endpoint requires the usage_read authorization scope.'
|
|
31151
|
+
operationId: GetProjectedCost
|
|
31152
|
+
parameters:
|
|
31153
|
+
- description: String to specify whether cost is broken down at a parent-org
|
|
31154
|
+
level or at the sub-org level. Available views are `summary` and `sub-org`.
|
|
31155
|
+
Defaults to `summary`.
|
|
31156
|
+
in: query
|
|
31157
|
+
name: view
|
|
31158
|
+
required: false
|
|
31159
|
+
schema:
|
|
31160
|
+
type: string
|
|
31161
|
+
responses:
|
|
31162
|
+
'200':
|
|
31163
|
+
content:
|
|
31164
|
+
application/json;datetime-format=rfc3339:
|
|
31165
|
+
schema:
|
|
31166
|
+
$ref: '#/components/schemas/ProjectedCostResponse'
|
|
31167
|
+
description: OK
|
|
31168
|
+
'400':
|
|
31169
|
+
content:
|
|
31170
|
+
application/json;datetime-format=rfc3339:
|
|
31171
|
+
schema:
|
|
31172
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
31173
|
+
description: Bad Request
|
|
31174
|
+
'403':
|
|
31175
|
+
content:
|
|
31176
|
+
application/json;datetime-format=rfc3339:
|
|
31177
|
+
schema:
|
|
31178
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
31179
|
+
description: Forbidden - User is not authorized
|
|
31180
|
+
'429':
|
|
31181
|
+
content:
|
|
31182
|
+
application/json;datetime-format=rfc3339:
|
|
31183
|
+
schema:
|
|
31184
|
+
$ref: '#/components/schemas/APIErrorResponse'
|
|
31185
|
+
description: Too many requests
|
|
31186
|
+
security:
|
|
31187
|
+
- apiKeyAuth: []
|
|
31188
|
+
appKeyAuth: []
|
|
31189
|
+
- AuthZ:
|
|
31190
|
+
- usage_read
|
|
31191
|
+
summary: Get projected cost across your account
|
|
31192
|
+
tags:
|
|
31193
|
+
- Usage Metering
|
|
29938
31194
|
/api/v2/user_invitations:
|
|
29939
31195
|
post:
|
|
29940
31196
|
description: Sends emails to one or more users inviting them to join the organization.
|
|
@@ -30440,6 +31696,8 @@ tags:
|
|
|
30440
31696
|
name: Container Images
|
|
30441
31697
|
- description: The Containers API allows you to query container data for your organization.
|
|
30442
31698
|
name: Containers
|
|
31699
|
+
- description: Send events for DORA Metrics to measure and improve software delivery.
|
|
31700
|
+
name: DORA Metrics
|
|
30443
31701
|
- description: 'Interact with your dashboard lists through the API to
|
|
30444
31702
|
|
|
30445
31703
|
organize, find, and share all of your dashboards with your team and
|
|
@@ -30549,6 +31807,9 @@ tags:
|
|
|
30549
31807
|
description: Find out more at
|
|
30550
31808
|
url: https://docs.datadoghq.com/monitors/create/types/
|
|
30551
31809
|
name: Monitors
|
|
31810
|
+
- description: Configure your Datadog Okta integration directly through the Datadog
|
|
31811
|
+
API.
|
|
31812
|
+
name: Okta Integration
|
|
30552
31813
|
- description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/)
|
|
30553
31814
|
|
|
30554
31815
|
directly through the Datadog API.'
|