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 health status.

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

GET

/health

API takes api_id and gives back status of the API

API EndpointAPI Endpoint

Query Parameters

Param

Type

Description

Example

api_id

string (required)

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

string

API Health status. Possible values : healthy, unhealthy

healthy


Did this page help you?