Resourcly health API

The health API from Resourcly — 3 operation(s) for health.

Operations 3

GET /health Liveness probe
GET /ready Readiness probe
GET /ready/detailed Detailed readiness probe with pool stats

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/resourcly-health-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

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

OpenAPI Specification

resourcly-health-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: API for document processing, item similarity search, and analytics.
  title: Resourcly analytics Health API
  termsOfService: https://resourcly.com/terms
  contact:
    name: API Support
    email: support@resourcly.com
  license:
    name: Proprietary
  version: 1.0.0
servers:
- url: https://api.resourcly.com/v1
tags:
- name: health
paths:
  /health:
    get:
      description: Returns OK if the service is alive
      tags:
      - health
      summary: Liveness probe
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.HealthResponse'
  /ready:
    get:
      description: Returns service readiness status including database connectivity
      tags:
      - health
      summary: Readiness probe
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ReadyResponse'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.ReadyResponse'
  /ready/detailed:
    get:
      description: Returns service readiness status including database pool statistics for observability
      tags:
      - health
      summary: Detailed readiness probe with pool stats
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.DetailedReadyResponse'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.DetailedReadyResponse'
components:
  schemas:
    handlers.DetailedReadyResponse:
      type: object
      properties:
        pool_stats:
          $ref: '#/components/schemas/handlers.PoolStats'
        services:
          type: object
          additionalProperties:
            type: string
        status:
          type: string
    handlers.ReadyResponse:
      type: object
      properties:
        services:
          type: object
          additionalProperties:
            type: string
        status:
          type: string
    handlers.HealthResponse:
      type: object
      properties:
        status:
          type: string
        version:
          type: string
    handlers.PoolStats:
      type: object
      properties:
        acquired_conns:
          type: integer
        backpressure:
          description: '"normal", "warning", "active"'
          type: string
        idle_conns:
          type: integer
        max_conns:
          type: integer
        total_conns:
          type: integer
        usage_percent:
          type: number
  securitySchemes:
    BearerAuth:
      description: 'Firebase JWT token. Format: "Bearer {token}"'
      type: apiKey
      name: Authorization
      in: header