TItidelift
Alignments

Get recent saved alignments

Changed on

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

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

Request

  • Base URL
    https://api.tidelift.com/external-api
  • Auth
    HTTP bearer

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

  • 750fbd28bc2cRevision changes
    • warning

      added the new no_packages_found enum value to the / response property for the response status

    • info

      api tag Alignments added

    • info

      api tag Projects removed

    • info

      added the new optional query request parameter branch

    • info

      added the new optional query request parameter revision

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      response property items/error_code deprecated

    • info

      response property items/error_details deprecated

    • info

      response property items/error_message deprecated

  • 1146b360bd91Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • warning

      added the new canceling_obsolete_scans enum value to the / response property for the response status

    • warning

      added the new complete enum value to the / response property for the response status

    • warning

      added the new error enum value to the / response property for the response status

    • warning

      added the new failure enum value to the / response property for the response status

    • warning

      added the new inexact_versions enum value to the / response property for the response status

    • warning

      added the new invalid_external_identifier enum value to the / response property for the response status

    • warning

      added the new invalid_packages enum value to the / response property for the response status

    • warning

      added the new invalid_version enum value to the / response property for the response status

    • warning

      added the new manifest_parse enum value to the / response property for the response status

    • warning

      added the new marked_failed enum value to the / response property for the response status

    • warning

      added the new multiple_manifests_same_platform enum value to the / response property for the response status

    • warning

      added the new no_manifests_found enum value to the / response property for the response status

    • warning

      added the new retriable_error enum value to the / response property for the response status

    • warning

      added the new retries_exhausted enum value to the / response property for the response status

    • warning

      added the new running enum value to the / response property for the response status

    • warning

      added the new scheduled enum value to the / response property for the response status

    • warning

      added the new success enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status