.generator/schemas/v2/openapi.yaml in datadog_api_client-1.9.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-1.10.0
- old
+ new
@@ -848,15 +848,10 @@
$ref: '#/components/schemas/AuthNMappingAttributes'
id:
description: ID of the AuthN Mapping.
example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
type: string
- included:
- description: Included data in the AuthN Mapping response.
- items:
- $ref: '#/components/schemas/AuthNMappingIncluded'
- type: array
relationships:
$ref: '#/components/schemas/AuthNMappingRelationships'
type:
$ref: '#/components/schemas/AuthNMappingsType'
required:
@@ -886,14 +881,12 @@
format: date-time
readOnly: true
type: string
saml_assertion_attribute_id:
description: The ID of the SAML assertion attribute.
- example: 0
- format: int32
- maximum: 2147483647
- type: integer
+ example: '0'
+ type: string
type: object
AuthNMappingCreateAttributes:
description: Key/Value pair of attributes used for create request.
properties:
attribute_key:
@@ -951,10 +944,15 @@
AuthNMappingResponse:
description: AuthN Mapping response from the API.
properties:
data:
$ref: '#/components/schemas/AuthNMapping'
+ included:
+ description: Included data in the AuthN Mapping response.
+ items:
+ $ref: '#/components/schemas/AuthNMappingIncluded'
+ type: array
type: object
AuthNMappingUpdateAttributes:
description: Key/Value pair of attributes used for update request.
properties:
attribute_key:
@@ -1005,10 +1003,15 @@
data:
description: Array of returned AuthN Mappings.
items:
$ref: '#/components/schemas/AuthNMapping'
type: array
+ included:
+ description: Included data in the AuthN Mapping response.
+ items:
+ $ref: '#/components/schemas/AuthNMappingIncluded'
+ type: array
meta:
$ref: '#/components/schemas/ResponseMetaAttributes'
type: object
AuthNMappingsSort:
description: Sorting options for AuthN Mappings.
@@ -1046,10 +1049,27 @@
- authn_mappings
example: authn_mappings
type: string
x-enum-varnames:
- AUTHN_MAPPINGS
+ ChargebackBreakdown:
+ description: Charges breakdown.
+ properties:
+ charge_type:
+ description: The type of charge for a particular product.
+ example: on_demand
+ type: string
+ cost:
+ description: The cost for a particular product and charge type during a
+ given month.
+ format: double
+ type: number
+ product_name:
+ description: The product for which cost is being reported.
+ example: infra_host
+ type: string
+ type: object
CloudWorkloadSecurityAgentRuleAttributes:
description: A Cloud Workload Security Agent rule returned by the API.
properties:
category:
description: The category of the Agent rule.
@@ -1240,10 +1260,62 @@
- deflate
type: string
x-enum-varnames:
- GZIP
- DEFLATE
+ CostByOrg:
+ description: Cost data.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/CostByOrgAttributes'
+ id:
+ description: Unique ID of the response.
+ type: string
+ type:
+ $ref: '#/components/schemas/CostByOrgType'
+ type: object
+ CostByOrgAttributes:
+ description: 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
+ public_id:
+ description: The organization public ID.
+ type: string
+ total_cost:
+ description: The total cost of products for the month.
+ format: double
+ type: number
+ type: object
+ CostByOrgResponse:
+ description: Chargeback Summary response.
+ properties:
+ data:
+ description: Response containing Chargeback Summary.
+ items:
+ $ref: '#/components/schemas/CostByOrg'
+ type: array
+ type: object
+ CostByOrgType:
+ default: cost_by_org
+ description: Type of cost data.
+ enum:
+ - cost_by_org
+ example: cost_by_org
+ type: string
+ x-enum-varnames:
+ - COST_BY_ORG
Creator:
description: Creator of the object.
properties:
email:
description: Email of the creator.
@@ -1549,10 +1621,13 @@
items:
$ref: '#/components/schemas/HTTPLogError'
type: array
type: object
HTTPLogItem:
+ additionalProperties:
+ description: Additional log attributes.
+ type: string
description: Logs that are sent over HTTP.
properties:
ddsource:
description: 'The integration name associated with your log: the technology
from which the log originated.
@@ -1590,20 +1665,24 @@
See [reserved attributes](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes).'
example: payment
type: string
required:
- - name
+ - message
type: object
HourlyUsageType:
description: Usage type that is being measured.
enum:
+ - app_sec_host_count
- observability_pipelines_bytes_processed
+ - lambda_traced_invocations_count
example: observability_pipelines_bytes_processed
type: string
x-enum-varnames:
+ - APP_SEC_HOST_COUNT
- OBSERVABILITY_PIPELINES_BYTES_PROCESSSED
+ - LAMBDA_TRACED_INVOCATIONS_COUNT
IdPMetadataFormData:
description: The form data submitted to upload IdP metadata
properties:
idp_file:
description: The IdP metadata XML file
@@ -2521,10 +2600,18 @@
meta:
$ref: '#/components/schemas/IncidentResponseMeta'
required:
- data
type: object
+ IntakePayloadAccepted:
+ description: The payload accepted for intake.
+ properties:
+ status:
+ description: The status of the intake payload.
+ example: ok
+ type: string
+ type: object
ListApplicationKeysResponse:
description: Response for a list of application keys.
properties:
data:
description: Array of application keys.
@@ -2646,11 +2733,11 @@
LogsAggregateBucketValueTimeseries:
description: A timeseries array
items:
$ref: '#/components/schemas/LogsAggregateBucketValueTimeseriesPoint'
type: array
-
+ x-generate-alias-as-model: true
LogsAggregateBucketValueTimeseriesPoint:
description: A timeseries point
properties:
time:
description: The time value for this point
@@ -2802,10 +2889,16 @@
query:
description: The archive query/filter. Logs matching this query are included
in the archive.
example: source:nginx
type: string
+ rehydration_max_scan_size_in_gb:
+ description: Maximum scan size for rehydration from this archive.
+ example: 100
+ format: int64
+ nullable: true
+ type: integer
rehydration_tags:
description: An array of tags to add to rehydrated logs from an archive.
example:
- team:intake
- team:app
@@ -2846,10 +2939,16 @@
query:
description: The archive query/filter. Logs matching this query are included
in the archive.
example: source:nginx
type: string
+ rehydration_max_scan_size_in_gb:
+ description: Maximum scan size for rehydration from this archive.
+ example: 100
+ format: int64
+ nullable: true
+ type: integer
rehydration_tags:
description: An array of tags to add to rehydrated logs from an archive.
example:
- team:intake
- team:app
@@ -3787,10 +3886,18 @@
description: A metric tag name.
maxLength: 200
pattern: ^[A-Za-z][A-Za-z0-9\.\-\_:\/]*$
type: string
type: array
+ MetricContentEncoding:
+ default: deflate
+ description: HTTP header used to compress the media-type.
+ enum:
+ - deflate
+ type: string
+ x-enum-varnames:
+ - DEFLATE
MetricCustomAggregation:
description: A time and space aggregation combination for use in query.
example:
space: sum
time: sum
@@ -3900,10 +4007,67 @@
- distinct_metric_volumes
example: distinct_metric_volumes
type: string
x-enum-varnames:
- DISTINCT_METRIC_VOLUMES
+ MetricEstimate:
+ description: Object for a metric cardinality estimate.
+ properties:
+ attributes:
+ $ref: '#/components/schemas/MetricEstimateAttributes'
+ id:
+ $ref: '#/components/schemas/MetricName'
+ type:
+ $ref: '#/components/schemas/MetricEstimateResourceType'
+ type: object
+ MetricEstimateAttributes:
+ description: Object containing the definition of a metric estimate attribute.
+ properties:
+ estimate_type:
+ $ref: '#/components/schemas/MetricEstimateType'
+ estimated_at:
+ description: Timestamp when the cardinality estimate was requested.
+ example: '2022-04-27T09:48:37.463835Z'
+ format: date-time
+ type: string
+ estimated_output_series:
+ description: Estimated cardinality of the metric based on the queried configuration.
+ example: 50
+ format: int64
+ type: integer
+ type: object
+ MetricEstimateResourceType:
+ default: metric_cardinality_estimate
+ description: The metric estimate resource type.
+ enum:
+ - metric_cardinality_estimate
+ example: metric_cardinality_estimate
+ type: string
+ x-enum-varnames:
+ - METRIC_CARDINALITY_ESTIMATE
+ MetricEstimateResponse:
+ description: Response object that includes metric cardinality estimates.
+ properties:
+ data:
+ $ref: '#/components/schemas/MetricEstimate'
+ type: object
+ MetricEstimateType:
+ default: count_or_gauge
+ description: Estimate type based on the queried configuration. By default, `count_or_gauge`
+ is returned. `distribution` is returned for distribution metrics without percentiles
+ enabled. Lastly, `percentile` is returned if `filter[pct]=true` is queried
+ with a distribution metric.
+ enum:
+ - count_or_gauge
+ - distribution
+ - percentile
+ example: distribution
+ type: string
+ x-enum-varnames:
+ - COUNT_OR_GAUGE
+ - DISTRIBUTION
+ - PERCENTILE
MetricIngestedIndexedVolume:
description: Object for a single metric's ingested and indexed volume.
properties:
attributes:
$ref: '#/components/schemas/MetricIngestedIndexedVolumeAttributes'
@@ -3934,14 +4098,155 @@
- metric_volumes
example: metric_volumes
type: string
x-enum-varnames:
- METRIC_VOLUMES
+ MetricIntakeType:
+ description: The type of metric.
+ enum:
+ - 0
+ - 1
+ - 2
+ - 3
+ - 15
+ format: int32
+ type: integer
+ x-enum-varnames:
+ - UNSPECIFIED
+ - COUNT
+ - RATE
+ - GAUGE
+ - UNSPECIFIED_LEGACY
+ MetricMetadata:
+ description: Metadata for the metric.
+ properties:
+ origin:
+ $ref: '#/components/schemas/MetricOrigin'
+ type: object
MetricName:
description: The metric name for this resource.
example: test.metric.latency
type: string
+ MetricOrigin:
+ description: Metric origin information.
+ properties:
+ metric_type:
+ default: 0
+ description: The origin metric type code
+ format: int32
+ maximum: 1000
+ type: integer
+ product:
+ default: 0
+ description: The origin product code
+ format: int32
+ maximum: 1000
+ type: integer
+ service:
+ default: 0
+ description: The origin service code
+ format: int32
+ maximum: 1000
+ type: integer
+ type: object
+ MetricPayload:
+ description: The metrics' payload.
+ properties:
+ series:
+ description: A list of time series to submit to Datadog.
+ example:
+ - metric: system.load.1
+ points:
+ - timestamp: 1475317847
+ value: 0.7
+ items:
+ $ref: '#/components/schemas/MetricSeries'
+ type: array
+ required:
+ - series
+ type: object
+ MetricPoint:
+ description: A point object is of the form `{POSIX_timestamp, numeric_value}`.
+ example:
+ timestamp: 1575317847
+ value: 0.5
+ properties:
+ timestamp:
+ description: 'The timestamp should be in seconds and current.
+
+ Current is defined as not more than 10 minutes in the future or more than
+ 1 hour in the past.'
+ format: int64
+ type: integer
+ value:
+ description: The numeric value format should be a 64bit float gauge-type
+ value.
+ format: double
+ type: number
+ type: object
+ MetricResource:
+ description: Metric resource.
+ properties:
+ name:
+ description: The name of the metric.
+ type: string
+ type:
+ description: The type of metric.
+ type: string
+ type: object
+ MetricSeries:
+ description: 'A metric to submit to Datadog.
+
+ See [Datadog metrics](https://docs.datadoghq.com/developers/metrics/#custom-metrics-properties).'
+ properties:
+ interval:
+ description: If the type of the metric is rate or count, define the corresponding
+ interval.
+ example: 20
+ format: int64
+ type: integer
+ metadata:
+ $ref: '#/components/schemas/MetricMetadata'
+ metric:
+ description: The name of the timeseries.
+ example: system.load.1
+ type: string
+ points:
+ description: Points relating to a metric. All points must be objects with
+ timestamp and a scalar value (cannot be a string). Timestamps should be
+ in POSIX time in seconds, and cannot be more than ten minutes in the future
+ or more than one hour in the past.
+ items:
+ $ref: '#/components/schemas/MetricPoint'
+ type: array
+ resources:
+ description: A list of resources to associate with this metric.
+ items:
+ $ref: '#/components/schemas/MetricResource'
+ type: array
+ source_type_name:
+ description: The source type name.
+ example: datadog
+ type: string
+ tags:
+ description: A list of tags associated with the metric.
+ example:
+ - environment:test
+ items:
+ description: Individual tags.
+ type: string
+ type: array
+ type:
+ $ref: '#/components/schemas/MetricIntakeType'
+ unit:
+ description: The unit of point value.
+ example: second
+ type: string
+ required:
+ - metric
+ - points
+ type: object
MetricTagConfiguration:
description: Object for a single metric tag configuration.
example:
attributes:
aggregations:
@@ -4536,11 +4841,11 @@
RUMAggregateBucketValueTimeseries:
description: A timeseries array.
items:
$ref: '#/components/schemas/RUMAggregateBucketValueTimeseriesPoint'
type: array
-
+ x-generate-alias-as-model: true
RUMAggregateBucketValueTimeseriesPoint:
description: A timeseries point.
properties:
time:
description: The time value for this point.
@@ -5169,14 +5474,12 @@
RelationshipToSAMLAssertionAttributeData:
description: Data of AuthN Mapping relationship to SAML Assertion Attribute.
properties:
id:
description: The ID of the SAML assertion attribute.
- example: 0
- format: int32
- maximum: 2147483647
- type: integer
+ example: '0'
+ type: string
type:
$ref: '#/components/schemas/SAMLAssertionAttributesType'
required:
- id
- type
@@ -5474,14 +5777,12 @@
properties:
attributes:
$ref: '#/components/schemas/SAMLAssertionAttributeAttributes'
id:
description: The ID of the SAML assertion attribute.
- example: 0
- format: int32
- maximum: 2147483647
- type: integer
+ example: '0'
+ type: string
type:
$ref: '#/components/schemas/SAMLAssertionAttributesType'
required:
- id
- type
@@ -5871,16 +6172,18 @@
enum:
- threshold
- new_value
- anomaly_detection
- impossible_travel
+ - hardcoded
type: string
x-enum-varnames:
- THRESHOLD
- NEW_VALUE
- ANOMALY_DETECTION
- IMPOSSIBLE_TRAVEL
+ - HARDCODED
SecurityMonitoringRuleEvaluationWindow:
description: 'A time window is specified to match when at least one of the cases
matches true. This is a sliding window
and evaluates in real time.'
@@ -5902,10 +6205,17 @@
- TEN_MINUTES
- FIFTEEN_MINUTES
- THIRTY_MINUTES
- ONE_HOUR
- TWO_HOURS
+ SecurityMonitoringRuleHardcodedEvaluatorType:
+ description: Hardcoded evaluator type.
+ enum:
+ - log4shell
+ type: string
+ x-enum-varnames:
+ - LOG4SHELL
SecurityMonitoringRuleImpossibleTravelOptions:
description: Options on impossible travel rules.
properties:
baselineUserLocations:
$ref: '#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocations'
@@ -6024,10 +6334,12 @@
properties:
detectionMethod:
$ref: '#/components/schemas/SecurityMonitoringRuleDetectionMethod'
evaluationWindow:
$ref: '#/components/schemas/SecurityMonitoringRuleEvaluationWindow'
+ hardcodedEvaluatorType:
+ $ref: '#/components/schemas/SecurityMonitoringRuleHardcodedEvaluatorType'
impossibleTravelOptions:
$ref: '#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptions'
keepAlive:
$ref: '#/components/schemas/SecurityMonitoringRuleKeepAlive'
maxSignalDuration:
@@ -6460,10 +6772,19 @@
data:
$ref: '#/components/schemas/ServiceAccountCreateData'
required:
- data
type: object
+ UsageApplicationSecurityMonitoringResponse:
+ description: Application Security Monitoring usage response.
+ properties:
+ data:
+ description: Response containing Application Security Monitoring usage.
+ items:
+ $ref: '#/components/schemas/UsageDataObject'
+ type: array
+ type: object
UsageAttributesObject:
description: Usage attributes data.
properties:
org_name:
description: The organization name.
@@ -6491,10 +6812,19 @@
description: Unique ID of the response.
type: string
type:
$ref: '#/components/schemas/UsageTimeSeriesType'
type: object
+ UsageLambdaTracedInvocationsResponse:
+ description: Lambda Traced Invocations usage response.
+ properties:
+ data:
+ description: Response containing Lambda Traced Invocations usage.
+ items:
+ $ref: '#/components/schemas/UsageDataObject'
+ type: array
+ type: object
UsageObservabilityPipelinesResponse:
description: Observability Pipelines usage response.
properties:
data:
description: Response containing Observability Pipelines usage.
@@ -7331,18 +7661,10 @@
in: query
name: sort
required: false
schema:
$ref: '#/components/schemas/AuthNMappingsSort'
- - description: Include additional information in the response.
- in: query
- name: include
- required: false
- schema:
- items:
- type: string
- type: array
- description: Filter all mappings by the given string.
in: query
name: filter
required: false
schema:
@@ -9425,10 +9747,111 @@
tags:
- Metrics
x-menu-order: 6
x-undo:
type: safe
+ /api/v2/metrics/{metric_name}/estimate:
+ get:
+ description: Returns the estimated cardinality for a metric with a given tag,
+ percentile and number of aggregations configuration using Metrics without
+ Limits™.
+ operationId: EstimateMetricsOutputSeries
+ parameters:
+ - $ref: '#/components/parameters/MetricName'
+ - description: Filtered tag keys that the metric is configured to query with.
+ example: app,host
+ in: query
+ name: filter[groups]
+ required: false
+ schema:
+ type: string
+ - description: The number of hours of look back (from now) to estimate cardinality
+ with.
+ example: 49
+ in: query
+ name: filter[hours_ago]
+ required: false
+ schema:
+ type: integer
+ - description: The number of aggregations that a `count`, `rate`, or `gauge`
+ metric is configured to use. Max number of aggregation combos is 9.
+ example: 1
+ in: query
+ name: filter[num_aggregations]
+ required: false
+ schema:
+ type: integer
+ - description: A boolean, for distribution metrics only, to estimate cardinality
+ if the metric includes additional percentile aggregators.
+ example: true
+ in: query
+ name: filter[pct]
+ required: false
+ schema:
+ type: boolean
+ - description: A window, in hours, from the look back to estimate cardinality
+ with.
+ example: 6
+ in: query
+ name: filter[timespan_h]
+ required: false
+ schema:
+ type: integer
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/MetricEstimateResponse'
+ description: Success
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: API error response.
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: API error response.
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: API error response.
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Too Many Requests
+ security:
+ - apiKeyAuth: []
+ appKeyAuth: []
+ - AuthZ: []
+ summary: Tag Configuration Cardinality Estimator
+ tags:
+ - Metrics
+ x-dd-ownership:
+ notification_configuration:
+ manual_escalation_policy: '[Points Aggregation] Primary'
+ prod_high_urgency: '@pagerduty-Points-Aggregation @slack-points-aggr-ops'
+ prod_low_urgency: '@slack-points-aggr-ops'
+ slack_support_channel: '#points-aggregation'
+ staging_high_urgency: '@slack-points-aggr-stg-ops'
+ staging_low_urgency: '@slack-points-aggr-stg-ops'
+ team: points-aggregation
+ team_escalation: '[Points Aggregation] Primary'
+ x-menu-order: 10
+ x-permission:
+ operator: OPEN
+ permissions: []
+ x-undo:
+ type: safe
/api/v2/metrics/{metric_name}/tags:
delete:
description: 'Deletes a metric''s tag configuration. Can only be used with application
keys from users with the `Manage Tags for Metrics` permission.'
@@ -11327,10 +11750,84 @@
x-undo:
type: safe
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+ /api/v2/series:
+ post:
+ description: "The metrics end-point allows you to post time-series data that
+ can be graphed on Datadog\u2019s dashboards.\nThe maximum payload size is
+ 500 kilobytes (512000 bytes). Compressed payloads must have a decompressed
+ size of less than 5 megabytes (5242880 bytes).\n\nIf you\u2019re submitting
+ metrics directly to the Datadog API without using DogStatsD, expect:\n\n-
+ 64 bits for the timestamp\n- 64 bits for the value\n- 20 bytes for the metric
+ names\n- 50 bytes for the timeseries\n- The full payload is approximately
+ 100 bytes."
+ operationId: SubmitMetrics
+ parameters:
+ - description: HTTP header used to compress the media-type.
+ in: header
+ name: Content-Encoding
+ required: false
+ schema:
+ $ref: '#/components/schemas/MetricContentEncoding'
+ requestBody:
+ content:
+ application/json:
+ examples:
+ dynamic-points:
+ description: "Post time-series data that can be graphed on Datadog\u2019s
+ dashboards."
+ externalValue: examples/metrics/dynamic-points.json.sh
+ summary: Dynamic Points
+ x-variables:
+ NOW: $(date +%s)
+ schema:
+ $ref: '#/components/schemas/MetricPayload'
+ required: true
+ responses:
+ '202':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/IntakePayloadAccepted'
+ description: Payload accepted
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Bad Request
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Authentication error
+ '408':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Request timeout
+ '413':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/APIErrorResponse'
+ description: Payload too large
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ security:
+ - apiKeyAuth: []
+ summary: Submit metrics
+ tags:
+ - Metrics
+ x-codegen-request-body-name: body
+ x-menu-order: 1
+ x-undo:
+ type: safe
/api/v2/service_accounts:
post:
description: Create a service account for your organization.
operationId: CreateServiceAccount
requestBody:
@@ -11999,9 +12496,185 @@
x-undo:
type: idempotent
x-unstable: '**Note**: This endpoint is in public beta.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+ /api/v2/usage/application_security:
+ get:
+ description: Get hourly usage for Application Security .
+ operationId: GetUsageApplicationSecurityMonitoring
+ parameters:
+ - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
+ for usage beginning at this hour.'
+ in: query
+ name: start_hr
+ required: true
+ schema:
+ format: date-time
+ type: string
+ - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
+ for usage ending
+
+ **before** this hour.'
+ in: query
+ name: end_hr
+ required: false
+ schema:
+ format: date-time
+ type: string
+ responses:
+ '200':
+ content:
+ application/json;datetime-format=rfc3339:
+ schema:
+ $ref: '#/components/schemas/UsageApplicationSecurityMonitoringResponse'
+ 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 hourly usage for Application Security
+ tags:
+ - Usage Metering
+ x-menu-order: 38
+ x-undo:
+ type: safe
+ /api/v2/usage/cost_by_org:
+ get:
+ description: Get cost across multi-org account. Cost by org data for a given
+ month becomes available no later than the 16th of the following month.
+ operationId: GetCostByOrg
+ parameters:
+ - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
+ for cost beginning 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: false
+ schema:
+ format: date-time
+ type: string
+ responses:
+ '200':
+ content:
+ application/json;datetime-format=rfc3339:
+ schema:
+ $ref: '#/components/schemas/CostByOrgResponse'
+ 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 cost across multi-org account
+ tags:
+ - Usage Metering
+ x-menu-order: 39
+ x-undo:
+ type: safe
+ /api/v2/usage/lambda_traced_invocations:
+ get:
+ description: Get hourly usage for Lambda Traced Invocations.
+ operationId: GetUsageLambdaTracedInvocations
+ parameters:
+ - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
+ for usage beginning at this hour.'
+ in: query
+ name: start_hr
+ required: true
+ schema:
+ format: date-time
+ type: string
+ - description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
+ for usage ending
+
+ **before** this hour.'
+ in: query
+ name: end_hr
+ required: false
+ schema:
+ format: date-time
+ type: string
+ responses:
+ '200':
+ content:
+ application/json;datetime-format=rfc3339:
+ schema:
+ $ref: '#/components/schemas/UsageLambdaTracedInvocationsResponse'
+ 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 hourly usage for Lambda Traced Invocations
+ tags:
+ - Usage Metering
+ x-menu-order: 38
+ x-undo:
+ type: safe
/api/v2/usage/observability_pipelines:
get:
description: Get hourly usage for Observability Pipelines.
operationId: GetUsageObservabilityPipelines
parameters: