Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Asobeast Com Health API
x-refined-note:
- x-authored-by differs across the merged source definitions and was not carried
- x-engine differs across the merged source definitions and was not carried
- x-evidence-tiers differs across the merged source definitions and was not carried
- x-generated differs across the merged source definitions and was not carried
- x-generated-from differs across the merged source definitions and was not carried
- x-generator differs across the merged source definitions and was not carried
- x-provenance differs across the merged source definitions and was not carried
- x-sources differs across the merged source definitions and was not carried
version: '1.0'
description: 'Operations tagged Health across 2 of this provider''s published API definitions: asobeast-com-openapi-generated.yml, asobeast-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:3000/api/backend
description: Web origin proxy
- url: http://localhost:4000
description: Direct API
tags:
- name: Health
paths:
/api/health:
get:
operationId: get_api_health
tags:
- Health
summary: GET /api/health
x-source: https://docs.asobeast.com/operations/restore.md
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: code-example
language: curl
snippet: curl --fail --silent --show-error http://127.0.0.1:3001/api/health
security:
- bearer: []
/health:
get:
operationId: HealthController_check
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
'503':
description: The database cannot be reached. The body is the error envelope with status, db, redis and pipeline added, and Retry-After says when to try again
summary: Liveness, database and pipeline health check
tags:
- Health
security:
- personalApiToken: []
servers:
- url: http://localhost:3000/api/backend
description: Web origin proxy
- url: http://localhost:4000
description: Direct API
components:
securitySchemes:
bearer:
type: http
scheme: bearer
personalApiToken:
scheme: bearer
bearerFormat: asob
type: http
x-refined-from:
- asobeast-com-openapi-generated.yml
- asobeast-com-openapi.json