APIs.io Engineering Platform Packages API

Manage packages for authenticated users and organizations.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 27 operations across 21 paths, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

27 operations 21 paths 8 schemas 6 DELETE15 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

2015-07-09

Base URL

https://{bucketname}.s3.amazonaws.com

Authentication

API Key

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform Packages API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

hmac — Amazon Signature authorization v4

Paths & Operations 27

Across 21 paths, the API surfaces 27 operations — 6 DELETE, 15 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Packages 27

Manage packages for authenticated users and organizations.

GET

/orgs/{org}/docker/conflicts

APIs.io Engineering Platform Get list of conflicting packages during Docker migration for organization

packages/list-docker-migration-conflicting-packages-for-organization 1 param → 200403401

GET

/orgs/{org}/packages

APIs.io Engineering Platform List packages for an organization

packages/list-packages-for-organization 5 params → 200403401400

GET

/orgs/{org}/packages/{package_type}/{package_name}

APIs.io Engineering Platform Get a package for an organization

packages/get-package-for-organization 3 params → 200

DELETE

/orgs/{org}/packages/{package_type}/{package_name}

APIs.io Engineering Platform Delete a package for an organization

packages/delete-package-for-org 3 params → 204404403401

POST

/orgs/{org}/packages/{package_type}/{package_name}/restore

APIs.io Engineering Platform Restore a package for an organization

packages/restore-package-for-org 4 params → 204404403401

GET

/orgs/{org}/packages/{package_type}/{package_name}/versions

APIs.io Engineering Platform List package versions for a package owned by an organization

packages/get-all-package-versions-for-package-owned-by-org 6 params → 200404403401

GET

/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}

APIs.io Engineering Platform Get a package version for an organization

packages/get-package-version-for-organization 4 params → 200

DELETE

/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}

APIs.io Engineering Platform Delete package version for an organization

packages/delete-package-version-for-org 4 params → 204404403401

POST

/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore

APIs.io Engineering Platform Restore package version for an organization

packages/restore-package-version-for-org 4 params → 204404403401

GET

/user/docker/conflicts

APIs.io Engineering Platform Get list of conflicting packages during Docker migration for authenticated-user

packages/list-docker-migration-conflicting-packages-for-authenticated-user → 200

GET

/user/packages

APIs.io Engineering Platform List packages for the authenticated user's namespace

packages/list-packages-for-authenticated-user 4 params → 200400

GET

/user/packages/{package_type}/{package_name}

APIs.io Engineering Platform Get a package for the authenticated user

packages/get-package-for-authenticated-user 2 params → 200

DELETE

/user/packages/{package_type}/{package_name}

APIs.io Engineering Platform Delete a package for the authenticated user

packages/delete-package-for-authenticated-user 2 params → 204404403401

POST

/user/packages/{package_type}/{package_name}/restore

APIs.io Engineering Platform Restore a package for the authenticated user

packages/restore-package-for-authenticated-user 3 params → 204404403401

GET

/user/packages/{package_type}/{package_name}/versions

APIs.io Engineering Platform List package versions for a package owned by the authenticated user

packages/get-all-package-versions-for-package-owned-by-authenticated-user 5 params → 200404403401

GET

/user/packages/{package_type}/{package_name}/versions/{package_version_id}

APIs.io Engineering Platform Get a package version for the authenticated user

packages/get-package-version-for-authenticated-user 3 params → 200

DELETE

/user/packages/{package_type}/{package_name}/versions/{package_version_id}

APIs.io Engineering Platform Delete a package version for the authenticated user

packages/delete-package-version-for-authenticated-user 3 params → 204404403401

POST

/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore

APIs.io Engineering Platform Restore a package version for the authenticated user

packages/restore-package-version-for-authenticated-user 3 params → 204404403401

GET

/users/{username}/docker/conflicts

APIs.io Engineering Platform Get list of conflicting packages during Docker migration for user

packages/list-docker-migration-conflicting-packages-for-user 1 param → 200403401

GET

/users/{username}/packages

APIs.io Engineering Platform List packages for a user

packages/list-packages-for-user 5 params → 200403401400

GET

/users/{username}/packages/{package_type}/{package_name}

APIs.io Engineering Platform Get a package for a user

packages/get-package-for-user 3 params → 200

DELETE

/users/{username}/packages/{package_type}/{package_name}

APIs.io Engineering Platform Delete a package for a user

packages/delete-package-for-user 3 params → 204404403401

POST

/users/{username}/packages/{package_type}/{package_name}/restore

APIs.io Engineering Platform Restore a package for a user

packages/restore-package-for-user 4 params → 204404403401

GET

/users/{username}/packages/{package_type}/{package_name}/versions

APIs.io Engineering Platform List package versions for a package owned by a user

packages/get-all-package-versions-for-package-owned-by-user 3 params → 200404403401

GET

/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}

APIs.io Engineering Platform Get a package version for a user

packages/get-package-version-for-user 4 params → 200

DELETE

/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}

APIs.io Engineering Platform Delete package version for a user

packages/delete-package-version-for-user 4 params → 204404403401

POST

/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore

APIs.io Engineering Platform Restore package version for a user

packages/restore-package-version-for-user 4 params → 204404403401

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are nullable-minimal-repository (87 properties), nullable-simple-user (21 properties), simple-user (21 properties), package-version (11 properties). Each schema is shown below with its type and property counts.

nullable-simple-user

object

A GitHub user.

21 properties 18 required

code-of-conduct

object

Code Of Conduct

5 properties 4 required

basic-error

object

Basic Error

4 properties

package-version

object

A version of a software package

11 properties 6 required

simple-user

object

A GitHub user.

21 properties 18 required

package

object

A software package

11 properties 9 required

nullable-minimal-repository

object

Minimal Repository

87 properties 46 required

security-and-analysis

object

3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Packages

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Packages API

Metadata

Authentication & Security 1

Paths & Operations 27

Schemas 8

Specification

Source

API Details

Provider

Explore more