> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trlyr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Health check



## OpenAPI

````yaml https://api.trlyr.com/auth/docs/doc.json get /auth/healthcheck
openapi: 3.1.0
info:
  description: >
    This API manages authentication, users, organisations, groups, permissions,
    and resource associations for the terralayr system. 
     
    Use the public endpoints to authenticate and obtain access tokens. Admin
    endpoints require a valid Bearer token and appropriate permissions. 
     
    ### Authorization 
     
    Public endpoints such as `/auth/public/authenticate` do not require an
    existing token. 
     
    To retrieve a valid token, authenticate with username and password: 
     
    ``` 

    POST https://api.trlyr.com/auth/public/authenticate 

    ``` 
     
    with the following JSON body: 
     
    ``` 

    { 
        "username": "YOUR_USERNAME", 
        "password": "YOUR_PASSWORD" 
    } 

    ``` 
     
    Your username and password are the ones you created after receiving an
    invitation to join your organisation. 
     
    You should receive a JSON response body from which you can extract your
    token under `access_token`. 
     
    If you have any questions, don't hesitate to contact our account manager at
    the following address: support@trlyr.com. 
  title: terralayr Auth API
  version: 1.0.0
servers:
  - description: Production API
    url: https://api.trlyr.com
  - description: Sandbox API
    url: https://api.sandbox.trlyr.com
security: []
tags:
  - name: auth
  - name: admin
externalDocs:
  description: ''
  url: ''
paths:
  /auth/healthcheck:
    get:
      tags:
        - auth
      summary: Health check
      responses:
        '200':
          description: OK

````