Oracle Deployment API

The deployment API from Oracle — 5 operation(s) for deployment.

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 Specification

oracle-deployment-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: 'API for the API Gateway service. Use this API to manage gateways, deployments, and related items.

    For more information, see

    [Overview of API Gateway](/iaas/Content/APIGateway/Concepts/apigatewayoverview.htm).

    '
  title: Gateway Deployment API
  version: '20190501'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/4a7a190925fb30298864e9aee04c85cfd197a64c6eca47f749c72b5d9b9046ba.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the API Gateway 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/4a7a190925fb30298864e9aee04c85cfd197a64c6eca47f749c72b5d9b9046ba.yaml
    what: the harvested document for API Gateway API
servers:
- url: http://127.0.0.1/20190501
- url: https://127.0.0.1/20190501
tags:
- name: deployment
paths:
  /deployments:
    get:
      description: 'Returns a list of deployments.

        '
      operationId: ListDeployments
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/GatewayIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DeploymentLifecycleStateQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of DeploymentSummary objects.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response,

                additional pages of results remain. For important details about how

                pagination works, see

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

                '
              schema:
                type: string
                default: 'null'
            opc-prev-page:
              description: 'For list pagination. When this header appears in the response,

                additional pages of results were seen previously. For important details

                about how pagination works, see

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

                '
              schema:
                type: string
                default: 'null'
            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
                default: 'null'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentCollection'
        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 Deployments in a compartment
      tags:
      - deployment
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DeploymentSummary'
    post:
      description: 'Creates a new deployment.

        '
      operationId: CreateDeployment
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: The deployment is being created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
                default: 'null'
            location:
              description: 'Location of the resource.

                '
              schema:
                type: string
                default: 'null'
            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
                default: 'null'
            opc-work-request-id:
              description: 'The OCID of the work request. Use

                [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with

                this id to track the status

                of the request.

                '
              schema:
                type: string
                default: 'null'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
        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 Deployment
      tags:
      - deployment
      x-obmcs-client-retries-enabled: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDeploymentDetails'
        description: Details for the new deployment
        required: true
  /deployments/{deploymentId}:
    delete:
      description: Deletes the deployment with the given identifier.
      operationId: DeleteDeployment
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: Accepted the request. The deployment 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
                default: 'null'
            opc-work-request-id:
              description: 'The OCID of the work request. Use

                [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with

                this id to track the status

                of the request.

                '
              schema:
                type: string
                default: 'null'
        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 Deployment
      tags:
      - deployment
      x-related-resource: '#/definitions/Deployment'
    get:
      description: Gets a deployment by identifier.
      operationId: GetDeployment
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the deployment with the given identifier.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
                default: 'null'
            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
                default: 'null'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
        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 Deployment
      tags:
      - deployment
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates the deployment with the given identifier.
      operationId: UpdateDeployment
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: The deployment 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
                default: 'null'
            opc-work-request-id:
              description: 'The OCID of the work request. Use

                [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with

                this id to track the status

                of the request.

                '
              schema:
                type: string
                default: 'null'
        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 Deployment identified by the id
      tags:
      - deployment
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDeploymentDetails'
        description: The information to be updated.
        required: true
  /deployments/{deploymentId}/actions/addLock:
    post:
      description: Adds a lock to a Deployment resource.
      operationId: AddDeploymentLock
      parameters:
      - description: 'Unique identifier for the request.

          If you need to contact Oracle about a particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
      - description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`

          parameter to the value of the etag from a previous GET or POST response for that resource. The resource

          will be updated or deleted only if the etag you provide matches the resource''s current etag value.

          '
        in: header
        name: if-match
        schema:
          type: string
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/AddResourceLockDetailsBodyParam'
      responses:
        200:
          description: Lock is added.
          headers:
            etag:
              description: 'etag for the returned Deployment resource.

                '
              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/Deployment'
        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/DefaultError'
      summary: Adds a lock to a Deployment resource.
      tags:
      - deployment
      x-related-resource: '#/definitions/Deployment'
  /deployments/{deploymentId}/actions/changeCompartment:
    post:
      description: Changes the deployment compartment.
      operationId: ChangeDeploymentCompartment
      parameters:
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: The deployment's compartment will be changed.
          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
                default: 'null'
            opc-work-request-id:
              description: 'The OCID of the work request. Use

                [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with

                this id to track the status

                of the request.

                '
              schema:
                type: string
                default: 'null'
        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: Change the deployment compartment.
      tags:
      - deployment
      x-related-resource: '#/definitions/Deployment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeDeploymentCompartmentDetails'
        description: Details of the target compartment.
        required: true
  /deployments/{deploymentId}/actions/removeLock:
    post:
      description: Removes a lock from a Deployment resource.
      operationId: RemoveDeploymentLock
      parameters:
      - description: 'Unique identifier for the request.

          If you need to contact Oracle about a particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
      - description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`

          parameter to the value of the etag from a previous GET or POST response for that resource. The resource

          will be updated or deleted only if the etag you provide matches the resource''s current etag value.

          '
        in: header
        name: if-match
        schema:
          type: string
      - $ref: '#/components/parameters/DeploymentIdentifierPathParam'
      - $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam'
      responses:
        200:
          description: Lock is removed.
          headers:
            etag:
              description: 'etag for the returned Deployment resource.

                '
              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/Deployment'
        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/DefaultError'
      summary: Removes a lock to a Deployment resource.
      tags:
      - deployment
      x-related-resource: '#/definitions/Deployment'
components:
  schemas:
    SetQueryParameterPolicy:
      description: 'Set parameters on the query string as they pass through the gateway.

        '
      properties:
        items:
          description: 'The list of query parameters.

            '
          items:
            $ref: '#/components/schemas/SetQueryParameterPolicyItem'
          maxItems: 20
          minItems: 1
          type: array
      required:
      - items
      type: object
    ResourceLock:
      description: 'Resource locks are used to prevent certain APIs from being called for the resource.

        A full lock prevents both updating the resource and deleting the resource. A delete

        lock prevents deleting the resource.

        '
      properties:
        message:
          description: 'A message added by the creator of the lock. This is typically used to give an

            indication of why the resource is locked.

            '
          type: string
        relatedResourceId:
          description: 'The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.

            '
          type: string
        timeCreated:
          description: When the lock was created.
          format: date-time
          type: string
        type:
          description: Type of the lock.
          enum:
          - FULL
          - DELETE
          type: string
      required:
      - type
      type: object
    RateLimitingPolicy:
      description: Limit the number of requests that should be handled for the specified window using a specfic key.
      properties:
        rateInRequestsPerSecond:
          description: The maximum number of requests per second to allow.
          type: integer
        rateKey:
          description: The key used to group requests together.
          enum:
          - CLIENT_IP
          - TOTAL
          type: string
      required:
      - rateInRequestsPerSecond
      - rateKey
      type: object
    RenameQueryParameterPolicyItem:
      description: 'The value will be a copy of the original value of the source parameter and will not be affected by any other

        transformation policies applied to that parameter.

        '
      properties:
        from:
          description: 'The original case-sensitive name of the query parameter.  This name must be unique across transformation

            policies.

            '
          example: bookId
          maxLength: 2048
          minLength: 1
          type: string
        to:
          description: 'The new name of the query parameter.  This name must be unique across transformation policies.

            '
          example: bookIsbn
          maxLength: 2048
          minLength: 1
          type: string
      required:
      - from
      - to
      type: object
    ResponseCacheStorePolicy:
      description: 'Base policy for how a response from a backend is cached in the Response Cache.

        '
      discriminator:
        propertyName: type
      properties:
        type:
          description: Type of the Response Cache Store Policy.
          enum:
          - FIXED_TTL_STORE_POLICY
          type: string
      required:
      - type
    Error:
      description: Error Information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
      type: object
    HeaderTransformationPolicy:
      description: 'A set of transformations to apply to HTTP headers that pass through the gateway.

        '
      properties:
        filterHeaders:
          $ref: '#/components/schemas/FilterHeaderPolicy'
        renameHeaders:
          $ref: '#/components/schemas/RenameHeaderPolicy'
        setHeaders:
          $ref: '#/components/schemas/SetHeaderPolicy'
      type: object
    ApiSpecificationRoute:
      description: 'A single route that forwards requests to a particular backend and may contain some additional policies.

        '
      properties:
        backend:
          $ref: '#/components/schemas/ApiSpecificationRouteBackend'
        loggingPolicies:
          $ref: '#/components/schemas/ApiSpecificationLoggingPolicies'
        methods:
          default:
          - ANY
          description: 'A list of allowed methods on this route.

            '
          items:
            enum:
            - ANY
            - HEAD
            - GET
            - POST
            - PUT
            - PATCH
            - DELETE
            - OPTIONS
            type: string
          type: array
          uniqueItems: true
        path:
          description: 'A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers

            to allow wildcard and parameterized matching.

            '
          example: /todos
          type: string
        requestPolicies:
          $ref: '#/components/schemas/ApiSpecificationRouteRequestPolicies'
        responsePolicies:
          $ref: '#/components/schemas/ApiSpecificationRouteResponsePolicies'
      required:
      - path
      - backend
      type: object
    ContentValidation:
      description: Content validation properties.
      discriminator:
        propertyName: validationType
      properties:
        validationType:
          default: NONE
          description: 'Validation type defines the content validation method.


            Make the validation to first parse the body as the respective format.

            '
          enum:
          - NONE
          type: string
      required:
      - validationType
      type: object
    RemoveResourceLockDetails:
      description: 'Used to remove a resource lock.

        Resource locks are used to prevent certain APIs from being called for the resource.

        A full lock prevents both updating the resource and deleting the resource. A delete

        lock prevents deleting the resource.

        '
      properties:
        type:
          description: Type of the lock.
          enum:
          - FULL
          - DELETE
          type: string
      required:
      - type
      type: object
    SetQueryParameterPolicyItem:
      description: 'Set will add a new query parameter if it was not in the original request.  If the parameter already exists on the

        request, you can choose to override, append, or skip it.

        '
      properties:
        ifExists:
          default: OVERWRITE
          description: 'If a query parameter with the same name already exists in the request, OVERWRITE will overwrite the value,

            APPEND will append to the existing value, or SKIP will keep the existing value.

            '
          enum:
          - OVERWRITE
          - APPEND
          - SKIP
          type: string
        name:
          description: 'The case-sensitive name of the query parameter.  This name must be unique across transformation policies.

            '
          example: bookIsbn
          maxLength: 2048
          minLength: 1
          type: string
        values:
          description: 'A list of new values.  Each value can be a constant or may include one or more expressions enclosed within

            ${} delimiters.

            '
          items:
            example: ${request.headers[bookIsbn]}
            maxLength: 4096
            minLength: 1
            type: string
          maxItems: 10
          minItems: 1
          type: array
      required:
      - name
      - values
      type: object
    HeaderValidationRequestPolicy:
      allOf:
      - $ref: '#/components/schemas/ValidationRequestPolicy'
      - properties:
          headers:
            description: The List of Headers
            items:
              $ref: '#/components/schemas/HeaderValidationItem'
            minItems: 1
            type: array
            uniqueItems: true
        type: object
      description: Validate the HTTP headers on the incoming API requests on a specific route.
    CorsPolicy:
      description: 'Enable CORS (Cross-Origin-Resource-Sharing) request handling.

        '
      properties:
        allowedHeaders:
          default: []
          description: 'The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header.

            ''*'' will allow all headers.

            '
          example:
          - '*'
          - Content-Type
          - X-Foo-Bar
          items:
            type: string
          maxItems: 50
          type: array
          uniqueItems: true
        allowedMethods:
          default: []
          description: 'The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the

            Access-Control-Allow-Methods header. ''*'' will allow all methods.

            '
          example:
          - '*'
          - GET
          - POST
          items:
            type: string
          maxItems: 50
          type: array
          uniqueItems: true
        allowedOrigins:
          description: 'The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will

            send the Access-Control-Allow-Origin header with the best origin match for the circumstances. ''*'' will match

            any origins, and ''null'' will match queries from ''file:'' origins. All other origins must be qualified with the

            scheme, full hostname, and port if necessary.

            '
          example:
          - '*'
          - 'null'
          - https://friendly.com:8080
          items:
            type: string
          maxItems: 50
          type: array
          uniqueItems: true
        exposedHeaders:
          default: []
          description: 'The list of headers that the client will be allowed to see from the response as indicated by the

            Access-Control-Expose-Headers header. ''*'' will expose all headers.

            '
          example:
          - '*'
          - opc-request-id
          items:
            type: string
          maxItems: 50
          type: array
        isAllowCredentialsEnabled:
          default: false
          description: 'Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

            '
          example: false
          type: boolean
        maxAgeInSeconds:
          default: 0
          description: 'The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age

            if greater than 0.

            '
          example: 600
          minimum: 0
          type: integer
      required:
      - allowedOrigins
      type: object
    UsagePlansPolicy:
      description: Usage plan policies for this deployment
      properties:
        tokenLocations:
          description: "A list of context variables specifying where API tokens may be located in a request.\nExample locations:\n  - \"request.headers[token]\"\n  - \"request.query[token]\"\n  - \"request.auth[Token]\"\n  - \"request.path[TOKEN]\"\n"
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 10
          minItems: 1
          type: array
      required:
      - tokenLocations
      type: object
    RouteAuthorizationPolicy:
      description: 'If authentication has been performed, validate whether the request scope (if any) applies to this route.

        If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.

        '
      discriminator:
        propertyName: type
      properties:
        type:
          default: AUTHENTICATION_ONLY
          description: 'Indicates how authorization should be applied. For a type of ANY_OF, an "allowedScope"

            property must also be specified. Otherwise, only a type is required. For a type of ANONYMOUS, an

            authenticated API must have the "isAnonymousAccessAllowed" property set to "true" in the authentication

            policy.

            '
          enum:
          - ANONYMOUS
          - ANY_OF
          - AUTHENTICATION_ONLY
          type: string
      type: object
    RenameHeaderPolicyItem:
      description: 'The value will be a copy of the original value of the source header and will not be affected by any other

        transformation policies applied to that header.

        '
      properties:
        from:
          description: 'The original case-insensitive name of the header.  This name must be unique across transformation policies.

            '
          example: X-Username
          maxLength: 1024
          minLength: 1
          type: string
        to:
          description: 'The new name of the header.  This name must be unique across transformation policies.

            '
          example: X-User-ID
          maxLength: 1024
          minLength: 1
          type: string
      required:
      - from
      - to
      type: object
    MutualTlsDetails:
      description: 'Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.

        '
      properties:
        allowedSans:
          description: Allowed list of CN or SAN which will be used for verification of certificate.
          items:
            minLength: 1
            type: string
          type: array
        isVerifiedCertificateRequired:
          default: false
          description: Determines whether to enable client verification when API Consumer makes connection to the gateway.
          type: boolean
      type: object
    FilterHeaderPolicy:
      description: 'Filter HTTP headers as they pass through the gateway.  The gateway applies filters after other transformations,

        so any headers set or renamed must also be listed here when using an ALLOW type policy.

        '
      properties:
        items:
          description: 'The list of headers.

            '
          items:
            $ref: '#/components/schemas/FilterHeaderPolicyItem'
          maxItems: 20
          minItems: 0
          type: array
        type:
          default: BLOCK
          description: 'BLOCK drops any headers that are in the list of items, so it acts as an exclusion list.  ALLOW

            permits only the headers in the list and removes all others, so it acts as an inclusion list.

            '
          enum:
          - ALLOW
          - BLOCK
          type: string
      required:
      - type
      - items
      type: object
    ApiSpecificationRouteRequestPolicies:
      description: 'Behavior appl

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