Oracle Vaults API

The vaults API from Oracle — 11 operation(s) for vaults.

Operations 13

GET /secrets Lists all secrets. #
POST /secrets Creates a secret. #
GET /secrets/{secretId} Gets details about a secret. #
PUT /secrets/{secretId} Updates a secret's properties. #
POST /secrets/{secretId}/actions/cancelDeletion Cancels a scheduled secret deletion. #
POST /secrets/{secretId}/actions/cancelRotation Cancels an ongoing secret rotation. #
POST /secrets/{secretId}/actions/changeCompartment Moves a secret into a different compartment. #
POST /secrets/{secretId}/actions/rotate Rotates an existing secret. #
POST /secrets/{secretId}/actions/scheduleDeletion Schedules the deletion of a secret. #
GET /secrets/{secretId}/version/{secretVersionNumber} Gets details about a secret version. #
POST /secrets/{secretId}/version/{secretVersionNumber}/actions/cancelDeletion Cancels a scheduled secret version deletion. #
POST /secrets/{secretId}/version/{secretVersionNumber}/actions/scheduleDeletion Schedules a deletion of a secret version. #
GET /secrets/{secretId}/versions Lists all secret versions for a secret. #

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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/oracle-vaults-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

oracle-vaults-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: Use the Secret Management API to manage secrets and secret versions. For more information, see [Managing Secrets](/Content/KeyManagement/Tasks/managingsecrets.htm).
  title: Vault Secret Management Vaults API
  version: '20180608'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/c0c869fc4c1c4efd44bf513113ce577a2785863654be723d8e57442a45bb0f9d.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Vault Secret Management 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/c0c869fc4c1c4efd44bf513113ce577a2785863654be723d8e57442a45bb0f9d.yaml
    what: the harvested document for Vault Secret Management API
servers:
- url: https://vaults.$region.oci.oraclecloud.com/20180608
tags:
- name: vaults
paths:
  /secrets:
    get:
      description: Lists all secrets in the specified vault and compartment.
      operationId: ListSecrets
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/FilterByNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/VaultIdQueryParam'
      - description: 'A filter that returns only resources that match the specified lifecycle state. The state value is case-insensitive.

          '
        in: query
        name: lifecycleState
        required: false
        x-obmcs-enumref: '#/definitions/SecretSummary/lifecycleState'
        schema:
          type: string
      responses:
        '200':
          description: A list of secret summary objects.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then there are additional items still to get. Include this value as the `page` parameter for the

                subsequent GET request. For information about pagination, see

                [List Pagination](/Content/API/Concepts/usingapi.htm#List_Pagination).

                '
              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:
                items:
                  $ref: '#/components/schemas/SecretSummary'
                type: array
        '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/DefaultError'
      summary: Lists all secrets.
      tags:
      - vaults
      x-example: 'GET /20180608/secrets?compartmentId=<compartment_OCID>

        Host: <var>&lt;managementEndpoint&gt;</var>

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

        '
      x-obmcs-client-retries-enabled: true
    post:
      description: 'Creates a new secret according to the details of the request.


        This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.

        '
      operationId: CreateSecret
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '200':
          description: The secret is being created.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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/Secret'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Creates a secret.
      tags:
      - vaults
      x-example: "POST /20180608/secrets\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"vaultId\": \"<var>&lt;vault_OCID&gt;</var>\",\n  \"secretRules\": \"[]\",\n  \"compartmentId\": \"\",\n  \"secretName\": \"testSecret\",\n  \"description\": \"my test secret\",\n  \"keyId\": \"<var>&lt;key_OCID&gt;</var>\",\n  \"secretContent\":\n    {\n      \"content\": \"<var>&lt;base64_encoded_secret_contents&gt;</var>\",\n      \"contentType\": \"BASE64\"\n    }\n}\n"
      x-obmcs-client-retries-enabled: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSecretDetails'
        description: Request to create a new secret.
        required: true
  /secrets/{secretId}:
    get:
      description: Gets information about the specified secret.
      operationId: GetSecret
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      responses:
        '200':
          description: The specified secret object.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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/Secret'
        '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/DefaultError'
      summary: Gets details about a secret.
      tags:
      - vaults
      x-example: 'GET /20180608/secrets/<var>&lt;secret_OCID&gt;</var>

        Host: <var>&lt;managementEndpoint&gt;</var>

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

        '
      x-obmcs-client-retries-enabled: true
    put:
      description: 'Updates the properties of a secret. Specifically, you can update the version number of the secret to make

        that version number the current version. You can also update a secret''s description, its free-form or defined tags, rules

        and the secret contents. Updating the secret content automatically creates a new secret version. You cannot, however, update the current secret version number, secret contents, and secret rules at the

        same time. Furthermore, the secret must in an `ACTIVE` lifecycle state to be updated.


        This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.

        '
      operationId: UpdateSecret
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      responses:
        '200':
          description: The secret is being updated according to the request.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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/Secret'
        '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/DefaultError'
      summary: Updates a secret's properties.
      tags:
      - vaults
      x-example: "PUT /20180608/secrets/<var>&lt;secret_OCID&gt;</var>\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"description\": \"updated version of my test secret\",\n  \"currentVersionNumber\": 4\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSecretDetails'
        description: Request to update a secret.
        required: true
  /secrets/{secretId}/actions/cancelDeletion:
    post:
      description: 'Cancels the pending deletion of the specified secret. Canceling

        a scheduled deletion restores the secret''s lifecycle state to what

        it was before you scheduled the secret for deletion.

        '
      operationId: CancelSecretDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      responses:
        '204':
          description: The secret's scheduled deletion has been canceled.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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
        '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/DefaultError'
      summary: Cancels a scheduled secret deletion.
      tags:
      - vaults
      x-example: 'POST /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/cancelDeletion

        Host: <var>&lt;managementEndpoint&gt;</var>

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

        '
      x-related-resource: '#/definitions/Secret'
  /secrets/{secretId}/actions/cancelRotation:
    post:
      description: "Cancels the ongoing secret rotation. The cancellation is contingent on how\nfar the rotation process has progressed. Upon cancelling a rotation, all \nfuture rotations are also disabled.\n"
      operationId: CancelSecretRotation
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      responses:
        '204':
          description: The request to cancel the secret rotation was successful.
          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/DefaultError'
      summary: Cancels an ongoing secret rotation.
      tags:
      - vaults
      x-example: 'POST /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/actions/cancelRotation

        Host: <var>&lt;managementEndpoint&gt;</var>

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

        '
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Secret'
  /secrets/{secretId}/actions/changeCompartment:
    post:
      description: 'Moves a secret into a different compartment within the same tenancy. For information about

        moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).


        When provided, if-match is checked against the ETag values of the secret.

        '
      operationId: ChangeSecretCompartment
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      responses:
        '204':
          description: The compartment information for the secret has been updated.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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
        '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/DefaultError'
      summary: Moves a secret into a different compartment.
      tags:
      - vaults
      x-example: "POST /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/actions/changeCompartment\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\"\n}\n"
      x-related-resource: '#/definitions/Secret'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeSecretCompartmentDetails'
        description: The updated compartment details.
        required: true
  /secrets/{secretId}/actions/rotate:
    post:
      description: 'API to force rotation of an existing secret in Vault and the specified target system; expects secret to have a valid Target System Details object

        '
      operationId: RotateSecret
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      responses:
        '202':
          description: The secret rotation request has been accepted
          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 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/DefaultError'
      summary: Rotates an existing secret.
      tags:
      - vaults
      x-example: 'POST /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/actions/rotate

        Host: <var>&lt;managementEndpoint&gt;</var>

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

        '
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Secret'
  /secrets/{secretId}/actions/scheduleDeletion:
    post:
      description: 'Schedules the deletion of the specified secret. This sets the lifecycle state of the secret

        to `PENDING_DELETION` and then deletes it after the specified retention period ends.

        '
      operationId: ScheduleSecretDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      responses:
        '204':
          description: The secret is scheduled for deletion.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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
        '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/DefaultError'
      summary: Schedules the deletion of a secret.
      tags:
      - vaults
      x-example: "POST /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/actions/scheduleDeletion\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"timeOfDeletion\": \"2018-04-03T21:10:29.600Z\"\n}\n"
      x-related-resource: '#/definitions/Secret'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleSecretDeletionDetails'
        description: Request to schedule the deletion of a secret.
        required: true
  /secrets/{secretId}/version/{secretVersionNumber}:
    get:
      description: 'Gets information about the specified version of a secret.

        '
      operationId: GetSecretVersion
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      - $ref: '#/components/parameters/SecretVersionNumberRequiredPathParam'
      responses:
        '200':
          description: The specified secret version object.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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/SecretVersion'
        '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/DefaultError'
      summary: Gets details about a secret version.
      tags:
      - vaults
      x-example: 'GET /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/version/<var>&lt;secret_version_number&gt;</var>

        Host: <var>&lt;managementEndpoint&gt;</var>

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

        '
      x-obmcs-client-retries-enabled: true
  /secrets/{secretId}/version/{secretVersionNumber}/actions/cancelDeletion:
    post:
      description: Cancels the scheduled deletion of a secret version.
      operationId: CancelSecretVersionDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      - $ref: '#/components/parameters/SecretVersionNumberRequiredPathParam'
      responses:
        '204':
          description: The scheduled secret version deletion has been canceled.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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
        '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/DefaultError'
      summary: Cancels a scheduled secret version deletion.
      tags:
      - vaults
      x-example: 'POST /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/version/<var>&lt;secret_version_number&gt;</var>/actions/cancelDeletion

        Host: <var>&lt;managementEndpoint&gt;</var>

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

        '
      x-related-resource: '#/definitions/SecretVersion'
  /secrets/{secretId}/version/{secretVersionNumber}/actions/scheduleDeletion:
    post:
      description: 'Schedules the deletion of the specified secret version. This deletes it after the specified retention period ends. You can only

        delete a secret version if the secret version rotation state is marked as `DEPRECATED`.

        '
      operationId: ScheduleSecretVersionDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      - $ref: '#/components/parameters/SecretVersionNumberRequiredPathParam'
      responses:
        '204':
          description: The secret version is scheduled for deletion.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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
        '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/DefaultError'
      summary: Schedules a deletion of a secret version.
      tags:
      - vaults
      x-example: "POST /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/version/<var>&lt;secret_version_number&gt;</var>/actions/scheduleDeletion\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"timeOfDeletion\": \"2018-04-03T21:10:29.600Z\"\n}\n"
      x-related-resource: '#/definitions/SecretVersion'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleSecretVersionDeletionDetails'
        description: 'Request to delete a secret version.

          '
        required: true
  /secrets/{secretId}/versions:
    get:
      description: Lists all secret versions for the specified secret.
      operationId: ListSecretVersions
      parameters:
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      - $ref: '#/components/parameters/SecretVersionSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        '200':
          description: 'The secret version summary object for the specified secret.

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

                then there are additional items still to get. Include this value as the `page` parameter for the

                subsequent GET request. For information about pagination, see

                [List Pagination](/Content/API/Concepts/usingapi.htm#List_Pagination).

                '
              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:
                items:
                  $ref: '#/components/schemas/SecretVersionSummary'
                type: array
        '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/DefaultError'
      summary: Lists all secret versions for a secret.
      tags:
      - vaults
      x-example: 'GET /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/versions

        Host: <var>&lt;managementEndpoint&gt;</var>

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

        '
      x-obmcs-client-retries-enabled: true
components:
  schemas:
    SecretContentDetails:
      description: The content of the secret and metadata to help identify it.
      discriminator:
        propertyName: contentType
      properties:
        contentType:
          description: The base64-encoded content of the secret.
          enum:
          - BASE64
          type: string
        name:
          description: Names should be unique within a secret. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods.
          maxLength: 50
          type: string
        stage:
          default: CURRENT
          description: 'The rotation state of the secret content. The default is `CURRENT`, meaning that the secret is currently in use. A secret version

            that you mark as `PENDING` is staged and available for use, but you don''t yet want to rotate it into current, active use. For example,

            you might create or update a secret and mark its rotation state as `PENDING` if you haven''t yet updated the secret on the target system.

            When creating a secret, only the value `CURRENT` is applicable, although the value `LATEST` is also automatically applied. When updating

            a secret, you can specify a version''s rotation state as either `CURRENT` or `PENDING`.

            '
          enum:
          - CURRENT
          - PENDING
          type: string
      required:
      - contentType
      type: object
      x-example: "{\n  \"content\": \"<var>&lt;secret_text&gt;</var>\",\n  \"contentType\": \"BASE64\",\n  \"stage\": \"PENDING\"\n}\n"
    ScheduleSecretVersionDeletionDetails:
      description: Schedules the deletion of the specified secret version.
      properties:
        timeOfDeletion:
          description: 'An optional property indicating when to delete the secret version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            Example: `2019-04-03T21:10:29.600Z`

            '
          format: date-time
          type: string
      type: object
      x-example: "{\n  \"timeOfDeletion\": \"2020-04-18T05:30:00.000Z\"\n}\n"
    SecretRule:
      description: A rule that you can apply to a secret to enforce certain conditions on the secret's usage and management.
      discriminator:
        propertyName: ruleType
      properties:
        ruleType:
          description: The type of rule, which either controls when the secret contents expire or whether they can be reused.
          enum:
          - SECRET_EXPIRY_RULE
          - SECRET_REUSE_RULE
          type: string
      required:
      - ruleType
      type: object
      x-example: "{\n  \"ruleType\": \"SECRET_EXPIRY_RULE\"\n}\n"
    SecretGenerationContext:
      description: Captures a configurable set of secret generation rules such as length, base characters, additional characters, and so on.
      discriminator:
        propertyName: generationType
      properties:
        generationType:
          description: Name of the predefined secret generation type.
          enum:
          - PASSPHRASE
          - SSH_KEY
          - BYTES
          type: string
        secretTemplate:
          description: "SecretTemplate captures structure in which customer wants to store secrets. This is optional and a default structure is available for each secret type. \nThe template can have any structure with static values that are not generated. Within the template, you can insert predefined placeholders to store secrets. \nThese placeholders are later replaced with the generated content and saved as a Base64 encoded content.\n"
          type: string
      required:
      - generationType
      type: object
      x-example: "{\n  \"generationType\": \"SSH_KEY\",\n  \"generationTemplate\

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