Update properties on a Remote VNC Jump Item resource.

patch

https://{support.example.com}/api/config/v1/jump-item/remote-vnc/{id}

Modifies an existing Remote VNC Jump Item resource with the given {id} using the given properties.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

1 to 2147483647

Unique identifier for the resource.

Body Params

A Remote VNC Jump Item resource with modified properties.

name

string

required

length between 1 and 128

The name of the Remote VNC Jump Item.

jumpoint_id

int32

required

1 to 2147483647

The unique identifier of the Jumpoint through which connections are made.

hostname

string

required

length between 1 and 128

The hostname or IP address.

port

int32

100 to 65535

Defaults to 5900

The port to use. Must be between 100 and 65535, inclusive.

jump_group_id

int32

required

1 to 2147483647

The unique identifier of the Jump Group or user that owns this Jump Item.

jump_group_type

string

enum

Defaults to shared

The type of Jump Group that owns this Jump Item.

Allowed:

tag

string

length between 0 and 64

The Jump Item's tag.

comments

string

length between 0 and 1024

The Jump Item's comments.

jump_policy_id

int32 | null

1 to 2147483647

The unique identifier of the Jump Policy used to manage access to this Jump Item.

session_policy_id

int32 | null

2 to 2147483647

The unique identifier of the Session Policy used to control the rep's capabilities in the session.

Responses

200Indicates the existing Remote VNC Jump Item was successfully updated and returns the updated Remote VNC Jump Item.

404The specified resource was not found.

422One or more request parameters are invalid. The body contains a general error message as well as a validation error dictionary.