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

# Readiness

> Returns 503 while draining, so a rolling deploy stops sending traffic before the process exits.



## OpenAPI

````yaml /api-reference/auth.json get /readyz
openapi: 3.1.0
info:
  title: truscan auth
  version: 1.0.0
  description: >-
    Identity: accounts, sessions, password resets and API keys.


    This is the only service that verifies a credential, because it is the
    service that issues them. Every other service decodes the identity the edge
    already verified.


    Protected routes accept either credential, a dashboard session JWT or an
    `tru_` API key, on the same path. There is no key-only variant of any route.
servers:
  - url: https://api.truscan.co
    description: Production
security: []
tags:
  - name: session
    description: Sign up, sign in, password reset
  - name: keys
    description: API key management
paths:
  /readyz:
    get:
      tags:
        - session
      summary: Readiness
      description: >-
        Returns 503 while draining, so a rolling deploy stops sending traffic
        before the process exits.
      responses:
        '200':
          description: Serving.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
        '503':
          description: Draining.
components:
  schemas:
    Health:
      type: object
      properties:
        status:
          type: string
          examples:
            - ok
        service:
          type: string
          examples:
            - auth
        time:
          type: string
          format: date-time

````