They are services used to check whether the Managerial APIs are working or not.


1.Healthcheck API

Description/Purpose: It is used to check whether the sevice is operational or not.

Permission: No authorization is required to access this endpoint.

Endpoint: https://<management_app_url>/apiops/test/healthcheck

HTTP Method: GET

Request Headers: 

HeaderValue
Accepttext/plain


Request Body: (none)

Response:

StatusStatus CodeDescriptionBodyHeaders
Success200

successful operation

OK

Content-Type: text/plain;charset=UTF-8

2.Secure Test API

Description/Purpose: It is used to verify whether the service is functioning with the token. After successful access, it returns the result as Hello {name}.

Permission: The Apinizer management console can be accessed using the token of any user who can log in.

Endpoint: https://<management_app_url>/apiops/test/hello/{name}

HTTP Method: GET

Request Headers: 

HeaderValue
Authorization

< Access Token >

Tokens are required to access this endpoint.

For detailed information on how to get tokens, ou can visit the Authentication page.

Accepttext/plain


Request Body: (none)

Response:

StatusStatus CodeDescriptionBodyHeaders
Success200

successful operation

Hello <name>

Content-Type: text/plain;charset=UTF-8
Error401unauthorized

{

"status":"FAILURE",

"resultMessage":"Token can not be validated!"

}

Content-Type: application/json