---
title: "Get this OpenAPI document"
method: GET
path: "/openapi.json"
---

# Get this OpenAPI document

`GET /openapi.json`

## Request

- Base URL: `https://app.yoping.me/api/v1`
- URL: `https://app.yoping.me/api/v1/openapi.json`
- Auth: none required

Returns this OpenAPI 3.1 specification as JSON. No authentication required.

## Response `200`

The OpenAPI document.

- object

## Other responses

- `429`: Too many requests (code `rate_limited`). A global per-IP budget of 300 requests/minute (burst 60) applies to every endpoint; login, signup, and test alerts have tighter dedicated limits.

---

[API](https://skmtc.dev/yoping/apis/yopingme-api.md) · [All operations](https://skmtc.dev/yoping/apis/yopingme-api/llms.txt) · [OpenAPI document](https://skmtc.dev/yoping/apis/yopingme-api/revisions/76d8deb40173?raw)