PEXA

PEXA Health Check API

The Health Check API from PEXA — 2 operation(s) for health check.

Documentation GitHub OpenAPI

Operations 2

GET /health Health Check #

GET /v2/health Health Check #

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/pexa:pexa-health-check-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: Pexa Health Check API
  version: '1.0'
  description: 'Operations tagged HealthCheck across 3 of this provider''s published API definitions: pexa-exchange-api-legacy-swagger.json, pexa-exchange-api-swagger.json, pexa-plus-marketplace-b2b-api-oas300-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://localhost/
- url: https://plus.pexa.com.au/api/plus/v1
  description: Product server
tags:
- name: Health Check
paths:
  /health:
    get:
      tags:
      - Health Check
      summary: Health Check
      description: This API verifies whether the application is up and running.
      operationId: HealthCheck
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
    servers:
    - url: https://localhost/
  /v2/health:
    get:
      tags:
      - Health Check
      summary: Health Check
      description: 'This API verifies whether the application is up and running.


        Scopes:

        au_pub_cert_pexa_healthcheck_api_v2_read (non-prod)

        au_pub_pexa_healthcheck_api_v2_read (prod)'
      operationId: getV2Health
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      x-operation-id-source: normalized
      x-operation-id-original: HealthCheck
components:
  parameters:
    SubscriberId:
      description: Subscriber id
      in: header
      name: X-Pexa-Subscriber-ID
      required: true
      schema:
        type: integer
        example: 12345
  schemas:
    Errors:
      description: List of errors related to the API
      type: object
      properties:
        errors:
          description: Errors returned by the service
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/Error'
    Error:
      description: Detailed error related to the API
      type: object
      properties:
        code:
          description: The error code
          type: string
          example: PL.TITSE.001
        message:
          description: Human-readable description of the error for debugging purposes
          type: string
          example: The land title reference provided is invalid for the jurisdiction.
        field:
          description: Name of the field provided in the original request (if any) that the error pertains to
          type: string
          example: landTitleReference
  responses:
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - code: '500001'
              message: An internal error has occurred
x-refined-from:
- pexa-exchange-api-legacy-swagger.json
- pexa-exchange-api-swagger.json
- pexa-plus-marketplace-b2b-api-oas300-openapi.yaml