Skip to content

Latest commit

 

History

History
359 lines (183 loc) · 8.58 KB

AdminApi.md

File metadata and controls

359 lines (183 loc) · 8.58 KB
Raw

\AdminApi

All URIs are relative to http://localhost/api/v3

Method HTTP request Description
admin_apps_list GET /admin/apps/
admin_metrics_retrieve GET /admin/metrics/
admin_models_list GET /admin/models/
admin_settings_partial_update PATCH /admin/settings/
admin_settings_retrieve GET /admin/settings/
admin_settings_update PUT /admin/settings/
admin_system_create POST /admin/system/
admin_system_retrieve GET /admin/system/
admin_version_history_list GET /admin/version/history/
admin_version_history_retrieve GET /admin/version/history/{id}/
admin_version_retrieve GET /admin/version/
admin_workers_retrieve GET /admin/workers/

admin_apps_list

Vecmodels::App admin_apps_list()

Read-only view list all installed apps

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::App

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

admin_metrics_retrieve

models::LoginMetrics admin_metrics_retrieve()

Login Metrics per 1h

Parameters

This endpoint does not need any parameter.

Return type

models::LoginMetrics

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

admin_models_list

Vecmodels::App admin_models_list()

Read-only view list all installed models

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::App

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

admin_settings_partial_update

models::Settings admin_settings_partial_update(patched_settings_request)

Settings view

Parameters

Name Type Description Required Notes
patched_settings_request Option<PatchedSettingsRequest>

Return type

models::Settings

Authorization

authentik

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

admin_settings_retrieve

models::Settings admin_settings_retrieve()

Settings view

Parameters

This endpoint does not need any parameter.

Return type

models::Settings

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

admin_settings_update

models::Settings admin_settings_update(settings_request)

Settings view

Parameters

Name Type Description Required Notes
settings_request Option<SettingsRequest>

Return type

models::Settings

Authorization

authentik

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

admin_system_create

models::SystemInfo admin_system_create()

Get system information.

Parameters

This endpoint does not need any parameter.

Return type

models::SystemInfo

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

admin_system_retrieve

models::SystemInfo admin_system_retrieve()

Get system information.

Parameters

This endpoint does not need any parameter.

Return type

models::SystemInfo

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

admin_version_history_list

Vecmodels::VersionHistory admin_version_history_list(build, ordering, search, version)

VersionHistory Viewset

Parameters

Name Type Description Required Notes
build Option<String>
ordering Option<String> Which field to use when ordering the results.
search Option<String> A search term.
version Option<String>

Return type

Vecmodels::VersionHistory

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

admin_version_history_retrieve

models::VersionHistory admin_version_history_retrieve(id)

VersionHistory Viewset

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this Version history. [required]

Return type

models::VersionHistory

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

admin_version_retrieve

models::Version admin_version_retrieve()

Get running and latest version.

Parameters

This endpoint does not need any parameter.

Return type

models::Version

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

admin_workers_retrieve

models::Workers admin_workers_retrieve()

Get currently connected worker count.

Parameters

This endpoint does not need any parameter.

Return type

models::Workers

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]