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

303 lines
10 KiB
Plaintext

---
id: admin-workers-retrieve
title: "admin_workers_retrieve"
description: "Get currently connected worker count."
sidebar_label: "admin_workers_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVE1v2zAM/SuGzkFUpD0MPa0YgiLAOhRotx2GIpBtNlYjS6pEZwsM//eRstNo/cKA7WRZ4sfj4yN74TwEhdrZVS3Ohapbbdc/XdhCiOsAGDTsQMxEDbEK2rMhmV0CFlUXAlg0+6Jy1kKFUBejI110FufkhWoTxfmPMay4m4kI5KZxT5e9UB02FEFv6e9uoNcA0TsbgXx6sTg54Q8FRzLio/Le6CqBlQ+RgfQiVg20ik+490DQXPlAWCi3D1wa6jFagpSZaYq6gSCGgdM+djpAzUhHO8KCGg0bfh+5IMPhOQuCbs7+EeWfEb8po+vkWixDcOFFGdbZ9b0GU6+B32MWUoWg9uSgEdr8PlIP7SYVWrkaXn9Rda05rTLXeb7hyMMR2ojsTT5O/yMfl2Ah6Kq4uF69QUgNqLR5paj3qs0bPgXIOj4lfadMumoBG8cTs4EkNoUN/cgkdDnNjxQs+LBj+bDeu2CSjddydyrFkM3DDRMyVpRNxRP2BtFzsGRF/yWoMIlX23uXLCf0R/eZ4Mwj5sXJ4mz+Yb54wfCV2hIrxcFr7FMRdesN8ARzI1WVGkkdY6ZFA8a4jxv3lGmuHfNNXQYa3iRTlWBerW4pxFg2lxDPpdxobLpyXrlWZiHk8VQaV0pKZeXn1afll5tlKtO7iK2yWfBE9bRxYvHWqsqk+PdbayQd4RdKbwgJV5eq6KdGHzbaTEz56cQSagglv/Z9qSJ8DWYY+Pqxg8Arj447FbQquVO08sgBVE2NZHVsgUzERVWBZ0XtlOlSmc/Hh2XzpL7LJTPM5GVqmdQxOxw4+mFJ2H0Wm2Ami1u3BUtQZxMI5H9KROL/DfWKHtA=
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_workers_retrieve"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/admin/workers/"}
>
</MethodEndpoint>
Get currently connected worker count.
<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={"count"}
required={true}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"count\": 0\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>