This endpoint lets you read your RepoForge.io Access Logs. You can optionally use query parameters to filter the logs

Example

# without filtering (get all logs)
response = session.get('https://api.repoforge.io/rest/v1/access-logs')
print(response.json())

# with filtering
from datetime import datetime, timedelta
query = {
    "limit": 1,
    "start_time": (datetime.now() - timedelta(hours=24)).isoformat(),
    "end_time": (datetime.now() - timedelta(hours=2)).isoformat(),
    "access_type": "Python",
    "package_name": "mypackage",
}
response = session.get(f"https://api.repoforge.io/rest/v1/access-logs?{urlencode(query)}")

The Access Token endpoint lets you create, read, rotate and delete RepoForge.io Access Tokens.

Important: For security reasons, the token attribute is only visible when you initially create a new access token, or when you rotate an existing one. Whenever you call a GET request on this endpoint, you'll see a value. You cannot rotate or delete the Access Token you are currently using to authenticate the REST API

Example

payload = dict(
    name="A new token",
    roles=["d8b787be-bd91-42a0-865c-df97d5b8e5ac"]
)
response = session.post('https://api.repoforge.io/rest/v1/access-tokens', json=payload)
print(response.json()["token"])

Returns a list of all RepoForge.io access tokens currently being managed by your organisation.

Example

response = session.get('https://api.repoforge.io/rest/v1/access-tokens')
print(response.json())

Retrieves a single access token by its UUID

Example

response = session.get('https://api.repoforge.io/rest/v1/access-tokens/2211bded-b41b-4313-a96c-f955dd12aa8b')
print(response.json())

Finds an access token by its UUID and deletes it. The deleted token value will no longer be valid, and you will no longer be able to use it to authenticate.

You CANNOT delete the access token that you are currently using to authenticate the REST API

Example

token_uuid = "uuid-of-token"
response = session.delete(f"https://api.repoforge.io/rest/v1/access-tokens/{token_uuid}")
assert response.status_code == 200

Finds an access token by its UUID and rotates it. The old token value will no longer be valid, and you will no longer be able to use it to authenticate. The token roles will remain unchanged.

You CANNOT rotate the access token that you are currently using to authenticate the REST API

Example

token_uuid = "uuid-of-token"
response = session.patch(f"https://api.repoforge.io/rest/v1/access-tokens/{token_uuid}/rotate")
assert response.status_code == 200
new_token = response.json()["token"]

This endpoint lists all NPM packages belonging to your organisation.

Example Usage

response = session.get("https://api.repoforge.io/rest/v1/npm")
assert response.status_code == 200
print(response.json())

This endpoint retrieves a single NPM package by its registry name and package name.

Example Usage

response = session.get("https://api.repoforge.io/rest/v1/npm/@repoforge/my-package")
assert response.status_code == 200

print(response.json())

This endpoint lets you update the permissions of a single NPM package by its registry name and package name. You must supply either public (true|false) or permissions_mode (PACKAGE_LEVEL|DEFAULT) in the payload.

Packages marked as public can be installed/downloaded using the NPM client without providing any credentials.

Non-public packages that use the DEFAULT permissions mode can be installed by any authenticated user with the relevant role - e.g one with the permissions to Download NPM packages for your organisation.

Packages that use PACKAGE_LEVEL permissions can only be accessed by those authenticated users that have been explicitly assigned to the relevant roles created for that specific package.

Setting the permissions mode to PACKAGE_LEVEL will always cause the package to be non-public.

Example Usage

# making a package public
payload = dict(
    public=True
)
response = session.patch("https://api.repoforge.io/rest/v1/npm/@repoforge/npm-package", json=payload)
assert response.status_code == 200

assert response.json()['public'] == True

changing the permissions mode to package_level

payload = dict(
    permissions_mode="PACKAGE_LEVEL"
)
response = session.patch("https://api.repoforge.io/rest/v1/npm/@repoforge/npm-package", json=payload)
assert response.status_code == 200

Deletes a NPM version by its registry name, package name and version number. If no other versions exist under the same parent NPM package, then the NPM package will be deleted, too.

Example

response = session.delete("https://api.repoforge.io/rest/v1/npm/@repoforge/mypackage/1.0.0")
assert response.status_code == 200

Returns a list of all Python packages owned owned by your organisation.

Example Usage

response = session.get("https://api.repoforge.io/rest/v1/python")
assert response.status_code == 200
print(response.json())

Retrieves a single Python package by its name

Example Usage

response = session.get("https://api.repoforge.io/rest/v1/python/my-package")
assert response.status_code == 200
print(response.json())

This endpoint lets you update the permissions of a single Python package by its package name. You must supply either public (true|false) or permissions_mode (PACKAGE_LEVEL|DEFAULT) in the payload.

Packages marked as public can be installed/downloaded using the NPM client without providing any credentials.

Non-public packages that use the DEFAULT permissions mode can be installed by any authenticated user with the relevant role - e.g one with the permissions to Download Python packages for your organisation.

Packages that use PACKAGE_LEVEL permissions can only be accessed by those authenticated users that have been explicitly assigned to the relevant roles created for that specific package.

Setting the permissions mode to PACKAGE_LEVEL will always cause the package to be non-public.

Example Usage

# Marking a package as public
payload = dict(
    public=True
)
response = session.patch("https://api.repoforge.io/rest/v1/python/my-package", json=payload)
assert response.status_code == 200

assert response.json()['public'] == True

# changing the permissions mode
payload = dict(
    permissions_mode="PACKAGE_LEVEL"
)
response = session.patch("https://api.repoforge.io/rest/v1/python/my-package", json=payload)
assert response.status_code == 200

Deletes a version from a Python package by the package name, file type and version. If this is the last remaining version of the parent package, then the parent package will also be deleted.

Example Usage

response = session.delete(
    "{host}/rest/v1/python/my-package/bdist_wheel/1.0.0/mypackage-3.7-py3-none-any.whl"
)
assert response.status_code == 200

Returns a list of all Docker registries managed by your organisation.

Example Usage

response = session.get("https://api.repoforge.io/rest/v1/docker")
assert response.status_code == 200
print(response.json())

Retrieves a single docker registry by its name

Example Usage

response = session.get("https://api.repoforge.io/rest/v1/docker/my-registry")
assert response.status_code == 200
print(response.json())

This endpoint lets you update the permissions of a single Docker registry by its registry name. You must supply either public (true|false) or permissions_mode (PACKAGE_LEVEL|DEFAULT) in the payload.

Registries marked as public can be installed/downloaded using the NPM client without providing any credentials.

Non-public registries that use the DEFAULT permissions mode can be installed by any authenticated user with the relevant role - e.g one with the permissions to Download Python packages for your organisation.

Registries that use PACKAGE_LEVEL permissions can only be accessed by those authenticated users that have been explicitly assigned to the relevant roles created for that specific registry.

Setting the permissions mode to PACKAGE_LEVEL will always cause the package to be non-public.

Example Usage

payload = dict(
    public=True
)
response = session.patch("https://api.repoforge.io/rest/v1/docker/my-registry", json=payload)
assert response.status_code == 200
assert response.json()['public'] == True

Deletes a version from a Docker tag by the registry name and tag reference.

Example Usage

response = session.delete("https://api.repoforge.io/rest/v1/docker/my-registry/latest")
assert response.status_code == 200

List all available system roles. Roles are managed by the system and cannot be created or changed, but can be associated with access token objects to control resources within RepoForge.io.

Example

response = session.get('https://api.repoforge.io/rest/v1/roles')
print(response.json())

Returns a list of all Debian packages managed by your organisation

Example usage

response = session.get("http://localhost:5001/rest/v1/debian")
assert response.status_code == 200, response.text

print(response.json())

Retrieves a single Debian package by its name

Example usage

response = session.get("http://localhost:5001/rest/v1/debian/mypackage")
assert response.status_code == 200, response.text

print(response.json())

This endpoint lets you update the permissions of a single Debian package by its package name. You must supply either public (true|false) or permissions_mode (PACKAGE_LEVEL|DEFAULT) in the payload.

Packages marked as public can be installed/downloaded using the NPM client without providing any credentials.

Non-public packages that use the DEFAULT permissions mode can be installed by any authenticated user with the relevant role - e.g one with the permissions to Download Debian packages for your organisation.

Packages that use PACKAGE_LEVEL permissions can only be accessed by those authenticated users that have been explicitly assigned to the relevant roles created for that specific package.

Setting the permissions mode to PACKAGE_LEVEL will always cause the package to be non-public.

Example Usage

# Marking a package as public
payload = dict(
    public=True
)
response = session.patch("http://localhost:5001/rest/v1/debian/my-package", json=payload)
assert response.status_code == 200

assert response.json()['public'] == True

# changing the permissions mode
payload = dict(
    permissions_mode="PACKAGE_LEVEL"
)
response = session.patch("http://localhost:5001/rest/v1/debian/my-package", json=payload)
assert response.status_code == 200

Deletes a file from a Debian package by its architecture and name

Example usage

response = session.delete("http://localhost:5001/rest/v1/debian/mypackage/arm64/mypackage_1.0_all.deb")
assert response.status_code == 200, response.text
print(response.json())

Returns the RepoForge.io public key for GPG signing requests

This endpoint lets you create a new Debian package, or add a new version to an existing Debian package, if a package with the same name already exists for your account.

This endpoint accepts a single uploaded file under the content key, which must be a valid Debian package containing included valid metadata

This endpoint verifies the auth token and returns an empty response. This endpoint essentially controls authentication and permissions to the entire docker registry

Returns a 401 if token is invalid

Returns a list of tags for a given registry

Start a new Docker upload. This endpoint just generates a UUID and returns an empty response with two response headers - docker-upload-uuid, the generated ID, and Location, which is the path to where the client should send blobs to upload.

This method creates or updates a blob in S3 at a path containing a given UUID. It supports multipart uploads via the content-range header.

This method is used to finalise the multipart upload of a blob stored at a path in S3 based on a given UUID. It first creates/updates the blob on S3 in a similar way to the patch_blobs endpoint. Once done, it then moves the blob from its UUID path on s3 to a path based on the content digest.

Very simple function that just checks if a blob exists based on a given hash id, name and digest. Returns an empty response.

Gets a blob from S3 by the given hash id, name and digest, and returns a streaming response back to the user

Simple function to check to see whether a manifest exists and returns the content type and digest headers in the response

Similar to the head_manifest endpoint above, but this one actually returns the content of the manifest as well

Creates a new Docker manifest

This endpoint allows the creation of new NPM packages. If an NPM package with the same name and scope already exists, then it will either add new versions to that package (if the given version number does not already exist), or overwrite the existing versions of that version number.

This method finds and returns an NPMPackage by its scope and name