Download OpenAPI specification:Download
| Main Tags | Most Popular Pages |
|---|---|
|
➤
Welcome
➤ Prerequisites ➤ Access Token ➤ Updates ➤ APIs Developer Guide ➤ Appendix |
➤
Authentication
➤ Service Plans ➤ Account Management ➤ Billing Management ➤ Access Control ➤ Operator Logs ➤ Advanced Reports |
The Dashboard is the default landing screen after login, providing a centralized view of key system information such as product details, license status, instance and host system data, administrator information, and database details.
Business applications can use this service API to get the dashboard's data.
| Authorization required | string Default: Bearer {access_token} The access token obtained as a result of first authenticating with a client certificate to receive a subject token, then exchange the subject token using the Token Exchange endpoint. The certificate must belong to a SigningHub Administrator authorized to perform this action. |
| Content-Type required | string Default: application/json |
| Accept required | string Default: application/json |
| x-forwarded-for | string Client IP address, typically set by reverse proxy or load balancer |
| Accept-Language | string Preferred language (e.g., en-US, ar-SA) |
{- "product": {
- "name": "string",
- "version": "string",
- "build": "string"
}, - "instance": {
- "start_time": "string"
}, - "database": {
- "name": "string",
- "port": "string",
- "user": "string",
- "provider": "string"
}, - "admin": {
- "login_time": "string",
- "name": "string",
- "email": "string"
}, - "host_system": {
- "host_address": "string",
- "os_name": "string"
}, - "license": {
- "company_name": "string",
- "type": "string",
- "renewal_period": "string",
- "expiry_date": "string",
- "company": {
- "address": "string",
- "email_address": "string",
- "fax_no": "string",
- "name": "string",
- "phone_no": "string"
}, - "product": {
- "name": "string",
- "version": "string"
}, - "modules": [
- {
- "count": "string",
- "name": "string",
- "status": "string",
- "sub_modules": [
- {
- "name": "string",
- "status": "string"
}
]
}
]
}
}