Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Authlete Lifecycle API
description: Welcome to the **Authlete API documentation**.
version: 3.0.16
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- description: 🇺🇸 US Cluster
url: https://us.authlete.com
- description: 🇯🇵 Japan Cluster
url: https://jp.authlete.com
- description: 🇪🇺 Europe Cluster
url: https://eu.authlete.com
- description: 🇧🇷 Brazil Cluster
url: https://br.authlete.com
security:
- bearer: []
tags:
- name: Lifecycle
paths:
/api/lifecycle/healthcheck:
get:
summary: Health Check
security: []
description: Perform a health check of the server.
parameters:
- in: query
name: extended
description: 'If `true`, perform extended health checks (e.g. database connectivity).
'
required: false
schema:
type: boolean
responses:
'200':
description: OK
content:
text/plain:
schema:
type: string
example: OK
'500':
description: Internal Server Error
content:
text/plain:
schema:
type: string
tags:
- Lifecycle
operationId: getApiLifecycleHealthcheck
x-operation-id-source: derived
components:
securitySchemes:
bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Authenticate every request with a **Service Access Token** or **Organization Token**.
Set the token value in the `Authorization: Bearer <token>` header.
**Service Access Token**: Scoped to a single service. Use when automating service-level configuration or runtime flows.
**Organization Token**: Scoped to the organization; inherits permissions across services. Use for org-wide automation or when managing multiple services programmatically.
Both token types are issued by the Authlete console or provisioning APIs.
'