outposts_instances_partial_update

PATCH 
/api/v3//outposts/instances/:uuid/

Outpost Viewset

Request

Path Parameters

uuid uuidrequired

A UUID string identifying this Outpost.

application/json

Body

namestring

Possible values: non-empty

typeOutpostTypeEnum (string)

Possible values: [proxy, ldap, radius, rac]

providersinteger[]

service_connectionuuidnullable

Select Service-Connection authentik should use to manage this outpost. Leave empty if authentik should not handle the deployment.

config object

property name*any

managedManaged by authentik (string)nullable

Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.

Possible values: non-empty

Responses

200

application/json

Schema

Schema

pkuuidrequired

namestringrequired

typeOutpostTypeEnum (string)required

Possible values: [proxy, ldap, radius, rac]

providersinteger[]required

providers_obj object[]required

Array [

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.

invalidation_flowuuidrequired

Flow used ending the session from a 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

]

service_connectionuuidnullable

Select Service-Connection authentik should use to manage this outpost. Leave empty if authentik should not handle the deployment.

service_connection_obj object

ServiceConnection Serializer

pkuuidrequired

namestringrequired

localboolean

If enabled, use the local connection. Required Docker socket/Kubernetes Integration

componentstringrequired

Return component used to edit this object

verbose_namestringrequired

Return object's verbose_name

verbose_name_pluralstringrequired

Return object's plural verbose_name

meta_model_namestringrequired

Return internal model name

refresh_interval_sintegerrequired

token_identifierstringrequired

Get Token identifier

config objectrequired

property name*any

managedManaged by authentik (string)nullable

Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.

Example (auto)

{
  "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "type": "proxy",
  "providers": [
    0
  ],
  "providers_obj": [
    {
      "pk": 0,
      "name": "string",
      "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "authorization_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "invalidation_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "property_mappings": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "component": "string",
      "assigned_application_slug": "string",
      "assigned_application_name": "string",
      "assigned_backchannel_application_slug": "string",
      "assigned_backchannel_application_name": "string",
      "verbose_name": "string",
      "verbose_name_plural": "string",
      "meta_model_name": "string"
    }
  ],
  "service_connection": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "service_connection_obj": {
    "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "local": true,
    "component": "string",
    "verbose_name": "string",
    "verbose_name_plural": "string",
    "meta_model_name": "string"
  },
  "refresh_interval_s": 0,
  "token_identifier": "string",
  "config": {},
  "managed": "string"
}

400

application/json

Schema

Schema

non_field_errorsstring[]

codestring

property name*any

Validation Error

Example (auto)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

{
  "detail": "string",
  "code": "string"
}

Authorization: http

name: authentiktype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "/api/v3/outposts/instances/:uuid/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"type\": \"proxy\",\n  \"providers\": [\n    0\n  ],\n  \"service_connection\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"config\": {},\n  \"managed\": \"string\"\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

Bearer Token

Parameters

uuid — pathrequired

Body

{
  "name": "string",
  "type": "proxy",
  "providers": [
    0
  ],
  "service_connection": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "config": {},
  "managed": "string"
}