Skip to main content

rac_endpoints_partial_update

PATCH 
/api/v3//rac/endpoints/:pbm_uuid/

Endpoint Viewset

Request​

Path Parameters

    pbm_uuid uuidrequired

    A UUID string identifying this RAC Endpoint.

Body

    name string

    Possible values: non-empty

    provider integer
    protocol ProtocolEnum (string)

    Possible values: [rdp, vnc, ssh]

    host string

    Possible values: non-empty

    settings
    property_mappings uuid[]
    auth_mode AuthModeEnum (string)

    Possible values: [static, prompt]

    maximum_connections integer

    Possible values: >= -2147483648 and <= 2147483647

Responses​

Schema

    pk uuidrequired
    name stringrequired
    provider integerrequired

    provider_obj

    object

    required

    RACProvider Serializer

    pk ID (integer)required
    name stringrequired
    authentication_flow uuidnullable

    Flow used for authentication when the associated application is accessed by an un-authenticated user.

    authorization_flow uuidrequired

    Flow used when authorizing this provider.

    property_mappings uuid[]
    component stringrequired

    Get object component so that we know how to edit the object

    assigned_application_slug stringrequired

    Internal application name, used in URLs.

    assigned_application_name stringrequired

    Application's display Name.

    assigned_backchannel_application_slug stringrequired

    Internal application name, used in URLs.

    assigned_backchannel_application_name stringrequired

    Application's display Name.

    verbose_name stringrequired

    Return object's verbose_name

    verbose_name_plural stringrequired

    Return object's plural verbose_name

    meta_model_name stringrequired

    Return internal model name

    settings
    outpost_set string[]required
    connection_expiry string

    Determines how long a session lasts. Default of 0 means that the sessions lasts until the browser is closed. (Format: hours=-1;minutes=-2;seconds=-3)

    delete_token_on_disconnect boolean

    When set to true, connection tokens will be deleted upon disconnect.

    protocol ProtocolEnum (string)required

    Possible values: [rdp, vnc, ssh]

    host stringrequired
    settings
    property_mappings uuid[]
    auth_mode AuthModeEnum (string)required

    Possible values: [static, prompt]

    launch_url stringnullablerequired

    Build actual launch URL (the provider itself does not have one, just individual endpoints)

    maximum_connections integer

    Possible values: >= -2147483648 and <= 2147483647

Authorization: http

name: authentiktype: httpscheme: bearer

Request Collapse all
Base URL
/api/v3
Auth
Parameters
— pathrequired
Body
{
  "name": "string",
  "provider": 0,
  "protocol": "rdp",
  "host": "string",
  "settings": {},
  "property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "auth_mode": "static",
  "maximum_connections": 0
}