Skip to main content

outposts_instances_create

POST 
/api/v3//outposts/instances/

Outpost Viewset

Request​

Bodyrequired

    namestringrequired

    Possible values: non-empty

    typeOutpostTypeEnum (string)required

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

    providersinteger[]required
    service_connectionuuidnullable

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

    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.

    Possible values: non-empty

Responses​

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.

Authorization: http

name: authentiktype: httpscheme: bearer

Request Collapse all
Base URL
/api/v3
Auth
Body required
{
  "name": "string",
  "type": "proxy",
  "providers": [
    0
  ],
  "service_connection": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "config": {},
  "managed": "string"
}