/

/Template API

Changes Docs Sign in

Docs
History
Schema

Filter operations

AccountEndpointModule8

ApiKeyEndpointModule11

DocumentSearchEndpointModule1

ExternalAuthEndpointModule1

InvitationEndpointModule6

local-only4

OrganizationEndpointModule10

TeamEndpointModule8

Template.Api9

get/api/v1/auth/capabilities
get/api/v1/auth/session
get/api/v1/auth/csrf
post/api/v1/auth/logout
get/api/v1/system/statusReturns API status and echoes a validated optional value.
get/api/v1/system/authenticatedConfirms that cookie authentication and authorization succeeded.
get/api/healthReports whether the API is ready to receive traffic.
get/api/health/liveReports whether the API process can answer requests.
get/api/health/readyReports whether the API is ready to receive traffic.

Template.Api

Reports whether the API is ready to receive traffic.

get/api/health/ready

Request

The document declares no server URL.
Auth: none declared

Response

OK

Changes