Oracle

Oracle Oce Instance API

The oceInstance API from Oracle — 7 operation(s) for oceinstance.

Documentation GitHub OpenAPI

Operations 10

GET /oceInstances Gets a list of all OceInstances in a compartment #

POST /oceInstances Creates a new OceInstance #

DELETE /oceInstances/{oceInstanceId} Delete a provisioned OceInstance #

GET /oceInstances/{oceInstanceId} Get OceInstance #

PUT /oceInstances/{oceInstanceId} Update the OceInstance identified by the id #

POST /oceInstances/{oceInstanceId}/actions/changeCompartment Moves a OceInstance into a different compartment. When provided, If-Match is checked against ETag values of the OceInstance. #

GET /workRequests List Work Requests #

GET /workRequests/{workRequestId} GET Work Request Status #

GET /workRequests/{workRequestId}/errors Lists work request errors #

GET /workRequests/{workRequestId}/logs Lists work request logs #

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-oceinstance-api-openapi.yml

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-oceinstance-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  description: Oracle Content Management is a cloud-based content hub to drive omni-channel content management and accelerate experience delivery
  title: Oracle Content Management Oce Instance API
  version: '20190912'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/e2f95e05ed80584945feff93d4c6a65dc7eabc98f95d08926e3ba270599fc590.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Oracle Content 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/e2f95e05ed80584945feff93d4c6a65dc7eabc98f95d08926e3ba270599fc590.yaml
    what: the harvested document for Oracle Content Management API
servers:
- url: http://127.0.0.1/20190912
- url: https://127.0.0.1/20190912
tags:
- name: oceInstance
paths:
  /oceInstances:
    get:
      description: 'Returns a list of OceInstances.

        '
      operationId: ListOceInstances
      parameters:
      - $ref: '#/components/parameters/TenancyIdQueryParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of OceInstanceSummary objects.
          headers:
            opc-next-page:
              description: 'For pagination of a list of `OceInstance`s. If this header appears in the response, then this

                is a partial list of OceInstances. Include this value as the `page` parameter in a subsequent

                GET request to get the next batch of OceInstances.

                '
              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/OceInstanceSummary'
                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/default'
      summary: Gets a list of all OceInstances in a compartment
      tags:
      - oceInstance
    post:
      description: 'Creates a new OceInstance.

        '
      operationId: CreateOceInstance
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The OceInstance will be created.
          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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        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/default'
      summary: Creates a new OceInstance
      tags:
      - oceInstance
      x-related-resource: '#/definitions/OceInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOceInstanceDetails'
        description: Details for the new OceInstance.
        required: true
  /oceInstances/{oceInstanceId}:
    delete:
      description: Deletes a OceInstance resource by identifier
      operationId: DeleteOceInstance
      parameters:
      - $ref: '#/components/parameters/OceInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The OceInstance will be deleted.
          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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        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'
      summary: Delete a provisioned OceInstance
      tags:
      - oceInstance
      x-related-resource: '#/definitions/OceInstance'
    get:
      description: Gets a OceInstance by identifier
      operationId: GetOceInstance
      parameters:
      - $ref: '#/components/parameters/OceInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the OceInstance with the given id
          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/OceInstance'
        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: Get OceInstance
      tags:
      - oceInstance
    put:
      description: Updates the OceInstance
      operationId: UpdateOceInstance
      parameters:
      - $ref: '#/components/parameters/OceInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The OceInstance 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        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'
      summary: Update the OceInstance identified by the id
      tags:
      - oceInstance
      x-related-resource: '#/definitions/OceInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOceInstanceDetails'
        description: The information to be updated.
        required: true
  /oceInstances/{oceInstanceId}/actions/changeCompartment:
    post:
      description: Moves a OceInstance into a different compartment
      operationId: ChangeOceInstanceCompartment
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/OceInstanceIdentifierPathParam'
      responses:
        202:
          description: Accepted the request. The OceInstance 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              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 a OceInstance into a different compartment. When provided, If-Match is checked against ETag values of the OceInstance.
      tags:
      - oceInstance
      x-related-resource: '#/definitions/OceInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeOceInstanceCompartmentDetails'
        description: The information about compartment details to be moved.
        required: true
  /workRequests:
    get:
      description: 'Lists the work requests in a compartment.

        '
      operationId: ListWorkRequests
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/ResourceIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: The list is being retrieved.
          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 a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next 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:
                items:
                  $ref: '#/components/schemas/WorkRequest'
                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/default'
      summary: List Work Requests
      tags:
      - oceInstance
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}:
    get:
      description: Gets the status of the work request with the given ID.
      operationId: GetWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The detail of the work 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
            retry-after:
              description: some decimal number representing the number of seconds the client should wait before polling this endpoint again
              schema:
                type: number
                format: float
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequest'
        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: GET Work Request Status
      tags:
      - oceInstance
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}/errors:
    get:
      description: 'Return a (paginated) list of errors for a given work request.

        '
      operationId: ListWorkRequestErrors
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: List of work request errors.
          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 might be additional items still to get. Include this value as the `page` parameter for the

                subsequent GET request.

                '
              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/WorkRequestError'
                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/default'
      summary: Lists work request errors
      tags:
      - oceInstance
      x-related-resource: '#/definitions/WorkRequestError'
  /workRequests/{workRequestId}/logs:
    get:
      description: 'Return a (paginated) list of logs for a given work request.

        '
      operationId: ListWorkRequestLogs
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: List of work request logs.
          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 might be additional items still to get. Include this value as the `page` parameter for the

                subsequent GET request.

                '
              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/WorkRequestLogEntry'
                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/default'
      summary: Lists work request logs
      tags:
      - oceInstance
      x-related-resource: '#/definitions/WorkRequestLogEntry'
components:
  schemas:
    WorkflowStep:
      description: Workflow step of workflow monitor.
      properties:
        status:
          description: workflow step status
          type: string
        stepName:
          description: workflow step name
          type: string
    WorkRequestError:
      description: An error encountered while executing a work request.
      properties:
        code:
          description: 'A machine-usable code for the error that occured. Error codes are listed on

            (https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)

            '
          type: string
        message:
          description: A human readable description of the issue encountered.
          type: string
        timestamp:
          description: The time the error occured. An RFC3339 formatted datetime string.
          format: date-time
          type: string
      required:
      - code
      - message
      - timestamp
    WorkRequest:
      description: A description of workrequest status
      properties:
        compartmentId:
          description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to

            the same compartment as the resource the work request affects. If the work request affects multiple resources,

            and those resources are not in the same compartment, it is up to the service team to pick the primary

            resource whose compartment should be used

            '
          type: string
        id:
          description: The id of the work request.
          type: string
        operationType:
          description: type of the work request
          enum:
          - CREATE_OCE_INSTANCE
          - UPDATE_OCE_INSTANCE
          - DELETE_OCE_INSTANCE
          type: string
        percentComplete:
          description: Percentage of the request completed.
          format: float
          type: number
        resources:
          description: The resources affected by this work request.
          items:
            $ref: '#/components/schemas/WorkRequestResource'
          type: array
        status:
          description: status of current work request.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - CANCELING
          - CANCELED
          type: string
        timeAccepted:
          description: 'The date and time the request was created, as described in

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),

            section 14.29.

            '
          format: date-time
          type: string
        workflowMonitor:
          $ref: '#/components/schemas/WorkflowMonitor'
      required:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
    CreateOceInstanceDetails:
      description: The information about new OceInstance.
      properties:
        adminEmail:
          description: Admin Email for Notification
          type: string
        compartmentId:
          description: Compartment Identifier
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: OceInstance description
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        idcsAccessToken:
          description: Identity Cloud Service access token identifying a stripe and service administrator user
          type: string
        identityStripe:
          $ref: '#/components/schemas/IdentityStripeDetails'
        instanceAccessType:
          description: Flag indicating whether the instance access is private or public
          enum:
          - PUBLIC
          - PRIVATE
          type: string
        instanceLicenseType:
          description: Flag indicating whether the instance license is new cloud or bring your own license
          enum:
          - NEW
          - BYOL
          - PREMIUM
          - STARTER
          type: string
          x-obmcs-top-level-enum: '#/definitions/LicenseType'
        instanceUsageType:
          description: Instance type based on its usage
          enum:
          - PRIMARY
          - NONPRIMARY
          type: string
        name:
          description: OceInstance Name
          type: string
        objectStorageNamespace:
          description: Object Storage Namespace of Tenancy
          type: string
        tenancyId:
          description: Tenancy Identifier
          type: string
        tenancyName:
          description: Tenancy Name
          type: string
        upgradeSchedule:
          description: 'Upgrade schedule type representing service to be upgraded immediately whenever latest version is released

            or delay upgrade of the service to previous released version

            '
          type: string
          x-obmcs-enumref: '#/definitions/OceInstance/upgradeSchedule'
        wafPrimaryDomain:
          description: Web Application Firewall(WAF) primary domain
          type: string
      required:
      - compartmentId
      - name
      - tenancyId
      - idcsAccessToken
      - tenancyName
      - objectStorageNamespace
      - adminEmail
      type: object
    UpdateOceInstanceDetails:
      description: The information to be updated.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: OceInstance description
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        instanceLicenseType:
          description: Flag indicating whether the instance license is new cloud or bring your own license
          enum:
          - NEW
          - BYOL
          - PREMIUM
          - STARTER
          type: string
          x-obmcs-top-level-enum: '#/definitions/LicenseType'
        instanceUsageType:
          description: Instance type based on its usage
          enum:
          - PRIMARY
          - NONPRIMARY
          type: string
        wafPrimaryDomain:
          description: Web Application Firewall(WAF) primary domain
          type: string
      type: object
    IdentityStripeDetails:
      description: Details of the identity stripe used for OceInstance
      properties:
        serviceName:
          description: 'Name of the Identity Cloud Service instance in My Services to be used.

            Example: `secondstripe`

            '
          type: string
        tenancy:
          description: 'Value of the Identity Cloud Service tenancy.

            Example: `idcs-8416ebdd0d674f84803f4193cce026e9`

            '
          type: string
      required:
      - serviceName
      - tenancy
    OceInstanceSummary:
      description: Summary of the OceInstance.
      properties:
        adminEmail:
          description: Admin Email for Notification
          type: string
        compartmentId:
          description: Compartment Identifier
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: OceInstance description, can be updated
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        guid:
          description: Unique GUID identifier that is immutable on creation
          type: string
        id:
          description: Unique identifier that is immutable on creation
          type: string
        idcsTenancy:
          description: IDCS Tenancy Identifier
          type: string
        instanceAccessType:
          description: Flag indicating whether the instance access is private or public
          enum:
          - PUBLIC
          - PRIVATE
          type: string
        instanceLicenseType:
          description: Flag indicating whether the instance license is new cloud or bring your own license
          enum:
          - NEW
          - BYOL
          - PREMIUM
          - STARTER
          type: string
          x-obmcs-top-level-enum: '#/definitions/LicenseType'
        instanceUsageType:
          description: Instance type based on its usage
          enum:
          - PRIMARY
          - NONPRIMARY
          type: string
        lifecycleState:
          description: The current state of the file system.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
        name:
          description: OceInstance Name
          type: string
        objectStorageNamespace:
          description: Object Storage Namespace of tenancy
          type: string
        service:
          additionalProperties:
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"name": "value"}`

              '
            type: object
          description: 'SERVICE data.

            Example: `{"service": {"IDCS": "value"}}`

            '
          type: object
        stateMessage:
          description: An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        tenancyId:
          description: Tenancy Identifier
          type: string
        tenancyName:
          description: Tenancy Name
          type: string
        timeCreated:
          description: The time the the OceInstance was created. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeUpdated:
          description: The time the OceInstance was updated. An RFC3339 formatted datetime string
          format: date-time
          type: string
        upgradeSchedule:
          description: 'Upgrade schedule type representing service to be upgraded immediately whenever latest version is released

            or delay upgrade of the service to previous released version

            '
          type: string
          x-obmcs-enumref: '#/defi

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