--- title: "Get a saved alignment with additional information" method: GET path: "/v1/{org_name}/projects/{project}/alignments/{revision}/status" tags: ["Alignments"] --- # Get a saved alignment with additional information `GET /v1/{org_name}/projects/{project}/alignments/{revision}/status` The alignment will also include information on violations per dependency. ## Path parameters - `org_name` string, required - `project` string, required - `revision` string, required ## Response `200` Detailed results and status of saved alignment. - AlignmentStatus - `_meta` object, required - `version` string - `organization` string, required — Name of the Team that owns the alignment. - `team` string — Name of the Team that owns the alignment. - `files` string, required — File names used in the alignment analysis. - `alignment_pct` number, float, required — Percentage of Package releases that are aligned to the Catalog's standards. - `unapproved` AlignmentRelease[], nullable, required — Package releases in the alignment that are not included in the catalog and have no status. - `id` integer - `latest_release_number` string, nullable — Version of the package that is considered the most recent release. - `license_normalized` boolean, nullable — If license data has been normalized to SPDX values from an upstream source. - `license_set_by_admin` boolean, nullable — If license data has been set by a Tidelift researcher. - `licenses` string, nullable — License expression for this release. - `name` string — The package name. - `platform` string — The package platform. - `project_license` string, nullable — The license data tied to the package. - `repository_license` string, nullable — The license data tied to the package's source repository. - `type` string, nullable - `unknown` boolean, nullable — If Tidelift does not have any upstream data for this package. - `direct` boolean — If the package is referenced directly by the project dependency manifest. - `resolved_version` string — Real release version that the manifest resolved to. - `requirement` string — Raw requirement text included in the project manifest file. - `lockfile_requirement` string, nullable — Raw requirement text included in the project's manifest lockfile. - `original_license` string, nullable — The license found using only upstream source data. - `version` string — Version of the release used in the alignment analysis. - `status` string, nullable — Status of this release within the alignment results. - `alternatives` object[], nullable, required — List of alternative Package releases that could be used to bring the project closer to full alignment. - `name` string — The package name. - `platform` string — The package platform. - `in_use` string[] — List of releases for this package that are used in other projects. - `not_in_use` string[] — List of releases for this package that are in the catalog but not used in other projects. - `upcoming_denials` object[], nullable, required — Package releases that are configured to be out of alignment with the Catalog's standards in the future. - `name` string — The name of the package. - `platform` string — The platform of the package. - `version` string — The version of the release. - `deny_at` string — The date when the release will no longer be acceptable to be used. - `reason` string — The reason why the release will no longer be allowed or why the decision has been delayed. - `highest_approved_version` string, nullable — The latest version of this package that is allowed for use. - `approved` AlignmentRelease[], nullable, required — Package releases in the alignment that are approved for use. - `id` integer - `latest_release_number` string, nullable — Version of the package that is considered the most recent release. - `license_normalized` boolean, nullable — If license data has been normalized to SPDX values from an upstream source. - `license_set_by_admin` boolean, nullable — If license data has been set by a Tidelift researcher. - `licenses` string, nullable — License expression for this release. - `name` string — The package name. - `platform` string — The package platform. - `project_license` string, nullable — The license data tied to the package. - `repository_license` string, nullable — The license data tied to the package's source repository. - `type` string, nullable - `unknown` boolean, nullable — If Tidelift does not have any upstream data for this package. - `direct` boolean — If the package is referenced directly by the project dependency manifest. - `resolved_version` string — Real release version that the manifest resolved to. - `requirement` string — Raw requirement text included in the project manifest file. - `lockfile_requirement` string, nullable — Raw requirement text included in the project's manifest lockfile. - `original_license` string, nullable — The license found using only upstream source data. - `version` string — Version of the release used in the alignment analysis. - `status` string, nullable — Status of this release within the alignment results. - `requested` AlignmentRelease[], nullable, required — Package releases in the alignment that have been requested but have not been analyzed yet. - `id` integer - `latest_release_number` string, nullable — Version of the package that is considered the most recent release. - `license_normalized` boolean, nullable — If license data has been normalized to SPDX values from an upstream source. - `license_set_by_admin` boolean, nullable — If license data has been set by a Tidelift researcher. - `licenses` string, nullable — License expression for this release. - `name` string — The package name. - `platform` string — The package platform. - `project_license` string, nullable — The license data tied to the package. - `repository_license` string, nullable — The license data tied to the package's source repository. - `type` string, nullable - `unknown` boolean, nullable — If Tidelift does not have any upstream data for this package. - `direct` boolean — If the package is referenced directly by the project dependency manifest. - `resolved_version` string — Real release version that the manifest resolved to. - `requirement` string — Raw requirement text included in the project manifest file. - `lockfile_requirement` string, nullable — Raw requirement text included in the project's manifest lockfile. - `original_license` string, nullable — The license found using only upstream source data. - `version` string — Version of the release used in the alignment analysis. - `status` string, nullable — Status of this release within the alignment results. - `denied` AlignmentRelease[], nullable, required — Package releases in the alignment that are not approved for use. - `id` integer - `latest_release_number` string, nullable — Version of the package that is considered the most recent release. - `license_normalized` boolean, nullable — If license data has been normalized to SPDX values from an upstream source. - `license_set_by_admin` boolean, nullable — If license data has been set by a Tidelift researcher. - `licenses` string, nullable — License expression for this release. - `name` string — The package name. - `platform` string — The package platform. - `project_license` string, nullable — The license data tied to the package. - `repository_license` string, nullable — The license data tied to the package's source repository. - `type` string, nullable - `unknown` boolean, nullable — If Tidelift does not have any upstream data for this package. - `direct` boolean — If the package is referenced directly by the project dependency manifest. - `resolved_version` string — Real release version that the manifest resolved to. - `requirement` string — Raw requirement text included in the project manifest file. - `lockfile_requirement` string, nullable — Raw requirement text included in the project's manifest lockfile. - `original_license` string, nullable — The license found using only upstream source data. - `version` string — Version of the release used in the alignment analysis. - `status` string, nullable — Status of this release within the alignment results. - `no_new_introduction` AlignmentRelease[], nullable — Package releases in the alignment that are approved for use, but are not allowed to introduce any further issues. - `id` integer - `latest_release_number` string, nullable — Version of the package that is considered the most recent release. - `license_normalized` boolean, nullable — If license data has been normalized to SPDX values from an upstream source. - `license_set_by_admin` boolean, nullable — If license data has been set by a Tidelift researcher. - `licenses` string, nullable — License expression for this release. - `name` string — The package name. - `platform` string — The package platform. - `project_license` string, nullable — The license data tied to the package. - `repository_license` string, nullable — The license data tied to the package's source repository. - `type` string, nullable - `unknown` boolean, nullable — If Tidelift does not have any upstream data for this package. - `direct` boolean — If the package is referenced directly by the project dependency manifest. - `resolved_version` string — Real release version that the manifest resolved to. - `requirement` string — Raw requirement text included in the project manifest file. - `lockfile_requirement` string, nullable — Raw requirement text included in the project's manifest lockfile. - `original_license` string, nullable — The license found using only upstream source data. - `version` string — Version of the release used in the alignment analysis. - `status` string, nullable — Status of this release within the alignment results. - `catalog` object, required — The catalog used to determine the alignment status of each package release. - `id` string - `name` string - `display_name` string - `catalog_standards` object[] - `slug` string, required - `name` string, required - `description` string, required - `enabled` boolean, required - `project` string, nullable, required — Name of the project used for the alignment. - `baseline_alignment` object, nullable, required — A previous alignment that can be used to compare data between. This can be useful to spot regressions that have been introduced since the baseline alignment was run. - `number` integer, required — The ordered alignment number within the project. - `date` string, date-time, required — When the alignment was run. - `actions` object[], required - `action_description` string, required - `action` object, required - `package_name` string - `dependency_source` string - `current_version` string - `suggested_version` string - `violations` object[], required - `title` string - `error` ScanLog, nullable — Information about a scan problem, if there was one. - `code` 'inexact_versions' | 'invalid_version' | 'invalid_packages' — Machine-readable code for the issue. - `message` string — Human-readable message about the issue. - `details` object — List of details about the issue. - `platform` string, nullable — Relevant platform that triggered the issue. - `path` string, nullable — Relevant manifest path that triggered the issue. - `kind` 'lockfile' | 'manifest', nullable — Relevant manifest kind that triggered the issue. - `message` string, nullable — Relevant human-readable message about this detail. - `warnings` ScanLog[] - `code` 'inexact_versions' | 'invalid_version' | 'invalid_packages' — Machine-readable code for the issue. - `message` string — Human-readable message about the issue. - `details` object — List of details about the issue. - `platform` string, nullable — Relevant platform that triggered the issue. - `path` string, nullable — Relevant manifest path that triggered the issue. - `kind` 'lockfile' | 'manifest', nullable — Relevant manifest kind that triggered the issue. - `message` string, nullable — Relevant human-readable message about this detail. - `details_url` string, 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. - `revision` string, required — Revision of the project that was used for alignment analysis. - `external_identifier` string, nullable, required — The external identifier for the scan, if set - `alignment_counts` object, required — Counts of releases that fall within each bucket within the alignment results. - `approved` integer — Number of releases with an approved status. - `denied` integer — Number of releases with a denied status. - `requested` integer — Number of releases that have been requested to the catalog, but do not have a status yet. - `unapproved` integer — Number of releases without any status. - `newly_introduced` integer — Number of releases with a new issue from the baseline alignment. - `no_new_introduction` integer — Number of releases that are approved for use, but are not allowed to add any new issues to the project. - `production_alignment_counts` object, required — Counts of releases that are likely deployed with the project code that fall within each bucket within the alignment results. - `approved` integer — Number of releases with an approved status. - `denied` integer — Number of releases with a denied status. - `requested` integer — Number of releases that have been requested to the catalog, but do not have a status yet. - `unapproved` integer — Number of releases without any status. - `newly_introduced` integer — Number of releases with a new issue from the baseline alignment. - `no_new_introduction` integer — Number of releases that are approved for use, but are not allowed to add any new issues to the project. ## Other responses - `403` — 403 Forbidden - `404` — 404 Scan Not Found --- [API](https://skmtc.net/tidelift/apis/tidelift-external-api.md) · [All operations](https://skmtc.net/tidelift/apis/tidelift-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tidelift/tidelift-external-api/revisions/5f36bed372bb/schema)