Get Status


About
- Using this API, you’ll be able to check the health of any API that you're using.
- This API takes in
api_id
which obtained as x-api-id response header from actual Compliance API and gives healthstatus
.
What does checking the Health of an API mean?
- The health of an API can tell you if the API you intend to use is functional or not.
Endpoint
HTTP Method | Resource | Description |
---|---|---|
| /health | API takes |
Query Parameters
Param | Type | Description | Example |
---|---|---|---|
api_id |
| API ID obtained as x-api-id response header from API. | API ID : NjluYzB2dnJiMDpqaTJ5ZmM6R0VU for GST Compliance : Public : Search GSTIN API |
Response
Param | Type | Description | Example |
---|---|---|---|
status |
| API Health status. Possible values : | healthy |
Updated about 2 months ago
Did this page help you?