Region
Ship
Packages, releases and the service catalog
66 operations
package-registries
20 operationsnpm, Cargo and PyPI registries beside your code
- GET/groups/{group_id}/packagesList a group's packages
- GET/groups/{group_id}/packages/{format}/{package_name}A package's detail with its versions
- DEL/groups/{group_id}/packages/{format}/{package_name}Delete an entire package
- DEL/groups/{group_id}/packages/{format}/{package_name}/versions/{version}Delete a single package version
- GET/packages/{group_id}/cargo/{seg1}/{seg2}Sparse-index file for a crate whose name is one or two characters long
- GET/packages/{group_id}/cargo/{seg1}/{seg2}/{seg3}Sparse-index file for a crate whose name is three or more characters long
- GET/packages/{group_id}/cargo/api/v1/cratesSearch a group's Cargo registry
- GET/packages/{group_id}/cargo/api/v1/crates/{crate_name}/{version}/downloadDownload a `.crate` file
- PUT/packages/{group_id}/cargo/api/v1/crates/{crate_name}/{version}/unyankRestore a yanked crate version (`cargo yank --undo`)
- DEL/packages/{group_id}/cargo/api/v1/crates/{crate_name}/{version}/yankYank a crate version (`cargo yank`)
- PUT/packages/{group_id}/cargo/api/v1/crates/newPublish a crate (`cargo publish`)
- GET/packages/{group_id}/cargo/config.jsonThe Cargo sparse-registry `config.json`
- GET/packages/{group_id}/npm/-/v1/searchSearch a group's npm registry
- GET/packages/{group_id}/npm/{package}Serve an npm packument
- PUT/packages/{group_id}/npm/{package}Publish a package version (`npm publish`)
- GET/packages/{group_id}/npm/{package}/-/{version}/{filename}Download a package tarball
- POST/packages/{group_id}/pypi/Upload a distribution file (`twine upload`)
- GET/packages/{group_id}/pypi/files/{project}/{version}/{filename}Download a distribution file
- GET/packages/{group_id}/pypi/simple/List the projects in a group's PyPI registry (simple index)
- GET/packages/{group_id}/pypi/simple/{project}/List a PyPI project's files (simple index)
releases
10 operationsReleases, their assets and source archives
- GET/repositories/{repo_id}/releasesList a repository's releases, newest first
- POST/repositories/{repo_id}/releasesCreate a release for a tag, creating the tag from a target ref when absent
- GET/repositories/{repo_id}/releases/{tag_name}Get a release by its tag
- PATCH/repositories/{repo_id}/releases/{tag_name}Update a release's title, notes, or draft/prerelease flags
- DEL/repositories/{repo_id}/releases/{tag_name}Delete a release and its assets (the git tag is left intact)
- GET/repositories/{repo_id}/releases/{tag_name}/archiveDownload a source archive of a release's tag
- POST/repositories/{repo_id}/releases/{tag_name}/assetsRegister a release asset and get a presigned upload URL
- GET/repositories/{repo_id}/releases/{tag_name}/assets/{asset_id}Download a release asset.
- DEL/repositories/{repo_id}/releases/{tag_name}/assets/{asset_id}Delete a release asset and its uploaded file
- GET/repositories/{repo_id}/releases/latestGet the newest published, non-prerelease release
catalog
36 operationsThe service catalog — the estate, derived from what the platform already builds
- GET/catalog/check-kindsDescribe every derived check the platform implements
- GET/catalog/environments/{environment_id}Get an environment by id
- PATCH/catalog/environments/{environment_id}Patch an environment
- DEL/catalog/environments/{environment_id}Delete an environment
- GET/catalog/environments/{environment_id}/deploymentsWhat is deployed into an environment
- GET/catalog/environments/{environment_id}/variablesList an environment's variables
- PUT/catalog/environments/{environment_id}/variables/{name}Create or replace an environment variable
- DEL/catalog/environments/{environment_id}/variables/{name}Delete an environment variable
- GET/catalog/scorecards/{scorecard_id}Read one scorecard
- PATCH/catalog/scorecards/{scorecard_id}Amend a scorecard
- DEL/catalog/scorecards/{scorecard_id}Delete a scorecard
- GET/catalog/scorecards/{scorecard_id}/resultsList a scorecard's results, worst state first
- GET/catalog/services/{service_id}Get a service by id
- PATCH/catalog/services/{service_id}Update a service
- DEL/catalog/services/{service_id}Delete a service
- POST/catalog/services/{service_id}/checks/{scorecard_id}/{check_key}/attestAttest a check no machine can see
- GET/catalog/services/{service_id}/dependenciesList the services this service depends on
- GET/catalog/services/{service_id}/dependentsList the services that depend on this service
- GET/catalog/services/{service_id}/deploymentsA service's deployment history
- GET/catalog/services/{service_id}/deployments/currentWhat a service has deployed right now
- GET/catalog/services/{service_id}/deployments/driftHow far behind its default branch each deployment is
- GET/catalog/services/{service_id}/graphWalk the dependency graph outward from a service
- GET/catalog/services/{service_id}/overviewEverything a service page shows, in one call
- GET/catalog/services/{service_id}/scorecardsEvery scorecard's verdict on one service
- GET/groups/{group_id}/catalog/deploymentsThe deployment board — services × environments
- GET/groups/{group_id}/catalog/environmentsList a group's environments
- POST/groups/{group_id}/catalog/environmentsDeclare an environment on a group
- GET/groups/{group_id}/catalog/scorecardsList the scorecards that apply to a group
- POST/groups/{group_id}/catalog/scorecardsDeclare a scorecard on a group
- GET/groups/{group_id}/catalog/servicesList a group's services, each with its deployment promotion track
- POST/groups/{group_id}/catalog/servicesDeclare a service in a group
- GET/groups/{group_id}/catalog/services/by-slug/{slug}Get a service by its slug within a namespace
- GET/repositories/{repo_id}/catalog/environmentsList a repository's environments
- POST/repositories/{repo_id}/catalog/environmentsDeclare an environment on a repository
- GET/repositories/{repo_id}/catalog/resolveResolve repository paths to the services that own them
- GET/repositories/{repo_id}/catalog/servicesList the services bound to a repository, each with its deployment promotion track