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 work request. operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeaderParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: List of work request errors. 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/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request errors tags: - desktopService x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Return a (paginated) list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeaderParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: List of work request logs. 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/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request logs tags: - desktopService x-related-resource: '#/definitions/WorkRequestLogEntry' components: schemas: CreateDesktopPoolDetails: description: Provides the configuration information used to create the desktop pool. properties: arePrivilegedUsers: description: Indicates whether desktop pool users have administrative privileges on their desktop. type: boolean availabilityDomain: description: The availability domain of the desktop pool. maxLength: 255 minLength: 1 type: string availabilityPolicy: $ref: '#/components/schemas/DesktopAvailabilityPolicy' compartmentId: description: The OCID of the compartment which will contain the desktop pool. maxLength: 255 minLength: 1 type: string contactDetails: description: 'Contact information of the desktop pool administrator. Avoid entering confidential information. ' maxLength: 1024 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only the string type is supported. type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user friendly description providing additional information about the resource. Avoid entering confidential information. ' maxLength: 400 type: string devicePolicy: $ref: '#/components/schemas/DesktopDevicePolicy' displayName: description: A user friendly display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object image: $ref: '#/components/schemas/DesktopImage' isStorageEnabled: description: Indicates whether storage is enabled for the desktop pool. type: boolean maximumSize: description: The maximum number of desktops permitted in the desktop pool. format: int32 maximum: 10000 minimum: 1 type: integer networkConfiguration: $ref: '#/components/schemas/DesktopNetworkConfiguration' nsgIds: description: A list of network security groups for the private access. items: maxLength: 255 minLength: 1 type: string maxItems: 4 type: array shapeName: description: The shape of the desktop pool. maxLength: 255 minLength: 1 type: string standbySize: description: The maximum number of standby desktops available in the desktop pool. format: int32 type: integer storageBackupPolicyId: description: The backup policy OCID of the storage. maxLength: 1024 minLength: 0 type: string storageSizeInGBs: description: The size in GBs of the storage for the desktop pool. format: int32 maximum: 32768 minimum: 50 type: integer timeStartScheduled: description: The start time of the desktop pool. format: date-time type: string timeStopScheduled: description: The stop time of the desktop pool. format: date-time type: string required: - compartmentId - displayName - maximumSize - standbySize - shapeName - isStorageEnabled - storageSizeInGBs - storageBackupPolicyId - devicePolicy - availabilityPolicy - image - networkConfiguration - contactDetails - arePrivilegedUsers - availabilityDomain type: object HostingOptions: description: Provides information about where a desktop is hosted. properties: connectAddress: description: The connection address of the desktop. maxLength: 255 minLength: 1 type: string image: $ref: '#/components/schemas/DesktopImage' required: - image - connectAddress type: object Error: description: Provides information about an error message. properties: code: description: A short error code. type: string message: description: A human readable message describing the error. type: string required: - code - message type: object UpdateDesktopDetails: description: Provides the details of an updated desktop. properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only the string type is supported. type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user friendly display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object Desktop: description: Provides information about a desktop including name, state, id, configuration, owner, and time created. properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only the string type is supported. type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object devicePolicy: $ref: '#/components/schemas/DesktopDevicePolicy' displayName: description: A user friendly display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object hostingOptions: $ref: '#/components/schemas/HostingOptions' id: description: The OCID of the desktop. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the desktop. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' poolId: description: The OCID of the desktop pool the desktop is a member of. maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time the resource was created. format: date-time type: string userName: description: The owner of the desktop. maxLength: 255 minLength: 1 type: string required: - id - lifecycleState - timeCreated - displayName - devicePolicy - hostingOptions - userName - poolId type: object DesktopPoolVolumeCollection: description: A list of volumes within a desktop pool. properties: items: description: A list of desktop pool volumes. items: $ref: '#/components/schemas/DesktopPoolVolumeSummary' type: array required: - items type: object DesktopPoolVolumeSummary: description: Provides information about a volume within the desktop pool. properties: availabilityDomain: description: The availability domain of the desktop pool. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only the string type is supported. type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the desktop pool volume. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the desktop pool volume. enum: - ACTIVE - INACTIVE type: string name: description: The name of the desktop pool volume. maxLength: 255 minLength: 1 type: string poolId: description: The OCID of the desktop pool to which this volume belongs. maxLength: 255 minLength: 1 type: string userName: description: The owner of the desktop pool volume. maxLength: 255 minLength: 1 type: string required: - id - name - lifecycleState - userName - availabilityDomain type: object ChangeDesktopPoolCompartmentDetails: description: Provides the OCID of the new compartment that will contain the desktop pool. properties: compartmentId: description: The OCID of the compartment which will contain the desktop pool. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path that the user can do a GET on to access the resource metadata. type: string identifier: description: The identifier of the resource the work request affects. type: string required: - actionType - entityType - identifier DesktopSummary: description: Provides information about a desktop. properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only the string type is supported. type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user friendly display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the desktop. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the desktop. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' poolId: description: The pool ID of the desktop. maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time the resource was created. format: date-time type: string userName: description: The owner of the desktop. maxLength: 255 minLength: 1 type: string required: - id - lifecycleState - timeCreated - displayName - userName - poolId type: object DesktopPool: description: Provides information about a desktop pool including all configuration parameters. properties: arePrivilegedUsers: description: Indicates whether desktop pool users have administrative privileges on their desktop. type: boolean availabilityDomain: description: The availability domain of the desktop pool. maxLength: 255 minLength: 1 type: string availabilityPolicy: $ref: '#/components/schemas/DesktopAvailabilityPolicy' compartmentId: description: The OCID of the compartment of the desktop pool. maxLength: 255 minLength: 1 type: string contactDetails: description: 'Contact information of the desktop pool administrator. Avoid entering confidential information. ' maxLength: 1024 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only the string type is supported. type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user friendly description providing additional information about the resource. Avoid entering confidential information. ' maxLength: 400 type: string devicePolicy: $ref: '#/components/schemas/DesktopDevicePolicy' displayName: description: A user friendly display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the desktop pool. maxLength: 255 minLength: 1 type: string image: $ref: '#/components/schemas/DesktopImage' isStorageEnabled: description: Indicates whether storage is enabled for the desktop pool. type: boolean lifecycleState: description: The current state of the desktop pool. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' maximumSize: description: The maximum number of desktops permitted in the desktop pool. format: int32 maximum: 10000 minimum: 1 type: integer networkConfiguration: $ref: '#/components/schemas/DesktopNetworkConfiguration' nsgIds: description: A list of network security groups for the network. items: maxLength: 255 minLength: 1 type: string maxItems: 4 type: array shapeName: description: The shape of the desktop pool. maxLength: 255 minLength: 1 type: string standbySize: description: The maximum number of standby desktops available in the desktop pool. format: int32 type: integer storageBackupPolicyId: description: The backup policy OCID of the storage. maxLength: 1024 minLength: 0 type: string storageSizeInGBs: description: The size in GBs of the storage for the desktop pool. format: int32 maximum: 32768 minimum: 50 type: integer timeCreated: description: The date and time the resource was created. format: date-time type: string timeStartScheduled: description: The start time of the desktop pool. format: date-time type: string timeStopScheduled: description: The stop time of the desktop pool. format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - timeCreated - maximumSize - standbySize - shapeName - isStorageEnabled - storageSizeInGBs - storageBackupPolicyId - devicePolicy - availabilityPolicy - image - networkConfiguration - contactDetails - arePrivilegedUsers - availabilityDomain type: object DesktopCollection: description: A list of desktops. properties: items: description: A list of desktop summaries. items: $ref: '#/components/schemas/DesktopSummary' type: array required: - items type: object WorkRequestSummaryCollection: description: Results of a workRequest search. properties: items: description: List of workRequestSummary objects. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object WorkRequest: description: A description of workrequest status. properties: compartmentId: description: The ocid of the compartment that contains the work request. type: string id: description: The id of the work request. type: string operationType: description: Type of the work request. enum: - CREATE_DESKTOP_POOL - UPDATE_DESKTOP_POOL - DELETE_DESKTOP_POOL - MOVE_DESKTOP_POOL - START_DESKTOP_POOL - STOP_DESKTOP_POOL - DELETE_DESKTOP - UPDATE_DESKTOP - START_DESKTOP - STOP_DESKTOP type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted WorkRequestErrorCollection: description: Results of a workRequestError search. properties: items: description: List of workRequestError objects. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object DesktopPoolCollection: description: A list of desktop pools. properties: items: description: A list of desktop pool summaries. items: $ref: '#/components/schemas/DesktopPoolSummary' type: array required: - items type: object DesktopNetworkConfiguration: description: Provides information about the network configuration of the desktop pool. properties: subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet in the customer VCN where the connectivity will be established. ' maxLength: 255 minLength: 1 type: string vcnId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the customer VCN. ' maxLength: 255 minLength: 1 type: string required: - vcnId - subnetId type: object DesktopPoolDesktopSummary: description: '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. ' properties: definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only the string type is supported. type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object desktopId: description: The OCID of the desktop. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object instanceId: description: The OCID of the compute resource used by this desktop. maxLength: 255 minLength: 1 type: string isAssigned: description: Indicates whether the desktop is assigned to a user. type: boolean lifecycleState: description: The state of the desktop. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' timeCreated: description: The date and time the resource was created. format: date-time type: string userName: description: The owner of the desktop. maxLength: 255 minLength: 1 type: string required: - desktopId - instanceId - isAssigned - lifecycleState - timeCreated type: object DesktopAvailabilityPolicy: description: Provides the start and stop schedule information for desktop availability of the desktop pool. properties: startSchedule: $ref: '#/components/schemas/DesktopSchedule' stopSchedule: $ref: '#/components/schemas/DesktopSchedule' required: - startSchedule - stopSchedule type: object WorkRequestSummary: description: A summary of the status of a work request. properties: compartmentId: description: The ocid of the compartment that contains the work request. type: string id: description: The id of the work request. type: string operationType: description: Type of the work request enum: - CREATE_DESKTOP_POOL - UPDATE_DESKTOP_POOL - DELETE_DESKTOP_POOL - MOVE_DESKTOP_POOL - START_DESKTOP_POOL - STOP_DESKTOP_POOL - DELETE_DESKTOP - UPDATE_DESKTOP - START_DESKTOP - STOP_DESKTOP type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted DesktopPoolDesktopCollection: description: A list of desktops within a desktop pool. properties: items: description: A list of desktops. items: $ref: '#/components/schemas/DesktopPoolDesktopSummary' type: array required: - items type: object WorkRequestError: description: An error encountered while executing a work request. properties: code: description: 'A machine-usable code for the error that occured. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) ' type: string message: description: A human readable description of the issue encountered. type: string timestamp: description: The time the error occured. An RFC3339 formatted datetime string. format: date-time type: string required: - code - message - timestamp DesktopSchedule: description: Provides the schedule information for a desktop. properties: cronExpression: description: A cron expression describing the desktop's schedule. maxLength: 64 minLength: 1 type: string timezone: description: The timezone of the desktop's schedule. maxLength: 64 minLength: 1 type: string required: - cronExpression - timezone type: object UpdateDesktopPoolDetails: description: Provides the details of a request to update the desktop pool. properties: availabilityPolicy: $ref: '#/components/schemas/DesktopAvailabilityPolicy' contactDetails: description: 'Contact information of the desktop pool administrator. Avoid entering confidential information. ' maxLength: 1024 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only the string type is supported. type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user friendly description providing additional information about the resource. Avoid entering confidential information. ' maxLength: 400 type: string devicePolicy: $ref: '#/components/schemas/DesktopDevicePolicy' displayName: description: A user friendly display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object maximumSize: description: The maximum number of desktops permitted in the desktop pool. format: int32 maximum: 10000 minimum: 1 type: integer standbySize: description: The maximum number of standby desktops available in the desktop pool. format: int32 type: integer timeStartScheduled: description: The start time of the desktop pool. format: date-time type: string timeStopScheduled: description: The stop time of the desktop pool. format: date-time type: string type: object DesktopDevicePolicy: description: 'Provides the settings for desktop and client device options, such as audio in and out, client drive mapping, and clipboard access. ' properties: audioMode: description: "The audio mode.\nNONE: No access to the local audio devices is permitted.\nTODESKTOP: The user may record audio on their desktop. \nFROMDESKTOP: The user may play audio on their desktop.\nFULL: The user may play and record audio on their desktop.\n" enum: - NONE - TODESKTOP - FROMDESKTOP - FULL type: string cdmMode: description: "The client local drive access mode.\nNONE: No access to local drives permitted.\nREADONLY: The user may read from local drives on their desktop.\nFULL: The user may read from and write to their local drives on their desktop. \n" enum: - NONE - READONLY - FULL type: string clipboardMode: description: "The clipboard mode.\nNONE: No access to the local clipboard is permitted.\nTODESKTOP: The clipboard can be used to transfer data to the desktop only. \nFROMDESKTOP: The clipboard can be used to transfer data from the desktop only.\nFULL: The clipboard can be used to transfer data to and from the desktop.\n" enum: - NONE - TODESKTOP - FROMDESKTOP - FULL type: string isDisplayEnabled: description: Indicates whether the display is enabled. type: boolean isKeyboardEnabled: description: Indicates whether the keyboard is enabled. type: boolean isPointerEnabled: description: Indicates whether the pointer is enabled. type: boolean isPrintingEnabled: description: Indicates whether printing is enabled. type: boolean required: - clipboardMode - audioMode - cdmMode - isPrintingEnabled - isPointerEnabled - isKeyboardEnabled - isDisplayEnabled type: object DesktopPoolSummary: description: 'Provides information about the desktop pool such as number of active desktops, name, OCID, state, and maximum size. ' properties: activeDesktops: description: The number of active desktops in the desktop pool. format: int32 type: integer compartmentId: description: The OCID of the compartment which will contain the desktop pool. maxLength: 255 minLength: 1 type: string contactDetails: description: 'Contact information of the desktop pool administrator. Avoid entering confidential information. ' maxLength: 1024 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only the string type is supported. type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user friendly display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the desktop pool. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the desktop pool. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' maximumSize: description: The maximum number of desktops permitted in the desktop pool. format: int32 maximum: 10000 minimum: 1 type: integer timeCreated: description: The date and time the resource was created. format: date-time type: string required: - id - displayName - lifecycleState - maximumSize - contactDetails - compartmentId - timeCreated type: object DesktopImage: description: Provides information about the desktop image. properties: imageId: description: The OCID of the desktop image. maxLength: 255 minLength: 1 type: string imageName: description: The name of the desktop image. maxLength: 255 minLength: 1 type: string required: - imageId - imageName type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: Human-readable log message. type: string timestamp: description: The time the log message was written. An RFC3339 formatted datetime string format: date-time type: string required: - message - timestamp WorkRequestLogEntryCollection: description: Results of a workRequestLog search. properties: items: description: List of workRequestLogEntries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object parameters: AvailabilityDomainQueryParam: description: The name of the availability domain. in: query name: availabilityDomain schema: type: string maxLength: 255 minLength: 1 SortByQueryParam: description: A field to sort by. in: query name: sortBy schema: type: string enum: - TIMECREATED - DISPLAYNAME default: TIMECREATED ResourceIdentifierQueryParam: description: The ID of the resource affected by the work request. in: query name: resourceId x-default-description: 'null' schema: type: string PageQueryParam: description: For list pagination. in: query name: page schema: type: string maxLength: 1024 minLength: 1 DesktopPoolIdPathParam: description: The OCID of the desktop pool. in: path name: desktopPoolId required: true schema: type: string CompartmentIdQueryParam: description: The OCID of the compartment of the desktop pool. in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 1 RetryTokenHeaderParam: description: A token that uniquely identifies a request. in: header name: opc-retry-token schema: type: string maxLength: 64 minLength: 1 WorkRequestStatusQueryParam: description: A filter to return only resources their lifecycleState matches the given OperationStatus. in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED IfMatchHeaderParam: description: For optimistic concurrency control. in: header name: if-match schema: type: string maxLength: 255 minLength: 1 LimitQueryParam: description: The maximum number of results to return. in: query name: limit schema: type: integer format: int32 default: 100 maximum: 100 WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string WorkRequestIdQueryParam: description: The ID of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' schema: type: string DesktopPoolIdOptionalQueryParam: description: The OCID of the desktop pool. in: query name: desktopPoolId schema: type: string SortOrderQueryParam: description: A field to indicate the sort order. in: query name: sortOrder schema: type: string enum: - ASC - DESC default: DESC RequestIdHeaderParam: description: The unique identifier of the request. in: header name: opc-request-id schema: type: string maxLength: 1024 minLength: 1 LifecycleQueryParam: description: A filter to return only results with the given lifecycleState. in: query name: lifecycleState schema: type: string maxLength: 255 minLength: 1 QueryPreserveVolumesParam: description: Whether the volumes are preserved when a desktop pool is deleted. in: query name: areVolumesPreserved schema: type: boolean default: false DisplayNameQueryParam: description: A filter to return only results with the given displayName. in: query name: displayName schema: type: string maxLength: 255 minLength: 1 WorkRequestSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. ' in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted DesktopIdPathParam: description: The OCID of the desktop. in: path name: desktopId required: true schema: type: string IdQueryParam: description: A filter to return only results with the given OCID. in: query name: id schema: type: string maxLength: 1024 minLength: 1 responses: default: description: Unknown error headers: opc-request-id: description: The unique identifier of the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: content-location: description: A URL containing the location of the newly created resource. type: string etag: description: For optimistic concurrency. See if-match. type: string location: description: A URL containing location of the newly created resource. type: string opc-next-page: description: For pagination. type: string opc-request-id: description: The unique identifier of the request. type: string opc-work-request-id: description: A unique identifier for an asynchronous request. type: string retry-after: description: The number of seconds the client should wait before polling this endpoint again. type: integer x-properties: arePrivilegedUsers: description: Indicates whether desktop pool users have administrative privileges on their desktop. type: boolean availabilityDomain: description: The availability domain of the desktop pool. maxLength: 255 minLength: 1 type: string contactDetails: description: 'Contact information of the desktop pool administrator. Avoid entering confidential information. ' maxLength: 1024 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: The value of the tag. Only the string type is supported. type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user friendly description providing additional information about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: A user friendly display name. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isStorageEnabled: description: Indicates whether storage is enabled for the desktop pool. type: boolean maximumSize: description: The maximum number of desktops permitted in the desktop pool. format: int32 maximum: 10000 minimum: 1 type: integer nsgId: maxLength: 255 minLength: 1 type: string shapeName: description: The shape of the desktop pool. maxLength: 255 minLength: 1 type: string standbySize: description: The maximum number of standby desktops available in the desktop pool. format: int32 type: integer startTime: description: The start time of the desktop pool. format: date-time type: string stopTime: description: The stop time of the desktop pool. format: date-time type: string storageBackupPolicyId: description: The backup policy OCID of the storage. maxLength: 1024 minLength: 0 type: string storageSizeInGBs: description: The size in GBs of the storage for the desktop pool. format: int32 maximum: 32768 minimum: 50 type: integer subnetId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet in the customer VCN where the connectivity will be established. ' maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: The value of the tag. Only the string type is supported. type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the resource was created. format: date-time type: string vcnId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the customer VCN. ' maxLength: 255 minLength: 1 type: string x-obmcs-client-retries-enabled: true