v1.0.0

Packster API

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

Package version management service — store, retrieve, and manage versioned build artifacts.

---

system

Service health

Operations

GET/health

---

Health check

GET

/health

Returns the health status of the MongoDB and Redis connections.

Authorizations

ApiKeyAuth

API token obtained via the /register endpoint. Pass as the X-Api-Token header on every request.

Type

API Key (header: X-Api-Token)

Responses

All services healthy.

Content-Type

application/json

{

  

"mongo": "Mongo is fine",

  

"redis": "Redis is fine"

}

GET

/health

Samples

---

auth

API token management (admin only)

Operations

PUT/registerGET/fetch/{token}DELETE/prune/{token}

---

Register a new API token

PUT

/register

Creates and returns a new API token. Requires admin privileges.

Authorizations

ApiKeyAuth

API token obtained via the /register endpoint. Pass as the X-Api-Token header on every request.

Type

API Key (header: X-Api-Token)

Request Body

application/json

{

  

"admin": false

}

Responses

Token created. The raw token string is returned as plain text.

Content-Type

text/plain

"a3f9b2c1d4e5f6a7b8c9..."

PUT

/register

Samples

---

Fetch an API token

GET

/fetch/{token}

Returns metadata for the specified token.

Authorizations

ApiKeyAuth

API token obtained via the /register endpoint. Pass as the X-Api-Token header on every request.

Type

API Key (header: X-Api-Token)

Parameters

Path Parameters

token*

The raw token string to look up.

Type

string

Required

Responses

Token metadata.

Content-Type

application/json

{

  

"token": "a3f9b2c1...",

  

"admin": false

}

GET

/fetch/{token}

Samples

---

Delete an API token

DELETE

/prune/{token}

Permanently removes the specified API token. Requires admin privileges.

Authorizations

ApiKeyAuth

API token obtained via the /register endpoint. Pass as the X-Api-Token header on every request.

Type

API Key (header: X-Api-Token)

Parameters

Path Parameters

token*

The raw token string to delete.

Type

string

Required

Responses

Token deleted.

DELETE

/prune/{token}

Samples

---

products

Product lifecycle

Operations

GET/product/accessPUT/product/createGET/product/fetch/{product}DELETE/product/delete/{product}PUT/product/modify/{action}DELETE/product/modify/{action}

---

List accessible products

GET

/product/access

Returns the names of all products the authenticated token has access to.

Authorizations

ApiKeyAuth

API token obtained via the /register endpoint. Pass as the X-Api-Token header on every request.

Type

API Key (header: X-Api-Token)

Responses

Product names accessible by the token.

Content-Type

application/json

[

  

[

  

  

"my-lib",

  

  

"other-lib"

  

]

]

GET

/product/access

Samples

---

Create a product

PUT

/product/create

Creates a new product. The calling token is automatically granted full maintainer access (download, upload, delete, maintainer).

Authorizations

ApiKeyAuth

API token obtained via the /register endpoint. Pass as the X-Api-Token header on every request.

Type

API Key (header: X-Api-Token)

Request Body

application/json

{

  

"name": "my-lib"

}

Responses

Product created.

PUT

/product/create

Samples

---

Fetch a product

GET

/product/fetch/{product}

Returns full product metadata including the token map and all versions. Requires the calling token to have access to the product, or admin privileges.

Authorizations

ApiKeyAuth

API token obtained via the /register endpoint. Pass as the X-Api-Token header on every request.

Type

API Key (header: X-Api-Token)

Parameters

Path Parameters

product*

Product name.

Type

string

Required

Responses

Product metadata.

Content-Type

application/json

{

  

"name": "my-lib",

  

"tokens": {

  

  

"additionalProperties": {

  

  

  

"maintainer": false,

  

  

  

"download": true,

  

  

  

"upload": false,

  

  

  

"delete": false

  

  

}

  

},

  

"versions": {

  

  

"additionalProperties": {

  

  

  

"path": "./prodcuts/my-lib/v1.0.0/my-lib.tar.gz",

  

  

  

"checksum": "sha256:abc123..."

  

  

}

  

}

}

GET

/product/fetch/{product}

Samples

---

Delete a product

DELETE

/product/delete/{product}

Permanently removes a product and all its metadata. Requires maintainer or admin access.

Authorizations

ApiKeyAuth

API token obtained via the /register endpoint. Pass as the X-Api-Token header on every request.

Type

API Key (header: X-Api-Token)

Parameters

Path Parameters

product*

Product name.

Type

string

Required

Responses

Product deleted.

DELETE

/product/delete/{product}

Samples

---

Modify a product (addToken)

PUT

/product/modify/{action}

Grants a token access to a product with the specified permissions. Requires maintainer or admin access.

Authorizations

ApiKeyAuth

API token obtained via the /register endpoint. Pass as the X-Api-Token header on every request.

Type

API Key (header: X-Api-Token)

Parameters

Path Parameters

action*

Must be addToken.

Type

string

Required

Valid values

"addToken"

Request Body

application/json

{

  

"product": "my-lib",

  

"token": "a3f9b2c1...",

  

"permissions": {

  

  

"maintainer": false,

  

  

"download": true,

  

  

"upload": false,

  

  

"delete": false

  

}

}

Responses

Token added.

PUT

/product/modify/{action}

Samples

---

Modify a product (deleteVersion / deleteToken)

DELETE

/product/modify/{action}

Dispatches to deleteVersion or deleteToken based on the action path parameter.

deleteVersion: Remove a version from a product.

Request body: DeleteVersionRequest

deleteToken: Revoke a token's access to a product. Requires maintainer or admin access.

Request body: DeleteProductTokenRequest

Authorizations

ApiKeyAuth

API token obtained via the /register endpoint. Pass as the X-Api-Token header on every request.

Type

API Key (header: X-Api-Token)

Parameters

Path Parameters

action*

Action to perform.

Type

string

Required

Valid values

"deleteVersion""deleteToken"

Request Body

application/json

{

  

"product": "my-lib",

  

"version": "v1.0.0"

}

Responses

Version deleted (deleteVersion).

DELETE

/product/modify/{action}

Samples

---

versions

Version artifact upload, download, and deletion

Operations

POST/product/uploadGET/product/download/{product}/{version}DELETE/product/delete/{product}/{version}

---

Upload a version artifact

POST

/product/upload

Uploads a file as a new version of a product. Requires Upload permission. Duplicate version names are rejected.

Authorizations

ApiKeyAuth

API token obtained via the /register endpoint. Pass as the X-Api-Token header on every request.

Type

API Key (header: X-Api-Token)

Request Body

multipart/form-data

object

Product name.

Version identifier.

Artifact file.

Format"binary"

Responses

Version uploaded.

POST

/product/upload

Samples

---

Download a version artifact

GET

/product/download/{product}/{version}

Streams the artifact file for the specified product version. Requires Download permission.

Authorizations

ApiKeyAuth

API token obtained via the /register endpoint. Pass as the X-Api-Token header on every request.

Type

API Key (header: X-Api-Token)

Parameters

Path Parameters

product*

Product name.

Type

string

Required

version*

Version identifier.

Type

string

Required

Responses

Artifact file binary.

Content-Type

application/octet-stream

GET

/product/download/{product}/{version}

Samples

---

Delete a version artifact

DELETE

/product/delete/{product}/{version}

Removes the artifact file and version metadata. Requires Delete permission.

Authorizations

ApiKeyAuth

API token obtained via the /register endpoint. Pass as the X-Api-Token header on every request.

Type

API Key (header: X-Api-Token)

Parameters

Path Parameters

product*

Product name.

Type

string

Required

version*

Version identifier.

Type

string

Required

Responses

Version deleted.

DELETE

/product/delete/{product}/{version}

Samples

---