Device Trust API

DigiCert® Device Trust Manager API helps you automate device identity management, certificate lifecycle operations, and software deployment for your IoT and connected device fleet.

What you can do

• Manage devices: Register, organize, and control device lifecycle states across your fleet.
• Issue and manage certificates: Automatically issue, renew, and revoke device certificates.
• Deploy software: Create artifacts, manage releases, and orchestrate deployments to device groups.
• Configure policies: Define certificate and authentication policies to control device access and identity requirements.
• Monitor operations: Query audit logs to track device activities, certificate operations, and deployment status.

Authentication

Base URL and endpoints

DigiCert® provides both production and demo environments across four geographic regions. Each API call starts with a region-specific hostname (base URL), followed by a predictable versioned path.

^{* Some API endpoints use a slightly different versioning pattern.}

Device lifecycle states

Devices in Device Trust Manager progress through distinct lifecycle states. Understanding these states helps you manage device operations effectively.

Software deployment workflow

Device Trust Manager uses a three-tier approach to manage software updates, which provides precise control over your deployment strategy.

1. Artifacts: Upload software packages or firmware images. An artifact represents the actual binary or package you want to deploy.
2. Releases: Associate artifacts with specific device groups. A release defines which artifact version should be deployed to which devices.
3. Deployments: Execute the deployment to push releases to target devices. Monitor deployment status and abort if needed.

Roles and permissions

Assigned roles determine what actions a user can perform. Roles are manager-specific and provide a granular permission structure. Use the /account/api/v1/role endpoint to see available roles for Device Trust Manager.

curl -X GET https://demo.one.digicert.com/account/api/v1/role?application_code=device_manager \
  -H "x-api-key: USER_API_TOKEN" \
  -H "Content-Type: application/json" | jq '.'

Important considerations

• Device deletion is permanent. Deleting a device immediately invalidates all associated certificates and removes the device from all groups. Deleted devices cannot be restored.
• Certificate policies define enrollment behavior. Before devices can request certificates, you must create certificate policies that specify certificate templates, validity periods, and approval workflows.
• Divisions organize your device fleet. Use divisions to create organizational boundaries. Devices, device groups, and policies belong to divisions, allowing you to delegate management to different teams.
• Batch operations for scale. Use batch enrollment endpoints for bulk operations like registering hundreds of devices or uploading authentication certificates at once.
• Deployment monitoring is critical. Always monitor deployment status using the deployment summary endpoint. Abort deployments that encounter errors to prevent fleet-wide issues.

Common operations