VMware Cloud Director API - POST-AcquireTicket

POST /vApp/{id}/screen/action/acquireTicket

Operation:

Description:

Retrieve a screen ticket that you can use with the VMRC browser plug-in to gain access to the console of a running VM.

Since:

0.9

Deprecated:

38.0

Input parameters

Output parameters

ScreenTicketType

Produce media type(s):: application/vnd.vmware.vcloud.screenTicket+xml
application/vnd.vmware.vcloud.screenTicket+json
Output type:: ScreenTicketType

Examples

Request: HTTP 1.1
POST /api/vApp/vm-ec94079b-3071-4a72-b95c-4154acb12c38/screen/action/acquireTicket

Headers:
x-vcloud-authorization: 4Ezv8QOCNMOaWCVI6gEHOXEG299HZAsmcB0qrgPRp1I=

Body:
Response: HTTP/1.1 200 OK

Headers:
Content-Length: 844
Content-Type: application/vnd.vmware.vcloud.screenticket+xml;version=5.5
Vary: Accept-Encoding

Body:

<?xml version="1.0" encoding="UTF-8"?><ScreenTicket
    xmlns="http://www.vmware.com/vcloud/v1.5"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.vmware.com/vcloud/v1.5 http://https://vcloud.example.com/api/v1.5/schema/master.xsd">mks://https://vcloud.example.com%3A7443/vm-274?ticket=cst-Bduh5SNji%2Bp1%2FOhcKukQCtlRdoKAsz8ajTmb3QMnj6ZpK5kg2sVhVMgWA5GdK%2Bm677fRCS1Jks7iu%2F1Tymrezp%2FEVkYe9aWFOFGRAkXKSp9PUpP6sKcNFdWLUZkCNkjvJyt4Jmapaomyrp502fk5r9IVkhSzvc8hUOTpg9R3f914ka6e%2FyktAV790B4UGMQQotafnLcC1t3I2SOrm3E12W7Lih%2Flj7rfO7wy5FKIqUQhO7Y%2Fh3wXdnXOGTlLwifJ9TUaeiXtvWzabrKFnxDuA5rqO5H3yCqu508t0kzuFpQUB0wfFzBEAsv1Ub%2BrMvxICBRbDHLJIBy68ht97x73HW9SyvT3TYLYBbPRXXNPpUg%3D-CcQq01MEitFh6vkTUtvvKOkSKyjUIoQqOuYy0g%3D%3D--tp-2C%3A69%3AB6%3A75%3AF8%3A4C%3A71%3A28%3A42%3A18%3A98%3A25%3ADA%3A1D%3A56%3A0C%3A5B%3AAA%3A20%3A9D--</ScreenTicket>