find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/backresto-com:backresto-com-health-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Backresto Com Health API
  version: '1.0'
  contact:
    name: BackResto
    url: https://developers.backresto.com/en/docs/support
    email: contact@backresto.com
  description: 'Operations tagged Health across 2 of this provider''s published API definitions: api_backresto.json, backresto-com-api-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Health
paths:
  /health/live:
    get:
      operationId: HealthController_getLiveness
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - ok
                required:
                - status
                additionalProperties: false
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: Unexpected server error.
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: A required dependency is unavailable.
      tags:
      - Health
      summary: Liveness probe
      description: Answers 200 while the process runs. No authentication.
  /health/ready:
    get:
      operationId: HealthController_getReadiness
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - ok
                required:
                - status
                additionalProperties: false
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: Unexpected server error.
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: A required dependency is unavailable.
      tags:
      - Health
      summary: Readiness probe
      description: Answers 200 when the database is reachable and 503 when it is not. No authentication.
  /health/version:
    get:
      operationId: HealthController_getVersion
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  environment:
                    type: string
                    enum:
                    - dev
                    - preprod
                    - main
                  imageDigest:
                    type: string
                    pattern: ^sha256:[a-f0-9]{64}$
                  migrationDigest:
                    type: string
                    pattern: ^[a-f0-9]{64}$
                  releaseId:
                    type: string
                    pattern: ^[a-f0-9]{64}$
                required:
                - environment
                - imageDigest
                - migrationDigest
                - releaseId
                additionalProperties: false
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: Unexpected server error.
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: A required dependency is unavailable.
      tags:
      - Health
      summary: Deployed release
      description: The release fingerprint, commit and environment serving the request. No authentication.
components:
  schemas:
    Problem:
      description: RFC 9457 problem details.
      properties:
        code:
          description: Machine-readable reason, on mobile ingestion routes only.
          type: string
        detail:
          type: string
        instance:
          description: The request path.
          type: string
        requestId:
          description: Echoes X-Request-ID; quote it to support.
          type: string
        status:
          type: integer
        title:
          type: string
        type:
          description: Stable URI naming the problem, e.g. https://api.backresto.com/problems/not-found.
          format: uri
          type: string
      required:
      - type
      - title
      - status
      - detail
      - instance
      - requestId
      type: object
x-refined-from:
- api_backresto.json
- backresto-com-api-openapi.json