outposts_instances_list

GET 
/api/v3//outposts/instances/

Outpost Viewset

Request

Query Parameters

managed__icontains string
managed__iexact string
name__icontains string
name__iexact string
ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

page_size integer

Number of results to return per page.

providers__isnull boolean
providers_by_pk integer[]
search string

A search term.

service_connection__name__icontains string
service_connection__name__iexact string

Responses

200

application/json

Schema

Schema

pagination

object

required

next numberrequired

previous numberrequired

count numberrequired

current numberrequired

total_pages numberrequired

start_index numberrequired

end_index numberrequired

results

object[]

required

Array [

pk uuidrequired

name stringrequired

type OutpostTypeEnum (string)required

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

providers integer[]required

providers_obj

object[]

required

Array [

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.

invalidation_flow uuidrequired

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

]

service_connection uuidnullable

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

service_connection_obj

object

required

ServiceConnection Serializer

pk uuidrequired

name stringrequired

local boolean

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

component stringrequired

Return component used to edit this object

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

refresh_interval_s integerrequired

token_identifier stringrequired

Get Token identifier

config

object

required

property name* any

managed Managed 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 (from schema)

{
  "pagination": {
    "next": 0,
    "previous": 0,
    "count": 0,
    "current": 0,
    "total_pages": 0,
    "start_index": 0,
    "end_index": 0
  },
  "results": [
    {
      "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",
      "refresh_interval_s": 0,
      "token_identifier": "string",
      "config": {},
      "managed": "string"
    }
  ]
}

400

application/json

Schema

Schema

non_field_errors string[]
code string
property name* any

Validation Error

Example (from schema)

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

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

{
  "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.Get, "/api/v3/outposts/instances/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
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

managed__icontains — query

managed__iexact — query

name__icontains — query

name__iexact — query

ordering — query

page — query

page_size — query

providers__isnull — query

---truefalse

providers_by_pk — query

search — query

service_connection__name__icontains — query

service_connection__name__iexact — query