How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Oracle

Oracle Desktop Service API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Oracle Desktop Service API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 21 operations across 15 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 20220618.

Requests are made against a single base URL, /20220618.

21 operations 15 paths 29 schemas 3 DELETE10 GET6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20220618
Base URL
https://{host}:{port}/ords/
Resource Areas
1

Paths & Operations 21

Across 15 paths, the API surfaces 21 operations — 3 DELETE, 10 GET, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

desktopService 21
GET
/desktopPools
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 res…
ListDesktopPools 10 params → 200400401404409429500default
POST
/desktopPools
Creates a desktop pool with the given configuration parameters.
CreateDesktopPool 2 params body → 201400401404409412429500
DELETE
/desktopPools/{desktopPoolId}
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 associat…
DeleteDesktopPool 4 params → 202400401404409412429500
GET
/desktopPools/{desktopPoolId}
Returns information about the desktop pool including all configuration parameters and the current state.
GetDesktopPool 2 params → 200400401404409412429500
PUT
/desktopPools/{desktopPoolId}
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.
UpdateDesktopPool 3 params body → 202400401404409412429500
POST
/desktopPools/{desktopPoolId}/actions/changeCompartment
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.
ChangeDesktopPoolCompartment 4 params body → 202400401404409412429500
POST
/desktopPools/{desktopPoolId}/actions/start
Starts the desktop pool with the specified OCID. Once the pool is ACTIVE, users will have access to their desktops within the pool.
StartDesktopPool 4 params → 202400401404409412429500
POST
/desktopPools/{desktopPoolId}/actions/stop
Stops the desktop pool with the specified OCID. Users will lose access to their desktops until you explicitly start the pool again.
StopDesktopPool 4 params → 202400401404409412429500
GET
/desktopPools/{desktopPoolId}/desktops
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 res…
ListDesktopPoolDesktops 11 params → 200400401404409429500default
GET
/desktopPools/{desktopPoolId}/volumes
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 resu…
ListDesktopPoolVolumes 11 params → 200400401404409429500default
GET
/desktops
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 ca…
ListDesktops 11 params → 200400401404409429500default
DELETE
/desktops/{desktopId}
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…
DeleteDesktop 3 params → 202400401404409412429500
GET
/desktops/{desktopId}
Provides information about the desktop with the specified OCID.
GetDesktop 2 params → 200400401404409412429500
PUT
/desktops/{desktopId}
Modifies information about the desktop such as the name.
UpdateDesktop 3 params body → 202400401404409412429500
POST
/desktops/{desktopId}/actions/start
Starts the desktop with the specified OCID.
StartDesktop 4 params → 202400401404409412429500
POST
/desktops/{desktopId}/actions/stop
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.
StopDesktop 4 params → 202400401404409412429500
GET
/workRequests
List Work Requests
ListWorkRequests 9 params → 200400401404429500default
DELETE
/workRequests/{workRequestId}
Cancel the work request
CancelWorkRequest 3 params → 202400401404429409412500
GET
/workRequests/{workRequestId}
GET Work Request Status
GetWorkRequest 2 params → 200400401404429500default
GET
/workRequests/{workRequestId}/errors
Lists work request errors
ListWorkRequestErrors 6 params → 200400401404429500default
GET
/workRequests/{workRequestId}/logs
Lists work request logs
ListWorkRequestLogs 6 params → 200400401404429500default

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are DesktopPool (24 properties), CreateDesktopPoolDetails (21 properties), UpdateDesktopPoolDetails (11 properties), DesktopPoolSummary (10 properties). Each schema is shown below with its type and property counts.

DesktopPoolVolumeCollection
object
A list of volumes within a desktop pool.
1 property 1 required
DesktopDevicePolicy
object
Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access.
7 properties 7 required
DesktopPoolDesktopSummary
object
Provides information about a desktop within a desktop pool, such as if it is assigned to a user, the state, owner, desktop pool, resource id, and time created.
8 properties 5 required
DesktopNetworkConfiguration
object
Provides information about the network configuration of the desktop pool.
2 properties 2 required
WorkRequestErrorCollection
object
Results of a workRequestError search.
1 property 1 required
DesktopPool
object
Provides information about a desktop pool including all configuration parameters.
24 properties 18 required
DesktopPoolDesktopCollection
object
A list of desktops within a desktop pool.
1 property 1 required
WorkRequestError
object
An error encountered while executing a work request.
3 properties 3 required
DesktopSummary
object
Provides information about a desktop.
8 properties 6 required
WorkRequestSummary
object
A summary of the status of a work request.
9 properties 7 required
WorkRequest
object
A description of workrequest status.
9 properties 7 required
WorkRequestLogEntryCollection
object
Results of a workRequestLog search.
1 property 1 required
DesktopPoolCollection
object
A list of desktop pools.
1 property 1 required
DesktopCollection
object
A list of desktops.
1 property 1 required
HostingOptions
object
Provides information about where a desktop is hosted.
2 properties 2 required
DesktopPoolVolumeSummary
object
Provides information about a volume within the desktop pool.
8 properties 5 required
UpdateDesktopDetails
object
Provides the details of an updated desktop.
3 properties
Desktop
object
Provides information about a desktop including name, state, id, configuration, owner, and time created.
10 properties 8 required
Error
object
Provides information about an error message.
2 properties 2 required
UpdateDesktopPoolDetails
object
Provides the details of a request to update the desktop pool.
11 properties
DesktopAvailabilityPolicy
object
Provides the start and stop schedule information for desktop availability of the desktop pool.
2 properties 2 required
DesktopPoolSummary
object
Provides information about the desktop pool such as number of active desktops, name, OCID, state, and maximum size.
10 properties 7 required
WorkRequestLogEntry
object
A log message from the execution of a work request.
2 properties 2 required
WorkRequestSummaryCollection
object
Results of a workRequest search.
1 property 1 required
ChangeDesktopPoolCompartmentDetails
object
Provides the OCID of the new compartment that will contain the desktop pool.
1 property 1 required
DesktopSchedule
object
Provides the schedule information for a desktop.
2 properties 2 required
WorkRequestResource
object
A resource created or operated on by a work request.
4 properties 3 required
CreateDesktopPoolDetails
object
Provides the configuration information used to create the desktop pool.
21 properties 15 required
DesktopImage
object
Provides information about the desktop image.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-desktopservice-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
AE Profile APIs.io
Oracle Integration Cloud API
AE Profile APIs.io
Oracle Fusion Cloud Applications API
AE Profile APIs.io
Oracle Fusion Cloud Financials REST API
AE Profile APIs.io
Oracle Fusion Cloud HCM REST API
AE Profile APIs.io
Oracle Fusion Cloud CX Sales and Service REST API
AE Profile APIs.io
Oracle Fusion Cloud SCM REST API
AE Profile APIs.io
Oracle Fusion Cloud Procurement REST API
AE Profile APIs.io
Oracle Content Management API
AE Profile APIs.io
OCI Generative AI API
AE Profile APIs.io
OCI AI Vision API
AE Profile APIs.io
OCI AI Language API
AE Profile APIs.io
← Back to O APIs
API Details
ID
oracle:oracle-desktopservice-api
Base URL
https://{host}:{port}/ords/
Docs
https://docs.oracle.com/en/database/oracle/oracle-database/
Provider
Oracle
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=oracle-desktopservice-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/oracle-desktopservice-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Oracle Desktop Service API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.