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

    namestring

    Possible values: non-empty

    providerinteger
    protocolProtocolEnum (string)

    Possible values: [rdp, vnc, ssh]

    hoststring

    Possible values: non-empty

    settings
    property_mappingsuuid[]
    auth_modeAuthModeEnum (string)

    Possible values: [static, prompt]

    maximum_connectionsinteger

    Possible values: >= -2147483648 and <= 2147483647

Responses​

Schema
    pkuuidrequired
    namestringrequired
    providerintegerrequired
    provider_obj object

    RACProvider Serializer

    pkID (integer)required
    namestringrequired
    authentication_flowuuidnullable

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

    authorization_flowuuidrequired

    Flow used when authorizing this provider.

    property_mappingsuuid[]
    componentstringrequired

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

    assigned_application_slugstringrequired

    Internal application name, used in URLs.

    assigned_application_namestringrequired

    Application's display Name.

    assigned_backchannel_application_slugstringrequired

    Internal application name, used in URLs.

    assigned_backchannel_application_namestringrequired

    Application's display Name.

    verbose_namestringrequired

    Return object's verbose_name

    verbose_name_pluralstringrequired

    Return object's plural verbose_name

    meta_model_namestringrequired

    Return internal model name

    settings
    outpost_setstring[]required
    connection_expirystring

    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_disconnectboolean

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

    protocolProtocolEnum (string)required

    Possible values: [rdp, vnc, ssh]

    hoststringrequired
    settings
    property_mappingsuuid[]
    auth_modeAuthModeEnum (string)required

    Possible values: [static, prompt]

    launch_urlstringnullablerequired

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

    maximum_connectionsinteger

    Possible values: >= -2147483648 and <= 2147483647

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "/api/v3/rac/endpoints/:pbm_uuid/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"provider\": 0,\n  \"protocol\": \"rdp\",\n  \"host\": \"string\",\n  \"settings\": {},\n  \"property_mappings\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ],\n  \"auth_mode\": \"static\",\n  \"maximum_connections\": 0\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
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
}