Application Information

The Application Information API allows the user to request the application information and application health status.

Security

jwt-bearer-token

apiKey	API Key
Name	Authorization
In	header

Summary

Get the application's health status.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document

Responses

Code	Description	Schema
200	Success	app_info_get_response_1
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

Summary

Get application information.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document

Responses

Code	Description	Schema
200	Success	app_info_get_response_2
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

Field Name	Type	Description
`build`	string
`platformName`	string	The platform name
`platformVersion`	string	The platform version number
`serverTimestamp`	date/time	The server timestamp
`serverTimestampUTC`	date/time	The server timestamp in Coordinated Universal Time (UTC)

Field Name	Type	Description
`appCode`	string	The application code
`appName`	string	The application name
`appVersion`	string	The application version
`info`	string
`serverTimestamp`	date/time	The server timestamp
`serverTimestampUTC`	date/time	The server timestamp in Coordinated Universal Time (UTC)
`stage`	string
`appDeploymentRegion`	string	The region where the application is deployed
`statusCode`	string	The application status code
`statusMessage`	string	The application status message
`url`	string	The application URL