Skip to main content

outposts_proxy_list

GET 
/api/v3//outposts/proxy/

ProxyProvider Viewset

Request​

Query Parameters

    name 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.

    search string

    A search term.

Responses​

Schema
    pagination objectrequired
    nextnumberrequired
    previousnumberrequired
    countnumberrequired
    currentnumberrequired
    total_pagesnumberrequired
    start_indexnumberrequired
    end_indexnumberrequired
    results object[]required
  • Array [
    • pkID (integer)required
    namestringrequired
    internal_hosturi
    external_hosturirequired
    internal_host_ssl_validationboolean

    Validate SSL Certificates of upstream servers

    client_idstring

    Possible values: <= 255 characters

    client_secretstring

    Possible values: <= 255 characters

    oidc_configuration object

    rest_framework Serializer for OIDC Configuration

    issuerstringrequired
    authorization_endpointstringrequired
    token_endpointstringrequired
    userinfo_endpointstringrequired
    end_session_endpointstringrequired
    introspection_endpointstringrequired
    jwks_uristringrequired
    response_types_supportedstring[]required
    id_token_signing_alg_values_supportedstring[]required
    subject_types_supportedstring[]required
    token_endpoint_auth_methods_supportedstring[]required
    cookie_secretstring
    certificateuuidnullable
    skip_path_regexstring

    Regular expressions for which authentication is not required. Each new line is interpreted as a new Regular Expression.

    basic_auth_enabledSet HTTP-Basic Authentication (boolean)

    Set a custom HTTP-Basic Authentication header based on values from authentik.

    basic_auth_password_attributeHTTP-Basic Password Key (string)

    User/Group Attribute used for the password part of the HTTP-Basic Header.

    basic_auth_user_attributeHTTP-Basic Username Key (string)

    User/Group Attribute used for the user part of the HTTP-Basic Header. If not set, the user's Email address is used.

    modeProxyMode (string)

    Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.

    Possible values: [proxy, forward_single, forward_domain]

    cookie_domainstring
    access_token_validitydoublenullablerequired

    Get token validity as second count

    intercept_header_authboolean

    When enabled, this provider will intercept the authorization header and authenticate requests based on its value.

    scopes_to_requeststring[]required

    Get all the scope names the outpost should request, including custom-defined ones

    assigned_application_slugstringrequired

    Internal application name, used in URLs.

    assigned_application_namestringrequired

    Application's display Name.

  • ]

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/api/v3/outposts/proxy/");
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
Parameters
— query
— query
— query
— query
— query