Oracle

Oracle Data Safe API

The dataSafe API from Oracle — 258 operation(s) for datasafe.

GitHub OpenAPI

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-datasafe-api-openapi.yml

OpenAPI Specification

oracle-datasafe-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: APIs for using Oracle Data Safe.
  title: Data Safe API
  version: '20181201'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/9fcfdf5451ced20c250b00300ef33ea3d173d05dd0bb98b21348904f03d6ccc0.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Data Safe API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/9fcfdf5451ced20c250b00300ef33ea3d173d05dd0bb98b21348904f03d6ccc0.yaml
    what: the harvested document for Data Safe API
servers:
- url: http://127.0.0.1/20181201
- url: https://127.0.0.1/20181201
tags:
- name: dataSafe
paths:
  /actions/downloadPrivilegeScript:
    post:
      description: 'Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database.

        '
      operationId: DownloadPrivilegeScript
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        200:
          description: The privilege script is downloaded successfully.
          headers:
            content-length:
              description: Size of the file.
              schema:
                type: integer
                format: int64
            etag:
              description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven)

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/octet-stream:
              schema:
                format: binary
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Downloads the privilege script to grant/revoke required roles from the Data Safe account on the target database.
      tags:
      - dataSafe
      x-obmcs-authz-declarations:
        authorizationRequired: false
      x-related-resource: '#/definitions/TargetDatabase'
  /alertAnalytics:
    get:
      description: 'Returns the aggregation details of the alerts.

        '
      operationId: ListAlertAnalytics
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/TimeStartQueryParam'
      - $ref: '#/components/parameters/TimeEndQueryParam'
      - $ref: '#/components/parameters/TimeZoneQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/AlertSortByQueryParam'
      - $ref: '#/components/parameters/AccessLevelQueryParam'
      - $ref: '#/components/parameters/AlertSCIMQueryParam'
      - $ref: '#/components/parameters/AlertSummaryFieldQueryParam'
      - $ref: '#/components/parameters/AlertGroupByQueryParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: A page of alerts aggregation objects.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertAnalyticsCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns the aggregation details of the alerts.
      tags:
      - dataSafe
      x-example: "GET /20181201/alertAnalytics?groupBy=targetId\n  {\n    \"items\": [\n      { \"metricName\": \"POLICY_VIOLATIONS\"  ,\n        \"timeStarted\": \"2021-05-25T00:00:00\",\n        \"timeEnded\": \"2021-05-26T00:00:40\",\n        \"count\": 3,\n        \"dimensions\": {\n          \"targetName\": \"target_1\"\n        }\n      },\n      { \"metricName\": \"HIGH_SEVERITY\"  ,\n        \"timeStarted\": \"2021-05-25T00:00:00\",\n        \"timeEnded\": \"2021-05-26T00:00:00\",\n        \"count\": 4,\n        \"dimensions\": {\n          \"targetName\": \"target_1\",\n          \"operation\": \"alter system set sqlsecurity false\"\n        }\n      }\n    ]\n  }\n"
      x-related-resource: '#/definitions/AlertSummary'
  /alertPolicies:
    get:
      description: 'Gets a list of all alert policies.

        '
      operationId: ListAlertPolicies
      parameters:
      - $ref: '#/components/parameters/AlertPolicyIdQueryParam'
      - $ref: '#/components/parameters/AlertPolicyTypeQueryParam'
      - $ref: '#/components/parameters/IsUserDefinedAlertPolicyQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/AlertPolicyLifecycleStateQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/AlertPolicySortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/TimeCreatedGreaterThanOrEqualToQueryParam'
      - $ref: '#/components/parameters/TimeCreatedLessThanQueryParam'
      - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam'
      - $ref: '#/components/parameters/AccessLevelQueryParam'
      responses:
        200:
          description: Alert policies retrieved successfully.
          headers:
            etag:
              description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven)

                '
              schema:
                type: string
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-prev-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the previous batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertPolicyCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of all alert policies.
      tags:
      - dataSafe
      x-example: 'GET /20181201/alertPolicies

        Host: datasafe.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/AlertPolicy'
  /alertPolicies/{alertPolicyId}:
    get:
      description: Gets the details of alert policy by its ID.
      operationId: GetAlertPolicy
      parameters:
      - $ref: '#/components/parameters/AlertPolicyIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Alert policy associated with the given OCID retrieved succesffully.
          headers:
            etag:
              description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven)

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertPolicy'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets the details of the specified alert policy.
      tags:
      - dataSafe
      x-example: 'GET /20181201/alertPolicies/<var>&lt;alertPolicyId&gt;</var>

        Host: datasafe.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /alertPolicies/{alertPolicyId}/rules:
    get:
      description: 'Lists the rules of the specified alert policy. The alert policy is said to be satisfied when all rules in the policy evaulate to true.

        If there are three rules: rule1,rule2 and rule3, the policy is satisfied if rule1 AND rule2 AND rule3 is True.

        '
      operationId: ListAlertPolicyRules
      parameters:
      - $ref: '#/components/parameters/AlertPolicyIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      responses:
        200:
          description: Policy rules associated with the given OCID retrieved successfully.
          headers:
            etag:
              description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven)

                '
              schema:
                type: string
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-prev-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the previous batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertPolicyRuleCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists the rules of the specified alert policy.
      tags:
      - dataSafe
      x-example: 'GET /20181201/alertPolicies/<var>&lt;alertPolicyId&gt;</var>/rules

        Host: datasafe.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-authz-declarations:
        authorizationRequired: downstream.fetcher().pathParams(request.resourceId).fetch('DataSafe', 'GetAlertPolicy').compartmentId != 'SEEDED_RESOURCE'
      x-related-resource: '#/definitions/AlertPolicy'
  /alerts:
    get:
      description: 'Gets a list of all alerts.

        '
      operationId: ListAlerts
      parameters:
      - $ref: '#/components/parameters/AlertIdQueryParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/AccessLevelQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/AlertSortByQueryParam'
      - $ref: '#/components/parameters/AlertSCIMQueryParam'
      - $ref: '#/components/parameters/AlertFieldQueryParam'
      responses:
        200:
          description: Alerts retrieved successfully.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-prev-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the previous batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of all alerts.
      tags:
      - dataSafe
      x-example: 'GET /20181201/alerts

        Host: datasafe.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/AlertSummary'
    patch:
      description: Updates the status of one or more alert specified by the alert IDs.
      operationId: PatchAlerts
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam'
      - $ref: '#/components/parameters/AccessLevelQueryParam'
      responses:
        202:
          description: Request received successfully. The alerts will be updated.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Patch alerts.
      tags:
      - dataSafe
      x-example: "PATCH /20181201/alerts?compartmentIdInSubtree=true&accessLevel=ACCESSIBLE\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\" : \"ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnmxsjheayom3pljsfppcf\",\n  \"items\":\n    [\n    { \"operation\": \"MERGE\",\n       \"selection\": \"items[?id=='ocid1.datasafealert.oc1.iad.abuwcljr7aix74dipj3qpikzynmrkjkqmbmr5bdatvwjqidswy25d7yokjwq']\",\n       \"value\": {\"status\":\"CLOSED\"}\n     },\n    { \"operation\": \"MERGE\",\n      \"selection\": \"items[?id=='ocid1.datasafealert.oc1.iad.abuwcljr7aix74dipj3qpikzynmrkjkqmbmr5bdatvwjqidswy25d7yjvjgfd']\",\n      \"value\": {\"status\":\"CLOSED\"}\n    }\n   ]\n}\n"
      x-related-resource: '#/definitions/Alert'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchAlertsDetails'
        description: The alert details to update the status of one or more alert specified by the alert IDs.
        required: true
  /alerts/actions/updateAll:
    post:
      description: Updates alerts in the specified compartment.
      operationId: AlertsUpdate
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam'
      - $ref: '#/components/parameters/AccessLevelQueryParam'
      responses:
        202:
          description: Request received successfully. The status of the alerts will be updated.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The OCID of the work request. Use [GetWorkRequest](#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates alerts in the specified compartment.
      tags:
      - dataSafe
      x-example: "POST /20181201/alerts/actions/updateAll?compartmentIdInSubtree=true&accessLevel=ACCESSIBLE\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"status\" : \"OPEN\",\n  \"compartmentId\":\"ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnmxsjheayom3pljsfppcf\"\n}\n\nPOST /20181201/alerts/actions/updateAll\nHost: datasafe.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"status\" : \"CLOSED\",\n  \"compartmentId\":\"ocid1.compartment.oc1..aaaaaaaaqkb3jtub4lnlha7vfvp4f2mj6zxraqfnmxsjheayom3pljsfppcf\",\n  \"targetId\":\"ocid1.datasafeinstance.target.dev2.arsgk6rrajbnicptestyf1a58zng0ukwarqeuedcuzdxy32gakkkuzesasew\"\n}\n"
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/Alert'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertsUpdateDetails'
        description: The details to update the alerts in the specified compartment.
        required: true
  /alerts/{alertId}:
    get:
      description: Gets the details of the specified alerts.
      operationId: GetAlert
      parameters:
      - $ref: '#/components/parameters/AlertIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Alert associated with the given OCID is retrieved successfully.
          headers:
            etag:
              description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven)

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alert'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets the details of the specified alerts.
      tags:
      - dataSafe
      x-example: 'GET /20181201/alerts/<var>&lt;alertId&gt;</var>

        Host: datasafe.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    put:
      description: Updates the status of the specified alert.
      operationId: UpdateAlert
      parameters:
      - $ref: '#/components/parameters/AlertIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Alert updated successfully.
          headers:
            etag:
              description: 'For optimistic concurrency control. For more information, see [ETags for Optimistic Concurrency Control](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven)

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alert'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates the status of the specified alert.
      tags:
      - dataSafe
      x-related-resource: '#/definitions/Alert'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAlertDetails'
        description: The details used to update alert status.
        required: true
  /alerts/{alertId}/actions/changeCompartment:
    post:
      description: Moves the specified alert into a different compartment.
      operationId: ChangeAlertCompartment
      parameters:
      - $ref: '#/components/parameters/AlertIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        204:
          description: Alert moved successfully.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Moves the specified alert into a different compartment.
      tags:
      - dataSafe
      x-related-resource: '#/definitions/Alert'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeAlertCompartmentDetails'
        description: The details used to change the compartment of an alert.
        required: true
  /attributeSets:
    get:
      description: 'Retrieves the list of attribute sets.


        The ListAttributeSets operation returns only the attribute sets in the specified `compartmentId`.


        The parameter `accessLevel` specifies whether to return only those compartments for which the

        requester has INSPECT permissions on at least one resource directly

        or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if

        Principal doesn''t have access to even one of the child compartments. This is valid only when

        `compartmentIdInSubtree` is set to `true`.


        The parameter `compartmentIdInSubtree` applies when you perform ListAttributeSet on the

        `compartmentId` passed and when it is set to true, the entire hierarchy of compartments can be returned.

        To get a full list of all compartments and subcompartments in the tenancy (root compartment),

        set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ACCESSIBLE.

        '
      operationId: ListAttributeSets
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam'
      - $ref: '#/components/parameters/AccessLevelQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/AttributeSetIdQueryParam'
      - $ref: '#/components/parameters/AttributeSetTypeQueryParam'
      - $ref: '#/components/parameters/AttributeSetLifecycleStateQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IsUserDefinedAttributeSetQueryParam'
      - $ref: '#/components/parameters/InUseAttributeSetQueryParam'
      responses:
        200:
          description: List of attribute set records retrieved successfully.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-prev-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the previous batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          x-related-resource: '#/definitions/AttributeSet'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttributeSetCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summa

# --- truncated at 32 KB (2008 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-datasafe-api-openapi.yml