Spiral API (0.1.0)

Organizations are the top-level administrative unit in Spiral. They are used to configure single sign-on, billing, audit logging, and other settings that apply to all users within the organization.

Since resources belong to projects, and all projects must belong to an organization, each user must be a member of at least one organization in order to use Spiral.

Lists all organizations that the user belongs to, paginated. The user must be a member of at least one organization in order to use Spiral.

The user can be logged in to an exactly one organization at a time. Unlike this one, other organization APIs will operate on the currently logged in organization.

An organization owner can use this link to access the organization configuration portal.

The organization configuration portal is used to configure single sign-on, billing, audit logging, and other settings that apply to all users within the organization.

In Spiral, projects are the fundamental unit for structuring resources, access controls, and usage tracking.

The project will be created in the currently logged in organization.

Lists all projects in the currently logged in organization, paginated. Lists projects visible to the currently logged in user.

Builtin providers are preconfigured and managed by Spiral. Resources that require access to a file system can use builtin providers to access the underlying object storage.

Update the default file system for a project. This operation will replace the existing file system with the new one. It is only possible to update the file system if there are no mounts associated with the current file system. File system can be updated to one of the builtin file systems or an external, e.g. your own S3 bucket.

Spiral File Systems provide a means to securely federate and accelerate access to underlying object storage. File Systems are scoped to a project. However, unlike many other resource types, each project may only have a single file system, called default file system. Project resources that require access to a file system will use the default file system, unless otherwise specified on resource creation—different different resources have different API for specifying file system. Note that a project always has a default file system—if it is not explicitly set, a default builtin provider is used.

Mount grants permission to use a specific path within the file system to a Spiral resource. When resources that require a file system are created they configure a mount against a file system. This means human users cannot currently read or write to a Spiral File System.

Lists all mounts for a project's file system, paginated. Access to Spiral File Systems is limited to Spiral resources themselves. Note that file systems can only be reconfigured when they have zero mounts.

Remove a mount from the file system.

Create an SPFS token for a given mount.

Token is used to authenticate with the Spiral File System. SPFS tokens are short-lived and scoped to a mount path within the file system.

Workloads are typically long-running services that need to access Spiral resources, yet cannot be authenticated using OIDC.

Workloads are principals and therefore can be granted roles in the same way as users.

De-activates a workload.

This operation irreversibly revokes all client credentials associated with the workload.

Create workload credentials. Only the three most recent credentials are active at any given time.

Credentials can be exchanged for an access token using the OAuth2 token endpoint.

Revoke workload credentials.

Create a new table.

List all tables in the project.

Exchange client credentials, authorization codes, or refresh tokens for access tokens.