Sign in
Alignments

Get recent saved alignments

Gets a list of all the saved alignments from the previous three weeks

get/v1/catalog/{org_name}/{project}/alignments

Path parameters

org_namestring required
Example:My-Company

The name of the Organization.

projectstring required

Query parameters

branchstring
revisionstring

Response

List of saved alignments

alignment_idstring

Unique identifier for the alignment results.

revisionstring

Revision of the project that was used for alignment analysis.

finished_atstring nullable

Time when the alignment finished analyzing release data.

release_countinteger nullable

Number of releases included in the alignment results.

newly_introduced_countinteger

Number of new issues found since the baseline alignment.

alignment_pctnumber float nullable

Percentage of releases that are aligned to the catalog's configured standards.

branchstring

Branch name of the project that was used for alignment analysis.

status'scheduled' | 'running' | 'complete' | 'error' nullable

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

result'success' | 'failure' nullable

Status of whether all releases are in alignment or not.

error_code'retriable_error' | 'manifest_parse' | 'no_manifests_found' | 'no_packages_found' | 'retries_exhausted' | 'canceling_obsolete_scans' | 'multiple_manifests_same_platform' | 'inexact_versions' | 'marked_failed' | 'invalid_external_identifier' | 'invalid_version' | 'invalid_packages' nullable

Short code to represent an error encountered during analysis.

error_messagestring nullable

A more descriptive summary of any error encountered during analysis.

error_detailsstring nullable

String representation of some more metadata of an error encountered during analysis.

Changes

No recorded changes to this endpoint across all 1 revision of this API.