TabaPay Health API
The Health API from TabaPay — 2 operation(s) for health.
OpenAPI Specification
openapi: 3.0.0
info:
title: TabaPay APIs 3D Secure Health API
description: TabaPay Resource and Service Operations
version: 1.0.0
license:
name: All rights reserved
servers:
- url: https://{FQDN}:{PORT}
description: TabaPay APIs
variables:
FQDN:
default: FQDN
description: Contact [TabaPay Support](https://tabapay.zendesk.com/hc/en-us/requests/new) for the Fully Qualified Domain Name you should be using.
PORT:
default: PORT
description: Ensure you have the capability to access the PORT TabaPay specifies in your credentials file.
security:
- bearerAuth: []
tags:
- name: Health
paths:
/health:
get:
operationId: HealthController_check
parameters: []
responses:
'200':
description: The Health Check is successful
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: ok
info:
type: object
example:
database:
status: up
additionalProperties:
type: object
required:
- status
properties:
status:
type: string
additionalProperties: true
nullable: true
error:
type: object
example: {}
additionalProperties:
type: object
required:
- status
properties:
status:
type: string
additionalProperties: true
nullable: true
details:
type: object
example:
database:
status: up
additionalProperties:
type: object
required:
- status
properties:
status:
type: string
additionalProperties: true
'503':
description: The Health Check is not successful
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: error
info:
type: object
example:
database:
status: up
additionalProperties:
type: object
required:
- status
properties:
status:
type: string
additionalProperties: true
nullable: true
error:
type: object
example:
redis:
status: down
message: Could not connect
additionalProperties:
type: object
required:
- status
properties:
status:
type: string
additionalProperties: true
nullable: true
details:
type: object
example:
database:
status: up
redis:
status: down
message: Could not connect
additionalProperties:
type: object
required:
- status
properties:
status:
type: string
additionalProperties: true
summary: Health check
tags:
- Health
/health/live:
get:
operationId: HealthController_live
parameters: []
responses:
'200':
description: ''
summary: Liveness check
tags:
- Health
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
custom-header:
type: apiKey
name: Authorization
in: header