.generator/schemas/v2/openapi.yaml in datadog_api_client-2.24.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.25.0

- old
+ new

@@ -214,10 +214,17 @@ in: path name: service_id required: true schema: type: string + FileID: + description: File ID. + in: path + name: file_id + required: true + schema: + type: string GCPSTSServiceAccountID: description: Your GCP STS enabled service account's unique ID. in: path name: account_id required: true @@ -349,10 +356,17 @@ in: path name: todo_id required: true schema: type: string + InstanceId: + description: The ID of the workflow instance. + in: path + name: instance_id + required: true + schema: + type: string MetricID: description: The name of the log-based metric. in: path name: metric_id required: true @@ -448,11 +462,11 @@ name: role_id required: true schema: type: string RuleId: - description: The ID of the rule/scorecard. + description: The ID of the rule. in: path name: rule_id required: true schema: type: string @@ -534,10 +548,17 @@ name: user_id required: true schema: example: 00000000-0000-9999-0000-000000000000 type: string + WorkflowId: + description: The ID of the workflow. + in: path + name: workflow_id + required: true + schema: + type: string requestBodies: {} responses: BadRequestResponse: content: application/json: @@ -682,11 +703,11 @@ description: Resources related to the API key. properties: created_by: $ref: '#/components/schemas/RelationshipToUser' modified_by: - $ref: '#/components/schemas/RelationshipToUser' + $ref: '#/components/schemas/NullableRelationshipToUser' type: object APIKeyResponse: description: Response for retrieving an API key. properties: data: @@ -1382,10 +1403,19 @@ saml_assertion_attribute: $ref: '#/components/schemas/RelationshipToSAMLAssertionAttribute' team: $ref: '#/components/schemas/RelationshipToTeam' type: object + AuthNMappingResourceType: + description: The type of resource being mapped to. + enum: + - role + - team + type: string + x-enum-varnames: + - ROLE + - TEAM AuthNMappingResponse: description: AuthN Mapping response from the API. properties: data: $ref: '#/components/schemas/AuthNMapping' @@ -5388,10 +5418,16 @@ $ref: '#/components/schemas/CostByOrgType' type: object CostByOrgAttributes: description: Cost attributes data. properties: + account_name: + description: The account name. + type: string + account_public_id: + description: The account public ID. + type: string charges: description: List of charges data reported for the requested month. items: $ref: '#/components/schemas/ChargebackBreakdown' type: array @@ -5499,10 +5535,238 @@ name: description: Name of the creator. nullable: true type: string type: object + CustomCostGetResponseMeta: + description: Meta for the response from the Get Custom Costs endpoints. + properties: + version: + description: Version of Custom Costs file + type: string + type: object + CustomCostListResponseMeta: + description: Meta for the response from the List Custom Costs endpoints. + properties: + total_filtered_count: + description: Number of Custom Costs files returned by the List Custom Costs + endpoint + format: int64 + type: integer + version: + description: Version of Custom Costs file + type: string + type: object + CustomCostUploadResponseMeta: + description: Meta for the response from the Upload Custom Costs endpoints. + properties: + version: + description: Version of Custom Costs file + type: string + type: object + CustomCostsFileGetResponse: + description: Response for Get Custom Costs files. + properties: + data: + $ref: '#/components/schemas/CustomCostsFileMetadataWithContentHighLevel' + meta: + $ref: '#/components/schemas/CustomCostGetResponseMeta' + type: object + CustomCostsFileLineItem: + description: Line item details from a Custom Costs file. + properties: + BilledCost: + description: Total cost in the cost file. + example: 100.5 + format: double + type: number + BillingCurrency: + description: Currency used in the Custom Costs file. + example: USD + type: string + ChargeDescription: + description: Description for the line item cost. + example: Monthly usage charge for my service + type: string + ChargePeriodEnd: + description: End date of the usage charge. + example: '2023-02-28' + pattern: ^\d{4}-\d{2}-\d{2}$ + type: string + ChargePeriodStart: + description: Start date of the usage charge. + example: '2023-02-01' + pattern: ^\d{4}-\d{2}-\d{2}$ + type: string + ProviderName: + description: Name of the provider for the line item. + type: string + Tags: + additionalProperties: + type: string + description: Additional tags for the line item. + type: object + type: object + CustomCostsFileListResponse: + description: Response for List Custom Costs files. + properties: + data: + description: List of Custom Costs files. + items: + $ref: '#/components/schemas/CustomCostsFileMetadataHighLevel' + type: array + meta: + $ref: '#/components/schemas/CustomCostListResponseMeta' + type: object + CustomCostsFileMetadata: + description: Schema of a Custom Costs metadata. + properties: + billed_cost: + description: Total cost in the cost file. + example: 100.5 + format: double + type: number + billing_currency: + description: Currency used in the Custom Costs file. + example: USD + type: string + charge_period: + $ref: '#/components/schemas/CustomCostsFileUsageChargePeriod' + name: + description: Name of the Custom Costs file. + example: my_file.json + type: string + provider_names: + description: Providers contained in the Custom Costs file. + items: + description: Name of the provider. + example: my_provider + type: string + type: array + status: + description: Status of the Custom Costs file. + example: active + type: string + uploaded_at: + description: Timestamp, in millisecond, of the upload time of the Custom + Costs file. + example: 1704067200000 + format: double + type: number + uploaded_by: + $ref: '#/components/schemas/CustomCostsUser' + type: object + CustomCostsFileMetadataHighLevel: + description: JSON API format for a Custom Costs file. + properties: + attributes: + $ref: '#/components/schemas/CustomCostsFileMetadata' + id: + description: ID of the Custom Costs metadata. + type: string + type: + description: Type of the Custom Costs file metadata. + type: string + type: object + CustomCostsFileMetadataWithContent: + description: Schema of a cost file's metadata. + properties: + billed_cost: + description: Total cost in the cost file. + example: 100.5 + format: double + type: number + billing_currency: + description: Currency used in the Custom Costs file. + example: USD + type: string + charge_period: + $ref: '#/components/schemas/CustomCostsFileUsageChargePeriod' + content: + description: Detail of the line items from the Custom Costs file. + items: + $ref: '#/components/schemas/CustomCostsFileLineItem' + type: array + name: + description: Name of the Custom Costs file. + example: my_file.json + type: string + provider_names: + description: Providers contained in the Custom Costs file. + items: + description: Name of a provider. + example: my_provider + type: string + type: array + status: + description: Status of the Custom Costs file. + example: active + type: string + uploaded_at: + description: Timestamp in millisecond of the upload time of the Custom Costs + file. + example: 1704067200000 + format: double + type: number + uploaded_by: + $ref: '#/components/schemas/CustomCostsUser' + type: object + CustomCostsFileMetadataWithContentHighLevel: + description: JSON API format of for a Custom Costs file with content. + properties: + attributes: + $ref: '#/components/schemas/CustomCostsFileMetadataWithContent' + id: + description: ID of the Custom Costs metadata. + type: string + type: + description: Type of the Custom Costs file metadata. + type: string + type: object + CustomCostsFileUploadRequest: + description: Request for uploading a Custom Costs file. + items: + $ref: '#/components/schemas/CustomCostsFileLineItem' + type: array + CustomCostsFileUploadResponse: + description: Response for Uploaded Custom Costs files. + properties: + data: + $ref: '#/components/schemas/CustomCostsFileMetadataHighLevel' + meta: + $ref: '#/components/schemas/CustomCostUploadResponseMeta' + type: object + CustomCostsFileUsageChargePeriod: + description: Usage charge period of a Custom Costs file. + properties: + end: + description: End of the usage of the Custom Costs file. + example: 1706745600000 + format: double + type: number + start: + description: Start of the usage of the Custom Costs file. + example: 1704067200000 + format: double + type: number + type: object + CustomCostsUser: + description: Metadata of the user that has uploaded the Custom Costs file. + properties: + email: + description: The name of the Custom Costs file. + example: email.test@datadohq.com + type: string + icon: + description: The name of the Custom Costs file. + example: icon.png + type: string + name: + description: Name of the user. + example: Test User + type: string + type: object CustomDestinationAttributeTagsRestrictionListType: default: ALLOW_LIST description: 'How `forward_tags_restriction_list` parameter should be interpreted. If `ALLOW_LIST`, then only tags whose keys on the forwarded logs match the @@ -6130,12 +6394,13 @@ env: description: Environment name to where the service was deployed. example: staging type: string finished_at: - description: Unix timestamp in nanoseconds when the deployment finished. - It should not be older than 1 hour. + description: Unix timestamp when the deployment finished. It must be in + nanoseconds, milliseconds, or seconds, and it should not be older than + 1 hour. example: 1693491984000000000 format: int64 type: integer git: $ref: '#/components/schemas/DORAGitInfo' @@ -6145,11 +6410,12 @@ service: description: Service name from a service available in the Service Catalog. example: shopist type: string started_at: - description: Unix timestamp in nanoseconds when the deployment started. + description: Unix timestamp when the deployment started. It must be in nanoseconds, + milliseconds, or seconds. example: 1693491974000000000 format: int64 type: integer version: description: Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/). @@ -6222,12 +6488,12 @@ env: description: Environment name that was impacted by the incident. example: staging type: string finished_at: - description: Unix timestamp in nanoseconds when the incident finished. It - should not be older than 1 hour. + description: Unix timestamp when the incident finished. It must be in nanoseconds, + milliseconds, or seconds, and it should not be older than 1 hour. example: 1693491984000000000 format: int64 type: integer git: $ref: '#/components/schemas/DORAGitInfo' @@ -6250,11 +6516,12 @@ severity: description: Incident severity. example: High type: string started_at: - description: Unix timestamp in nanoseconds when the incident started. + description: Unix timestamp when the incident started. It must be in nanoseconds, + milliseconds, or seconds. example: 1693491974000000000 format: int64 type: integer team: description: Name of the team owning the services impacted. If possible, @@ -6571,10 +6838,133 @@ - detailed_finding example: detailed_finding type: string x-enum-varnames: - DETAILED_FINDING + DeviceAttributes: + description: The device attributes + properties: + description: + description: The device description + example: a device monitored with NDM + type: string + device_type: + description: The device type + example: other + type: string + integration: + description: The device integration + example: snmp + type: string + interface_statuses: + $ref: '#/components/schemas/DeviceAttributesInterfaceStatuses' + ip_address: + description: The device IP address + example: 1.2.3.4 + type: string + location: + description: The device location + example: paris + type: string + model: + description: The device model + example: xx-123 + type: string + name: + description: The device name + example: example device + type: string + os_hostname: + description: The device OS hostname + type: string + os_name: + description: The device OS name + example: example OS + type: string + os_version: + description: The device OS version + example: 1.0.2 + type: string + ping_status: + description: The device ping status + example: unmonitored + type: string + product_name: + description: The device product name + example: example device + type: string + serial_number: + description: The device serial number + example: X12345 + type: string + status: + description: The device SNMP status + example: ok + type: string + subnet: + description: The device subnet + example: 1.2.3.4/24 + type: string + sys_object_id: + description: The device `sys_object_id` + example: 1.3.6.1.4.1.99999 + type: string + tags: + description: The list of device tags + example: + - device_ip:1.2.3.4 + - device_id:example:1.2.3.4 + items: + type: string + type: array + vendor: + description: The device vendor + example: example vendor + type: string + version: + description: The device version + example: 1.2.3 + type: string + type: object + DeviceAttributesInterfaceStatuses: + description: Count of the device interfaces by status + example: + down: 1 + 'off': 2 + up: 12 + warning: 5 + properties: + down: + description: The number of interfaces that are down + format: int64 + type: integer + 'off': + description: The number of interfaces that are off + format: int64 + type: integer + up: + description: The number of interfaces that are up + format: int64 + type: integer + warning: + description: The number of interfaces that are in a warning state + format: int64 + type: integer + type: object + DevicesListData: + description: The devices list data + properties: + attributes: + $ref: '#/components/schemas/DeviceAttributes' + id: + description: The device ID + example: example:1.2.3.4 + type: string + type: + description: The type of the resource. The value should always be device. + type: string + type: object DowntimeCreateRequest: description: Request for creating a downtime. properties: data: $ref: '#/components/schemas/DowntimeCreateRequestData' @@ -8104,10 +8494,11 @@ description: Attributes of a full application key. properties: created_at: description: Creation date of the application key. example: '2020-11-23T10:00:00.000Z' + format: date-time readOnly: true type: string key: description: The application key. readOnly: true @@ -8299,18 +8690,143 @@ - gcp_service_account example: gcp_service_account type: string x-enum-varnames: - GCP_SERVICE_ACCOUNT + GetDeviceAttributes: + description: The device attributes + properties: + description: + description: A description of the device. + example: a device monitored with NDM + type: string + device_type: + description: The type of the device. + example: other + type: string + integration: + description: The integration of the device. + example: snmp + type: string + ip_address: + description: The IP address of the device. + example: 1.2.3.4 + type: string + location: + description: The location of the device. + example: paris + type: string + model: + description: The model of the device. + example: xx-123 + type: string + name: + description: The name of the device. + example: example device + type: string + os_hostname: + description: The operating system hostname of the device. + example: 1.0.2 + type: string + os_name: + description: The operating system name of the device. + example: example OS + type: string + os_version: + description: The operating system version of the device. + example: 1.0.2 + type: string + ping_status: + description: The ping status of the device. + example: unmonitored + type: string + product_name: + description: The product name of the device. + example: example device + type: string + serial_number: + description: The serial number of the device. + example: X12345 + type: string + status: + description: The status of the device. + example: ok + type: string + subnet: + description: The subnet of the device. + example: 1.2.3.4/24 + type: string + sys_object_id: + description: The device `sys_object_id`. + example: 1.3.6.1.4.1.99999 + type: string + tags: + description: A list of tags associated with the device. + example: + - device_ip:1.2.3.4 + - device_id:example:1.2.3.4 + items: + type: string + type: array + vendor: + description: The vendor of the device. + example: example vendor + type: string + version: + description: The version of the device. + example: 1.2.3 + type: string + type: object + GetDeviceData: + description: Get device response data. + properties: + attributes: + $ref: '#/components/schemas/GetDeviceAttributes' + id: + description: The device ID + example: example:1.2.3.4 + type: string + type: + description: The type of the resource. The value should always be device. + type: string + type: object + GetDeviceResponse: + description: The `GetDevice` operation's response. + properties: + data: + $ref: '#/components/schemas/GetDeviceData' + type: object GetFindingResponse: description: The expected response schema when getting a finding. properties: data: $ref: '#/components/schemas/DetailedFinding' required: - data type: object + GetInterfacesData: + description: The interfaces list data + properties: + attributes: + $ref: '#/components/schemas/InterfaceAttributes' + id: + description: The interface ID + example: example:1.2.3.4:99 + type: string + type: + description: The type of the resource. The value should always be interface. + type: string + type: object + GetInterfacesResponse: + description: The `GetInterfaces` operation's response. + properties: + data: + description: Get Interfaces response + items: + $ref: '#/components/schemas/GetInterfacesData' + type: array + type: object GetTeamMembershipsSort: description: Specifies the order of returned team memberships enum: - manager_name - -manager_name @@ -8485,10 +9001,16 @@ type: object HourlyUsageAttributes: description: Attributes of hourly usage for a product family for an org for a time period. properties: + account_name: + description: The account name. + type: string + account_public_id: + description: The account public ID. + type: string measurements: description: List of the measured usage values for the product family for the org for the time period. items: $ref: '#/components/schemas/HourlyUsageMeasurement' @@ -10472,10 +10994,51 @@ items: description: An empty error list. type: string type: array type: object + InterfaceAttributes: + description: The interface attributes + properties: + alias: + description: The interface alias + example: interface_0 + type: string + description: + description: The interface description + example: a network interface + type: string + index: + description: The interface index + example: 0 + format: int64 + type: integer + mac_address: + description: The interface MAC address + example: 00:00:00:00:00:00 + type: string + name: + description: The interface name + example: if0 + type: string + status: + $ref: '#/components/schemas/InterfaceAttributesStatus' + type: object + InterfaceAttributesStatus: + description: The interface status + enum: + - up + - down + - warning + - 'off' + example: up + type: string + x-enum-varnames: + - UP + - DOWN + - WARNING + - 'OFF' JSONAPIErrorItem: description: API error response body properties: detail: description: A human-readable explanation specific to this occurrence of @@ -10633,10 +11196,36 @@ $ref: '#/components/schemas/ApplicationKeyResponseIncludedItem' type: array meta: $ref: '#/components/schemas/ApplicationKeyResponseMeta' type: object + ListDevicesResponse: + description: List devices response. + properties: + data: + description: The list devices response data. + items: + $ref: '#/components/schemas/DevicesListData' + type: array + meta: + $ref: '#/components/schemas/ListDevicesResponseMetadata' + type: object + ListDevicesResponseMetadata: + description: Object describing meta attributes of response. + properties: + page: + $ref: '#/components/schemas/ListDevicesResponseMetadataPage' + type: object + ListDevicesResponseMetadataPage: + description: Pagination object. + properties: + total_filtered_count: + description: Total count of devices matched by the filter. + example: 1 + format: int64 + type: integer + type: object ListDowntimesResponse: description: Response for retrieving all downtimes. properties: data: description: An array of downtimes. @@ -10743,10 +11332,41 @@ next: description: Link for the next set of rules. example: /api/v2/scorecard/rules?page%5Blimit%5D=2&page%5Boffset%5D=2&page%5Bsize%5D=2 type: string type: object + ListTagsResponse: + description: List tags response. + properties: + data: + $ref: '#/components/schemas/ListTagsResponseData' + type: object + ListTagsResponseData: + description: The list tags response data. + properties: + attributes: + $ref: '#/components/schemas/ListTagsResponseDataAttributes' + id: + description: The device ID + example: example:1.2.3.4 + type: string + type: + description: The type of the resource. The value should always be tags. + type: string + type: object + ListTagsResponseDataAttributes: + description: The definition of ListTagsResponseDataAttributes object. + properties: + tags: + description: The list of tags + example: + - tag:test + - tag:testbis + items: + type: string + type: array + type: object ListTeamsInclude: description: Included related resources optionally requested. enum: - team_links - user_team_permissions @@ -14834,10 +15454,16 @@ $ref: '#/components/schemas/ProjectedCostType' type: object ProjectedCostAttributes: description: Projected Cost attributes data. properties: + account_name: + description: The account name. + type: string + account_public_id: + description: The account public ID. + type: string charges: description: List of charges data reported for the requested month. items: $ref: '#/components/schemas/ChargebackBreakdown' type: array @@ -15094,11 +15720,12 @@ format: int32 maximum: 2147483647 type: integer type: description: Type of the RUM application. Supported values are `browser`, - `ios`, `android`, `react-native`, `flutter`. + `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, + `kotlin-multiplatform`. example: browser type: string updated_at: description: Timestamp in ms of the last update date. example: 1659479836169 @@ -15137,11 +15764,12 @@ description: Name of the RUM application. example: my_new_rum_application type: string type: description: Type of the RUM application. Supported values are `browser`, - `ios`, `android`, `react-native`, `flutter`. + `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, + `kotlin-multiplatform`. example: browser type: string required: - name type: object @@ -15210,11 +15838,12 @@ format: int32 maximum: 2147483647 type: integer type: description: Type of the RUM application. Supported values are `browser`, - `ios`, `android`, `react-native`, `flutter`. + `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, + `kotlin-multiplatform`. example: browser type: string updated_at: description: Timestamp in ms of the last update date. example: 1659479836169 @@ -15280,11 +15909,12 @@ description: Name of the RUM application. example: updated_name_for_my_existing_rum_application type: string type: description: Type of the RUM application. Supported values are `browser`, - `ios`, `android`, `react-native`, `flutter`. + `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, + `kotlin-multiplatform`. example: browser type: string type: object RUMApplicationUpdateRequest: description: RUM application update request. @@ -15949,11 +16579,11 @@ RelationshipToRuleDataObject: description: Rule relationship data. properties: id: description: The unique ID for a scorecard. - example: 00000000-0000-beef-0000-000000000000 + example: q8MQxk8TCqrHnWkp type: string type: $ref: '#/components/schemas/ScorecardType' type: object RelationshipToSAMLAssertionAttribute: @@ -16638,12 +17268,10 @@ RoleRelationships: description: Relationships of the role object. properties: permissions: $ref: '#/components/schemas/RelationshipToPermissions' - users: - $ref: '#/components/schemas/RelationshipToUsers' type: object RoleResponse: description: Response containing information about a single role. properties: data: @@ -16669,10 +17297,15 @@ readOnly: true type: string name: description: Name of the role. type: string + user_count: + description: The user count. + format: int32 + maximum: 2147483647 + type: integer type: object RoleUpdateData: description: Data related to the update of a role. properties: attributes: @@ -16794,11 +17427,11 @@ example: Deployments automated via Deployment Trains type: string type: object RuleId: description: The unique ID for a scorecard rule. - example: 00000000-0000-beef-0000-000000000000 + example: q8MQxk8TCqrHnWkx type: string RuleOutcomeRelationships: description: The JSON:API relationship to a scorecard rule. properties: rule: @@ -17371,10 +18004,22 @@ status: $ref: '#/components/schemas/SecurityMonitoringRuleSeverity' required: - status type: object + SecurityMonitoringRuleConvertPayload: + description: Convert a rule from JSON to Terraform. + oneOf: + - $ref: '#/components/schemas/SecurityMonitoringStandardRulePayload' + - $ref: '#/components/schemas/SecurityMonitoringSignalRulePayload' + SecurityMonitoringRuleConvertResponse: + description: Result of the convert rule request containing Terraform content. + properties: + terraformContent: + description: Terraform string as a result of converting the rule from JSON. + type: string + type: object SecurityMonitoringRuleCreatePayload: description: Create a new rule. oneOf: - $ref: '#/components/schemas/SecurityMonitoringStandardRuleCreatePayload' - $ref: '#/components/schemas/SecurityMonitoringSignalRuleCreatePayload' @@ -17397,23 +18042,25 @@ - new_value - anomaly_detection - impossible_travel - hardcoded - third_party + - anomaly_threshold type: string x-enum-varnames: - THRESHOLD - NEW_VALUE - ANOMALY_DETECTION - IMPOSSIBLE_TRAVEL - HARDCODED - THIRD_PARTY + - ANOMALY_THRESHOLD 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.' + and evaluates in real time. For third party rules, this field is not used.' enum: - 0 - 60 - 300 - 600 @@ -17453,11 +18100,12 @@ or credentialed API access.' example: true type: boolean SecurityMonitoringRuleKeepAlive: description: "Once a signal is generated, the signal will remain \u201Copen\u201D - if a case is matched at least once within\nthis keep alive window." + if a case is matched at least once within\nthis keep alive window. For third + party rules, this field is not used." enum: - 0 - 60 - 300 - 600 @@ -22006,10 +22654,11 @@ readOnly: true type: string url: description: The URL for the link example: https://example.com + format: url type: string required: - label - url type: object @@ -22616,10 +23265,42 @@ attributes: $ref: '#/components/schemas/UpdateOpenAPIResponseAttributes' id: $ref: '#/components/schemas/ApiID' type: object + UpdateRuleRequest: + description: Request to update a scorecard rule. + properties: + data: + $ref: '#/components/schemas/UpdateRuleRequestData' + type: object + UpdateRuleRequestData: + description: Data for the request to update a scorecard rule. + properties: + attributes: + $ref: '#/components/schemas/RuleAttributes' + type: + $ref: '#/components/schemas/RuleType' + type: object + UpdateRuleResponse: + description: The response from a rule update request. + properties: + data: + $ref: '#/components/schemas/UpdateRuleResponseData' + type: object + UpdateRuleResponseData: + description: The data for a rule update response. + properties: + attributes: + $ref: '#/components/schemas/RuleAttributes' + id: + $ref: '#/components/schemas/RuleId' + relationships: + $ref: '#/components/schemas/RelationshipToRule' + type: + $ref: '#/components/schemas/RuleType' + type: object UsageApplicationSecurityMonitoringResponse: description: Application Security Monitoring usage response. properties: data: description: Response containing Application Security Monitoring usage. @@ -22733,10 +23414,14 @@ description: Handle of the user. type: string icon: description: URL of the user's icon. type: string + mfa_enabled: + description: If user has MFA enabled. + readOnly: true + type: boolean modified_at: description: Time that the user was last modified. format: date-time type: string name: @@ -23231,10 +23916,111 @@ - PAST_ONE_MONTH - PAST_THREE_MONTHS - PAST_SIX_MONTHS - PAST_ONE_YEAR - ALERT + WorkflowInstanceCreateMeta: + description: Additional information for creating a workflow instance. + properties: + payload: + additionalProperties: {} + description: The input parameters to the workflow. + type: object + type: object + WorkflowInstanceCreateRequest: + description: Request used to create a workflow instance. + properties: + meta: + $ref: '#/components/schemas/WorkflowInstanceCreateMeta' + type: object + WorkflowInstanceCreateResponse: + additionalProperties: {} + description: Response returned upon successful workflow instance creation. + properties: + data: + $ref: '#/components/schemas/WorkflowInstanceCreateResponseData' + type: object + WorkflowInstanceCreateResponseData: + additionalProperties: {} + description: Data about the created workflow instance. + properties: + id: + description: The ID of the workflow execution. It can be used to fetch the + execution status. + type: string + type: object + WorkflowInstanceListItem: + additionalProperties: {} + description: An item in the workflow instances list. + properties: + id: + description: The ID of the workflow instance + type: string + type: object + WorkflowListInstancesResponse: + additionalProperties: {} + description: Response returned when listing workflow instances. + properties: + data: + description: A list of workflow instances. + items: + $ref: '#/components/schemas/WorkflowInstanceListItem' + type: array + meta: + $ref: '#/components/schemas/WorkflowListInstancesResponseMeta' + type: object + WorkflowListInstancesResponseMeta: + additionalProperties: {} + description: Metadata about the instances list + properties: + page: + $ref: '#/components/schemas/WorkflowListInstancesResponseMetaPage' + type: object + WorkflowListInstancesResponseMetaPage: + additionalProperties: {} + description: Page information for the list instances response. + properties: + totalCount: + description: The total count of items. + format: int64 + type: integer + type: object + WorklflowCancelInstanceResponse: + description: Information about the canceled instance. + properties: + data: + $ref: '#/components/schemas/WorklflowCancelInstanceResponseData' + type: object + WorklflowCancelInstanceResponseData: + description: Data about the canceled instance. + properties: + id: + description: The id of the canceled instance + type: string + type: object + WorklflowGetInstanceResponse: + additionalProperties: {} + description: The state of the given workflow instance. + properties: + data: + $ref: '#/components/schemas/WorklflowGetInstanceResponseData' + type: object + WorklflowGetInstanceResponseData: + additionalProperties: {} + description: The data of the instance response. + properties: + attributes: + $ref: '#/components/schemas/WorklflowGetInstanceResponseDataAttributes' + type: object + WorklflowGetInstanceResponseDataAttributes: + additionalProperties: {} + description: The attributes of the instance response data. + properties: + id: + description: The id of the instance. + type: string + type: object securitySchemes: AuthZ: description: This API uses OAuth 2 with the implicit grant flow. flows: authorizationCode: @@ -23564,10 +24350,15 @@ schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Forbidden '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_api_catalog_read summary: List APIs tags: - API Management x-unstable: '**Note**: This endpoint is in public beta. @@ -23604,10 +24395,15 @@ schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: API not found error '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_api_catalog_write summary: Delete an API tags: - API Management x-unstable: '**Note**: This endpoint is in public beta. @@ -23650,10 +24446,15 @@ schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: API not found error '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_api_catalog_read summary: Get an API tags: - API Management x-unstable: '**Note**: This endpoint is in public beta. @@ -23705,10 +24506,15 @@ schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: API not found error '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_api_catalog_write summary: Update an API tags: - API Management x-unstable: '**Note**: This endpoint is in public beta. @@ -23752,10 +24558,15 @@ schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Forbidden '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_api_catalog_write summary: Create a new API tags: - API Management x-unstable: '**Note**: This endpoint is in public beta. @@ -24324,10 +25135,15 @@ in: query name: filter required: false schema: type: string + - description: Filter by mapping resource type. Defaults to "role" if not specified. + in: query + name: resource_type + schema: + $ref: '#/components/schemas/AuthNMappingResourceType' responses: '200': content: application/json: schema: @@ -24544,10 +25360,15 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_read summary: Search cases tags: - Case Management x-pagination: limitParam: page[size] @@ -24578,10 +25399,15 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Create a case tags: - Case Management /api/v2/cases/projects: get: @@ -24602,10 +25428,15 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_read summary: Get all projects tags: - Case Management post: description: Create a project. @@ -24632,10 +25463,15 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Create a project tags: - Case Management /api/v2/cases/projects/{project_id}: delete: @@ -24654,10 +25490,15 @@ schema: $ref: '#/components/schemas/APIErrorResponse' description: API error response '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Remove a project tags: - Case Management get: description: Get the details of a project by `project_id`. @@ -24679,10 +25520,15 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_read summary: Get the details of a project tags: - Case Management /api/v2/cases/{case_id}: get: @@ -24705,10 +25551,15 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_read summary: Get the details of a case tags: - Case Management /api/v2/cases/{case_id}/archive: post: @@ -24738,10 +25589,15 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Archive case tags: - Case Management /api/v2/cases/{case_id}/assign: post: @@ -24771,10 +25627,15 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Assign case tags: - Case Management /api/v2/cases/{case_id}/priority: post: @@ -24804,10 +25665,15 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Update case priority tags: - Case Management /api/v2/cases/{case_id}/status: post: @@ -24837,10 +25703,15 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Update case status tags: - Case Management /api/v2/cases/{case_id}/unarchive: post: @@ -24870,10 +25741,15 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Unarchive case tags: - Case Management /api/v2/cases/{case_id}/unassign: post: @@ -24903,10 +25779,15 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cases_write summary: Unassign case tags: - Case Management /api/v2/ci/pipeline: post: @@ -25589,10 +26470,11 @@ summary: Update Cloud Cost Management AWS CUR config tags: - Cloud Cost Management /api/v2/cost/aws_related_accounts: get: + deprecated: true description: List the AWS accounts in an organization by calling 'organizations:ListAccounts' from the specified management account. operationId: ListAWSRelatedAccounts parameters: - description: The ID of the management account to filter by. @@ -25765,10 +26647,122 @@ - AuthZ: - cloud_cost_management_write summary: Update Cloud Cost Management Azure config tags: - Cloud Cost Management + /api/v2/cost/custom_costs: + get: + description: List the Custom Costs files. + operationId: ListCustomCostsFiles + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomCostsFileListResponse' + description: OK + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Forbidden + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read + summary: List Custom Costs files + tags: + - Cloud Cost Management + put: + description: Upload a Custom Costs file. + operationId: UploadCustomCostsFile + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomCostsFileUploadRequest' + required: true + responses: + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomCostsFileUploadResponse' + description: Accepted + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Forbidden + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write + summary: Upload Custom Costs file + tags: + - Cloud Cost Management + /api/v2/cost/custom_costs/{file_id}: + delete: + description: Delete the specified Custom Costs file. + operationId: DeleteCustomCostsFile + parameters: + - $ref: '#/components/parameters/FileID' + responses: + '204': + description: No Content + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Forbidden + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_write + summary: Delete Custom Costs file + tags: + - Cloud Cost Management + get: + description: Fetch the specified Custom Costs file. + operationId: GetCustomCostsFile + parameters: + - $ref: '#/components/parameters/FileID' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CustomCostsFileGetResponse' + description: OK + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Forbidden + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - cloud_cost_management_read + summary: Get Custom Costs file + tags: + - Cloud Cost Management /api/v2/cost/enabled: get: description: Get the Cloud Cost Management activity. operationId: GetCloudCostActivity responses: @@ -30515,10 +31509,176 @@ x-codegen-request-body-name: body x-pagination: limitParam: page[limit] pageOffsetParam: page[offset] resultsPath: data + /api/v2/ndm/devices: + get: + description: Get the list of devices. + operationId: ListDevices + parameters: + - description: The page number to fetch. + example: 0 + in: query + name: page[number] + required: false + schema: + format: int64 + type: integer + - description: The number of devices to return per page. + example: 10 + in: query + name: page[size] + required: false + schema: + format: int64 + type: integer + - description: The field to sort the devices by. + example: status + in: query + name: sort + required: false + schema: + type: string + - description: Filter devices by tag. + example: status:ok + in: query + name: filter[tag] + required: false + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListDevicesResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get the list of devices + tags: + - Network Device Monitoring + /api/v2/ndm/devices/{device_id}: + get: + description: Get the device details. + operationId: GetDevice + parameters: + - description: The id of the device to fetch. + example: example:1.2.3.4 + in: path + name: device_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GetDeviceResponse' + description: OK + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get the device details + tags: + - Network Device Monitoring + /api/v2/ndm/interfaces: + get: + description: Get the list of interfaces of the device. + operationId: GetInterfaces + parameters: + - description: The ID of the device to get interfaces from. + example: example:1.2.3.4 + in: query + name: device_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GetInterfacesResponse' + description: OK + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get the list of interfaces of the device + tags: + - Network Device Monitoring + /api/v2/ndm/tags/devices/{device_id}: + get: + description: Get the list of tags for a device. + operationId: ListDeviceUserTags + parameters: + - description: The id of the device to fetch tags for. + example: example:1.2.3.4 + in: path + name: device_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListTagsResponse' + description: OK + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get the list of tags for a device + tags: + - Network Device Monitoring + patch: + description: Update the tags for a device. + operationId: UpdateDeviceUserTags + parameters: + - description: The id of the device to update tags for. + example: example:1.2.3.4 + in: path + name: device_id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ListTagsResponse' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListTagsResponse' + description: OK + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Update the tags for a device + tags: + - Network Device Monitoring /api/v2/org_configs: get: description: Returns all Org Configs (name, description, and value). operationId: ListOrgConfigs responses: @@ -30597,15 +31757,10 @@ $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - security: - - apiKeyAuth: [] - appKeyAuth: [] - - AuthZ: - - org_management summary: Update a specific Org Config tags: - Organizations /api/v2/permissions: get: @@ -31452,26 +32607,42 @@ - Security Rules: `security-rule` - Service Level Objectives: `slo` + - Synthetic Global Variables: `synthetic-global-variable` + - Synthetic Tests: `synthetic-test` + + - Synthetic Private Locations: `synthetic-private-location` + + - Monitors: `monitor` + + #### Supported relations for resources - Resource Type | Supported Relations + Resource Type | Supported Relations - -------------------------|-------------------------- + ----------------------------|-------------------------- - Dashboards | `viewer`, `editor` + Dashboards | `viewer`, `editor` - Notebooks | `viewer`, `editor` + Notebooks | `viewer`, `editor` - Powerpacks | `viewer`, `editor` + Powerpacks | `viewer`, `editor` - Security Rules | `viewer`, `editor` + Security Rules | `viewer`, `editor` - Service Level Objectives | `viewer`, `editor`' + Service Level Objectives | `viewer`, `editor` + + Synthetic Global Variables | `viewer`, `editor` + + Synthetic Tests | `viewer`, `editor` + + Synthetic Private Locations | `viewer`, `editor` + + Monitors | `viewer`, `editor`' operationId: UpdateRestrictionPolicy parameters: - $ref: '#/components/parameters/ResourceID' requestBody: content: @@ -32648,10 +33819,47 @@ tags: - Service Scorecards x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + put: + description: Updates an existing rule. + operationId: UpdateScorecardRule + parameters: + - $ref: '#/components/parameters/RuleId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRuleRequest' + description: Rule attributes. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRuleResponse' + description: Rule updated successfully + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - apm_service_catalog_write + summary: Update an existing rule + tags: + - Service Scorecards + x-codegen-request-body-name: body + x-unstable: '**Note**: This endpoint is in public beta. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/security/cloud_workload/policy/download: get: description: 'The download endpoint generates a Cloud Workload Security policy file from your currently active @@ -33150,10 +34358,49 @@ - security_monitoring_rules_write summary: Create a detection rule tags: - Security Monitoring x-codegen-request-body-name: body + /api/v2/security_monitoring/rules/convert: + post: + description: 'Convert a rule that doesn''t (yet) exist from JSON to Terraform + for datadog provider + + resource datadog_security_monitoring_rule.' + operationId: ConvertSecurityMonitoringRuleFromJSONToTerraform + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityMonitoringRuleConvertPayload' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityMonitoringRuleConvertResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/ConcurrentModificationResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_write + summary: Convert a rule from JSON to Terraform + tags: + - Security Monitoring + x-codegen-request-body-name: body /api/v2/security_monitoring/rules/test: post: description: Test a rule. operationId: TestSecurityMonitoringRule requestBody: @@ -33307,10 +34554,41 @@ - security_monitoring_rules_write summary: Update an existing rule tags: - Security Monitoring x-codegen-request-body-name: body + /api/v2/security_monitoring/rules/{rule_id}/convert: + get: + description: 'Convert an existing rule from JSON to Terraform for datadog provider + + resource datadog_security_monitoring_rule.' + operationId: ConvertExistingSecurityMonitoringRule + parameters: + - $ref: '#/components/parameters/SecurityMonitoringRuleID' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityMonitoringRuleConvertResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_read + summary: Convert an existing rule from JSON to Terraform + tags: + - Security Monitoring /api/v2/security_monitoring/rules/{rule_id}/test: post: description: Test an existing rule. operationId: TestExistingSecurityMonitoringRule parameters: @@ -36003,10 +37281,19 @@ name: end_date required: false schema: format: date-time type: string + - description: 'Boolean to specify whether to include accounts connected to + the current account as partner customers in the Datadog partner network + program. Defaults to `false`. ' + in: query + name: include_connected_accounts + required: false + schema: + default: false + type: boolean responses: '200': content: application/json;datetime-format=rfc3339: schema: @@ -36071,10 +37358,19 @@ name: end_month required: false schema: format: date-time type: string + - description: 'Boolean to specify whether to include accounts connected to + the current account as partner customers in the Datadog partner network + program. Defaults to `false`. ' + in: query + name: include_connected_accounts + required: false + schema: + default: false + type: boolean responses: '200': content: application/json;datetime-format=rfc3339: schema: @@ -36158,10 +37454,19 @@ name: filter[include_descendants] required: false schema: default: false type: boolean + - description: Boolean to specify whether to include accounts connected to the + current account as partner customers in the Datadog partner network program. + Defaults to false. + in: query + name: filter[include_connected_accounts] + required: false + schema: + default: false + type: boolean - description: Include breakdown of usage by subcategories where applicable (for product family logs only). Defaults to false. in: query name: filter[include_breakdown] required: false @@ -36368,10 +37673,19 @@ in: query name: view required: false schema: type: string + - description: 'Boolean to specify whether to include accounts connected to + the current account as partner customers in the Datadog partner network + program. Defaults to `false`. ' + in: query + name: include_connected_accounts + required: false + schema: + default: false + type: boolean responses: '200': content: application/json;datetime-format=rfc3339: schema: @@ -36836,10 +38150,126 @@ - AuthZ: - teams_read summary: Get user memberships tags: - Teams + /api/v2/workflows/{workflow_id}/instances: + get: + description: List all instances of a given workflow. This API requires an application + key scoped with the workflows_read permission. + operationId: ListWorkflowInstances + parameters: + - $ref: '#/components/parameters/WorkflowId' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/PageNumber' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WorkflowListInstancesResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - workflows_read + summary: List workflow instances + tags: + - Workflow Automation + post: + description: Execute the given workflow. This API requires an application key + scoped with the workflows_run permission. + operationId: CreateWorkflowInstance + parameters: + - $ref: '#/components/parameters/WorkflowId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WorkflowInstanceCreateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WorkflowInstanceCreateResponse' + description: Created + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Execute a workflow + tags: + - Workflow Automation + x-codegen-request-body-name: body + /api/v2/workflows/{workflow_id}/instances/{instance_id}: + get: + description: Get a specific execution of a given workflow. This API requires + an application key scoped with the workflows_read permission. + operationId: GetWorkflowInstance + parameters: + - $ref: '#/components/parameters/WorkflowId' + - $ref: '#/components/parameters/InstanceId' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WorklflowGetInstanceResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - workflows_read + summary: Get a workflow instance + tags: + - Workflow Automation + /api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel: + put: + description: Cancels a specific execution of a given workflow. This API requires + an application key scoped with the workflows_run permission. + operationId: CancelWorkflowInstance + parameters: + - $ref: '#/components/parameters/WorkflowId' + - $ref: '#/components/parameters/InstanceId' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/WorklflowCancelInstanceResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Cancel a workflow instance + tags: + - Workflow Automation security: - apiKeyAuth: [] appKeyAuth: [] servers: - url: https://{subdomain}.{site} @@ -37057,10 +38487,14 @@ [Tag Policies](https://docs.datadoghq.com/monitors/settings/).' externalDocs: description: Find out more at url: https://docs.datadoghq.com/monitors/create/types/ name: Monitors +- description: The Network Device Monitoring API allows you to fetch devices and interfaces + and their attributes. See the [Network Device Monitoring page](https://docs.datadoghq.com/network_monitoring/) + for more information. + name: Network Device Monitoring - description: Configure your [Datadog Okta integration](https://docs.datadoghq.com/integrations/okta/) directly through the Datadog API. name: Okta Integration - description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/) @@ -37152,12 +38586,12 @@ balance feature development with platform stability, and improve communication with internal and external users.' name: Service Level Objectives -- description: 'API to create, update scorecard rules and outcomes. See [Service Scorecards](https://docs.datadoghq.com/service_catalog/scorecards) - for more information. +- description: 'API to create and update scorecard rules and outcomes. See [Service + Scorecards](https://docs.datadoghq.com/service_catalog/scorecards) for more information. This feature is currently in BETA. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' name: Service Scorecards @@ -37203,6 +38637,11 @@ name: Usage Metering - description: Create, edit, and disable users. externalDocs: url: https://docs.datadoghq.com/account_management/users name: Users +- description: Automate your teams operational processes with Datadog Workflow Automation. + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/service_management/workflows/ + name: Workflow Automation x-group-parameters: true