- Overview
- Reference Guide
- Setup & Architecture
- Release Notes
- API Reference
-
Integration Guides
-
Signing Capabilities
- Supported Formats and Platforms
- Timestamping
- Windows Signing - SignTool
- Apple Signing
- AppX & MSIX Signing
- Visual Studio ClickOnce
- Jar Signing
- Sign HLK/HCK using CodeSign Secure
- NuGet Signing
- Mage Signing
- Sign OVA/OVF using Encryption Consulting’s Utility Tool
- Utility Tool for code signing
- Container Signing
- PKCS11 Wrapper
- Reproducible Build
- CI/CD Integration
-
Signing Capabilities
Getting Started
Use the CodeSign Secure REST API to automate signing-related tasks. This page covers the basics and a first request; the Swagger page on your server lists every endpoint for your version.
Basics
| Item | Value |
|---|---|
| Base URL | https://<your domain>/api/ |
| Transport | HTTPS on TCP 443 by default. The port can be changed to another HTTPS port, such as 8443. |
| Format | JSON requests and responses (Content-Type: application/json) |
| Authentication | A Bearer token generated on the Swagger API page, sent as Authorization: Bearer <token> |
| Interactive reference | Swagger API in the header bar of the portal |
| API version | 3.02 |
Note: The user that calls the API needs a role with the API Access permission. See Roles and Permissions.
Examples
curl
# Token copied from "Generate a Bearer token" on the Swagger API page
TOKEN='<your token>'
curl -s "https://codesign.example.com/api/certificate_manage/certificate_names" \
-H "Authorization: Bearer $TOKEN"
PowerShell
$token = '<your token>' # from "Generate a Bearer token" on the Swagger API page
$headers = @{ Authorization = "Bearer $token" }
Invoke-RestMethod -Uri "https://codesign.example.com/api/certificate_manage/certificate_names" -Headers $headers
Next steps
-
Get a token: Authorizing Requests.
-
Check headers, responses, and status codes: Request and Response Conventions.
-
Find an endpoint: Endpoint Reference.