Files
authentik/website/docs/developer-docs/api/reference/admin-version-retrieve.api.mdx
Tana M Berry 7a6d44d0df first pass
2024-10-22 15:10:13 -05:00

348 lines
13 KiB
Plaintext

---
id: admin-version-retrieve
title: "admin_version_retrieve"
description: "Get running and latest version."
sidebar_label: "admin_version_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVcFu2zAM/RVDl12MuEh7GHpaUQRFgHUr0K6XoghkmYnVyJIrydmCwP8+UnYctUm6rugpikzyvUdS5IaZGiz30uhpwc4ZLyqpZyuwDm9mFryVsAKWsgKcsLImQzS7Ap/YRmupFwnXRaK4B+eT3m+E9p4vHDt/6AKyx5Q5EI2Vfo2XG8YbX4L2con/Hlv8asHVRjtAnw0bn5zQjzDaoxEdeV0rKQLN7MkRhQ1zooSK08mva0BSJn8C4T/AtbaUBC879K14pGt7+B7AYTb04iBAb7yNykgRL35qhXq9baBNh7gd/vvCvuSazK2pEsFR+L8BZiuuZBHB5MYo4HoP57IEsUzk/DWYdEkX4gBU3khVzEruyvfpCPYJ2aeEFEFoM6g0NrGAFB0cxDSNL9DwvyT9hi8Whupjz70SeQSnNpi/j+BxvU56fxK3DZGh8oQPsivpKu5FuY/e0s1zIy3BPsRpjvQfoJjude1evx3pD3x7XnpF6u77nLRE46VAhjdnn/oq7wk9uCYTa43de4Yamc4loH6g7y4Kya3la3SQHiq334BEX5gCDn/hRSEJlqubGK+N8jBQ65gdzcfpp04pDVaK5OJmeiQhBXgu1QFRb6mNu6kPEFW8B31DJl5V4EtDu2EBRLvmHh89y8Jgz/qeyhgNeEv/wnxvrAo2tcxWpxlro/l/SwnpFEVbYOBeel9TsGBFTw64BRuISD03wbJnv3Mfehtvxyfjs9HX0Xgvw9d8GVZA79XVKXGyqhXQFqBCchEKiRWjTLMSlDLfFmZAGklD+cYqAy6r0KY80Lye3mGITjZJcOdZtpC+bPKRMFUWhch2p1yZPEMonX2fXk5+3E6CTHrZFddR8JDqYXocW8pRK75nP3fp9vDHZ7VCDqQr8N/0Jd7u7l1yU0bNUxraXg9ss8lxVP+yqm3p+rkBS8sdjytuJc+pRrjc0QFnHJaQ+mIJaMIuhIA6TCSumiDw9cOhhhn67mpCuaW0xaO464t0e6Do2/Gg11FspBks7swSNFJNexKe/iMQtv1fAkAolA==
sidebar_class_name: "get api-method"
info_path: docs/developer-docs/api/reference/authentik
custom_edit_url: null
hide_send_button: true
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"admin_version_retrieve"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/admin/version/"}
>
</MethodEndpoint>
Get running and latest version.
<div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
>
<div>
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"version_current"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Get current version","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"version_latest"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Get latest version from cache","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"version_latest_valid"}
required={true}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"Check if latest version is valid","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"build_hash"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","description":"Get build hash, if version is not latest or released","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"outdated"}
required={true}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"Check if we're running the latest version","readOnly":true}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"outpost_outdated"}
required={true}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean","description":"Check if any outpost is outdated/has a version mismatch","readOnly":true}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"version_current\": \"string\",\n \"version_latest\": \"string\",\n \"version_latest_valid\": true,\n \"build_hash\": \"string\",\n \"outdated\": true,\n \"outpost_outdated\": true\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"400"}
value={"400"}
>
<div>
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"non_field_errors"}
required={false}
schemaName={"string[]"}
qualifierMessage={undefined}
schema={{"type":"array","items":{"type":"string"}}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"code"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
name={"property name*"}
required={false}
schemaName={"any"}
qualifierMessage={undefined}
schema={{"type":"object","description":"Validation Error","properties":{"non_field_errors":{"type":"array","items":{"type":"string"}},"code":{"type":"string"}},"additionalProperties":{},"title":"ValidationError"}}
collapsible={false}
discriminator={false}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"non_field_errors\": [\n \"string\"\n ],\n \"code\": \"string\"\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"403"}
value={"403"}
>
<div>
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"detail"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"code"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"detail\": \"string\",\n \"code\": \"string\"\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>