Create Web Mks Ticket

Create Web Mks Ticket

Create a WebMKS ticket allowing to open a VM console in a browser.

Request
URI
POST
https://{api_host}/cloudapi/vcf/webMksTickets
COPY
Request Body
WebMksTicketRequest of type(s) application/json
Required

Show optional properties

{
    "namespace": {},
    "virtualMachineName": "string"
}
{
    "namespace": {
        "name": "string",
        "id": "string"
    },
    "virtualMachineName": "string"
}
object
namespace
Required

Entity reference used to describe VCD entities

string
virtualMachineName
Required

The name of the virtual machine to request a WebMKS ticket for.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns WebMksTicket of type(s) application/json;version=40.0 
"WebMksTicket Object"
string
host
Optional

The hostname that serves the WebMKS stream.

string
ticket
Optional

The WebMKS ticket.

string
webConsoleUrl
Optional

The URL to open a Web Console in an HTTP browser (composing above host and ticket values).

string
vmrcUrl
Optional

The URL to open the VMRC application (composing above host and ticket values).


Vendor Extension

This operation contains the following vendor extensions defined in the spec:

                    [object Object]
Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"namespace:"object","virtualMachineName:"string"}' https://{api_host}/cloudapi/vcf/webMksTickets
Availability
Added in 40.0
On This Page
Web Mks Ticket Operations
POST
Create Web Mks Ticket