Oracle

Oracle Desktop Service API

The desktopService API from Oracle — 15 operation(s) for desktopservice.

GitHub OpenAPI

Documentation

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

Specifications

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

OpenAPI Specification

oracle-desktopservice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: 'Create and manage cloud-hosted desktops which can be accessed from a web browser or installed client.

    '
  title: Secure Desktops Desktop Service API
  version: '20220618'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/a8275f52cebad9a3de0a1b275d5e5e511cd9a6b531113923b8a8d4d85a1d0e9c.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Secure Desktops 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/a8275f52cebad9a3de0a1b275d5e5e511cd9a6b531113923b8a8d4d85a1d0e9c.yaml
    what: the harvested document for Secure Desktops API
servers:
- url: /20220618
tags:
- name: desktopService
paths:
  /desktopPools:
    get:
      description: 'Returns a list of desktop pools within the given compartment. You can limit the results to an availability domain, pool name, or pool state. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

        '
      operationId: ListDesktopPools
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/AvailabilityDomainQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/IdQueryParam'
      - $ref: '#/components/parameters/LifecycleQueryParam'
      - $ref: '#/components/parameters/LimitQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      - $ref: '#/components/parameters/PageQueryParam'
      responses:
        '200':
          description: A collection of desktop pools.
          headers:
            opc-next-page:
              description: For pagination.
              schema:
                type: string
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DesktopPoolCollection'
        '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'
      tags:
      - desktopService
      x-related-resource: '#/definitions/DesktopPool'
    post:
      description: Creates a desktop pool with the given configuration parameters.
      operationId: CreateDesktopPool
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeaderParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      responses:
        '201':
          description: "The desktop pool has been initialized. Use the identifier in the opc-work-request-id header to determine when creation is complete. \n"
          headers:
            Content-Location:
              description: A URL containing the location of the newly created resource.
              schema:
                type: string
            Location:
              description: A URL containing location of the newly created resource.
              schema:
                type: string
            etag:
              description: For optimistic concurrency. See if-match.
              schema:
                type: string
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
            opc-work-request-id:
              description: A unique identifier for an asynchronous request.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DesktopPool'
        '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'
      tags:
      - desktopService
      x-related-resource: '#/definitions/DesktopPool'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDesktopPoolDetails'
        description: The details of the desktop pool to create.
        required: true
  /desktopPools/{desktopPoolId}:
    delete:
      description: 'Deletes a desktop pool with the specified OCID. The service terminates all compute instances and users immediately lose access to their desktops. You can choose to preserve the block volumes associated with the pool.

        '
      operationId: DeleteDesktopPool
      parameters:
      - $ref: '#/components/parameters/DesktopPoolIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      - $ref: '#/components/parameters/QueryPreserveVolumesParam'
      responses:
        '202':
          description: The request has been accepted. The desktop pool is being deleted.
          headers:
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
            opc-work-request-id:
              description: A unique identifier for an asynchronous request.
              schema:
                type: string
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      tags:
      - desktopService
      x-related-resource: '#/definitions/DesktopPool'
    get:
      description: 'Returns information about the desktop pool including all configuration parameters and the current state.

        '
      operationId: GetDesktopPool
      parameters:
      - $ref: '#/components/parameters/DesktopPoolIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      responses:
        '200':
          description: A desktop pool.
          headers:
            etag:
              description: For optimistic concurrency. See if-match.
              schema:
                type: string
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DesktopPool'
        '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'
      tags:
      - desktopService
      x-related-resource: '#/definitions/DesktopPool'
    put:
      description: 'Modifies the configuration of the desktop pool such as the availability, contact information, description, name, device policy, pool size, standby size, and start or stop time.

        '
      operationId: UpdateDesktopPool
      parameters:
      - $ref: '#/components/parameters/DesktopPoolIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      responses:
        '202':
          description: The request has been accepted. The desktop pool is being updated.
          headers:
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
            opc-work-request-id:
              description: A unique identifier for an asynchronous request.
              schema:
                type: string
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      tags:
      - desktopService
      x-related-resource: '#/definitions/DesktopPool'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDesktopPoolDetails'
        description: The details of the update.
        required: true
  /desktopPools/{desktopPoolId}/actions/changeCompartment:
    post:
      description: 'Moves a desktop pool into a different compartment within the same tenancy. You must provide the OCID of the desktop pool and the OCID of the compartment that you are moving the pool to.

        '
      operationId: ChangeDesktopPoolCompartment
      parameters:
      - $ref: '#/components/parameters/DesktopPoolIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      - $ref: '#/components/parameters/RetryTokenHeaderParam'
      responses:
        '202':
          description: The request has been accepted. The desktop pool is being moved.
          headers:
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
            opc-work-request-id:
              description: A unique identifier for an asynchronous request.
              schema:
                type: string
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      tags:
      - desktopService
      x-related-resource: '#/definitions/DesktopPool'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeDesktopPoolCompartmentDetails'
        description: The details of the new compartment of the desktop pool.
        required: true
  /desktopPools/{desktopPoolId}/actions/start:
    post:
      description: 'Starts the desktop pool with the specified OCID. Once the pool is ACTIVE, users will have access to their desktops within the pool.

        '
      operationId: StartDesktopPool
      parameters:
      - $ref: '#/components/parameters/DesktopPoolIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      - $ref: '#/components/parameters/RetryTokenHeaderParam'
      responses:
        '202':
          description: The request has been accepted. The desktop pool is being started.
          headers:
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
            opc-work-request-id:
              description: A unique identifier for an asynchronous request.
              schema:
                type: string
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      tags:
      - desktopService
      x-related-resource: '#/definitions/DesktopPool'
  /desktopPools/{desktopPoolId}/actions/stop:
    post:
      description: 'Stops the desktop pool with the specified OCID. Users will lose access to their desktops until you explicitly start the pool again.

        '
      operationId: StopDesktopPool
      parameters:
      - $ref: '#/components/parameters/DesktopPoolIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      - $ref: '#/components/parameters/RetryTokenHeaderParam'
      responses:
        '202':
          description: The request has been accepted. The desktop pool is being stopped.
          headers:
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
            opc-work-request-id:
              description: A unique identifier for an asynchronous request.
              schema:
                type: string
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      tags:
      - desktopService
      x-related-resource: '#/definitions/DesktopPool'
  /desktopPools/{desktopPoolId}/desktops:
    get:
      description: 'Returns a list of desktops within a given desktop pool. You can limit the results to an availability domain, desktop name, or desktop state. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

        '
      operationId: ListDesktopPoolDesktops
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DesktopPoolIdPathParam'
      - $ref: '#/components/parameters/AvailabilityDomainQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/IdQueryParam'
      - $ref: '#/components/parameters/LifecycleQueryParam'
      - $ref: '#/components/parameters/LimitQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      - $ref: '#/components/parameters/PageQueryParam'
      responses:
        '200':
          description: A collection of the desktop pool's desktops.
          headers:
            opc-next-page:
              description: For pagination.
              schema:
                type: string
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DesktopPoolDesktopCollection'
        '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'
      tags:
      - desktopService
      x-related-resource: '#/definitions/DesktopPool'
  /desktopPools/{desktopPoolId}/volumes:
    get:
      description: 'Returns a list of volumes within the given desktop pool. You can limit the results to an availability domain, volume name, or volume state. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

        '
      operationId: ListDesktopPoolVolumes
      parameters:
      - $ref: '#/components/parameters/DesktopPoolIdPathParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/AvailabilityDomainQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/IdQueryParam'
      - $ref: '#/components/parameters/LifecycleQueryParam'
      - $ref: '#/components/parameters/LimitQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      - $ref: '#/components/parameters/PageQueryParam'
      responses:
        '200':
          description: A collection of the desktop pool's volumes.
          headers:
            opc-next-page:
              description: For pagination.
              schema:
                type: string
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DesktopPoolVolumeCollection'
        '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'
      tags:
      - desktopService
      x-related-resource: '#/definitions/DesktopPool'
  /desktops:
    get:
      description: 'Returns a list of desktops filtered by the specified parameters. You can limit the results to an availability domain, desktop name, desktop OCID, desktop state, pool OCID, or compartment OCID. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

        '
      operationId: ListDesktops
      parameters:
      - $ref: '#/components/parameters/AvailabilityDomainQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/IdQueryParam'
      - $ref: '#/components/parameters/LifecycleQueryParam'
      - $ref: '#/components/parameters/LimitQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PageQueryParam'
      - $ref: '#/components/parameters/DesktopPoolIdOptionalQueryParam'
      responses:
        '200':
          description: A collection of desktops.
          headers:
            opc-next-page:
              description: For pagination.
              schema:
                type: string
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DesktopCollection'
        '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'
      tags:
      - desktopService
      x-related-resource: '#/definitions/Desktop'
  /desktops/{desktopId}:
    delete:
      description: 'Deletes the desktop with the specified OCID. The service terminates the associated compute instance. The end-user loses access to the desktop instance permanently. Any associated block volume becomes inactive but is not deleted.

        '
      operationId: DeleteDesktop
      parameters:
      - $ref: '#/components/parameters/DesktopIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      responses:
        '202':
          description: The request has been accepted. The desktop is being deleted.
          headers:
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
            opc-work-request-id:
              description: A unique identifier for an asynchronous request.
              schema:
                type: string
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      tags:
      - desktopService
      x-related-resource: '#/definitions/Desktop'
    get:
      description: Provides information about the desktop with the specified OCID.
      operationId: GetDesktop
      parameters:
      - $ref: '#/components/parameters/DesktopIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      responses:
        '200':
          description: A desktop.
          headers:
            etag:
              description: For optimistic concurrency. See if-match.
              schema:
                type: string
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Desktop'
        '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'
      tags:
      - desktopService
      x-related-resource: '#/definitions/Desktop'
    put:
      description: Modifies information about the desktop such as the name.
      operationId: UpdateDesktop
      parameters:
      - $ref: '#/components/parameters/DesktopIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      responses:
        '202':
          description: The request has been accepted. The desktop is being updated.
          headers:
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
            opc-work-request-id:
              description: A unique identifier for an asynchronous request.
              schema:
                type: string
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      tags:
      - desktopService
      x-related-resource: '#/definitions/Desktop'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDesktopDetails'
        description: The details of the update.
        required: true
  /desktops/{desktopId}/actions/start:
    post:
      description: Starts the desktop with the specified OCID.
      operationId: StartDesktop
      parameters:
      - $ref: '#/components/parameters/DesktopIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      - $ref: '#/components/parameters/RetryTokenHeaderParam'
      responses:
        '202':
          description: The request has been accepted. The desktop is being started.
          headers:
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
            opc-work-request-id:
              description: A unique identifier for an asynchronous request.
              schema:
                type: string
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      tags:
      - desktopService
      x-related-resource: '#/definitions/Desktop'
  /desktops/{desktopId}/actions/stop:
    post:
      description: 'Stops the desktop with the specified OCID. Stopping a desktop causes the end-user to lose access to their desktop instance until the desktop is restarted.

        '
      operationId: StopDesktop
      parameters:
      - $ref: '#/components/parameters/DesktopIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      - $ref: '#/components/parameters/RetryTokenHeaderParam'
      responses:
        '202':
          description: The request has been accepted. The desktop is being stopped.
          headers:
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
            opc-work-request-id:
              description: A unique identifier for an asynchronous request.
              schema:
                type: string
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      tags:
      - desktopService
      x-related-resource: '#/definitions/Desktop'
  /workRequests:
    get:
      description: Lists the work requests in a compartment.
      operationId: ListWorkRequests
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/WorkRequestIdQueryParam'
      - $ref: '#/components/parameters/WorkRequestStatusQueryParam'
      - $ref: '#/components/parameters/ResourceIdentifierQueryParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      - $ref: '#/components/parameters/PageQueryParam'
      - $ref: '#/components/parameters/LimitQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/WorkRequestSortByQueryParam'
      responses:
        200:
          description: The list is being retrieved.
          headers:
            opc-next-page:
              description: For pagination.
              schema:
                type: string
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequestSummaryCollection'
        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:
      - desktopService
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}:
    delete:
      description: Cancel work request with the given ID.
      operationId: CancelWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeaderParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      responses:
        202:
          description: The work request will be cancelled.
          headers:
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Cancel the work request
      tags:
      - desktopService
      x-related-resource: '#/definitions/WorkRequest'
    get:
      description: Gets the status of the work request with the given ID.
      operationId: GetWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeaderParam'
      responses:
        200:
          description: The detail of the work request.
          headers:
            etag:
              description: For optimistic concurrency. See if-match.
              schema:
                type: string
            opc-request-id:
              description: The unique identifier of the request.
              schema:
                type: string
          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:
      - desktopService
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}/errors:
    get:
      description: Return a (paginated) list of errors for a given wo

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