Documentation Powered by Redocly

SigningHub Admin API Guide

Download OpenAPI specification:Download

Welcome

Welcome to SigningHub, a high trust digital signing solution for all your paperless business transactions. It is ideal for those organisations that recognise the value of using cryptographic digital signatures to protect their users and their documents against unauthorised or accidental or fraudulent changes.
Browse through the API content by selecting the relevant pages from the left panel. To quickly find specific web service information, enter search criteria in the search box on top left.

More about SigningHub
To know more about SigningHub, explore the following links:
  • Go to  SigningHub Knowledge Base to view all the relevant information of SigningHub.
  • Visit the Ascertia Community Portal to find answers to contact SigningHub support staff through the  Live Chat provision .  Our support staff may be occupied with other priority tasks so live chat is offered on an "as available" basis. 
Intended Readership
This guide is intended for developers who will integrate SigningHub into their respective web applications using the RESTful web services, and user interface offered by SigningHub. It is assumed that the reader has a basic knowledge of REST, Java, C#, HTML, JavaScript, HTTP and TLS/SSL. There is no Software Developers Kit (SDK) for the integration, instead the integration uses HTML Forms and JSON so that integration is simple from any language including .Net, Java, PHP etc.

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

Operator Alerts

The Operator Alerts Module enables operators to monitor system-generated alerts related to their activities and permissions. It provides access to alerts such as rate limiting violations and other critical system events, with support for pagination and advanced search filtering to efficiently track and manage operational issues.

Get System Alerts

Retrieves system alerts with pagination and advanced search filtering. Operators can view rate limiting violations and other system alerts based on their role permissions.

path Parameters
page
required
integer <int32>

Page number (1-based). Examples: 1, 2, 10. Optional - if not provided, only counts are returned.

records
required
integer <int32>

Records per page. Examples: 10, 20, 50, 100. Optional - if not provided, only counts are returned.

query Parameters
name
string

Filter by alert name. Example: "Rate Limit Exceeded"

sort-by
string (AdminEnumerations.OperatorAlertSortBy)
Enum: "CREATED_ON" "NAME" "SEVERITY" "POLICY" "IP_ADDRESS" "SERVICE_NAME" "ENDPOINT"

Sort criteria. Available options: CREATED_ON (default), NAME, SEVERITY, POLICY, IP_ADDRESS, SERVICE_NAME, ENDPOINT

asc
boolean

Sort ascending (true) or descending (false). Default: false

ip-address
string

Filter by IP address. Examples: "192.168.1.1", "10.0.0.5"

severity
string

Filter by severity level. Options: "Critical" or "1" (immediate attention), "High" or "2" (high priority), "Medium" or "3" (moderate priority), "Low" or "4" (low priority), "Info" or "5" (informational). Example: "High"

policy
string

Filter by rate limiting policy. Examples: "GLOBAL_POLICY", "IP_CONCURRENCY_POLICY", "SENSITIVE_ENDPOINT_POLICY"

service-name
string

Filter by service name. Examples: "Web API", "Admin API"

end-point
string

Filter by endpoint path. Examples: "/api/v1/users", "/api/documents"

date-from
string <date-time>

Filter alerts created on or after this date (ISO 8601 format). Examples: "2024-01-01T00:00:00Z", "2024-03-15"

date-to
string <date-time>

Filter alerts created on or before this date (ISO 8601 format). Examples: "2024-12-31T23:59:59Z", "2024-03-20"

header Parameters
x-search-text
string

Base64 encoded search text for general searching across all fields (from x-search-text header). Example: "MTkyLjE2OC4xLjE=" for "192.168.1.1"

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)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get System Alert

Retrieves a specific system alert by its ID with full details.

path Parameters
id
required
integer <int64>

Alert ID

header Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "policy": "string",
  • "endpoint": "string",
  • "service_name": "string",
  • "detail": "string",
  • "ip_address": "string",
  • "response_code": "string",
  • "is_seen": true,
  • "severity": "string",
  • "created_by": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "lastModified_by": "string",
  • "lastModified_on": "2019-08-24T14:15:22Z",
  • "suppressed_count": 0
}

Mark System Alerts as Read

Marks one or more system alerts as seen/read by the operator.

header Parameters
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)

Request Body schema: application/json

Request containing alert IDs to mark as seen

AlertIds
Array of integers or null <int64>

List of alert IDs to mark as read

Responses

Request samples

Content type
application/json
{
  • "AlertIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string"
}