Every endpoint of the eQuantic Space API, generated from the api itself.
The API that the web app, the eqs CLI and the runners all use. This page is generated from the api's own OpenAPI document, so it lists exactly the endpoints the api serves.
The token can be a personal access token or a service principal secret (see Access (RBAC)). Every request is checked against the roles of the identity behind the token.
GET/v1/accounts/azure-devopsConnection state (organization + connections) for the connect UI (P1c).
Responses
200
PUT/v1/accounts/azure-devopsConnect (or re-auth) an Azure DevOps organization with a PAT.
Request bodyConnectAzureAccountDto
Name
Type
Description
organizationrequired
string
Organization name only — `equantic` in `https://dev.azure.com/equantic`.
patrequired
string
Azure DevOps personal access token (Code read scope at minimum).
Responses
200
GET/v1/accounts/azure-devops/repositories
Responses
200
BitbucketAccount
GET/v1/accounts/bitbucketConnection state (login + connections) for the connect UI.
Responses
200
PUT/v1/accounts/bitbucketConnect (or re-auth) a Bitbucket account with a username + secret pair.
Request bodyConnectBitbucketAccountDto
Name
Type
Description
usernamerequired
string
HTTP Basic username (ADR-025 B1): the Bitbucket USERNAME when pairing
with an app password, or the Atlassian account E-MAIL when pairing with
the newer API tokens. Stored as the connection's login and replayed on
every Basic call.
secretrequired
string
App password or Atlassian API token (repository read at minimum).
workspacerequired
string
The Bitbucket WORKSPACE slug to list repositories under —
`equantic` in `bitbucket.org/equantic`. REQUIRED since CHANGE-2770 (the
user-wide listing endpoints return HTTP 410); stored on the account's
`host`. A workspace id is a slug: letters/numbers plus `-`/`_`.
PUT/v1/repositories/{repositoryId}/branch-protectionsUpserts THE rule for `branchPattern` (the body's key). PUT is declarative full state — omitted fields fall back to the defaults, they never keep the previous value.
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
Request bodyPutBranchProtectionDto
Name
Type
Description
branchPatternrequired
string
Exact branch name (`main`) or a simple segment-scoped `*` glob (`release/*`).
GET/_apis/artifactcache/artifacts/{id}Streams a committed entry — the target of every download URL we hand out, v1 and v2 alike. Answers `Range` with a 206 because that is how the Azure URLs GitHub issues behave, and buildkit's `type=gha` reads cache blobs through a ReaderAt that asks for `bytes=<offset>-`.
PUT/v1/ci-storage/policySaves the policy. The next sweep, at most an hour away, applies it.
Request bodyCiStoragePolicyDto
Name
Type
Description
cacheIdleDays
number
A cache entry nobody restored in more than this many days goes. 0 = never.
cacheRepoLimitGb
number
A repository's cache limit, in GB. 0 = no limit.
artifactRetentionDays
number
Artifact retention in days: GitHub allows 1 to 400.
logRetentionDays
number
Run log retention in days. 0 = never remove.
storageLimitGb
number
The most cache and artifacts may hold together, in GB. Null = automatic
(a fifth of the volume), 0 = no total limit.
diskFloorPercent
number
The share of the volume kept free, in percent. 0 = off.
Responses
200
POST/v1/ci-storage/previewWhat a candidate policy would come to on this disk, without saving it: the limit it sets, the disk's floor, and whether CI is over. The screen shows it while the operator types, from the same arithmetic the sweep uses, instead of a copy of that arithmetic in the browser. An empty field is the default, as it would be once saved.
Request bodyCiStoragePolicyDto
Name
Type
Description
cacheIdleDays
number
A cache entry nobody restored in more than this many days goes. 0 = never.
cacheRepoLimitGb
number
A repository's cache limit, in GB. 0 = no limit.
artifactRetentionDays
number
Artifact retention in days: GitHub allows 1 to 400.
logRetentionDays
number
Run log retention in days. 0 = never remove.
storageLimitGb
number
The most cache and artifacts may hold together, in GB. Null = automatic
(a fifth of the volume), 0 = no total limit.
diskFloorPercent
number
The share of the volume kept free, in percent. 0 = off.
Responses
200
POST/v1/ci-storage/sweepStarts a sweep now, for an operator who just lowered a limit, and answers as soon as it is recorded: the pass runs on, and the screen follows it in `sweeps`. `started` is false when this replica was already sweeping.
Responses
202
CodeBrowser
GET/v1/repositories/{repositoryId}/code/branchesBranch names + the default branch (the ref picker).
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
Responses
200
GET/v1/repositories/{repositoryId}/code/detect-stackInferred build stack (buildpack, port, relevant files, suggested env) from the repo's real files — backs the deploy wizard's "detect stack".
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
ref
query
string
Responses
200
GET/v1/repositories/{repositoryId}/code/fileRaw content of a single file.
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
pathrequired
query
string
ref
query
string
Responses
200
GET/v1/repositories/{repositoryId}/code/filepathsEvery file path at a ref (recursive) for the file finder.
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
ref
query
string
Responses
200
GET/v1/repositories/{repositoryId}/code/rawRaw file bytes — backs the README image proxy so private-repo images load with the owner's token. Served with `nosniff` + a locked-down CSP so a non-image path can never execute as active content in our origin.
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
pathrequired
query
string
ref
query
string
Responses
200
GET/v1/repositories/{repositoryId}/code/treeDirectory listing at `path` (root when omitted).
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
ref
query
string
path
query
object
Responses
200
CodeLinks
DELETE/v1/commit-links/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
GET/v1/items/{id}/branches
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
POST/v1/items/{id}/branchesdevelop (ADR-039): also needs `scm.write`, which the command asks.
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyCreateItemBranchDto
Name
Type
Description
repositoryIdrequired
string
A repository connected to the workspace.
name
string
The branch's name; by default the item's identifier and title.
base
string
The branch or ref it starts from; by default the repository's default branch.
Responses
201
GET/v1/items/{id}/code-links
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
POST/v1/items/{id}/commit-links
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyLinkCommitDto
Name
Type
Description
repositoryIdrequired
string
commitSharequired
string
message
string
author
string
url
string
Responses
201
POST/v1/items/{id}/pull-request-links
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyLinkPullRequestDto
Name
Type
Description
repositoryIdrequired
string
numberrequired
number
title
string
state
string
author
string
url
string
headSha
string
Responses
201
DELETE/v1/pull-request-links/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
Comments
GET/v1/blocks/{id}/comments
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
POST/v1/blocks/{id}/comments
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyCreateCommentDto
Name
Type
Description
bodyrequired
string
mentions
string[]
Mentioned user ids.
parentCommentId
string
Reply to this comment (must be on the same target); omit for top-level.
Responses
201
PATCH/v1/comments/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyUpdateCommentDto
Name
Type
Description
body
string
mentions
string[]
Responses
200
DELETE/v1/comments/{id}As editing: its author, or whoever may update the item.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
POST/v1/comments/{id}/reactions
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyReactionDto
Name
Type
Description
emojirequired
string
The emoji to add (e.g. "👍", "🎉").
Responses
204
DELETE/v1/comments/{id}/reactions/{emoji}
Parameters
Name
In
Type
Description
idrequired
path
string
emojirequired
path
string
Responses
204
PUT/v1/comments/{id}/resolution
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyResolveCommentDto
Name
Type
Description
resolvedrequired
boolean
true resolves the comment, false reopens it.
Responses
200
GET/v1/docs/{id}/comments
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
POST/v1/docs/{id}/comments
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyCreateCommentDto
Name
Type
Description
bodyrequired
string
mentions
string[]
Mentioned user ids.
parentCommentId
string
Reply to this comment (must be on the same target); omit for top-level.
Responses
201
GET/v1/items/{id}/comments
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
POST/v1/items/{id}/comments
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyCreateCommentDto
Name
Type
Description
bodyrequired
string
mentions
string[]
Mentioned user ids.
parentCommentId
string
Reply to this comment (must be on the same target); omit for top-level.
Responses
201
Containers
GET/v1/container-types
Responses
200
POST/v1/container-types
Request bodyCreateContainerTypeDto
Name
Type
Description
namerequired
string
icon
string
color
string
allowedChildTypeIds
string[]
ContainerType ids this type may directly nest (empty = leaf).
allowedItemTypeIds
string[]
ItemType ids this type may directly hold (F2; reserved).
Responses
201
PATCH/v1/containers/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyUpdateContainerDto
Name
Type
Description
name
string
config
object
Responses
200
DELETE/v1/containers/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
POST/v1/containers/{id}/duplicate
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
201
POST/v1/containers/{id}/move
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyMoveContainerDto
Name
Type
Description
parentContainerId
string
New parent; omit / null to move to the top level (under the Space).
afterContainerId
string
Place directly after this sibling; omit / null for the first position.
spaceId
string
Move to another Space of the same workspace; omit to stay where it is.
The whole subtree follows, and the items' Space-scoped links (sprint, key
result, tags) are dropped — they belong to the Space being left.
Responses
201
GET/v1/spaces/{spaceId}/containers
Parameters
Name
In
Type
Description
spaceIdrequired
path
string
Responses
200
POST/v1/spaces/{spaceId}/containers
Parameters
Name
In
Type
Description
spaceIdrequired
path
string
Request bodyCreateContainerDto
Name
Type
Description
namerequired
string
containerTypeIdrequired
string
parentContainerId
string
Omit / null for a top-level container directly under the Space.
config
object
Responses
201
Dependencies
DELETE/v1/dependencies/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
GET/v1/items/{id}/dependencies
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
POST/v1/items/{id}/dependencies
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyAddItemDependencyDto
Name
Type
Description
targetItemIdrequired
string
The other item in the relation.
typerequired
"blocks" | "blocked_by"
`blocks` → this item blocks the target; `blocked_by` → the target blocks it.
Responses
201
DeployCluster
DELETE/v1/deploy/clusterDeprovisions the active workspace's vcluster — reclaims the whole cluster. Running workloads are removed and the services marked stopped; the records survive and a redeploy re-provisions. Irreversible until the next deploy.
Responses
204
DeploymentLogs
GET/v1/deployments/{deploymentId}/logsLive build/deploy logs for a Deployment (Server-Sent Events).
Parameters
Name
In
Type
Description
deploymentIdrequired
path
string
Responses
200
GET/v1/deployments/{deploymentId}/logs/historyThe persisted log of a finished deploy (after the live SSE channel is gone).
Nest under this block (list item, table cell); omit for top-level.
afterBlockId
string
Place after this sibling block; omit / null for the first position.
Responses
201
GET/v1/docs/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
PATCH/v1/docs/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyUpdateDocDto
Name
Type
Description
title
string
icon
string
null clears the icon.
isArchived
boolean
Responses
200
DELETE/v1/docs/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
POST/v1/docs/{id}/move
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyMoveDocDto
Name
Type
Description
parentDocId
string
New parent doc; omit / null for the top level under the Space.
afterDocId
string
Place after this sibling; omit / null for the first position.
Responses
201
GET/v1/spaces/{spaceId}/docs
Parameters
Name
In
Type
Description
spaceIdrequired
path
string
Responses
200
POST/v1/spaces/{spaceId}/docs
Parameters
Name
In
Type
Description
spaceIdrequired
path
string
Request bodyCreateDocDto
Name
Type
Description
titlerequired
string
parentDocId
string
Omit / null for a top-level doc under the Space.
icon
string
Responses
201
DocUploads
POST/v1/docs/{docId}/uploads`POST /v1/docs/:docId/uploads` — raw-body upload (the global body parser skips `/v1/docs` uploads via RAW_STREAM_PREFIXES, so `req` is the unparsed stream). Filename from `x-filename`, content-type from `content-type`.
Parameters
Name
In
Type
Description
docIdrequired
path
string
Responses
201
GET/v1/uploads/{splat}`GET /v1/uploads/*splat` — serves an upload by its full key (which contains slashes). 404 when the key is unknown. Content-type is derived from the key's extension; the body is streamed back inline.
Responses
200
DocVersions
GET/v1/docs/{id}/versions
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
POST/v1/docs/{id}/versions
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyCaptureDocVersionDto
Responses
201
GET/v1/docs/{id}/versions/{versionId}/content
Parameters
Name
In
Type
Description
idrequired
path
string
versionIdrequired
path
string
Responses
200
Fleet
POST/v1/fleet/join-grantReserves a slot + mints a single-use join grant for a new VPS.
Request bodyRequestJoinGrantDto
Name
Type
Description
rolerequired
"server" | "agent"
The k3s role the new node will take.
Responses
201
GET/v1/fleet/nodesThe fleet's nodes + the control-plane quorum summary (one round-trip).
Responses
200
GET/v1/fleet/nodes/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
DELETE/v1/fleet/nodes/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
POST/v1/fleet/nodes/{id}/cordon
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
POST/v1/fleet/nodes/{id}/drain
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
POST/v1/fleet/nodes/provisionAuto-provisions a VPS that self-joins (ADR-017, Phase C slice 2): creates the cloud server from a saved provider credential with cloud-init that runs the fleet join one-liner on first boot. Returns metadata only — never the grant.
Request bodyProvisionNodeDto
Name
Type
Description
providerConfigIdrequired
string (uuid)
The registered FleetProvider credential to create the VPS with.
Optional server name; defaults to `eqs-<shortId>` when omitted.
Responses
201
POST/v1/fleet/nodes/registerRedeems a join grant — the caller is the unauthenticated new node, the grant is its credential. Returns what the join script needs to wire into the cluster (stubbed 503 this slice).
Request bodyRegisterNodeDto
Name
Type
Description
tokenrequired
string
The single-use join grant the node was handed at provisioning time.
wgPublicKeyrequired
string
The node's WireGuard public key (the private key never leaves the box).
publicIp
string
The node's public IP / wg endpoint, when it has one.
k3sNodeName
string
The k3s node name the box will register under, when known up front.
Responses
201
GET/v1/fleet/peersThe WireGuard mesh registry — a joined node's host-side sync agent pulls this (authenticated with its long-lived node token) and reconciles its own `wg0`. `@Public()` because the caller is a node, not a session user; the node token is the credential.
Parameters
Name
In
Type
Description
authorizationrequired
header
string
Responses
200
FleetProviders
GET/v1/fleet/providersLists registered credentials (metadata only — no tokens).
Responses
200
POST/v1/fleet/providersRegisters a credential (verifies the token live, then encrypts it).
Request bodyCreateFleetProviderDto
Name
Type
Description
namerequired
string
The operator's label, e.g. "Hetzner prod".
providerrequired
"hetzner" | "digitalocean"
Which cloud this credential talks to.
tokenrequired
string
The provider API token (verified live, then encrypted at rest).
defaultRegion
string
Default location/region slug for created VPSs (provider-specific).
defaultServerType
string
Default server type/size slug for created VPSs (provider-specific).
Responses
201
DELETE/v1/fleet/providers/{id}Removes a credential (soft delete).
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
GithubAccount
GET/v1/accounts/github
Responses
200
PUT/v1/accounts/github
Request bodyConnectGithubAccountDto
Name
Type
Description
tokenrequired
string
Personal access token (classic or fine-grained).
Responses
200
DELETE/v1/accounts/githubDisconnect every GitHub connection in the workspace.
Responses
204
PUT/v1/accounts/github/appConnect a BYO GitHub App by its credentials (the workspace's own App).
Request bodyConnectGithubAppDto
Name
Type
Description
installationIdrequired
string
appIdrequired
string
clientIdrequired
string
clientSecret
string
privateKeyrequired
string
webhookSecret
string
Responses
200
GET/v1/accounts/github/app/configGitHub App configuration for the connect-flow UI (managed availability).
Responses
200
GET/v1/accounts/github/app/installation-lookup"Already installed?" — look the managed App's installation up on an org/user, so an existing installation connects without a new install round-trip (the Install button stays for other orgs).
Parameters
Name
In
Type
Description
owner
query
object
Responses
200
POST/v1/accounts/github/app/managedFinalize a managed install (the platform App) from its installation id.
Request bodyConnectGithubManagedAppDto
Name
Type
Description
installationIdrequired
string
Responses
201
DELETE/v1/accounts/github/connections/{id}Disconnect one connection (App installation) by its id.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
GET/v1/accounts/github/repositories
Responses
200
GithubIssues
GET/v1/github/repos/{owner}/{repo}/issues
Parameters
Name
In
Type
Description
ownerrequired
path
string
reporequired
path
string
state
query
"open" | "closed" | "all"
open (the default), closed or all.
assignee
query
string
A login, `@me`, `none` (unassigned) or `*` (assigned to anyone).
author
query
string
A login or `@me`.
mention
query
string
A login or `@me`: the issues that mention them.
app
query
string
A GitHub App's slug: the issues it opened.
labels
query
string
Label names, separated by commas: the issue carries all of them.
milestone
query
string
A milestone's number or title, `none` or `*`.
type
query
string
An issue type's name, `none` or `*`.
search
query
string
Words to search for, in GitHub's search syntax.
limit
query
number
30 by default.
Responses
200
POST/v1/github/repos/{owner}/{repo}/issues
Parameters
Name
In
Type
Description
ownerrequired
path
string
reporequired
path
string
Request bodyCreateGithubIssueDto
Name
Type
Description
titlerequired
string
body
string
assignees
string[]
Logins, or `@me`.
labels
string[]
milestone
string
A milestone's number or title.
type
string
An issue type's name.
parent
number
The number of the issue this one is a sub-issue of.
PATCH/v1/github/repos/{owner}/{repo}/issues/{number}/comments/lastgh issue comment --edit-last: the member's last comment, which GitHub may show as the App's (see GithubMemberComments).
Parameters
Name
In
Type
Description
ownerrequired
path
string
reporequired
path
string
numberrequired
path
number
Request bodyEditLastGithubCommentDto
Name
Type
Description
bodyrequired
string
createIfNone
boolean
Comment instead, when the member has none to edit.
Responses
200
DELETE/v1/github/repos/{owner}/{repo}/issues/{number}/comments/lastgh issue comment --delete-last: answers the comment it deleted.
The destination, as `owner/name`, of the same owner.
Responses
200
GET/v1/github/repos/{owner}/{repo}/my-issuesgh issue status: the member's open issues, assigned, mentioning them and opened by them.
Parameters
Name
In
Type
Description
ownerrequired
path
string
reporequired
path
string
Responses
200
GitlabAccount
GET/v1/accounts/gitlabConnection state (login + host + connections) for the connect UI.
Responses
200
PUT/v1/accounts/gitlabConnect (or re-auth) a GitLab account with a PAT (+ optional host).
Request bodyConnectGitlabAccountDto
Name
Type
Description
patrequired
string
GitLab personal access token (`read_api`/`read_repository` at minimum).
host
string
Self-hosted GitLab base URL (ADR-025 G1), e.g.
`https://gitlab.example.com`. Omit/empty for gitlab.com. Normalized and
fully validated (https-only, no credentials/path) by the handler —
`normalizeGitlabHost` — so the error message can be precise.
Responses
200
GET/v1/accounts/gitlab/repositories
Responses
200
Goals
GET/v1/goals/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
PATCH/v1/goals/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyUpdateGoalDto
Name
Type
Description
name
string
description
string
null clears the description.
status
"ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "ACHIEVED"
startDate
string
endDate
string
Responses
200
DELETE/v1/goals/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
POST/v1/goals/{id}/key-results
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyCreateKeyResultDto
Name
Type
Description
namerequired
string
targetValuerequired
number
startValue
number
currentValue
number
unit
string
weight
number
Responses
201
PUT/v1/items/{id}/key-result
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodySetItemKeyResultDto
Name
Type
Description
keyResultId
string
The key result the item contributes to; omit / null to unlink.
Responses
200
PATCH/v1/key-results/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyUpdateKeyResultDto
Name
Type
Description
name
string
currentValue
number
startValue
number
targetValue
number
unit
string
null clears the unit.
weight
number
Responses
200
DELETE/v1/key-results/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
GET/v1/spaces/{spaceId}/goals
Parameters
Name
In
Type
Description
spaceIdrequired
path
string
Responses
200
POST/v1/spaces/{spaceId}/goals
Parameters
Name
In
Type
Description
spaceIdrequired
path
string
Request bodyCreateGoalDto
Name
Type
Description
namerequired
string
description
string
startDate
string
endDate
string
Responses
201
ItemLifecycle
POST/v1/items/{id}/close
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyCloseItemDto
Name
Type
Description
reason
"COMPLETED" | "NOT_PLANNED" | "DUPLICATE"
Why it is closed: completed (the default), not planned or a duplicate.
duplicateOf
string
With DUPLICATE: the item it duplicates, by identifier or id.
comment
string
Left on the item before it closes, and not at all when it is closed already.
Responses
200
POST/v1/items/{id}/lock
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyLockItemDto
Name
Type
Description
reason
"OFF_TOPIC" | "RESOLVED" | "SPAM" | "TOO_HEATED"
Responses
200
DELETE/v1/items/{id}/lock
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
POST/v1/items/{id}/pin
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
DELETE/v1/items/{id}/pin
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
GET/v1/items/{id}/relationsIts parent, its sub-items, and what blocks it and what it blocks.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
POST/v1/items/{id}/reopen
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyReopenItemDto
Name
Type
Description
comment
string
Left on the item before it reopens, and not at all when it is open already.
Responses
200
POST/v1/items/{id}/transferMoves the item, with its sub-items, to another list, in any space.
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyTransferItemDto
Name
Type
Description
containerIdrequired
string
The list it moves to, in its space or in another.
Responses
200
GET/v1/items/by-identifier/{identifier}
Parameters
Name
In
Type
Description
identifierrequired
path
string
Responses
200
GET/v1/me/itemsWhat is the member's: assigned to them, mentioning them, opened by them, in the spaces where they may read items.
Responses
200
GET/v1/spaces/{spaceId}/itemsPinned items first, then the most recently updated, a page at a time.
Parameters
Name
In
Type
Description
spaceIdrequired
path
string
state
query
"open" | "closed" | "all"
open (not in a done stage, the default), closed, or all.
assignee
query
string
`me`, a user's id or their email.
tag
query
string
A tag's label, in either case. Several, separated by commas, must all be on the item.
type
query
string
An item type's slug or name, in either case.
list
query
string
A list's id or name, in either case.
mention
query
string
`me`, a user's id or their email: a comment on the item mentions them.
q
query
string
Words the title holds, in either case.
limit
query
number
cursor
query
string
The `next` of the previous page.
Responses
200
Items
GET/v1/containers/{containerId}/items
Parameters
Name
In
Type
Description
containerIdrequired
path
string
Responses
200
POST/v1/containers/{containerId}/items
Parameters
Name
In
Type
Description
containerIdrequired
path
string
Request bodyCreateItemDto
Name
Type
Description
titlerequired
string
itemTypeIdrequired
string
description
string
Plain-text description — used when no rich blocks are sent.
descriptionBlocks
object[]
Rich description as editor blocks (`SerializedBlock[]`); the plain-text
`description` is derived from it server-side.
estimate
number
Effort estimate (>= 0) + its unit — planning / sprint capacity.
estimateUnit
"DAYS" | "HOURS" | "POINTS"
parentItemId
string
Parent item (Epic▸Story▸Task); omit / null for a top-level item.
workflowStageId
string
Board column to drop the new card into; omit / null for an unplaced item.
priority
string
startDate
string
Planned start. With `dueDate` it makes the item a span on the timeline.
dueDate
string
customFields
object
Custom-field values keyed by FieldDefinition id (validated server-side).
Responses
201
GET/v1/item-types
Responses
200
POST/v1/item-types
Request bodyCreateItemTypeDto
Name
Type
Description
namerequired
string
pluralNamerequired
string
identifierPrefixrequired
string
Uppercase prefix for human ids, e.g. "TASK" → TASK-1.
Another item type of the workspace; the identifier stays (ADR-039).
description
string
null clears the description.
descriptionBlocks
object[]
Rich description blocks; null clears. Plain text is derived server-side.
estimate
number
null clears the estimate.
estimateUnit
"DAYS" | "HOURS" | "POINTS"
null clears the estimate unit.
priority
string
null clears the priority.
startDate
string
null clears the planned start (back to a milestone).
dueDate
string
null clears the due date.
Responses
200
DELETE/v1/items/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
GET/v1/items/{id}/activity
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
PUT/v1/items/{id}/assignees
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodySetItemAssigneesDto
Name
Type
Description
userIdsrequired
string[]
The complete desired assignee set (replaces the current assignees).
Responses
200
POST/v1/items/{id}/duplicateCopy an item and its sub-items right after the original, in the same container and column. Assignees, tags, sprint, comments and links stay behind: a duplicate is a fresh start on the same work.
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyDuplicateItemDto
Name
Type
Description
title
string
The copy's title; defaults to the original's with " (cópia)".
Responses
201
PUT/v1/items/{id}/fields
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodySetFieldValuesDto
Name
Type
Description
valuesrequired
object
{ [fieldDefinitionId]: value | null } — null clears that field.
Responses
200
POST/v1/items/{id}/move
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyMoveItemDto
Name
Type
Description
containerId
string
Move into another container (board/list); omit to stay put.
parentItemId
string
Re-parent in the item tree; omit / null for top-level.
afterItemId
string
Place directly after this sibling; omit / null for the first position.
Responses
201
Maven
GET/maven/{splat}
Responses
200
POST/maven/{splat}
Responses
200
PUT/maven/{splat}
Responses
200
PATCH/maven/{splat}
Responses
200
DELETE/maven/{splat}
Responses
200
Me
GET/v1/me
Responses
200
Npm
GET/npm/{splat}
Responses
200
POST/npm/{splat}
Responses
200
PUT/npm/{splat}
Responses
200
PATCH/npm/{splat}
Responses
200
DELETE/npm/{splat}
Responses
200
NuGet
GET/nuget/{splat}
Responses
200
POST/nuget/{splat}
Responses
200
PUT/nuget/{splat}
Responses
200
PATCH/nuget/{splat}
Responses
200
DELETE/nuget/{splat}
Responses
200
Pipelines
POST/v1/pipelines/previewWell under the global ceiling: this is unauthenticated AND the most expensive thing an anonymous caller can ask for — parse, expression evaluation, matrix expansion and needs-graph planning, all synchronous on the event loop. A handful of previews per minute covers the landing-page demo; a flood of adversarial YAML would otherwise stall the whole api.
Request bodyPreviewPipelineDto
Name
Type
Description
yamlrequired
string
Raw workflow YAML to parse, validate and plan.
Responses
201
Previews
DELETE/v1/previews/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
POST/v1/previews/{id}/rebuild
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
GET/v1/repositories/{repositoryId}/open-prs
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
Responses
200
GET/v1/repositories/{repositoryId}/previews
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
Responses
200
POST/v1/repositories/{repositoryId}/previews
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
Request bodyCreatePreviewManuallyDto
Name
Type
Description
prNumberrequired
number
The open pull-request number to stand a preview up for.
POST/v1/pull-requests/{id}/reviewsSubmit (or re-submit) the caller's verdict — update-or-create per reviewer.
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodySubmitReviewDto
Name
Type
Description
staterequired
"approved" | "changes"
body
string
Optional summary accompanying the verdict.
Responses
201
GET/v1/pull-requests/{id}/threadsAll threads with comments; each carries `outdated` computed against the PR's current head (outdated threads are flagged, never hidden).
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
POST/v1/pull-requests/{id}/threadsOpen a thread (line-anchored when `path` is present — validated against the current persisted diff — else a PR-level conversation); `body` is the first comment.
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyCreateReviewThreadDto
Name
Type
Description
path
string
Diff file path to anchor to; omit for a PR-level conversation thread.
side
"old" | "new"
Which side of the diff the line lives on (default `new`).
line
number
1-based line number on `side`, as carried by the persisted diff's hunks.
blocking
boolean
Reviewer veto: while unresolved, the PR cannot merge (F3).
bodyrequired
string
The thread's opening comment.
Responses
201
POST/v1/threads/{id}/comments
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyAddThreadCommentDto
Name
Type
Description
bodyrequired
string
Responses
201
POST/v1/threads/{id}/resolveResolve. A BLOCKING thread only by its creator (the veto holder); non-blocking by anyone with review permission.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
201
POST/v1/threads/{id}/unresolveReopen — anyone with review permission.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
201
PullRequests
GET/v1/pull-requests/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
GET/v1/pull-requests/{id}/checksThe PR's native CI checks for its CURRENT head (F5a, ADR-024 D7) — fed by eQuantic CI on `prMode = equantic` repos; empty when none reported.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
POST/v1/pull-requests/{id}/closeClose without merging (F3a) — the author, or anyone holding `pull_request.merge` (checked in-handler; the route rides read). Reopen is F7 — a close is final until then.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
201
GET/v1/pull-requests/{id}/diffThe persisted diff of the PR's current head (F1b) — `pending: true` until materialized, so the UI polls instead of handling a 404.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
POST/v1/pull-requests/{id}/enqueueEnqueue on the merge queue (F4a, ADR-024 D6): gated by `canMerge` with `requireUpToDate` treated as satisfied (rebase-testing against the current target IS the queue's job); any other unmet reason → 400 listing them. Entries are tested in order per (repository, targetBranch) and landed by the queue processor; the strategy is fixed at enqueue.
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyEnqueuePullRequestDto
Name
Type
Description
strategy
"merge" | "squash" | "rebase"
Responses
201
DELETE/v1/pull-requests/{id}/enqueueRemove the PR's `waiting` entry from the merge queue (F4a) — the author, or anyone holding `pull_request.merge` (checked in-handler; the route rides read). A `testing` entry cannot be dequeued — its rebase-test is already running.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
POST/v1/pull-requests/{id}/mergeMerge (F3a): re-evaluates canMerge server-side, materializes the merge in an ephemeral workdir with OUR mechanism and pushes to the provider — never the provider's merge API (ADR-024 D3/D6). Blocked → 400 listing every unmet reason. The role gate is intentionally broad (`pull_request.merge` is granted to contributors); BRANCH PROTECTION does the real gating, per merge.
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyMergePullRequestDto
Name
Type
Description
strategy
"merge" | "squash" | "rebase"
Responses
201
GET/v1/pull-requests/{id}/merge-statusThe `canMerge` verdict + inputs (F3a, ADR-024 D5) — read-only; the merge endpoint re-evaluates server-side and never trusts this view.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
GET/v1/repositories/{repositoryId}/merge-queueThe merge queue of a (repository, target branch) (F4a): live entries in queue order (1-based `position`; the testing head is 1) followed by the last 20 settled entries (`position` null) as history. `target` defaults to the repository's default branch.
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
target
query
string
Responses
200
PUT/v1/repositories/{repositoryId}/pr-mode
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
Request bodySetPrModeDto
Name
Type
Description
moderequired
"provider" | "equantic"
Responses
204
GET/v1/repositories/{repositoryId}/pull-requests
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
state
query
string
Responses
200
POST/v1/repositories/{repositoryId}/pull-requests
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
Request bodyCreatePullRequestDto
Name
Type
Description
titlerequired
string
body
string
sourceBranchrequired
string
Branch whose changes the PR proposes (its head sha is resolved from the forge).
targetBranchrequired
string
Branch the PR merges into (its head sha becomes the diff base).
Responses
201
Pypi
GET/pypitwine uploads POST to the bare `/pypi/` — a dedicated route because the `*splat` wildcard below doesn't match an empty remainder.
Responses
200
POST/pypitwine uploads POST to the bare `/pypi/` — a dedicated route because the `*splat` wildcard below doesn't match an empty remainder.
Responses
200
PUT/pypitwine uploads POST to the bare `/pypi/` — a dedicated route because the `*splat` wildcard below doesn't match an empty remainder.
Responses
200
PATCH/pypitwine uploads POST to the bare `/pypi/` — a dedicated route because the `*splat` wildcard below doesn't match an empty remainder.
Responses
200
DELETE/pypitwine uploads POST to the bare `/pypi/` — a dedicated route because the `*splat` wildcard below doesn't match an empty remainder.
Responses
200
GET/pypi/{splat}
Responses
200
POST/pypi/{splat}
Responses
200
PUT/pypi/{splat}
Responses
200
PATCH/pypi/{splat}
Responses
200
DELETE/pypi/{splat}
Responses
200
Registry
GET/v2`GET /v2/` — the OCI version probe (`docker login` hits this first). A dedicated route because the `*splat` wildcard below only matches a non-empty remainder, so `/v2` and `/v2/` would otherwise 404 and fail the handshake.
Responses
200
POST/v2`GET /v2/` — the OCI version probe (`docker login` hits this first). A dedicated route because the `*splat` wildcard below only matches a non-empty remainder, so `/v2` and `/v2/` would otherwise 404 and fail the handshake.
Responses
200
PUT/v2`GET /v2/` — the OCI version probe (`docker login` hits this first). A dedicated route because the `*splat` wildcard below only matches a non-empty remainder, so `/v2` and `/v2/` would otherwise 404 and fail the handshake.
Responses
200
PATCH/v2`GET /v2/` — the OCI version probe (`docker login` hits this first). A dedicated route because the `*splat` wildcard below only matches a non-empty remainder, so `/v2` and `/v2/` would otherwise 404 and fail the handshake.
Responses
200
DELETE/v2`GET /v2/` — the OCI version probe (`docker login` hits this first). A dedicated route because the `*splat` wildcard below only matches a non-empty remainder, so `/v2` and `/v2/` would otherwise 404 and fail the handshake.
Responses
200
GET/v2/{splat}
Responses
200
POST/v2/{splat}
Responses
200
PUT/v2/{splat}
Responses
200
PATCH/v2/{splat}
Responses
200
DELETE/v2/{splat}
Responses
200
RegistryToken
GET/v1/registry/tokens
Responses
200
POST/v1/registry/tokensCreates a token and returns the raw value ONCE (store it now).
Request bodyCreateRegistryTokenDto
Name
Type
Description
namerequired
string
expiresInDays
number
Optional expiry in days (omit = never expires).
Responses
201
DELETE/v1/registry/tokens/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
Repositories
GET/v1/repositories
Responses
200
POST/v1/repositories
Request bodyConnectRepositoryDto
Name
Type
Description
fullNamerequired
string
GitHub/Bitbucket `owner/name` (e.g. `equantic/space-demo`), Azure DevOps
`org/project/repo` (e.g. `equantic/platform/api`) or GitLab
`group/subgroup/.../project` (deep subgroups) — 2–10 segments; the
`RepoFullName` VO revalidates (ADR-025 P1a/G1/B1). Segments may contain
spaces INSIDE (Azure project names, e.g. `equantic/My Project/api`) but
never at the edges — mirrors the VO's segment rule.
SCM provider — defaults to `github` for back-compat (ADR-025 P1b).
Responses
201
GET/v1/repositories/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
DELETE/v1/repositories/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
PATCH/v1/repositories/{id}/eqs-cli
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodySetRepositoryEqsCliDto
Name
Type
Description
enabledrequired
boolean
Responses
204
PATCH/v1/repositories/{id}/pipelinesMaster switch for this repo's CI (pauses every pipeline in it).
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodySetRepositoryPipelinesDto
Name
Type
Description
enabledrequired
boolean
Responses
204
GET/v1/repositories/{id}/preview-config
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
PUT/v1/repositories/{id}/preview-config
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodySetRepositoryPreviewConfigDto
Name
Type
Description
autoCreaterequired
boolean
"Auto-preview em PRs" — create a preview env automatically on PRs.
spaceIdrequired
string (uuid)
Target Space the preview environments deploy under.
baseEnvironmentId
string (uuid)
Optional base environment to clone env vars from.
Responses
200
PATCH/v1/repositories/pipelinesPauses or resumes many repositories' CI at once, all of them or none: one id the workspace does not have refuses the request with a 404 naming it.
Request bodySetRepositoriesPipelinesDto
Name
Type
Description
repositoryIdsrequired
string (uuid)[]
The repositories to pause or resume, all of them or none.
GET/v1/runs/{runId}/deploymentsEverywhere this run's own images are (or were) deployed.
Parameters
Name
In
Type
Description
runIdrequired
path
string
Responses
200
RunnerHosts
GET/v1/runner-hostsEvery registered machine, including the ones that are not working.
Responses
200
POST/v1/runner-hostsRegisters a machine, or updates one already registered under that name. Leave `privateKey` out — that is the intended path: the platform mints an ed25519 pair, keeps the private half encrypted, and returns the public one for the operator to install. Supplying a key is for someone who already has a dedicated CI key.
Request bodyRegisterRunnerHostDto
Name
Type
Description
namerequired
string
Unique, and the handle the job log names — `Running on 'mac-mini-1'`.
osrequired
"linux" | "windows" | "macos"
addressrequired
string
Hostname or IP the platform opens ssh to.
userrequired
string
The account CI runs as. Unprivileged, please: a job is untrusted code.
port
number
arch
"amd64" | "arm64"
labels
string[]
Extra `runs-on` labels beyond the implicit OS ones (e.g. `xcode-16`).
maxConcurrency
number
Jobs this machine takes at once.
privateKey
string
An existing OpenSSH private key, when the operator insists on supplying
one. Encrypted before it reaches the repository and never returned.
Responses
201
DELETE/v1/runner-hosts/{id}Forgets the machine. Its authorized_keys is not touched.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
POST/v1/runner-hosts/{id}/checkOpens an ssh session and asks the machine what it is.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
PUT/v1/runner-hosts/{id}/idle-stopSwitches a machine this platform runs on or off (ADR-036). Only a machine whose power it owns: everything else belongs to whoever runs it.
`draining` before a reboot, `offline` to retire, `online` to take work.
Responses
200
Runners
GET/v1/runners/capacity-policyThe CI capacity policy and what it currently buys. Super-admin: this decides how much of the machine the runner may take, which is an install-level decision rather than a workspace one.
Responses
200
PUT/v1/runners/capacity-policySaves the policy. Takes effect on the next budget refresh (≤30 s).
Request bodyCiPolicyDto
Name
Type
Description
targetCpuPerJob
number
Cores a job is sized around; sets how MANY jobs a node offers.
minJobCpu
number
Floor below which a slot is not worth offering.
minJobMemoryGi
number
platformReserveRatio
number
Share of each node kept for the platform itself.
minAdmissibleMemoryGi
number
Below this share, a node offers no slots and jobs wait. 0 = off.
maxConcurrentJobs
number
Hard cap on concurrent jobs. 0 = no cap.
pinnedJobCpu
string
Fixed per-job CPU; applies on its own, without the memory pin.
pinnedJobMemory
string
Fixed per-job memory, with its unit; applies on its own.
growJobMemory
boolean
Whether a running job's memory may be raised in place as it approaches
its ceiling (ADR-035). Null clears it back to the default, which is on.
maxJobMemoryGi
number
Never grow one job past this. 0 = only the node's free room bounds it.
queuedCeilingMinutes
number
How long a run may sit queued before the watchdog gives up on it, in
minutes. 0 = never. A week is the ceiling on the ceiling: past that the
commit it was triggered for is ancient, and a run nobody has missed in a
week is not one a longer wait would have saved.
runningCeilingMinutes
number
How long a run may be in progress. 0 = no ceiling.
jobCeilingMinutes
number
How long ONE job may run when its own executor stopped counting, for a
job that declares no `timeout-minutes` of its own. 0 = no ceiling.
minJobDiskGi
number
The disk a job slot is counted at, workspace and Docker together
(ADR-038). GitHub documents 14 GB for its runner; under 1 a job cannot
hold a checkout.
pinnedJobDisk
string
Fixed per-job disk, with its unit; applies on its own.
Responses
200
POST/v1/runners/capacity-policy/previewWhat a candidate policy WOULD yield on today's cluster, without saving it. The editor needs this because the knobs are not independently meaningful: a 25% reserve and a 4-core target together might mean "no jobs at all", and finding that out by saving and waiting for a run to queue is a cruel way to learn it. Same derivation as the live budget, same node facts, different knobs.
Request bodyCiPolicyDto
Name
Type
Description
targetCpuPerJob
number
Cores a job is sized around; sets how MANY jobs a node offers.
minJobCpu
number
Floor below which a slot is not worth offering.
minJobMemoryGi
number
platformReserveRatio
number
Share of each node kept for the platform itself.
minAdmissibleMemoryGi
number
Below this share, a node offers no slots and jobs wait. 0 = off.
maxConcurrentJobs
number
Hard cap on concurrent jobs. 0 = no cap.
pinnedJobCpu
string
Fixed per-job CPU; applies on its own, without the memory pin.
pinnedJobMemory
string
Fixed per-job memory, with its unit; applies on its own.
growJobMemory
boolean
Whether a running job's memory may be raised in place as it approaches
its ceiling (ADR-035). Null clears it back to the default, which is on.
maxJobMemoryGi
number
Never grow one job past this. 0 = only the node's free room bounds it.
queuedCeilingMinutes
number
How long a run may sit queued before the watchdog gives up on it, in
minutes. 0 = never. A week is the ceiling on the ceiling: past that the
commit it was triggered for is ancient, and a run nobody has missed in a
week is not one a longer wait would have saved.
runningCeilingMinutes
number
How long a run may be in progress. 0 = no ceiling.
jobCeilingMinutes
number
How long ONE job may run when its own executor stopped counting, for a
job that declares no `timeout-minutes` of its own. 0 = no ceiling.
minJobDiskGi
number
The disk a job slot is counted at, workspace and Docker together
(ADR-038). GitHub documents 14 GB for its runner; under 1 a job cannot
hold a checkout.
pinnedJobDisk
string
Fixed per-job disk, with its unit; applies on its own.
GET/v1/runsA page of the workspace's runs (ci-run-list), newest first unless `order` is `oldest`, narrowed to one repository, to the status a run shows and to one run number. Numbers count per repository, so `runNumber` alone lists each repository's run with that number, which is how the CLI tells a number one repository has from one several share.
GET/v1/runs/{id}/jobs/{jobRunId}/logs/streamLive job logs over SSE: replays the whole persisted backlog after `afterSeq`, every page of it (the first read also enforces ownership → 404), then tails new lines as the runner produces them, completing when the job finishes. A finished run replays once and completes immediately. Subscribed before the replay so no line is lost in the gap; deduped by the monotonic `seq`.
Parameters
Name
In
Type
Description
idrequired
path
string
jobRunIdrequired
path
string
last-event-idrequired
header
string
afterSeq
query
number
Responses
200
POST/v1/runs/{id}/jobs/{jobRunId}/review
Parameters
Name
In
Type
Description
idrequired
path
string
jobRunIdrequired
path
string
Request bodyReviewDeploymentDto
Name
Type
Description
decisionrequired
"approve" | "reject"
Responses
200
POST/v1/runs/{id}/rerun
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyRerunRunDto
Name
Type
Description
moderequired
"all" | "failed"
Responses
200
POST/v1/runs/dispatch
Request bodyDispatchWorkflowDto
Name
Type
Description
repositoryIdrequired
string (uuid)
workflowPathrequired
string
Path of the workflow file inside the repo.
ref
string
Branch, tag or sha to run on; defaults to the repository default branch.
The custom domain to attach, e.g. `app.mycompany.com`.
Responses
201
DELETE/v1/services/{serviceId}/domains/{domainId}
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
domainIdrequired
path
string
Responses
204
POST/v1/services/{serviceId}/domains/{domainId}/verifyRe-checks the DNS-TXT challenge; `{ verified }` reflects the new state.
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
domainIdrequired
path
string
Responses
201
PUT/v1/services/{serviceId}/domains/{domainId}/wwwTurns the `www.` alias of one domain on or off — idempotent, so it is also how the mode is changed. On a domain, not on the service: a service can hold several custom domains and each decides for itself.
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
domainIdrequired
path
string
Request bodySetWwwAliasDto
Name
Type
Description
enabledrequired
boolean
mode
"serve" | "redirect"
Responses
200
PUT/v1/services/{serviceId}/domains/addressChooses the name of the service's address under the platform's domain (ADR-040), `<name>.<deploy domain>`. The generated address keeps answering and redirects to it. Answers the service's domains. Declared before the `:domainId` routes: Express matches in order, and `address` would otherwise be read as a domain's id.
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
Request bodyChooseAddressDto
Name
Type
Description
namerequired
string
The name of the service's address under the platform's domain, as in
`cura-accounts` for `cura-accounts.apps.equantic.space`. Its rules
(ADR-040) are checked by the service, which answers with the one it breaks.
Responses
200
DELETE/v1/services/{serviceId}/domains/addressClears the chosen name: the generated address is the service's again.
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
Responses
204
ServiceEnvVars
GET/v1/services/{serviceId}/env
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
Responses
200
PUT/v1/services/{serviceId}/env
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
Request bodySetEnvVarDto
Name
Type
Description
keyrequired
string
valuerequired
string
secret
boolean
Encrypt at rest + space via a k8s Secret (default false).
Responses
204
DELETE/v1/services/{serviceId}/env/{key}
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
keyrequired
path
string
Responses
204
POST/v1/services/{serviceId}/env/applyRe-renders the manifest + env Secret with the current variables. Async.
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
Responses
202
GET/v1/services/{serviceId}/env/pendingWhether variables are waiting for a rollout. Server-side state on purpose: the reader can leave the tab, reload, or come back tomorrow and the pending apply is still there — and it clears itself when ANY rollout picks the variables up, not only one started from this screen.
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
Responses
200
ServiceExec
POST/v1/services/{id}/exec
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyExecServiceDto
Name
Type
Description
commandrequired
string[]
The command as argv. Never parsed or split by the platform — element 0 is the program, the rest are its arguments. For shell semantics, ask for a shell explicitly.
instance
string
A specific instance (pod) to run in. Defaults to the freshest Running one. An instance that is not this service's is refused, never redirected.
timeoutMs
number
Killed after this many milliseconds (default 60000, max 300000). A timeout answers with exit code 124.
stdin
string
Written to the command's stdin and closed. This is how a script or a SQL file is piped in — it is NOT written to any log, unlike the command itself.
Responses
201
ServiceMetrics
GET/v1/services/{serviceId}/metricsLive CPU/mem usage for the service's pods (read-only; safe to poll).
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
Responses
200
GET/v1/services/{serviceId}/metrics/historyCPU/mem time series for the service (read-only). `hours` 1–168, default 24.
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
hours
query
string
Responses
200
ServiceMq
GET/v1/services/{serviceId}/mq/queuesWhat is on the broker. Streams on NATS; refused on AMQP, which cannot.
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
Responses
200
POST/v1/services/{serviceId}/mq/queues/{target}/consumeTake messages off. They do not come back.
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
targetrequired
path
string
Request bodyBrokerOperationDto
Name
Type
Description
payload
string
The message body, for publish. Sent as bytes and never written to the audit log.
limit
number
Messages to read before truncating (default 100, max 10000).
timeoutMs
number
Operation timeout in milliseconds (default 15000, max 120000).
Responses
200
POST/v1/services/{serviceId}/mq/queues/{target}/peekLook without taking — as far as the broker allows; the result says.
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
targetrequired
path
string
Request bodyBrokerOperationDto
Name
Type
Description
payload
string
The message body, for publish. Sent as bytes and never written to the audit log.
limit
number
Messages to read before truncating (default 100, max 10000).
timeoutMs
number
Operation timeout in milliseconds (default 15000, max 120000).
Responses
200
POST/v1/services/{serviceId}/mq/queues/{target}/publishPut one on.
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
targetrequired
path
string
Request bodyBrokerOperationDto
Name
Type
Description
payload
string
The message body, for publish. Sent as bytes and never written to the audit log.
limit
number
Messages to read before truncating (default 100, max 10000).
timeoutMs
number
Operation timeout in milliseconds (default 15000, max 120000).
Responses
200
POST/v1/services/{serviceId}/mq/queues/{target}/purgeDiscard everything on it. `data.ddl`, not `data.write`. Not a schema change, so on the word alone it does not belong there. But `data.ddl` exists in this ADR because "editing a row and dropping a table are not the same risk", and emptying a production queue is the second kind.
Parameters
Name
In
Type
Description
serviceIdrequired
path
string
targetrequired
path
string
Request bodyBrokerOperationDto
Name
Type
Description
payload
string
The message body, for publish. Sent as bytes and never written to the audit log.
limit
number
Messages to read before truncating (default 100, max 10000).
timeoutMs
number
Operation timeout in milliseconds (default 15000, max 120000).
Responses
200
ServiceRuntimeLogs
GET/v1/services/{id}/instancesThe service's pods — the instance picker for the console + runtime logs.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
GET/v1/services/{id}/logs/runtimeLive runtime logs (`?instance=all` or a pod name) as Server-Sent Events.
Parameters
Name
In
Type
Description
idrequired
path
string
instance
query
object
Responses
200
Services
GET/v1/services/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
PATCH/v1/services/{id}Updates the service's runtime config, then re-rolls it.
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyUpdateServiceDto
Name
Type
Description
name
string
image
string
New image ref (image-source services only).
branch
string
dockerfilePath
string
port
number
internal
boolean
publicAllowedCidrs
string[]
CIDRs allowed to reach the public TCP port; empty = any source (ADR-013 F2).
Validated here rather than trusted: a typo'd CIDR would be rejected by the
cluster mid-rollout, and the safest place to catch it is before any of this
reaches the engine.
minInstances
number
0 = scale-to-zero.
maxInstances
number
cpuRequest
string
memRequest
string
cpuLimit
string
memLimit
string
healthPath
string
Readiness path; blank clears it, back to the plain TCP probe.
args
string[]
Container args (replaces the image's CMD). An empty array clears them.
Responses
200
DELETE/v1/services/{id}Deletes the service + all its vcluster resources (irreversible).
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
GET/v1/services/{id}/connectionConnection details for a marketplace service (host/port/credentials), for the Connect dialog. Gated on `env.read` rather than `service.read`: the response carries the service's real password, so it is exactly as sensitive as revealing an env secret.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
GET/v1/services/{id}/deploymentsThe service's deploy history (newest first).
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
GET/v1/services/{id}/provenanceWhere what this service is running came from: the version, the run that pushed it and the repository behind it (ADR-033).
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
POST/v1/services/{id}/redeployRe-rolls the service (rebuilds repo sources). Accepted; runs async.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
202
POST/v1/services/{id}/restartRestarts the service's pods in place (no rebuild). Accepted; runs async.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
202
POST/v1/services/{id}/rollbackRolls back to a prior deployment's image (redeploy, no rebuild).
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyRollbackServiceDto
Name
Type
Description
deploymentIdrequired
string
The prior deployment to roll back to (its image is redeployed).
Responses
202
POST/v1/services/{id}/startStarts a stopped service (scale back to its floor).
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
POST/v1/services/{id}/stopStops the service (scale to 0, KEDA paused).
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
SpaceEnvVars
GET/v1/spaces/{spaceId}/env
Parameters
Name
In
Type
Description
spaceIdrequired
path
string
Responses
200
PUT/v1/spaces/{spaceId}/env
Parameters
Name
In
Type
Description
spaceIdrequired
path
string
Request bodySetEnvVarDto
Name
Type
Description
keyrequired
string
valuerequired
string
secret
boolean
Encrypt at rest + space via a k8s Secret (default false).
Responses
204
DELETE/v1/spaces/{spaceId}/env/{key}
Parameters
Name
In
Type
Description
spaceIdrequired
path
string
keyrequired
path
string
Responses
204
Spaces
GET/v1/spaces
Responses
200
POST/v1/spaces
Request bodyCreateSpaceDto
Name
Type
Description
namerequired
string
description
string
color
string
Responses
201
GET/v1/spaces/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
PATCH/v1/spaces/{id}Renames the space (display name only; the slug stays stable).
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyUpdateSpaceDto
Name
Type
Description
namerequired
string
Responses
200
DELETE/v1/spaces/{id}Deletes the space + all its services' vcluster resources (irreversible).
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
POST/v1/spaces/{id}/moveMoves the space in the workspace's list, the order every member sees: first when `afterSpaceId` is null, otherwise right after that space.
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyMoveSpaceDto
Name
Type
Description
afterSpaceId
string
Place the space directly after this one; omit or null to put it first.
Both must belong to the active workspace.
Responses
200
SpaceServices
GET/v1/spaces/{id}/services
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
200
POST/v1/spaces/{id}/services
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyCreateServiceDto
Name
Type
Description
namerequired
string
sourcerequired
"image" | "repo" | "dockerfile" | "compose"
environmentId
string (uuid)
Target environment; defaults to the space's default (production).
Per-instance resource overrides. Omitted/blank leaves the service on the
engine default, which is what most services want — the wizard only sends
these when the operator opens Avançado and types a value.
memRequest
string
cpuLimit
string
memLimit
string
healthPath
string
Readiness path. Set → the probe becomes an HTTP GET against it; omitted →
the port just has to accept a TCP connection, which is all a portless or
non-HTTP workload can promise.
args
string[]
Container args (replaces the image's CMD). A catalog service inherits the
entry's args; passing them here overrides that for this one service.
internal
boolean
Internal (no public domain) — ClusterIP only. Databases are internal.
Persistent volume size in GiB (required when stateful).
dataPath
string
Container path the volume mounts at (required when stateful).
catalogServiceId
string (uuid)
Create from a catalog entry (one-click) — resolves image/port/stateful/etc.
version
string
Catalog image version (defaults to the catalog's newest).
fieldValues
object
Catalog field values (key → value) → env vars + the PVC size.
Responses
201
Sprints
PUT/v1/items/{id}/sprint
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodySetItemSprintDto
Name
Type
Description
sprintId
string
The target sprint; omit / null to remove the item from its sprint.
Responses
200
GET/v1/spaces/{spaceId}/sprints
Parameters
Name
In
Type
Description
spaceIdrequired
path
string
Responses
200
POST/v1/spaces/{spaceId}/sprints
Parameters
Name
In
Type
Description
spaceIdrequired
path
string
Request bodyCreateSprintDto
Name
Type
Description
namerequired
string
goal
string
startDate
string
endDate
string
capacity
number
Responses
201
PATCH/v1/sprints/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyUpdateSprintDto
Name
Type
Description
name
string
goal
string
null clears the goal.
startDate
string
endDate
string
capacity
number
Responses
200
DELETE/v1/sprints/{id}
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
POST/v1/sprints/{id}/transition
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyTransitionSprintDto
Name
Type
Description
actionrequired
"start" | "complete"
'start' (PLANNED → ACTIVE) or 'complete' (→ COMPLETED).
Responses
201
System
POST/v1/admin/system/licenseReplaces the platform licence with a new serial — the badge's action (ADR-018 amendment). Verified before it is stored, so a wrong serial cannot cost a working licence. Accepts a SERIAL only: a public key supplied here would let anyone verify a licence they signed themselves.
Request bodyApplyLicenseDto
Name
Type
Description
licenseKeyrequired
string
Responses
201
GET/v1/admin/system/update
Responses
200
POST/v1/admin/system/update/applyTriggers an update to the given tag (or the latest). Idempotent while running.
Request bodyApplyUpdateDto
Name
Type
Description
version
string
Target release tag (e.g. "v2026.06.19-142530"). Omit to update to the latest
GitHub release. Constrained to a safe tag shape — it is interpolated into a
release download URL and a Job manifest.
Responses
201
GET/v1/admin/system/update/status
Responses
200
GET/v1/admin/system/update/streamLive progress of the running update (Server-Sent Events).
Responses
200
GET/v1/admin/system/version
Responses
200
Tags
PUT/v1/items/{id}/tags
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodySetItemTagsDto
Name
Type
Description
tagIdsrequired
string[]
The complete desired tag set (replaces the current tags).
Responses
200
GET/v1/spaces/{spaceId}/tags
Parameters
Name
In
Type
Description
spaceIdrequired
path
string
Responses
200
POST/v1/spaces/{spaceId}/tags
Parameters
Name
In
Type
Description
spaceIdrequired
path
string
Request bodyCreateTagDto
Name
Type
Description
labelrequired
string
colorrequired
string
Responses
201
Templates
GET/v1/space-templates
Responses
200
POST/v1/spaces/{spaceId}/apply-templateMaterializes the template's whole structure into the Space.
Parameters
Name
In
Type
Description
spaceIdrequired
path
string
Request bodyApplyTemplateDto
Name
Type
Description
templateKeyrequired
string
The template key from the catalog (e.g. "scrum", "kanban", "bug-tracker").
Responses
204
Webhooks
POST/v1/webhooks/{provider}
Parameters
Name
In
Type
Description
providerrequired
path
string
Responses
202
Wiki
GET/v1/repositories/{repositoryId}/wikiWiki availability + pages (markdown), read from the `.wiki` git repo.
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
Responses
200
Workflows
GET/v1/repositories/{repositoryId}/workflows
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
Responses
200
PATCH/v1/repositories/{repositoryId}/workflows/{workflowFileId}/enabledEnables/disables ONE pipeline. Applies to the next event; runs already in flight finish (see SetWorkflowEnabledHandler).
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
workflowFileIdrequired
path
string
Request bodySetWorkflowEnabledDto
Name
Type
Description
enabledrequired
boolean
Responses
204
GET/v1/repositories/{repositoryId}/workflows/action-metadataAction metadata (inputs) for the step assistant — any `owner/repo@ref`.
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
usesrequired
query
string
Responses
200
GET/v1/repositories/{repositoryId}/workflows/contentRaw YAML of a workflow file (fetched from the provider on demand).
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
pathrequired
query
string
Responses
200
PUT/v1/repositories/{repositoryId}/workflows/contentCommits edited YAML back to a workflow file (needs Contents: write).
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
Request bodySaveWorkflowContentDto
Name
Type
Description
pathrequired
string
Workflow path, e.g. `.github/workflows/ci.yml`.
contentrequired
string
message
string
Commit message (defaults to "Update <path> via eQuantic Space").
branch
string
Target branch (defaults to the repo's default branch).
Responses
200
POST/v1/repositories/{repositoryId}/workflows/syncRe-reads `.github/workflows` from the provider and refreshes the interpreted rows. Manual counterpart to the automatic sync on connect/push — lets users pick up workflows added after the repo was connected. Provider errors are surfaced (not swallowed) so an empty refresh is explainable.
Parameters
Name
In
Type
Description
repositoryIdrequired
path
string
Responses
200
Workspace
GET/v1/workspacesThe user's workspaces, with the active one flagged.
Responses
200
POST/v1/workspacesCreate a workspace (under the user's tenant) and make it active.
Request bodyCreateWorkspaceDto
Name
Type
Description
namerequired
string
slug
string
Desired slug; derived from the name when omitted.
type
string
Onboarding hints persisted in `workspace.metadata`.
size
string
features
string[]
invites
string
Comma/space/newline-separated emails to invite (pending invitations).
inviteRole
string
Responses
201
PATCH/v1/workspaces/{id}Update a workspace's name and/or enabled features (owner/admin).
Parameters
Name
In
Type
Description
idrequired
path
string
Request bodyUpdateWorkspaceDto
Name
Type
Description
name
string
features
string[]
Responses
200
POST/v1/workspaces/{id}/activateSwitch the active workspace for the current session.
Parameters
Name
In
Type
Description
idrequired
path
string
Responses
204
GET/v1/workspaces/check-slugSlug-availability check for the wizard.