.generator/schemas/v2/openapi.yaml in datadog_api_client-1.5.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-1.6.0

- old
+ new

@@ -128,12 +128,20 @@ in: path name: archive_id required: true schema: type: string + CloudWorkloadSecurityAgentRuleID: + description: The ID of the Agent rule. + example: 3b5-v82-ns6 + in: path + name: agent_rule_id + required: true + schema: + type: string IncidentIDPathParameter: - description: The UUID the incident. + description: The UUID of the incident. in: path name: incident_id required: true schema: type: string @@ -475,12 +483,25 @@ ApplicationKeyCreateAttributes: description: Attributes used to create an application Key. properties: name: description: Name of the application key. - example: Application Key for submitting metrics + example: Application Key for managing dashboards type: string + scopes: + description: Array of scopes to grant the application key. This feature + is in private beta, please contact Datadog support to enable scopes for + your application keys. + example: + - dashboards_read + - dashboards_write + - dashboards_public_share + items: + description: Name of scope. + type: string + nullable: true + type: array required: - name type: object ApplicationKeyCreateData: description: Object used to create an application key. @@ -527,14 +548,25 @@ ApplicationKeyUpdateAttributes: description: Attributes used to update an application Key. properties: name: description: Name of the application key. - example: Application Key for submitting metrics + example: Application Key for managing dashboards type: string - required: - - name + scopes: + description: Array of scopes to grant the application key. This feature + is in private beta, please contact Datadog support to enable scopes for + your application keys. + example: + - dashboards_read + - dashboards_write + - dashboards_public_share + items: + description: Name of scope. + type: string + nullable: true + type: array type: object ApplicationKeyUpdateData: description: Object used to update an application key. properties: attributes: @@ -583,10 +615,194 @@ - application_keys example: application_keys type: string x-enum-varnames: - APPLICATION_KEYS + CloudWorkloadSecurityAgentRuleAttributes: + description: A Cloud Workload Security Agent rule returned by the API. + properties: + category: + description: The category of the Agent rule. + example: Process Activity + type: string + creationDate: + description: When the Agent rule was created, timestamp in milliseconds. + example: 1624366480320 + format: int64 + type: integer + creator: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreatorAttributes' + defaultRule: + description: Whether the rule is included by default. + example: false + type: boolean + description: + description: The description of the Agent rule. + example: My Agent rule + type: string + enabled: + description: Whether the Agent rule is enabled. + example: true + type: boolean + expression: + description: The SECL expression of the Agent rule. + example: exec.file.name == \"sh\" + type: string + name: + description: The name of the Agent rule. + example: my_agent_rule + type: string + updatedAt: + description: When the Agent rule was last updated, timestamp in milliseconds. + example: 1624366480320 + format: int64 + type: integer + updater: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdaterAttributes' + version: + description: The version of the Agent rule. + example: 23 + format: int64 + type: integer + CloudWorkloadSecurityAgentRuleCreateAttributes: + description: Create a new Cloud Workload Security Agent rule. + properties: + description: + description: The description of the Agent rule. + example: My Agent rule + type: string + enabled: + description: Whether the Agent rule is enabled. + example: true + type: boolean + expression: + description: The SECL expression of the Agent rule. + example: exec.file.name == \"sh\" + type: string + name: + description: The name of the Agent rule. + example: my_agent_rule + type: string + required: + - name + - expression + type: object + CloudWorkloadSecurityAgentRuleCreateData: + description: Object for a single Agent rule. + properties: + attributes: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateAttributes' + type: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType' + required: + - attributes + - type + type: object + CloudWorkloadSecurityAgentRuleCreateRequest: + description: Request object that includes the Agent rule to create. + properties: + data: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateData' + required: + - data + type: object + CloudWorkloadSecurityAgentRuleCreatorAttributes: + description: The attributes of the user who created the Agent rule. + properties: + handle: + description: The handle of the user. + example: datadog.user@example.com + type: string + name: + description: The name of the user. + example: Datadog User + type: string + type: object + CloudWorkloadSecurityAgentRuleData: + description: Object for a single Agent rule. + properties: + attributes: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleAttributes' + id: + description: The ID of the Agent rule. + example: 3dd-0uc-h1s + type: string + type: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType' + type: object + CloudWorkloadSecurityAgentRuleResponse: + description: Response object that includes an Agent rule. + properties: + data: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleData' + type: object + CloudWorkloadSecurityAgentRuleType: + default: agent_rule + description: The type of the resource. The value should always be `agent_rule`. + enum: + - agent_rule + example: agent_rule + type: string + x-enum-varnames: + - AGENT_RULE + CloudWorkloadSecurityAgentRuleUpdateAttributes: + description: Update an existing Cloud Workload Security Agent rule. + properties: + description: + description: The description of the Agent rule. + example: My Agent rule + type: string + enabled: + description: Whether the Agent rule is enabled. + example: true + type: boolean + expression: + description: The SECL expression of the Agent rule. + example: exec.file.name == \"sh\" + type: string + type: object + CloudWorkloadSecurityAgentRuleUpdateData: + description: Object for a single Agent rule. + properties: + attributes: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateAttributes' + type: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType' + required: + - attributes + - type + type: object + CloudWorkloadSecurityAgentRuleUpdateRequest: + description: Request object that includes the Agent rule with the attributes + to update. + properties: + data: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateData' + required: + - data + type: object + CloudWorkloadSecurityAgentRuleUpdaterAttributes: + description: The attributes of the user who last updated the Agent rule. + properties: + handle: + description: The handle of the user. + example: datadog.user@example.com + type: string + name: + description: The name of the user. + example: Datadog User + type: string + type: object + CloudWorkloadSecurityAgentRulesListResponse: + description: Response object that includes a list of Agent rule. + properties: + data: + description: A list of Agent rules objects. + items: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleData' + type: array + type: object ContentEncoding: description: HTTP header used to compress the media-type. enum: - gzip - deflate @@ -799,17 +1015,19 @@ type: string key: description: The API key. readOnly: true type: string + x-secret: true last4: description: The last four characters of the API key. example: abcd maxLength: 4 minLength: 4 readOnly: true type: string + x-secret: true modified_at: description: Date the API key was last modified. example: '2020-11-23T10:00:00.000Z' readOnly: true type: string @@ -841,21 +1059,36 @@ type: string key: description: The application key. readOnly: true type: string + x-secret: true last4: description: The last four characters of the application key. example: abcd maxLength: 4 minLength: 4 readOnly: true type: string + x-secret: true name: description: Name of the application key. - example: Application Key for submitting metrics + example: Application Key for managing dashboards type: string + scopes: + description: Array of scopes to grant the application key. This feature + is in private beta, please contact Datadog support to enable scopes for + your application keys. + example: + - dashboards_read + - dashboards_write + - dashboards_public_share + items: + description: Name of scope. + type: string + nullable: true + type: array type: object HTTPLog: description: Structured log message. items: $ref: '#/components/schemas/HTTPLogItem' @@ -1044,11 +1277,11 @@ x-enum-varnames: - DROPDOWN - TEXTBOX IncidentFieldAttributesValueType: default: multiselect - description: Type of the single value field definitions. + description: Type of the multiple value field definitions. enum: - multiselect - textarray - metrictag - autocomplete @@ -2852,11 +3085,11 @@ description: The search and filter query settings properties: from: default: now-15m description: The minimum time for the requested logs, supports date math - and regular timestamps + and regular timestamps (milliseconds). example: now-15m type: string indexes: default: - '*' @@ -2875,11 +3108,11 @@ example: service:web* AND @http.status_code:[200 TO 299] type: string to: default: now description: The maximum time for the requested logs, supports date math - and regular timestamps + and regular timestamps (milliseconds). example: now type: string type: object LogsQueryOptions: description: 'Global query options that are used during the query. @@ -3495,10 +3728,11 @@ example: abcd maxLength: 4 minLength: 4 readOnly: true type: string + x-secret: true modified_at: description: Date the API key was last modified. example: '2020-11-23T10:00:00.000Z' readOnly: true type: string @@ -3533,14 +3767,28 @@ example: abcd maxLength: 4 minLength: 4 readOnly: true type: string + x-secret: true name: description: Name of the application key. - example: Application Key for submitting metrics + example: Application Key for managing dashboards type: string + scopes: + description: Array of scopes to grant the application key. This feature + is in private beta, please contact Datadog support to enable scopes for + your application keys. + example: + - dashboards_read + - dashboards_write + - dashboards_public_share + items: + description: Name of scope. + type: string + nullable: true + type: array type: object PartialApplicationKeyResponse: description: Response for retrieving a partial application key. properties: data: @@ -3925,10 +4173,40 @@ description: Number of users with that role. format: int64 readOnly: true type: integer type: object + RoleClone: + description: Data for the clone role request. + properties: + attributes: + $ref: '#/components/schemas/RoleCloneAttributes' + type: + $ref: '#/components/schemas/RolesType' + required: + - type + - attributes + type: object + RoleCloneAttributes: + description: Attributes required to create a new role by cloning an existing + one. + properties: + name: + description: Name of the new role that is cloned. + example: cloned-role + type: string + required: + - name + type: object + RoleCloneRequest: + description: Request to create a role by cloning an existing role. + properties: + data: + $ref: '#/components/schemas/RoleClone' + required: + - data + type: object RoleCreateAttributes: description: Attributes of the created role. properties: created_at: description: Creation time of the role. @@ -4613,12 +4891,10 @@ $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptions' type: object SecurityMonitoringRuleQuery: description: Query for matching rule. properties: - agentRule: - $ref: '#/components/schemas/SecurityMonitoringRuntimeAgentRule' aggregation: $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation' distinctFields: description: Field for which the cardinality is measured. Sent as an array. items: @@ -4659,12 +4935,10 @@ - MAX - NEW_VALUE SecurityMonitoringRuleQueryCreate: description: Query for matching rule. properties: - agentRule: - $ref: '#/components/schemas/SecurityMonitoringRuntimeAgentRule' aggregation: $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation' distinctFields: description: Field for which the cardinality is measured. Sent as an array. items: @@ -4843,28 +5117,10 @@ example: 1 format: int32 maximum: 2147483647 type: integer type: object - SecurityMonitoringRuntimeAgentRule: - description: The Agent rule. - properties: - agentRuleId: - description: The Agent rule ID. Must be unique within the rule. - example: etc_shadow - type: string - expression: - description: 'A Runtime Security expression determines what activity should - be collected by the Datadog Agent. - - These logical expressions can use predefined operators and attributes. - Tags cannot be used in Runtime - - Security expressions. Instead, allow or deny based on tags under the advanced - option.' - type: string - type: object SecurityMonitoringSignal: description: Object description of a security signal. properties: attributes: description: 'The object containing all signal attributes and their @@ -4894,11 +5150,11 @@ - security:attack - technique:T1110-brute-force format: array items: description: The tag associated with the security signal. - format: string + type: string timestamp: description: The timestamp of the security signal. example: '2019-01-02T09:42:36.320Z' format: date-time type: string @@ -5329,25 +5585,25 @@ authorizationUrl: /oauth2/v1/authorize scopes: dashboards_public_share: The ability to share dashboards externally. dashboards_read: The ability to view dashboards. dashboards_write: The ability to create and change dashboards. - events_read: The ability to read events data. + events_read: The ability to read Events data. incident_read: The ability to view incidents in Datadog. - incident_settings_write: The ability to configure incident settings. + incident_settings_write: The ability to configure Incidents settings. incident_write: The ability to create, view, and manage incidents in Datadog. metrics_read: The ability to view custom metrics. security_monitoring_filters_read: The ability to read Security Filters. security_monitoring_filters_write: The ability to create, edit and delete Security Filters. - security_monitoring_rules_read: The ability to read Detection rules. + security_monitoring_rules_read: The ability to read Detection Rules. security_monitoring_rules_write: The ability to create and edit Detection - rules. - security_monitoring_signals_read: The ability to view Security signals. - user_access_invite: Allows users to invite other users to your organization. - user_access_manage: Grants the permission to disable users, manage user - roles and SAML-to-role mappings. + Rules. + security_monitoring_signals_read: The ability to view Security Signals. + user_access_invite: The ability to invite other users to your organization. + user_access_manage: The ability to disable users, manage user roles, and + manage SAML-to-role mappings. tokenUrl: /oauth2/v1/token type: oauth2 apiKeyAuth: description: Your Datadog API Key. in: header @@ -8026,10 +8282,72 @@ - Roles x-codegen-request-body-name: body x-menu-order: 4 x-undo: type: idempotent + /api/v2/roles/{role_id}/clone: + post: + description: Clone an existing role + operationId: CloneRole + parameters: + - $ref: '#/components/parameters/RoleID' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoleCloneRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/RoleResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Authentication error + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Not found + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Conflict + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_manage + summary: Create a new role by cloning an existing role + tags: + - Roles + x-codegen-request-body-name: body + x-menu-order: 12 + x-permission: OR(USER_ACCESS_MANAGE) + x-undo: + operationId: DeleteRole + parameters: + - name: role_id + source: data.id + type: unsafe /api/v2/roles/{role_id}/permissions: delete: description: Removes a permission from a role. operationId: RemovePermissionFromRole parameters: @@ -8339,10 +8657,217 @@ \"{{ user.data.type }}\"\n }\n}" step: the "user" has the "role" x-menu-order: 10 x-undo: type: safe + /api/v2/security/cloud_workload/policy/download: + get: + description: 'The download endpoint generates a Cloud Workload Security policy + file from your currently active + + Cloud Workload Security rules, and downloads them as a .policy file. This + file can then be deployed to + + your agents to update the policy running in your environment.' + operationId: DownloadCloudWorkloadPolicyFile + responses: + '200': + content: + application/yaml: + schema: + format: binary + type: string + description: OK + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_rules_read + summary: Get the latest Cloud Workload Security policy + tags: + - Cloud Workload Security + x-menu-order: 1 + x-undo: + type: safe + /api/v2/security_monitoring/cloud_workload_security/agent_rules: + get: + description: Get the list of Agent rules. + operationId: ListCloudWorkloadSecurityAgentRules + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRulesListResponse' + description: OK + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_cws_agent_rules_read + summary: Get all Cloud Workload Security Agent rules + tags: + - Cloud Workload Security + x-menu-order: 3 + x-undo: + type: safe + post: + description: Create a new Agent rule with the given parameters. + operationId: CreateCloudWorkloadSecurityAgentRule + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest' + description: The definition of the new Agent rule. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '409': + $ref: '#/components/responses/ConflictResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_cws_agent_rules_write + summary: Create a Cloud Workload Security Agent rule + tags: + - Cloud Workload Security + x-codegen-request-body-name: body + x-given: + agent_rule: + parameters: + - name: body + value: "{\n \"data\": {\n \"type\": \"agent_rule\",\n \"attributes\": + {\n \"name\": \"{{ unique_lower_alnum }}\",\n \"description\": + \"My Agent rule\",\n \"expression\": \"exec.file.name == \\\"sh\\\"\",\n + \ \"enabled\": true\n }\n }\n}" + step: there is a valid "agent_rule" in the system + x-menu-order: 4 + x-undo: + operationId: DeleteCloudWorkloadSecurityAgentRule + parameters: + - name: agent_rule_id + source: data.id + type: unsafe + /api/v2/security_monitoring/cloud_workload_security/agent_rules/{agent_rule_id}: + delete: + description: Delete a specific Agent rule. + operationId: DeleteCloudWorkloadSecurityAgentRule + parameters: + - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' + responses: + '204': + description: OK + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_cws_agent_rules_write + summary: Delete a Cloud Workload Security Agent rule + tags: + - Cloud Workload Security + x-menu-order: 6 + x-undo: + type: idempotent + get: + description: Get the details of a specific Agent rule. + operationId: GetCloudWorkloadSecurityAgentRule + parameters: + - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse' + description: OK + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_cws_agent_rules_read + summary: Get a Cloud Workload Security Agent rule + tags: + - Cloud Workload Security + x-menu-order: 2 + x-undo: + type: safe + patch: + description: 'Update a specific Agent rule. + + Returns the Agent rule object when the request is successful.' + operationId: UpdateCloudWorkloadSecurityAgentRule + parameters: + - $ref: '#/components/parameters/CloudWorkloadSecurityAgentRuleID' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest' + description: New definition of the Agent rule. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '409': + $ref: '#/components/responses/ConcurrentModificationResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_cws_agent_rules_write + summary: Update a Cloud Workload Security Agent rule + tags: + - Cloud Workload Security + x-codegen-request-body-name: body + x-menu-order: 5 + x-undo: + type: idempotent /api/v2/security_monitoring/configuration/security_filters: get: description: Get the list of configured security filters with their definitions. operationId: ListSecurityFilters responses: @@ -9947,11 +10472,11 @@ servers: - url: https://{subdomain}.{site} variables: site: default: datadoghq.com - description: The regional site for our customers. + description: The regional site for Datadog customers. enum: - datadoghq.com - us3.datadoghq.com - us5.datadoghq.com - datadoghq.eu @@ -9974,10 +10499,13 @@ description: Any Datadog deployment. subdomain: default: api description: The subdomain where the API is deployed. tags: +- description: Workload activity security rules for generating events using the Datadog + security Agent. + name: Cloud Workload Security - description: 'Interact with your dashboard lists through the API to organize, find, and share all of your dashboards with your team and organization.' @@ -10007,10 +10535,10 @@ - description: 'Archives forward all the logs ingested to a cloud storage system. See the [Archives Page](https://app.datadoghq.com/logs/pipelines/archives) - for a list of the archives currently configured in our UI.' + for a list of the archives currently configured in web UI.' externalDocs: description: Find out more at url: https://docs.datadoghq.com/logs/archives/ name: Logs Archives - description: Manage configuration of [log-based metrics](https://app.datadoghq.com/logs/pipelines/generate-metrics)