Get Status

Overview
- API takes
api_id
and gives backstatus
of the API
Problem
- You wish to monitor the health of the Sandbox API you are using.
- The health of an API can tell you if the API you intend to use is functional or not.
Solution
- You’ll be able to check the health of any API that you're using by simply entering the API ID.
How to Obtain API ID?
The ID can be obtained from the
x-api-id
response header of the API
Endpoint
HTTP Method | Resource |
---|---|
GET | /health |
Request
The API only requires ID in its query parameter.
Query Parameters
Param | Type | Example |
---|---|---|
api_id (Search GSTIN API) | string (required) | NjluYzB2dnJiMDpqaTJ5ZmM6R0VU |
Once the values are added, Your curl will look something like this
curl --request GET \
--url 'https://api.sandbox.co.in/health?api_id=NjluYzB2dnJiMDpqaTJ5ZmM6R0VU' \
--header 'Accept: application/json' \
--header 'Authorization: xxxxxxxxxxxxxx' \
--header 'x-api-key: xxxxxxxxxxxxxxx' \
--header 'x-api-version: 1.0'
Response
Param | Type | Description | Example |
---|---|---|---|
status | string | API Health status. Possible values : healthy , unhealthy | healthy |
Updated about 1 month ago