{
  "opencollection": "1.0.0",
  "info": {
    "name": "Secure Desktops Desktop Service API",
    "version": "20220618"
  },
  "items": [
    {
      "info": {
        "name": "desktopService",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "ListDesktopPools",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20220618/desktopPools",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The OCID of the compartment of the desktop pool."
              },
              {
                "name": "availabilityDomain",
                "value": "",
                "type": "query",
                "description": "The name of the availability domain."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only results with the given displayName."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "A filter to return only results with the given OCID."
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "A filter to return only results with the given lifecycleState."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to return."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "A field to sort by."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "A field to indicate the sort order."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "For list pagination."
              }
            ]
          },
          "docs": "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.\n"
        },
        {
          "info": {
            "name": "CreateDesktopPool",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20220618/desktopPools",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a desktop pool with the given configuration parameters."
        },
        {
          "info": {
            "name": "GetDesktopPool",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20220618/desktopPools/:desktopPoolId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "desktopPoolId",
                "value": "",
                "type": "path",
                "description": "The OCID of the desktop pool."
              }
            ]
          },
          "docs": "Returns information about the desktop pool including all configuration parameters and the current state.\n"
        },
        {
          "info": {
            "name": "UpdateDesktopPool",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/20220618/desktopPools/:desktopPoolId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "desktopPoolId",
                "value": "",
                "type": "path",
                "description": "The OCID of the desktop pool."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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.\n"
        },
        {
          "info": {
            "name": "DeleteDesktopPool",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/20220618/desktopPools/:desktopPoolId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "desktopPoolId",
                "value": "",
                "type": "path",
                "description": "The OCID of the desktop pool."
              },
              {
                "name": "areVolumesPreserved",
                "value": "",
                "type": "query",
                "description": "Whether the volumes are preserved when a desktop pool is deleted."
              }
            ]
          },
          "docs": "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.\n"
        },
        {
          "info": {
            "name": "ChangeDesktopPoolCompartment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20220618/desktopPools/:desktopPoolId/actions/changeCompartment",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "desktopPoolId",
                "value": "",
                "type": "path",
                "description": "The OCID of the desktop pool."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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.\n"
        },
        {
          "info": {
            "name": "StartDesktopPool",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20220618/desktopPools/:desktopPoolId/actions/start",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "desktopPoolId",
                "value": "",
                "type": "path",
                "description": "The OCID of the desktop pool."
              }
            ]
          },
          "docs": "Starts the desktop pool with the specified OCID. Once the pool is ACTIVE, users will have access to their desktops within the pool.\n"
        },
        {
          "info": {
            "name": "StopDesktopPool",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20220618/desktopPools/:desktopPoolId/actions/stop",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "desktopPoolId",
                "value": "",
                "type": "path",
                "description": "The OCID of the desktop pool."
              }
            ]
          },
          "docs": "Stops the desktop pool with the specified OCID. Users will lose access to their desktops until you explicitly start the pool again.\n"
        },
        {
          "info": {
            "name": "ListDesktopPoolDesktops",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20220618/desktopPools/:desktopPoolId/desktops",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The OCID of the compartment of the desktop pool."
              },
              {
                "name": "desktopPoolId",
                "value": "",
                "type": "path",
                "description": "The OCID of the desktop pool."
              },
              {
                "name": "availabilityDomain",
                "value": "",
                "type": "query",
                "description": "The name of the availability domain."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only results with the given displayName."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "A filter to return only results with the given OCID."
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "A filter to return only results with the given lifecycleState."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to return."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "A field to sort by."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "A field to indicate the sort order."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "For list pagination."
              }
            ]
          },
          "docs": "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.\n"
        },
        {
          "info": {
            "name": "ListDesktopPoolVolumes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20220618/desktopPools/:desktopPoolId/volumes",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "desktopPoolId",
                "value": "",
                "type": "path",
                "description": "The OCID of the desktop pool."
              },
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The OCID of the compartment of the desktop pool."
              },
              {
                "name": "availabilityDomain",
                "value": "",
                "type": "query",
                "description": "The name of the availability domain."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only results with the given displayName."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "A filter to return only results with the given OCID."
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "A filter to return only results with the given lifecycleState."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to return."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "A field to sort by."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "A field to indicate the sort order."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "For list pagination."
              }
            ]
          },
          "docs": "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.\n"
        },
        {
          "info": {
            "name": "ListDesktops",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20220618/desktops",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "availabilityDomain",
                "value": "",
                "type": "query",
                "description": "The name of the availability domain."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only results with the given displayName."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "A filter to return only results with the given OCID."
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "A filter to return only results with the given lifecycleState."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to return."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "A field to sort by."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "A field to indicate the sort order."
              },
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The OCID of the compartment of the desktop pool."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "For list pagination."
              },
              {
                "name": "desktopPoolId",
                "value": "",
                "type": "query",
                "description": "The OCID of the desktop pool."
              }
            ]
          },
          "docs": "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.\n"
        },
        {
          "info": {
            "name": "GetDesktop",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20220618/desktops/:desktopId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "desktopId",
                "value": "",
                "type": "path",
                "description": "The OCID of the desktop."
              }
            ]
          },
          "docs": "Provides information about the desktop with the specified OCID."
        },
        {
          "info": {
            "name": "UpdateDesktop",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/20220618/desktops/:desktopId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "desktopId",
                "value": "",
                "type": "path",
                "description": "The OCID of the desktop."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies information about the desktop such as the name."
        },
        {
          "info": {
            "name": "DeleteDesktop",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/20220618/desktops/:desktopId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "desktopId",
                "value": "",
                "type": "path",
                "description": "The OCID of the desktop."
              }
            ]
          },
          "docs": "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.\n"
        },
        {
          "info": {
            "name": "StartDesktop",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20220618/desktops/:desktopId/actions/start",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "desktopId",
                "value": "",
                "type": "path",
                "description": "The OCID of the desktop."
              }
            ]
          },
          "docs": "Starts the desktop with the specified OCID."
        },
        {
          "info": {
            "name": "StopDesktop",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20220618/desktops/:desktopId/actions/stop",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "desktopId",
                "value": "",
                "type": "path",
                "description": "The OCID of the desktop."
              }
            ]
          },
          "docs": "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.\n"
        },
        {
          "info": {
            "name": "List Work Requests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20220618/workRequests",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The OCID of the compartment of the desktop pool."
              },
              {
                "name": "workRequestId",
                "value": "",
                "type": "query",
                "description": "The ID of the asynchronous work request."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources their lifecycleState matches the given OperationStatus."
              },
              {
                "name": "resourceId",
                "value": "",
                "type": "query",
                "description": "The ID of the resource affected by the work request."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "For list pagination."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to return."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "A field to indicate the sort order."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.\n"
              }
            ]
          },
          "docs": "Lists the work requests in a compartment."
        },
        {
          "info": {
            "name": "GET Work Request Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20220618/workRequests/:workRequestId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The ID of the asynchronous request."
              }
            ]
          },
          "docs": "Gets the status of the work request with the given ID."
        },
        {
          "info": {
            "name": "Cancel the work request",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/20220618/workRequests/:workRequestId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The ID of the asynchronous request."
              }
            ]
          },
          "docs": "Cancel work request with the given ID."
        },
        {
          "info": {
            "name": "Lists work request errors",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20220618/workRequests/:workRequestId/errors",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The ID of the asynchronous request."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "For list pagination."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to return."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "A field to indicate the sort order."
              }
            ]
          },
          "docs": "Return a (paginated) list of errors for a given work request."
        },
        {
          "info": {
            "name": "Lists work request logs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20220618/workRequests/:workRequestId/logs",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workRequestId",
                "value": "",
                "type": "path",
                "description": "The ID of the asynchronous request."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "For list pagination."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to return."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "A field to indicate the sort order."
              }
            ]
          },
          "docs": "Return a (paginated) list of logs for a given work request.\n"
        }
      ]
    }
  ],
  "bundled": true
}