Skip to main content

Access Console

GET/api/v1/nodes/vnc/{node_id}

Path parameters

  • node_idPathstringrequired

    Path parameter node_id.

Query parameters

  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key used to authenticate requests to the Access Console

    • required
    • must be a non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Specifies the location for the request

    • non-empty string
    example{{location}}

Responses

200Successful response
object
codeinteger

HTTP status code of the response

example200
  • integer between 100 and 599
  • required
dataobject
errorsobject
messagestring

Status message returned by the Access Console.

exampleSuccess
  • Must be a non-empty string
  • Maximum length of 255 characters