---
title: "Get the API index"
method: GET
path: "/"
tags: ["Discovery"]
---

# Get the API index

`GET /`

## Request

- Base URL: `https://zephior.com/api/v1`
- URL: `https://zephior.com/api/v1/`
- Auth: none required

Returns the current public API version, status, authentication policy and canonical endpoint links.

## Response `200`

API index

- ApiIndex
  - `name` string, required
  - `version` string, required
  - `status` 'operational', required
  - `authentication` 'none', required
  - `readOnly` true, required
  - `endpoints` object, required
  - `documentation` string, uri
  - `openapi` string, uri, required
  - `versioningPolicy` string, uri

## Other responses

- `429`: Public API rate limit exceeded.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/zephior/apis/zephior-public-discovery-api.md) · [All operations](https://skmtc.dev/zephior/apis/zephior-public-discovery-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zephior/apis/zephior-public-discovery-api/revisions/3d7585b2bd5a?raw)