> For the complete documentation index, see [llms.txt](https://docs.decentraland.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.decentraland.org/apis/apis/auth-server/health.md).

# Health

Health check endpoints for monitoring and orchestration

## Readiness probe

> Returns 200 when service is ready to accept traffic

```json
{"openapi":"3.1.0","info":{"title":"Auth Server API","version":"1.0.0"},"tags":[{"name":"Health","description":"Health check endpoints for monitoring and orchestration"}],"servers":[{"url":"https://auth-api.decentraland.org","description":"Production server"},{"url":"https://auth-api.decentraland.zone","description":"Development server"},{"url":"http://localhost:{port}","description":"Local development server (replace {port} with your local port, typically 3000)","variables":{"port":{"default":"3000","description":"Local development server port"}}}],"security":[],"paths":{"/health/ready":{"get":{"tags":["Health"],"summary":"Readiness probe","description":"Returns 200 when service is ready to accept traffic","operationId":"getReadiness","responses":{"200":{"description":"Service is ready"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing what went wrong"}},"required":["error"]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing what went wrong"}},"required":["error"]}}}}}}}}}
```

## Startup probe

> Returns 200 when service has started

```json
{"openapi":"3.1.0","info":{"title":"Auth Server API","version":"1.0.0"},"tags":[{"name":"Health","description":"Health check endpoints for monitoring and orchestration"}],"servers":[{"url":"https://auth-api.decentraland.org","description":"Production server"},{"url":"https://auth-api.decentraland.zone","description":"Development server"},{"url":"http://localhost:{port}","description":"Local development server (replace {port} with your local port, typically 3000)","variables":{"port":{"default":"3000","description":"Local development server port"}}}],"security":[],"paths":{"/health/startup":{"get":{"tags":["Health"],"summary":"Startup probe","description":"Returns 200 when service has started","operationId":"getStartup","responses":{"200":{"description":"Service has started"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing what went wrong"}},"required":["error"]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing what went wrong"}},"required":["error"]}}}}}}}}}
```

## Liveness probe

> Returns 200 when service is alive

```json
{"openapi":"3.1.0","info":{"title":"Auth Server API","version":"1.0.0"},"tags":[{"name":"Health","description":"Health check endpoints for monitoring and orchestration"}],"servers":[{"url":"https://auth-api.decentraland.org","description":"Production server"},{"url":"https://auth-api.decentraland.zone","description":"Development server"},{"url":"http://localhost:{port}","description":"Local development server (replace {port} with your local port, typically 3000)","variables":{"port":{"default":"3000","description":"Local development server port"}}}],"security":[],"paths":{"/health/live":{"get":{"tags":["Health"],"summary":"Liveness probe","description":"Returns 200 when service is alive","operationId":"getLiveness","responses":{"200":{"description":"Service is alive","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"number","description":"Server timestamp in milliseconds"}},"required":["timestamp"]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing what went wrong"}},"required":["error"]}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing what went wrong"}},"required":["error"]}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.decentraland.org/apis/apis/auth-server/health.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.