License Hub Platform API Operations Index

License Hub Platform API Operations Index

All available License Hub Platform API Operations

Alarms
POST
Filter Alarm Definitions

Retrieves a list of alarm definitions based on specified filter criteria. This endpoint supports filtering by feature names, severities, event types, and enabled status. The response includes detailed information about each matching alarm definition.
GET
Get Alarm Definitions By Id

Retrieves a single alarm definition using its unique identifier. Returns detailed configuration information about the alarm definition including its feature name, event type, severity, and other associated metadata.
POST
Update Alarm Definition

Update Alarm Definition
POST
Filter Alarm Instances

Get alarm instances based on filter criteria
POST
Update Alarm Instances States

Update the states of a list of alarm instances by IDs
GET
Get Alarm Instance By Id

Retrieves a single alarm instance using its unique identifier
POST
Get Alarm Counts By Category And Severity

When invoking this API, the Alarm instances are accounted for in a map where the key is a category, by default feature name, and the value contains counts by severity. When the optional FeatureName request parameter is specified, the resulting list will only include the feature names passed along with the instance counts by severity for those features.
Backup Restore
GET
Get Backup Config

Returns saved remote backup server (SFTP) settings used by Backup and Restore. 204 if none configured.
PUT
Update Backup Config

Saves remote backup server settings; include current _revision from GET when updating.
GET
Get Recurring Backup Config

Returns scheduled (recurring) backup policy. 204 if not configured.
PUT
Update Recurring Backup Config

Saves scheduled backup policy; set weekly or interval fields to match backup_schedule_type.
POST
Start Backup

Starts an on-demand backup; poll GET /backup/status/{id} using the id from the 202 response.
GET
Get Backup Status

Returns one backup job by id (from POST /backup or GET /backup/status).
GET
Get Backup Status History

Returns the backup status history. Results are always returned in chronologically reverse order, i.e., the latest backup status first. To get the latest backup status, set the page size to 1 without other query parameter. If there's no latest backup, then the call returns an empty list.
POST
Start Restore

Starts restore from backup_id; poll GET /restore/status/{id} using the id from the 202 response.
GET
Get Restore Status

Returns one restore job by id (from POST /restore or GET /restore/status).
GET
Get Restore Status History

Returns all restore status history. Results are always returned in chronologically reverse order, i.e., the latest restore status first.
Certificates
GET
Get Trust Rollout Status

Retrieves the current status of an active or recently completed certificate rotation workflow, including overall progress and per-vertical summary node counts.

When to use: Use this endpoint to get a high-level view of the certificate rotation. It returns the overall_status, progress_percent, and per-vertical summary counts (success/failed/pending nodes) for all participating platform components.

Notes:

  • This endpoint returns summary-level data only - node-level detail arrays (success_nodes, failed_nodes, pending_nodes) are empty. To retrieve node-level details for specific verticals or statuses, use POST /trust/trust-rollout-status with filter criteria.
  • When no rotation is active (or after calling DELETE), the response body will reflect an empty/reset state.
  • This endpoint is safe to poll during an active rotation. The progress_percent field is updated continuously and represents an approximate progress indicator.
  • The vertical_key values in the vertical_status array are the valid inputs for the vertical_names filter in POST /trust/trust-rollout-status.
POST
Filter Trust Rollout Status

Retrieves the certificate rotation status with node-level detail for specific verticals and/or node statuses. This is the primary endpoint for diagnosing rotation failures.

When to use: Use this endpoint after GET /trust/trust-rollout-status reveals that a rotation has COMPLETED_WITH_FAILURES or is still IN_ROTATION with pending nodes. Filter by vertical and status to retrieve the exact list of nodes (with error messages) that require attention.

Filter Behavior:

  • vertical_names: Restricts results to the specified verticals. Values must match the TrustRolloutStatusVerticalKey enum. Obtain valid values from vertical_key fields in GET /trust/trust-rollout-status.
  • include_status: Restricts node-level detail to nodes in the specified states (SUCCESS, FAILED, PENDING). Only matching nodes are populated in success_nodes, failed_nodes, or pending_nodes.
  • If the request body is omitted, the response is equivalent to GET /trust/trust-rollout-status (summary-level data, no node detail).

Important: Node-level detail is only available for certain verticals (e.g., BAREMETALSECURITY, SENSOR). Other verticals (NSX, AVI, SSP, LH) always return empty node arrays - their status is limited to START_SUCCESSFUL or FAILED_TO_START_ROTATION.

Chaining:

  1. Call GET /trust/trust-rollout-status to identify the overall status and which verticals have failed_node_count > 0 in their status_summary.
  2. Call this endpoint with those vertical keys and include_status: ["FAILED"] to retrieve node-level error details for remediation.

Notes:

  • Returns 400 if vertical_names contains values not in the TrustRolloutStatusVerticalKey enum, or if include_status contains values outside of SUCCESS, FAILED, PENDING.
  • Verticals not matching the filter are excluded entirely from the response.
DELETE
Clear Trust Rollout Status

Clears and permanently resets the certificate rotation rollout status, returning the system to an idle state. This corresponds to the "Clear Status" action in the SSP Trust Management UI.

When to use: Call this endpoint after the rotation workflow has reached a terminal overall_status (COMPLETED_SUCCESSFULLY or COMPLETED_WITH_FAILURES) and you have acknowledged the result. This resets the system so a new rotation can be tracked cleanly in the future.

Preconditions:

  • The workflow must NOT be actively running. If overall_status is IN_ROTATION, this call returns 400. Verify the current state with GET /trust/trust-rollout-status before calling this endpoint.

Side Effects:

  • All rollout status data is permanently deleted. Subsequent GET /trust/trust-rollout-status calls will return an empty/reset status object.
  • This does NOT reverse or undo any certificate changes made during the rotation.
  • This action is irreversible - cleared status cannot be recovered.