The endpoints are grouped by area of CodeSign Secure. Each page lists its endpoints with their parameters, an example request, and the responses. Error responses and headers shared by all endpoints are described in Request and Response Conventions.
| Area | Description |
|---|---|
| Signing | The Signing endpoints sign hashes and verify signatures, serve the PKCS#11 client channel, list client certificate and signing-user mappings, manage reproducible-build signing projects, and accept source code for analysis. |
| Signing Requests | The Signing Requests endpoints raise signing requests for approval, list the requests waiting for a decision, send and validate approvers’ verification codes, record approval decisions, and check an artifact before signing. |
| Certificates | The Certificates endpoints list, create, and update signing certificates and certificate signing requests, and change a certificate’s status and key usage. |
| Applications and Environments | The Applications and Environments endpoints manage applications, teams, and the certificates each team holds, and the environments and approval policies that decide whether signing needs approval. |
| User Management | The User Management endpoints list, create, get, and update users, and return the signed-in user. |
| Permissions | The Permissions endpoint lists the permissions granted to a role. |
| The Email endpoints manage mail server settings and notification templates. | |
| System Setup | The System Setup endpoints return appliance information and status, list and stop backups, issue client authentication certificates, manage the portal TLS certificate, configure Loki and Splunk log forwarding, and create support packages. |
| Reports | The Reports endpoints return and export the certificate, client, signing, and activity reports and the daily log, download the system log, and return the data behind the report graphs. |
| Dashboard | The Dashboard endpoints return the counts and health information shown on the dashboard. |
| License | The License endpoint returns the active licence. |