Alignments

Get a saved alignment with additional information

The alignment will also include information on violations per dependency.

get/v1/{org_name}/projects/{project}/alignments/{revision}/status

Request

org_namestring required

Example:My-Company

The name of the Organization.

projectstring required

The name of the project. The external identifier will not work here.

revisionstring required

The revision of the alignment.

Detailed results and status of saved alignment.

organizationstring required

Name of the Team that owns the alignment.

teamstring

Name of the Team that owns the alignment.

filesstring required

File names used in the alignment analysis.

alignment_pctnumber float required

Percentage of Package releases that are aligned to the Catalog's standards.

projectstring nullable required

Name of the project used for the alignment.

details_urlstring required

URL to view more alignment details in the Tidelift UI.

status'scheduled' | 'running' | 'error' | 'failure' | 'success' nullable required

Status to indicate if the alignment has finished analyzing or is still running.

revisionstring required

Revision of the project that was used for alignment analysis.

external_identifierstring nullable required

The external identifier for the scan, if set