ReferenzAPI-Referenz

API-Referenz

Alle Endpunkte der eQuantic Space API, direkt aus der API generiert.

Die API, die die Web-App, die eqs-CLI und die Runner nutzen. Diese Seite wird aus dem OpenAPI-Dokument der API selbst erzeugt und listet genau die Endpunkte, die die API bereitstellt.

Basis-URL

WoBasis-URL
eQuantic Space Cloudhttps://api.app.equantic.space
Eine selbst gehostete Installationhttps://api.<deine-domain>

Authentifizierung

Sende ein Token im Authorization-Header:

bash
curl -H "Authorization: Bearer $EQS_TOKEN" https://api.app.equantic.space/v1/workspaces

Das Token kann ein persönliches Zugriffstoken oder das Secret eines Service Principals sein (siehe Zugriff (RBAC)). Jede Anfrage wird gegen die Rollen der Identität hinter dem Token geprüft.

Endpunkte

Die Zusammenfassungen sind auf Englisch, so wie die API sie dokumentiert.

400 Endpunkte in 74 Bereichen

Access

GET/v1/access/assignments

Parameter

NameOrtTypBeschreibung
scopeTypequerystring
scopeIdquerystring
inheritedquerystring

Antworten

  • 200
POST/v1/access/assignments

Request-BodyAddAssignmentDto

Antworten

  • 201
DELETE/v1/access/assignments/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
GET/v1/access/effective

Parameter

NameOrtTypBeschreibung
principalTypequerystring
principalIdPflichtquerystring
scopeTypequerystring
scopeIdquerystring

Antworten

  • 200
GET/v1/access/roles

Antworten

  • 200
POST/v1/access/roles

Request-BodyCreateRoleDto

Antworten

  • 201
PATCH/v1/access/roles/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyUpdateRoleDto

Antworten

  • 200
DELETE/v1/access/roles/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
GET/v1/access/scopes

Antworten

  • 200
GET/v1/access/service-principals

Antworten

  • 200
POST/v1/access/service-principals

Request-BodyCreateSpDto

Antworten

  • 201
GET/v1/access/service-principals/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring
scopeTypequerystring
scopeIdquerystring

Antworten

  • 200
PATCH/v1/access/service-principals/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyUpdateSpDto

Antworten

  • 200
DELETE/v1/access/service-principals/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
POST/v1/access/service-principals/{id}/assignments

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyAddSpAssignmentDto

Antworten

  • 201
DELETE/v1/access/service-principals/{id}/assignments/{assignmentId}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring
assignmentIdPflichtpathstring

Antworten

  • 204
POST/v1/access/service-principals/{id}/certificates

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyAddSpCertDto

Antworten

  • 201
POST/v1/access/service-principals/{id}/credentials

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyAddSpCredentialDto

Antworten

  • 201
DELETE/v1/access/service-principals/{id}/credentials/{credentialId}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring
credentialIdPflichtpathstring

Antworten

  • 204
GET/v1/access/tokens

Antworten

  • 200
POST/v1/access/tokens

Request-BodyCreateTokenDto

Antworten

  • 201
DELETE/v1/access/tokens/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204

App

GET/

Antworten

  • 200
GET/health

Antworten

  • 200

ArtifactBlob

GET/_apis/results/download/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
PUT/_apis/results/upload/{uploadId}

Parameter

NameOrtTypBeschreibung
uploadIdPflichtpathstring
blockidqueryobject
compqueryobject

Antworten

  • 201

ArtifactResults

POST/twirp/github.actions.results.api.v1.ArtifactService/CreateArtifact

Antworten

  • 201
POST/twirp/github.actions.results.api.v1.ArtifactService/FinalizeArtifact

Antworten

  • 201
POST/twirp/github.actions.results.api.v1.ArtifactService/GetSignedArtifactURL

Antworten

  • 201
POST/twirp/github.actions.results.api.v1.ArtifactService/ListArtifacts

Antworten

  • 201

Artifacts

GET/v1/artifacts

Antworten

  • 200
POST/v1/artifacts

Request-BodyCreateArtifactRepoDto

NameTypBeschreibung
typePflicht"container" | "npm" | "maven" | "nuget" | "rubygems" | "pypi"
namePflichtstring
visibilityPflicht"private" | "public" | "internal"
descriptionstring
immutableTagsboolean
scanOnPushboolean

Antworten

  • 201
GET/v1/artifacts/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
PATCH/v1/artifacts/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyUpdateArtifactRepoDto

NameTypBeschreibung
visibility"private" | "public" | "internal"
descriptionstring
immutableTagsboolean
scanOnPushboolean
requireSignedPullboolean

Antworten

  • 204
DELETE/v1/artifacts/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
POST/v1/artifacts/{id}/policies

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyCreatePolicyDto

NameTypBeschreibung
namePflichtstring
kindPflicht"keep-n" | "age" | "policy"
scopePflichtstring
valuePflichtnumber
actionPflicht"keep" | "delete" | "block"
enabledboolean

Antworten

  • 201
PATCH/v1/artifacts/{id}/policies/{policyId}

Parameter

NameOrtTypBeschreibung
policyIdPflichtpathstring

Request-BodyUpdatePolicyDto

NameTypBeschreibung
namestring
kind"keep-n" | "age" | "policy"
scopestring
valuenumber
action"keep" | "delete" | "block"
enabledboolean

Antworten

  • 204
DELETE/v1/artifacts/{id}/policies/{policyId}

Parameter

NameOrtTypBeschreibung
policyIdPflichtpathstring

Antworten

  • 204
GET/v1/artifacts/{id}/retention/preview

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
GET/v1/artifacts/{id}/signing-keys

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
POST/v1/artifacts/{id}/signing-keys

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyAddSigningKeyDto

NameTypBeschreibung
namePflichtstring
publicKeyPflichtstringPEM-encoded cosign public key (`cosign.pub`).

Antworten

  • 201
DELETE/v1/artifacts/{id}/signing-keys/{keyId}

Parameter

NameOrtTypBeschreibung
keyIdPflichtpathstring

Antworten

  • 204
GET/v1/artifacts/{id}/versions/{tag}/layers

Parameter

NameOrtTypBeschreibung
idPflichtpathstring
tagPflichtpathstring

Antworten

  • 200
GET/v1/artifacts/usage

Antworten

  • 200

AzureAccount

GET/v1/accounts/azure-devopsConnection state (organization + connections) for the connect UI (P1c).

Antworten

  • 200
PUT/v1/accounts/azure-devopsConnect (or re-auth) an Azure DevOps organization with a PAT.

Request-BodyConnectAzureAccountDto

NameTypBeschreibung
organizationPflichtstringOrganization name only — `equantic` in `https://dev.azure.com/equantic`.
patPflichtstringAzure DevOps personal access token (Code read scope at minimum).

Antworten

  • 200
GET/v1/accounts/azure-devops/repositories

Antworten

  • 200

BitbucketAccount

GET/v1/accounts/bitbucketConnection state (login + connections) for the connect UI.

Antworten

  • 200
PUT/v1/accounts/bitbucketConnect (or re-auth) a Bitbucket account with a username + secret pair.

Request-BodyConnectBitbucketAccountDto

NameTypBeschreibung
usernamePflichtstringHTTP 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.
secretPflichtstringApp password or Atlassian API token (repository read at minimum).
workspacePflichtstringThe 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 `-`/`_`.

Antworten

  • 200
GET/v1/accounts/bitbucket/repositories

Antworten

  • 200

Boards

POST/v1/containers/{containerId}/stages

Parameter

NameOrtTypBeschreibung
containerIdPflichtpathstring

Request-BodyCreateStageDto

NameTypBeschreibung
namePflichtstring
stageType"TODO" | "IN_PROGRESS" | "REVIEW" | "TESTING" | "DONE" | "BLOCKED" | "CUSTOM"
colorstring

Antworten

  • 201
GET/v1/containers/{containerId}/views

Parameter

NameOrtTypBeschreibung
containerIdPflichtpathstring

Antworten

  • 200
POST/v1/containers/{containerId}/views

Parameter

NameOrtTypBeschreibung
containerIdPflichtpathstring

Request-BodyCreateViewDto

NameTypBeschreibung
namePflichtstring
typePflicht"TABLE" | "LIST" | "BOARD" | "CALENDAR" | "TIMELINE" | "GANTT"
configobjectfilters/sorts/groupBy/columns keyed by fieldId — stored, executed client-side.
isDefaultboolean

Antworten

  • 201
GET/v1/containers/{containerId}/workflow

Parameter

NameOrtTypBeschreibung
containerIdPflichtpathstring

Antworten

  • 200
PUT/v1/items/{id}/stage

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodySetItemStageDto

NameTypBeschreibung
stageIdstringThe target stage; omit / null to unstage the item.

Antworten

  • 200
PATCH/v1/stages/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyUpdateStageDto

NameTypBeschreibung
namestring
colorstringnull clears the color.
stageType"TODO" | "IN_PROGRESS" | "REVIEW" | "TESTING" | "DONE" | "BLOCKED" | "CUSTOM"
afterStageIdstringReorder: place after this stage (omit / null for the first column).

Antworten

  • 200
DELETE/v1/stages/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
PATCH/v1/views/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyUpdateViewDto

NameTypBeschreibung
namestring
configobject
isDefaultboolean

Antworten

  • 200
DELETE/v1/views/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204

BranchProtections

GET/v1/repositories/{repositoryId}/branch-protections

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring

Antworten

  • 200
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.

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring

Request-BodyPutBranchProtectionDto

NameTypBeschreibung
branchPatternPflichtstringExact branch name (`main`) or a simple segment-scoped `*` glob (`release/*`).
requiredApprovalsnumber
requireChecksboolean
requireLinearboolean
requireUpToDateboolean
dismissStaleboolean
blockOnUnresolvedBlockingboolean
strategies"merge" | "squash" | "rebase"[]
defaultStrategy"merge" | "squash" | "rebase"

Antworten

  • 200
DELETE/v1/repositories/{repositoryId}/branch-protections/{ruleId}

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
ruleIdPflichtpathstring

Antworten

  • 204

Cache

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>-`.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring
tokenqueryobject

Antworten

  • 200
GET/_apis/artifactcache/cache

Parameter

NameOrtTypBeschreibung
keysPflichtquerystring
versionPflichtquerystring

Antworten

  • 200
POST/_apis/artifactcache/caches

Antworten

  • 201
POST/_apis/artifactcache/caches/{cacheId}

Parameter

NameOrtTypBeschreibung
cacheIdPflichtpathstring

Antworten

  • 204
PATCH/_apis/artifactcache/caches/{cacheId}

Parameter

NameOrtTypBeschreibung
cacheIdPflichtpathstring

Antworten

  • 204

CacheBlob

PUT/_apis/results/cache-upload/{uploadId}

Parameter

NameOrtTypBeschreibung
uploadIdPflichtpathstring
blockidqueryobject
compqueryobject

Antworten

  • 201

CacheResults

POST/twirp/github.actions.results.api.v1.CacheService/CreateCacheEntry

Antworten

  • 200
POST/twirp/github.actions.results.api.v1.CacheService/FinalizeCacheEntryUpload

Antworten

  • 200
POST/twirp/github.actions.results.api.v1.CacheService/GetCacheEntryDownloadURL

Antworten

  • 200

Catalog

GET/v1/catalog/categories

Antworten

  • 200
GET/v1/catalog/services

Parameter

NameOrtTypBeschreibung
categoryPflichtquerystring

Antworten

  • 200
GET/v1/catalog/services/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200

CiStorage

GET/v1/ci-storage

Antworten

  • 200
PUT/v1/ci-storage/policySaves the policy. The next sweep, at most an hour away, applies it.

Request-BodyCiStoragePolicyDto

NameTypBeschreibung
cacheIdleDaysnumberA cache entry nobody restored in more than this many days goes. 0 = never.
cacheRepoLimitGbnumberA repository's cache limit, in GB. 0 = no limit.
artifactRetentionDaysnumberArtifact retention in days: GitHub allows 1 to 400.
logRetentionDaysnumberRun log retention in days. 0 = never remove.
storageLimitGbnumberThe most cache and artifacts may hold together, in GB. Null = automatic (a fifth of the volume), 0 = no total limit.
diskFloorPercentnumberThe share of the volume kept free, in percent. 0 = off.

Antworten

  • 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

NameTypBeschreibung
cacheIdleDaysnumberA cache entry nobody restored in more than this many days goes. 0 = never.
cacheRepoLimitGbnumberA repository's cache limit, in GB. 0 = no limit.
artifactRetentionDaysnumberArtifact retention in days: GitHub allows 1 to 400.
logRetentionDaysnumberRun log retention in days. 0 = never remove.
storageLimitGbnumberThe most cache and artifacts may hold together, in GB. Null = automatic (a fifth of the volume), 0 = no total limit.
diskFloorPercentnumberThe share of the volume kept free, in percent. 0 = off.

Antworten

  • 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.

Antworten

  • 202

CodeBrowser

GET/v1/repositories/{repositoryId}/code/branchesBranch names + the default branch (the ref picker).

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring

Antworten

  • 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".

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
refquerystring

Antworten

  • 200
GET/v1/repositories/{repositoryId}/code/fileRaw content of a single file.

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
pathPflichtquerystring
refquerystring

Antworten

  • 200
GET/v1/repositories/{repositoryId}/code/filepathsEvery file path at a ref (recursive) for the file finder.

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
refquerystring

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
pathPflichtquerystring
refquerystring

Antworten

  • 200
GET/v1/repositories/{repositoryId}/code/treeDirectory listing at `path` (root when omitted).

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
refquerystring
pathqueryobject

Antworten

  • 200

Comments

GET/v1/blocks/{id}/comments

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
POST/v1/blocks/{id}/comments

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyCreateCommentDto

NameTypBeschreibung
bodyPflichtstring
mentionsstring[]Mentioned user ids.
parentCommentIdstringReply to this comment (must be on the same target); omit for top-level.

Antworten

  • 201
PATCH/v1/comments/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyUpdateCommentDto

NameTypBeschreibung
bodystring
mentionsstring[]

Antworten

  • 200
DELETE/v1/comments/{id}As editing: its author, or whoever may update the item.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
POST/v1/comments/{id}/reactions

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyReactionDto

NameTypBeschreibung
emojiPflichtstringThe emoji to add (e.g. "👍", "🎉").

Antworten

  • 204
DELETE/v1/comments/{id}/reactions/{emoji}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring
emojiPflichtpathstring

Antworten

  • 204
PUT/v1/comments/{id}/resolution

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyResolveCommentDto

NameTypBeschreibung
resolvedPflichtbooleantrue resolves the comment, false reopens it.

Antworten

  • 200
GET/v1/docs/{id}/comments

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
POST/v1/docs/{id}/comments

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyCreateCommentDto

NameTypBeschreibung
bodyPflichtstring
mentionsstring[]Mentioned user ids.
parentCommentIdstringReply to this comment (must be on the same target); omit for top-level.

Antworten

  • 201
GET/v1/items/{id}/comments

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
POST/v1/items/{id}/comments

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyCreateCommentDto

NameTypBeschreibung
bodyPflichtstring
mentionsstring[]Mentioned user ids.
parentCommentIdstringReply to this comment (must be on the same target); omit for top-level.

Antworten

  • 201

Containers

GET/v1/container-types

Antworten

  • 200
POST/v1/container-types

Request-BodyCreateContainerTypeDto

NameTypBeschreibung
namePflichtstring
iconstring
colorstring
allowedChildTypeIdsstring[]ContainerType ids this type may directly nest (empty = leaf).
allowedItemTypeIdsstring[]ItemType ids this type may directly hold (F2; reserved).

Antworten

  • 201
PATCH/v1/containers/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyUpdateContainerDto

NameTypBeschreibung
namestring
configobject

Antworten

  • 200
DELETE/v1/containers/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
POST/v1/containers/{id}/duplicate

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 201
POST/v1/containers/{id}/move

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyMoveContainerDto

NameTypBeschreibung
parentContainerIdstringNew parent; omit / null to move to the top level (under the Space).
afterContainerIdstringPlace directly after this sibling; omit / null for the first position.
spaceIdstringMove 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.

Antworten

  • 201
GET/v1/spaces/{spaceId}/containers

Parameter

NameOrtTypBeschreibung
spaceIdPflichtpathstring

Antworten

  • 200
POST/v1/spaces/{spaceId}/containers

Parameter

NameOrtTypBeschreibung
spaceIdPflichtpathstring

Request-BodyCreateContainerDto

NameTypBeschreibung
namePflichtstring
containerTypeIdPflichtstring
parentContainerIdstringOmit / null for a top-level container directly under the Space.
configobject

Antworten

  • 201

Dependencies

DELETE/v1/dependencies/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
GET/v1/items/{id}/dependencies

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
POST/v1/items/{id}/dependencies

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyAddItemDependencyDto

NameTypBeschreibung
targetItemIdPflichtstringThe other item in the relation.
typePflicht"blocks" | "blocked_by"`blocks` → this item blocks the target; `blocked_by` → the target blocks it.

Antworten

  • 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.

Antworten

  • 204

DeploymentLogs

GET/v1/deployments/{deploymentId}/logsLive build/deploy logs for a Deployment (Server-Sent Events).

Parameter

NameOrtTypBeschreibung
deploymentIdPflichtpathstring

Antworten

  • 200
GET/v1/deployments/{deploymentId}/logs/historyThe persisted log of a finished deploy (after the live SSE channel is gone).

Parameter

NameOrtTypBeschreibung
deploymentIdPflichtpathstring

Antworten

  • 200

DocCollab

POST/v1/docs/{id}/collab/token

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 201

Docs

PATCH/v1/blocks/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyUpdateBlockDto

NameTypBeschreibung
blockType"PARAGRAPH" | "HEADING_1" | "HEADING_2" | "HEADING_3" | "BULLET_ITEM" | "NUMBERED_ITEM" | "TODO" | "QUOTE" | "CODE" | "DIVIDER" | "CALLOUT" | "TOGGLE" | "IMAGE" | "FILE" | "EMBED" | "TABLE" | "MERMAID" | "EQUATION"
contentobjectnull clears the block's content.

Antworten

  • 200
DELETE/v1/blocks/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
POST/v1/blocks/{id}/move

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyMoveBlockDto

NameTypBeschreibung
parentBlockIdstringNew parent block (nest/indent); omit / null for top-level in the doc.
afterBlockIdstringPlace after this sibling block; omit / null for the first position.

Antworten

  • 201
POST/v1/docs/{docId}/blocks

Parameter

NameOrtTypBeschreibung
docIdPflichtpathstring

Request-BodyCreateBlockDto

NameTypBeschreibung
blockTypePflicht"PARAGRAPH" | "HEADING_1" | "HEADING_2" | "HEADING_3" | "BULLET_ITEM" | "NUMBERED_ITEM" | "TODO" | "QUOTE" | "CODE" | "DIVIDER" | "CALLOUT" | "TOGGLE" | "IMAGE" | "FILE" | "EMBED" | "TABLE" | "MERMAID" | "EQUATION"
contentobject
parentBlockIdstringNest under this block (list item, table cell); omit for top-level.
afterBlockIdstringPlace after this sibling block; omit / null for the first position.

Antworten

  • 201
GET/v1/docs/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
PATCH/v1/docs/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyUpdateDocDto

NameTypBeschreibung
titlestring
iconstringnull clears the icon.
isArchivedboolean

Antworten

  • 200
DELETE/v1/docs/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
POST/v1/docs/{id}/move

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyMoveDocDto

NameTypBeschreibung
parentDocIdstringNew parent doc; omit / null for the top level under the Space.
afterDocIdstringPlace after this sibling; omit / null for the first position.

Antworten

  • 201
GET/v1/spaces/{spaceId}/docs

Parameter

NameOrtTypBeschreibung
spaceIdPflichtpathstring

Antworten

  • 200
POST/v1/spaces/{spaceId}/docs

Parameter

NameOrtTypBeschreibung
spaceIdPflichtpathstring

Request-BodyCreateDocDto

NameTypBeschreibung
titlePflichtstring
parentDocIdstringOmit / null for a top-level doc under the Space.
iconstring

Antworten

  • 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`.

Parameter

NameOrtTypBeschreibung
docIdPflichtpathstring

Antworten

  • 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.

Antworten

  • 200

DocVersions

GET/v1/docs/{id}/versions

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
POST/v1/docs/{id}/versions

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyCaptureDocVersionDto

Antworten

  • 201
GET/v1/docs/{id}/versions/{versionId}/content

Parameter

NameOrtTypBeschreibung
idPflichtpathstring
versionIdPflichtpathstring

Antworten

  • 200

Fleet

POST/v1/fleet/join-grantReserves a slot + mints a single-use join grant for a new VPS.

Request-BodyRequestJoinGrantDto

NameTypBeschreibung
rolePflicht"server" | "agent"The k3s role the new node will take.

Antworten

  • 201
GET/v1/fleet/nodesThe fleet's nodes + the control-plane quorum summary (one round-trip).

Antworten

  • 200
GET/v1/fleet/nodes/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
DELETE/v1/fleet/nodes/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
POST/v1/fleet/nodes/{id}/cordon

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
POST/v1/fleet/nodes/{id}/drain

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 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

NameTypBeschreibung
providerConfigIdPflichtstring (uuid)The registered FleetProvider credential to create the VPS with.
regionPflichtstringProvider region/location slug (provider-specific).
serverTypePflichtstringProvider server-type/size slug (provider-specific).
rolePflicht"server" | "agent"The k3s role the new node will take.
namestringOptional server name; defaults to `eqs-<shortId>` when omitted.

Antworten

  • 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

NameTypBeschreibung
tokenPflichtstringThe single-use join grant the node was handed at provisioning time.
wgPublicKeyPflichtstringThe node's WireGuard public key (the private key never leaves the box).
publicIpstringThe node's public IP / wg endpoint, when it has one.
k3sNodeNamestringThe k3s node name the box will register under, when known up front.

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
authorizationPflichtheaderstring

Antworten

  • 200

FleetProviders

GET/v1/fleet/providersLists registered credentials (metadata only — no tokens).

Antworten

  • 200
POST/v1/fleet/providersRegisters a credential (verifies the token live, then encrypts it).

Request-BodyCreateFleetProviderDto

NameTypBeschreibung
namePflichtstringThe operator's label, e.g. "Hetzner prod".
providerPflicht"hetzner" | "digitalocean"Which cloud this credential talks to.
tokenPflichtstringThe provider API token (verified live, then encrypted at rest).
defaultRegionstringDefault location/region slug for created VPSs (provider-specific).
defaultServerTypestringDefault server type/size slug for created VPSs (provider-specific).

Antworten

  • 201
DELETE/v1/fleet/providers/{id}Removes a credential (soft delete).

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204

GithubAccount

GET/v1/accounts/github

Antworten

  • 200
PUT/v1/accounts/github

Request-BodyConnectGithubAccountDto

NameTypBeschreibung
tokenPflichtstringPersonal access token (classic or fine-grained).

Antworten

  • 200
DELETE/v1/accounts/githubDisconnect every GitHub connection in the workspace.

Antworten

  • 204
PUT/v1/accounts/github/appConnect a BYO GitHub App by its credentials (the workspace's own App).

Request-BodyConnectGithubAppDto

NameTypBeschreibung
installationIdPflichtstring
appIdPflichtstring
clientIdPflichtstring
clientSecretstring
privateKeyPflichtstring
webhookSecretstring

Antworten

  • 200
GET/v1/accounts/github/app/configGitHub App configuration for the connect-flow UI (managed availability).

Antworten

  • 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).

Parameter

NameOrtTypBeschreibung
ownerqueryobject

Antworten

  • 200
POST/v1/accounts/github/app/managedFinalize a managed install (the platform App) from its installation id.

Request-BodyConnectGithubManagedAppDto

NameTypBeschreibung
installationIdPflichtstring

Antworten

  • 201
DELETE/v1/accounts/github/connections/{id}Disconnect one connection (App installation) by its id.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
GET/v1/accounts/github/repositories

Antworten

  • 200

GithubIssues

GET/v1/github/repos/{owner}/{repo}/issues

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring
statequery"open" | "closed" | "all"open (the default), closed or all.
assigneequerystringA login, `@me`, `none` (unassigned) or `*` (assigned to anyone).
authorquerystringA login or `@me`.
mentionquerystringA login or `@me`: the issues that mention them.
appquerystringA GitHub App's slug: the issues it opened.
labelsquerystringLabel names, separated by commas: the issue carries all of them.
milestonequerystringA milestone's number or title, `none` or `*`.
typequerystringAn issue type's name, `none` or `*`.
searchquerystringWords to search for, in GitHub's search syntax.
limitquerynumber30 by default.

Antworten

  • 200
POST/v1/github/repos/{owner}/{repo}/issues

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring

Request-BodyCreateGithubIssueDto

NameTypBeschreibung
titlePflichtstring
bodystring
assigneesstring[]Logins, or `@me`.
labelsstring[]
milestonestringA milestone's number or title.
typestringAn issue type's name.
parentnumberThe number of the issue this one is a sub-issue of.
blockedBynumber[]Issues, by number, that block it.
blockingnumber[]Issues, by number, it blocks.

Antworten

  • 201
GET/v1/github/repos/{owner}/{repo}/issues/{number}

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring
numberPflichtpathnumber
commentsquerybooleanWith its comments.
relationsquerybooleanWith its parent, its sub-issues, and what blocks it and what it blocks.

Antworten

  • 200
PATCH/v1/github/repos/{owner}/{repo}/issues/{number}

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring
numberPflichtpathnumber

Request-BodyEditGithubIssueDto

NameTypBeschreibung
titlestring
bodystring
addAssigneesstring[]
removeAssigneesstring[]
addLabelsstring[]
removeLabelsstring[]
milestonestringA milestone's number or title; null takes it off.
typestringAn issue type's name; null takes it off.
parentnumberThe number of the issue it becomes a sub-issue of.
removeParentbooleanTakes it off its parent.
addBlockedBynumber[]Issues, by number, that block it from now on.
removeBlockedBynumber[]
addBlockingnumber[]Issues, by number, it blocks from now on.
removeBlockingnumber[]
addSubIssuesnumber[]Issues, by number, that become its sub-issues.
removeSubIssuesnumber[]

Antworten

  • 200
DELETE/v1/github/repos/{owner}/{repo}/issues/{number}GitHub cannot undo it, so it needs `issue.delete`, which only owners hold.

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring
numberPflichtpathnumber

Antworten

  • 204
GET/v1/github/repos/{owner}/{repo}/issues/{number}/branchesgh issue develop --list.

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring
numberPflichtpathnumber

Antworten

  • 200
POST/v1/github/repos/{owner}/{repo}/issues/{number}/branchesgh issue develop: a branch linked to the issue.

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring
numberPflichtpathnumber

Request-BodyCreateGithubIssueBranchDto

NameTypBeschreibung
repositorystringAnother repository for the branch, as `owner/name`, as a fork.
namestringBy default, as GitHub names it: the number and the title.
basestringThe branch it starts from; by default the repository's default branch.

Antworten

  • 201
POST/v1/github/repos/{owner}/{repo}/issues/{number}/close

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring
numberPflichtpathnumber

Request-BodyCloseGithubIssueDto

NameTypBeschreibung
reason"COMPLETED" | "NOT_PLANNED" | "DUPLICATE"COMPLETED (the default), NOT_PLANNED or DUPLICATE.
commentstringPosted before it is closed.
duplicateOfnumberWith DUPLICATE: the number of the issue it duplicates.

Antworten

  • 200
POST/v1/github/repos/{owner}/{repo}/issues/{number}/comments

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring
numberPflichtpathnumber

Request-BodyCommentGithubIssueDto

NameTypBeschreibung
bodyPflichtstring

Antworten

  • 201
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).

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring
numberPflichtpathnumber

Request-BodyEditLastGithubCommentDto

NameTypBeschreibung
bodyPflichtstring
createIfNonebooleanComment instead, when the member has none to edit.

Antworten

  • 200
DELETE/v1/github/repos/{owner}/{repo}/issues/{number}/comments/lastgh issue comment --delete-last: answers the comment it deleted.

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring
numberPflichtpathnumber

Antworten

  • 200
POST/v1/github/repos/{owner}/{repo}/issues/{number}/lock

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring
numberPflichtpathnumber

Request-BodyLockGithubIssueDto

NameTypBeschreibung
reason"OFF_TOPIC" | "RESOLVED" | "SPAM" | "TOO_HEATED"

Antworten

  • 200
DELETE/v1/github/repos/{owner}/{repo}/issues/{number}/lock

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring
numberPflichtpathnumber

Antworten

  • 200
POST/v1/github/repos/{owner}/{repo}/issues/{number}/pin

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring
numberPflichtpathnumber

Antworten

  • 200
DELETE/v1/github/repos/{owner}/{repo}/issues/{number}/pin

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring
numberPflichtpathnumber

Antworten

  • 200
POST/v1/github/repos/{owner}/{repo}/issues/{number}/reopen

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring
numberPflichtpathnumber

Request-BodyReopenGithubIssueDto

NameTypBeschreibung
commentstringPosted before it is reopened.

Antworten

  • 200
POST/v1/github/repos/{owner}/{repo}/issues/{number}/transfer

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring
numberPflichtpathnumber

Request-BodyTransferGithubIssueDto

NameTypBeschreibung
repositoryPflichtstringThe destination, as `owner/name`, of the same owner.

Antworten

  • 200
GET/v1/github/repos/{owner}/{repo}/my-issuesgh issue status: the member's open issues, assigned, mentioning them and opened by them.

Parameter

NameOrtTypBeschreibung
ownerPflichtpathstring
repoPflichtpathstring

Antworten

  • 200

GitlabAccount

GET/v1/accounts/gitlabConnection state (login + host + connections) for the connect UI.

Antworten

  • 200
PUT/v1/accounts/gitlabConnect (or re-auth) a GitLab account with a PAT (+ optional host).

Request-BodyConnectGitlabAccountDto

NameTypBeschreibung
patPflichtstringGitLab personal access token (`read_api`/`read_repository` at minimum).
hoststringSelf-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.

Antworten

  • 200
GET/v1/accounts/gitlab/repositories

Antworten

  • 200

Goals

GET/v1/goals/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
PATCH/v1/goals/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyUpdateGoalDto

NameTypBeschreibung
namestring
descriptionstringnull clears the description.
status"ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "ACHIEVED"
startDatestring
endDatestring

Antworten

  • 200
DELETE/v1/goals/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
POST/v1/goals/{id}/key-results

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyCreateKeyResultDto

NameTypBeschreibung
namePflichtstring
targetValuePflichtnumber
startValuenumber
currentValuenumber
unitstring
weightnumber

Antworten

  • 201
PUT/v1/items/{id}/key-result

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodySetItemKeyResultDto

NameTypBeschreibung
keyResultIdstringThe key result the item contributes to; omit / null to unlink.

Antworten

  • 200
PATCH/v1/key-results/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyUpdateKeyResultDto

NameTypBeschreibung
namestring
currentValuenumber
startValuenumber
targetValuenumber
unitstringnull clears the unit.
weightnumber

Antworten

  • 200
DELETE/v1/key-results/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
GET/v1/spaces/{spaceId}/goals

Parameter

NameOrtTypBeschreibung
spaceIdPflichtpathstring

Antworten

  • 200
POST/v1/spaces/{spaceId}/goals

Parameter

NameOrtTypBeschreibung
spaceIdPflichtpathstring

Request-BodyCreateGoalDto

NameTypBeschreibung
namePflichtstring
descriptionstring
startDatestring
endDatestring

Antworten

  • 201

ItemLifecycle

POST/v1/items/{id}/close

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyCloseItemDto

NameTypBeschreibung
reason"COMPLETED" | "NOT_PLANNED" | "DUPLICATE"Why it is closed: completed (the default), not planned or a duplicate.
duplicateOfstringWith DUPLICATE: the item it duplicates, by identifier or id.
commentstringLeft on the item before it closes, and not at all when it is closed already.

Antworten

  • 200
POST/v1/items/{id}/lock

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyLockItemDto

NameTypBeschreibung
reason"OFF_TOPIC" | "RESOLVED" | "SPAM" | "TOO_HEATED"

Antworten

  • 200
DELETE/v1/items/{id}/lock

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
POST/v1/items/{id}/pin

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
DELETE/v1/items/{id}/pin

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
GET/v1/items/{id}/relationsIts parent, its sub-items, and what blocks it and what it blocks.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
POST/v1/items/{id}/reopen

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyReopenItemDto

NameTypBeschreibung
commentstringLeft on the item before it reopens, and not at all when it is open already.

Antworten

  • 200
POST/v1/items/{id}/transferMoves the item, with its sub-items, to another list, in any space.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyTransferItemDto

NameTypBeschreibung
containerIdPflichtstringThe list it moves to, in its space or in another.

Antworten

  • 200
GET/v1/items/by-identifier/{identifier}

Parameter

NameOrtTypBeschreibung
identifierPflichtpathstring

Antworten

  • 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.

Antworten

  • 200
GET/v1/spaces/{spaceId}/itemsPinned items first, then the most recently updated, a page at a time.

Parameter

NameOrtTypBeschreibung
spaceIdPflichtpathstring
statequery"open" | "closed" | "all"open (not in a done stage, the default), closed, or all.
assigneequerystring`me`, a user's id or their email.
tagquerystringA tag's label, in either case. Several, separated by commas, must all be on the item.
typequerystringAn item type's slug or name, in either case.
listquerystringA list's id or name, in either case.
mentionquerystring`me`, a user's id or their email: a comment on the item mentions them.
qquerystringWords the title holds, in either case.
limitquerynumber
cursorquerystringThe `next` of the previous page.

Antworten

  • 200

Items

GET/v1/containers/{containerId}/items

Parameter

NameOrtTypBeschreibung
containerIdPflichtpathstring

Antworten

  • 200
POST/v1/containers/{containerId}/items

Parameter

NameOrtTypBeschreibung
containerIdPflichtpathstring

Request-BodyCreateItemDto

NameTypBeschreibung
titlePflichtstring
itemTypeIdPflichtstring
descriptionstringPlain-text description — used when no rich blocks are sent.
descriptionBlocksobject[]Rich description as editor blocks (`SerializedBlock[]`); the plain-text `description` is derived from it server-side.
estimatenumberEffort estimate (>= 0) + its unit — planning / sprint capacity.
estimateUnit"DAYS" | "HOURS" | "POINTS"
parentItemIdstringParent item (Epic▸Story▸Task); omit / null for a top-level item.
workflowStageIdstringBoard column to drop the new card into; omit / null for an unplaced item.
prioritystring
startDatestringPlanned start. With `dueDate` it makes the item a span on the timeline.
dueDatestring
customFieldsobjectCustom-field values keyed by FieldDefinition id (validated server-side).

Antworten

  • 201
GET/v1/item-types

Antworten

  • 200
POST/v1/item-types

Request-BodyCreateItemTypeDto

NameTypBeschreibung
namePflichtstring
pluralNamePflichtstring
identifierPrefixPflichtstringUppercase prefix for human ids, e.g. "TASK" → TASK-1.
iconstring
colorstring
hierarchyLevelnumber1=Epic … 5=Subtask.

Antworten

  • 201
GET/v1/item-types/{id}/fields

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
POST/v1/item-types/{id}/fields

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyCreateFieldDefinitionDto

NameTypBeschreibung
namePflichtstring
fieldTypePflicht"DATETIME" | "DATE" | "TEXT" | "LONG_TEXT" | "NUMBER" | "CURRENCY" | "SELECT" | "MULTI_SELECT" | "USER" | "MULTI_USER" | "CHECKBOX" | "URL" | "EMAIL" | "PHONE" | "RATING" | "PROGRESS" | "RELATION" | "FORMULA"
configobjectPer-type settings: { options }, { min, max }, { expression }…
isRequiredboolean

Antworten

  • 201
GET/v1/items/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
PATCH/v1/items/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyUpdateItemDto

NameTypBeschreibung
titlestring
itemTypeIdstringAnother item type of the workspace; the identifier stays (ADR-039).
descriptionstringnull clears the description.
descriptionBlocksobject[]Rich description blocks; null clears. Plain text is derived server-side.
estimatenumbernull clears the estimate.
estimateUnit"DAYS" | "HOURS" | "POINTS"null clears the estimate unit.
prioritystringnull clears the priority.
startDatestringnull clears the planned start (back to a milestone).
dueDatestringnull clears the due date.

Antworten

  • 200
DELETE/v1/items/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
GET/v1/items/{id}/activity

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
PUT/v1/items/{id}/assignees

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodySetItemAssigneesDto

NameTypBeschreibung
userIdsPflichtstring[]The complete desired assignee set (replaces the current assignees).

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyDuplicateItemDto

NameTypBeschreibung
titlestringThe copy's title; defaults to the original's with " (cópia)".

Antworten

  • 201
PUT/v1/items/{id}/fields

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodySetFieldValuesDto

NameTypBeschreibung
valuesPflichtobject{ [fieldDefinitionId]: value | null } — null clears that field.

Antworten

  • 200
POST/v1/items/{id}/move

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyMoveItemDto

NameTypBeschreibung
containerIdstringMove into another container (board/list); omit to stay put.
parentItemIdstringRe-parent in the item tree; omit / null for top-level.
afterItemIdstringPlace directly after this sibling; omit / null for the first position.

Antworten

  • 201

Maven

GET/maven/{splat}

Antworten

  • 200
POST/maven/{splat}

Antworten

  • 200
PUT/maven/{splat}

Antworten

  • 200
PATCH/maven/{splat}

Antworten

  • 200
DELETE/maven/{splat}

Antworten

  • 200

Me

GET/v1/me

Antworten

  • 200

Npm

GET/npm/{splat}

Antworten

  • 200
POST/npm/{splat}

Antworten

  • 200
PUT/npm/{splat}

Antworten

  • 200
PATCH/npm/{splat}

Antworten

  • 200
DELETE/npm/{splat}

Antworten

  • 200

NuGet

GET/nuget/{splat}

Antworten

  • 200
POST/nuget/{splat}

Antworten

  • 200
PUT/nuget/{splat}

Antworten

  • 200
PATCH/nuget/{splat}

Antworten

  • 200
DELETE/nuget/{splat}

Antworten

  • 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

NameTypBeschreibung
yamlPflichtstringRaw workflow YAML to parse, validate and plan.

Antworten

  • 201

Previews

DELETE/v1/previews/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
POST/v1/previews/{id}/rebuild

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
GET/v1/repositories/{repositoryId}/open-prs

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring

Antworten

  • 200
GET/v1/repositories/{repositoryId}/previews

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring

Antworten

  • 200
POST/v1/repositories/{repositoryId}/previews

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring

Request-BodyCreatePreviewManuallyDto

NameTypBeschreibung
prNumberPflichtnumberThe open pull-request number to stand a preview up for.

Antworten

  • 201

PrReviews

GET/v1/pull-requests/{id}/review-summaryThe `{approved, changes, unresolvedBlocking}` counts (F3's canMerge inputs).

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
GET/v1/pull-requests/{id}/reviews

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
POST/v1/pull-requests/{id}/reviewsSubmit (or re-submit) the caller's verdict — update-or-create per reviewer.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodySubmitReviewDto

NameTypBeschreibung
statePflicht"approved" | "changes"
bodystringOptional summary accompanying the verdict.

Antworten

  • 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).

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyCreateReviewThreadDto

NameTypBeschreibung
pathstringDiff 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`).
linenumber1-based line number on `side`, as carried by the persisted diff's hunks.
blockingbooleanReviewer veto: while unresolved, the PR cannot merge (F3).
bodyPflichtstringThe thread's opening comment.

Antworten

  • 201
POST/v1/threads/{id}/comments

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyAddThreadCommentDto

NameTypBeschreibung
bodyPflichtstring

Antworten

  • 201
POST/v1/threads/{id}/resolveResolve. A BLOCKING thread only by its creator (the veto holder); non-blocking by anyone with review permission.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 201
POST/v1/threads/{id}/unresolveReopen — anyone with review permission.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 201

PullRequests

GET/v1/pull-requests/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyEnqueuePullRequestDto

NameTypBeschreibung
strategy"merge" | "squash" | "rebase"

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyMergePullRequestDto

NameTypBeschreibung
strategy"merge" | "squash" | "rebase"

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
targetquerystring

Antworten

  • 200
PUT/v1/repositories/{repositoryId}/pr-mode

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring

Request-BodySetPrModeDto

NameTypBeschreibung
modePflicht"provider" | "equantic"

Antworten

  • 204
GET/v1/repositories/{repositoryId}/pull-requests

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
statequerystring

Antworten

  • 200
POST/v1/repositories/{repositoryId}/pull-requests

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring

Request-BodyCreatePullRequestDto

NameTypBeschreibung
titlePflichtstring
bodystring
sourceBranchPflichtstringBranch whose changes the PR proposes (its head sha is resolved from the forge).
targetBranchPflichtstringBranch the PR merges into (its head sha becomes the diff base).

Antworten

  • 201

Pypi

GET/pypitwine uploads POST to the bare `/pypi/` — a dedicated route because the `*splat` wildcard below doesn't match an empty remainder.

Antworten

  • 200
POST/pypitwine uploads POST to the bare `/pypi/` — a dedicated route because the `*splat` wildcard below doesn't match an empty remainder.

Antworten

  • 200
PUT/pypitwine uploads POST to the bare `/pypi/` — a dedicated route because the `*splat` wildcard below doesn't match an empty remainder.

Antworten

  • 200
PATCH/pypitwine uploads POST to the bare `/pypi/` — a dedicated route because the `*splat` wildcard below doesn't match an empty remainder.

Antworten

  • 200
DELETE/pypitwine uploads POST to the bare `/pypi/` — a dedicated route because the `*splat` wildcard below doesn't match an empty remainder.

Antworten

  • 200
GET/pypi/{splat}

Antworten

  • 200
POST/pypi/{splat}

Antworten

  • 200
PUT/pypi/{splat}

Antworten

  • 200
PATCH/pypi/{splat}

Antworten

  • 200
DELETE/pypi/{splat}

Antworten

  • 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.

Antworten

  • 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.

Antworten

  • 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.

Antworten

  • 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.

Antworten

  • 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.

Antworten

  • 200
GET/v2/{splat}

Antworten

  • 200
POST/v2/{splat}

Antworten

  • 200
PUT/v2/{splat}

Antworten

  • 200
PATCH/v2/{splat}

Antworten

  • 200
DELETE/v2/{splat}

Antworten

  • 200

RegistryToken

GET/v1/registry/tokens

Antworten

  • 200
POST/v1/registry/tokensCreates a token and returns the raw value ONCE (store it now).

Request-BodyCreateRegistryTokenDto

NameTypBeschreibung
namePflichtstring
expiresInDaysnumberOptional expiry in days (omit = never expires).

Antworten

  • 201
DELETE/v1/registry/tokens/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204

Repositories

GET/v1/repositories

Antworten

  • 200
POST/v1/repositories

Request-BodyConnectRepositoryDto

NameTypBeschreibung
fullNamePflichtstringGitHub/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.
provider"github" | "azure_devops" | "gitlab" | "bitbucket"SCM provider — defaults to `github` for back-compat (ADR-025 P1b).

Antworten

  • 201
GET/v1/repositories/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
DELETE/v1/repositories/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
PATCH/v1/repositories/{id}/eqs-cli

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodySetRepositoryEqsCliDto

NameTypBeschreibung
enabledPflichtboolean

Antworten

  • 204
PATCH/v1/repositories/{id}/pipelinesMaster switch for this repo's CI (pauses every pipeline in it).

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodySetRepositoryPipelinesDto

NameTypBeschreibung
enabledPflichtboolean

Antworten

  • 204
GET/v1/repositories/{id}/preview-config

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
PUT/v1/repositories/{id}/preview-config

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodySetRepositoryPreviewConfigDto

NameTypBeschreibung
autoCreatePflichtboolean"Auto-preview em PRs" — create a preview env automatically on PRs.
spaceIdPflichtstring (uuid)Target Space the preview environments deploy under.
baseEnvironmentIdstring (uuid)Optional base environment to clone env vars from.

Antworten

  • 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

NameTypBeschreibung
repositoryIdsPflichtstring (uuid)[]The repositories to pause or resume, all of them or none.
enabledPflichtboolean

Antworten

  • 204

RepositoryEnvironments

GET/v1/repositories/{repositoryId}/environments

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring

Antworten

  • 200
PUT/v1/repositories/{repositoryId}/environments/{name}

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
namePflichtpathstring

Request-BodySetEnvironmentDto

NameTypBeschreibung
requiresApprovalPflichtbooleanWhether a job targeting this environment must be manually approved first.

Antworten

  • 204
DELETE/v1/repositories/{repositoryId}/environments/{name}

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
namePflichtpathstring

Antworten

  • 204

RepositorySecrets

GET/v1/repositories/{repositoryId}/secrets

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring

Antworten

  • 200
PUT/v1/repositories/{repositoryId}/secrets/{name}

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
namePflichtpathstring

Request-BodySetSecretDto

NameTypBeschreibung
valuePflichtstring

Antworten

  • 204
DELETE/v1/repositories/{repositoryId}/secrets/{name}

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
namePflichtpathstring

Antworten

  • 204
GET/v1/repositories/{repositoryId}/secrets/github-namesNames defined on GitHub vs. set here, to hint what's missing.

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring

Antworten

  • 200

RepositoryVariables

GET/v1/repositories/{repositoryId}/variables

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring

Antworten

  • 200
PUT/v1/repositories/{repositoryId}/variables/{name}

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
namePflichtpathstring

Request-BodySetVariableDto

NameTypBeschreibung
valuePflichtstring

Antworten

  • 204
DELETE/v1/repositories/{repositoryId}/variables/{name}

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
namePflichtpathstring

Antworten

  • 204

Rollout

POST/v1/admin/system/rollout

Request-BodyRolloutPlanDto

NameTypBeschreibung
namespacePflichtstring
jobRolloutJobDto
ensurePullSecretstring
stepsPflichtRolloutStepDto[]

Antworten

  • 201
GET/v1/admin/system/rollout/status

Antworten

  • 200
GET/v1/admin/system/rollout/stream

Antworten

  • 200

Rubygems

GET/rubygems/{splat}

Antworten

  • 200
POST/rubygems/{splat}

Antworten

  • 200
PUT/rubygems/{splat}

Antworten

  • 200
PATCH/rubygems/{splat}

Antworten

  • 200
DELETE/rubygems/{splat}

Antworten

  • 200

RunDeployments

GET/v1/runs/{runId}/deploymentsEverywhere this run's own images are (or were) deployed.

Parameter

NameOrtTypBeschreibung
runIdPflichtpathstring

Antworten

  • 200

RunnerHosts

GET/v1/runner-hostsEvery registered machine, including the ones that are not working.

Antworten

  • 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

NameTypBeschreibung
namePflichtstringUnique, and the handle the job log names — `Running on 'mac-mini-1'`.
osPflicht"linux" | "windows" | "macos"
addressPflichtstringHostname or IP the platform opens ssh to.
userPflichtstringThe account CI runs as. Unprivileged, please: a job is untrusted code.
portnumber
arch"amd64" | "arm64"
labelsstring[]Extra `runs-on` labels beyond the implicit OS ones (e.g. `xcode-16`).
maxConcurrencynumberJobs this machine takes at once.
privateKeystringAn existing OpenSSH private key, when the operator insists on supplying one. Encrypted before it reaches the repository and never returned.

Antworten

  • 201
DELETE/v1/runner-hosts/{id}Forgets the machine. Its authorized_keys is not touched.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
POST/v1/runner-hosts/{id}/checkOpens an ssh session and asks the machine what it is.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyRunnerHostIdleStopDto

NameTypBeschreibung
minutesPflichtnumber

Antworten

  • 200
POST/v1/runner-hosts/{id}/power

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyRunnerHostPowerDto

NameTypBeschreibung
actionPflicht"on" | "off"

Antworten

  • 201
PUT/v1/runner-hosts/{id}/statusonline | draining | offline.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyRunnerHostStatusDto

NameTypBeschreibung
statusPflicht"online" | "draining" | "offline"`draining` before a reboot, `offline` to retire, `online` to take work.

Antworten

  • 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.

Antworten

  • 200
PUT/v1/runners/capacity-policySaves the policy. Takes effect on the next budget refresh (≤30 s).

Request-BodyCiPolicyDto

NameTypBeschreibung
targetCpuPerJobnumberCores a job is sized around; sets how MANY jobs a node offers.
minJobCpunumberFloor below which a slot is not worth offering.
minJobMemoryGinumber
platformReserveRationumberShare of each node kept for the platform itself.
minAdmissibleMemoryGinumberBelow this share, a node offers no slots and jobs wait. 0 = off.
maxConcurrentJobsnumberHard cap on concurrent jobs. 0 = no cap.
pinnedJobCpustringFixed per-job CPU; applies on its own, without the memory pin.
pinnedJobMemorystringFixed per-job memory, with its unit; applies on its own.
growJobMemorybooleanWhether 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.
maxJobMemoryGinumberNever grow one job past this. 0 = only the node's free room bounds it.
queuedCeilingMinutesnumberHow 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.
runningCeilingMinutesnumberHow long a run may be in progress. 0 = no ceiling.
jobCeilingMinutesnumberHow 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.
minJobDiskGinumberThe 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.
pinnedJobDiskstringFixed per-job disk, with its unit; applies on its own.

Antworten

  • 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

NameTypBeschreibung
targetCpuPerJobnumberCores a job is sized around; sets how MANY jobs a node offers.
minJobCpunumberFloor below which a slot is not worth offering.
minJobMemoryGinumber
platformReserveRationumberShare of each node kept for the platform itself.
minAdmissibleMemoryGinumberBelow this share, a node offers no slots and jobs wait. 0 = off.
maxConcurrentJobsnumberHard cap on concurrent jobs. 0 = no cap.
pinnedJobCpustringFixed per-job CPU; applies on its own, without the memory pin.
pinnedJobMemorystringFixed per-job memory, with its unit; applies on its own.
growJobMemorybooleanWhether 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.
maxJobMemoryGinumberNever grow one job past this. 0 = only the node's free room bounds it.
queuedCeilingMinutesnumberHow 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.
runningCeilingMinutesnumberHow long a run may be in progress. 0 = no ceiling.
jobCeilingMinutesnumberHow 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.
minJobDiskGinumberThe 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.
pinnedJobDiskstringFixed per-job disk, with its unit; applies on its own.

Antworten

  • 201
GET/v1/runners/poolLive runner-pool occupancy + waiting count (any authenticated user).

Antworten

  • 200

Runs

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.

Parameter

NameOrtTypBeschreibung
repositoryIdquerystring
limitquerynumber
offsetquerynumber
statusquery"queued" | "waiting" | "in_progress" | "success" | "failure" | "cancelled" | "timed_out" | "skipped" | "action_required" | "neutral"
orderquery"newest" | "oldest"
runNumberqueryinteger

Antworten

  • 200
GET/v1/runs/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
POST/v1/runs/{id}/cancel

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
GET/v1/runs/{id}/jobs/{jobRunId}/logs

Parameter

NameOrtTypBeschreibung
idPflichtpathstring
jobRunIdPflichtpathstring
afterSeqquerynumber

Antworten

  • 200
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`.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring
jobRunIdPflichtpathstring
last-event-idPflichtheaderstring
afterSeqquerynumber

Antworten

  • 200
POST/v1/runs/{id}/jobs/{jobRunId}/review

Parameter

NameOrtTypBeschreibung
idPflichtpathstring
jobRunIdPflichtpathstring

Request-BodyReviewDeploymentDto

NameTypBeschreibung
decisionPflicht"approve" | "reject"

Antworten

  • 200
POST/v1/runs/{id}/rerun

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyRerunRunDto

NameTypBeschreibung
modePflicht"all" | "failed"

Antworten

  • 200
POST/v1/runs/dispatch

Request-BodyDispatchWorkflowDto

NameTypBeschreibung
repositoryIdPflichtstring (uuid)
workflowPathPflichtstringPath of the workflow file inside the repo.
refstringBranch, tag or sha to run on; defaults to the repository default branch.
inputsobjectworkflow_dispatch inputs (string values, GitHub semantics).

Antworten

  • 201

ServiceConsole

POST/v1/services/{id}/console/token

Parameter

NameOrtTypBeschreibung
idPflichtpathstring
podquerystring

Antworten

  • 201

ServiceData

POST/v1/services/{serviceId}/data/ddlChange structure. A permission of its own — dropping a table is not editing a row.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring

Request-BodyRunStatementDto

NameTypBeschreibung
statementPflichtstringThe statement, in the engine's own language — SQL for a relational service, a command for Redis. Never parsed by the platform.
paramsobject[]Values bound by the driver as $1…, never spliced into the statement. They are NOT written to the audit log.
limitnumberRows to return before truncating (default 100, max 10000).
timeoutMsnumberStatement timeout in milliseconds (default 15000, max 120000).

Antworten

  • 200
POST/v1/services/{serviceId}/data/execWrite rows.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring

Request-BodyRunStatementDto

NameTypBeschreibung
statementPflichtstringThe statement, in the engine's own language — SQL for a relational service, a command for Redis. Never parsed by the platform.
paramsobject[]Values bound by the driver as $1…, never spliced into the statement. They are NOT written to the audit log.
limitnumberRows to return before truncating (default 100, max 10000).
timeoutMsnumberStatement timeout in milliseconds (default 15000, max 120000).

Antworten

  • 200
POST/v1/services/{serviceId}/data/queryRead. Runs in a read-only transaction where the engine supports one.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring

Request-BodyRunStatementDto

NameTypBeschreibung
statementPflichtstringThe statement, in the engine's own language — SQL for a relational service, a command for Redis. Never parsed by the platform.
paramsobject[]Values bound by the driver as $1…, never spliced into the statement. They are NOT written to the audit log.
limitnumberRows to return before truncating (default 100, max 10000).
timeoutMsnumberStatement timeout in milliseconds (default 15000, max 120000).

Antworten

  • 200
GET/v1/services/{serviceId}/data/tablesThe reader's tables (relational engines). A read, so `data.read`.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring

Antworten

  • 200
GET/v1/services/{serviceId}/data/tables/{table}One table's columns.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring
tablePflichtpathstring

Antworten

  • 200

ServiceDomains

GET/v1/services/{serviceId}/domains

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring

Antworten

  • 200
POST/v1/services/{serviceId}/domains

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring

Request-BodyAddDomainDto

NameTypBeschreibung
hostPflichtstringThe custom domain to attach, e.g. `app.mycompany.com`.

Antworten

  • 201
DELETE/v1/services/{serviceId}/domains/{domainId}

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring
domainIdPflichtpathstring

Antworten

  • 204
POST/v1/services/{serviceId}/domains/{domainId}/verifyRe-checks the DNS-TXT challenge; `{ verified }` reflects the new state.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring
domainIdPflichtpathstring

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring
domainIdPflichtpathstring

Request-BodySetWwwAliasDto

NameTypBeschreibung
enabledPflichtboolean
mode"serve" | "redirect"

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring

Request-BodyChooseAddressDto

NameTypBeschreibung
namePflichtstringThe 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.

Antworten

  • 200
DELETE/v1/services/{serviceId}/domains/addressClears the chosen name: the generated address is the service's again.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring

Antworten

  • 204

ServiceEnvVars

GET/v1/services/{serviceId}/env

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring

Antworten

  • 200
PUT/v1/services/{serviceId}/env

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring

Request-BodySetEnvVarDto

NameTypBeschreibung
keyPflichtstring
valuePflichtstring
secretbooleanEncrypt at rest + space via a k8s Secret (default false).

Antworten

  • 204
DELETE/v1/services/{serviceId}/env/{key}

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring
keyPflichtpathstring

Antworten

  • 204
POST/v1/services/{serviceId}/env/applyRe-renders the manifest + env Secret with the current variables. Async.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring

Antworten

  • 200

ServiceExec

POST/v1/services/{id}/exec

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyExecServiceDto

NameTypBeschreibung
commandPflichtstring[]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.
instancestringA specific instance (pod) to run in. Defaults to the freshest Running one. An instance that is not this service's is refused, never redirected.
timeoutMsnumberKilled after this many milliseconds (default 60000, max 300000). A timeout answers with exit code 124.
stdinstringWritten 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.

Antworten

  • 201

ServiceMetrics

GET/v1/services/{serviceId}/metricsLive CPU/mem usage for the service's pods (read-only; safe to poll).

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring

Antworten

  • 200
GET/v1/services/{serviceId}/metrics/historyCPU/mem time series for the service (read-only). `hours` 1–168, default 24.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring
hoursquerystring

Antworten

  • 200

ServiceMq

GET/v1/services/{serviceId}/mq/queuesWhat is on the broker. Streams on NATS; refused on AMQP, which cannot.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring

Antworten

  • 200
POST/v1/services/{serviceId}/mq/queues/{target}/consumeTake messages off. They do not come back.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring
targetPflichtpathstring

Request-BodyBrokerOperationDto

NameTypBeschreibung
payloadstringThe message body, for publish. Sent as bytes and never written to the audit log.
limitnumberMessages to read before truncating (default 100, max 10000).
timeoutMsnumberOperation timeout in milliseconds (default 15000, max 120000).

Antworten

  • 200
POST/v1/services/{serviceId}/mq/queues/{target}/peekLook without taking — as far as the broker allows; the result says.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring
targetPflichtpathstring

Request-BodyBrokerOperationDto

NameTypBeschreibung
payloadstringThe message body, for publish. Sent as bytes and never written to the audit log.
limitnumberMessages to read before truncating (default 100, max 10000).
timeoutMsnumberOperation timeout in milliseconds (default 15000, max 120000).

Antworten

  • 200
POST/v1/services/{serviceId}/mq/queues/{target}/publishPut one on.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring
targetPflichtpathstring

Request-BodyBrokerOperationDto

NameTypBeschreibung
payloadstringThe message body, for publish. Sent as bytes and never written to the audit log.
limitnumberMessages to read before truncating (default 100, max 10000).
timeoutMsnumberOperation timeout in milliseconds (default 15000, max 120000).

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
serviceIdPflichtpathstring
targetPflichtpathstring

Request-BodyBrokerOperationDto

NameTypBeschreibung
payloadstringThe message body, for publish. Sent as bytes and never written to the audit log.
limitnumberMessages to read before truncating (default 100, max 10000).
timeoutMsnumberOperation timeout in milliseconds (default 15000, max 120000).

Antworten

  • 200

ServiceRuntimeLogs

GET/v1/services/{id}/instancesThe service's pods — the instance picker for the console + runtime logs.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
GET/v1/services/{id}/logs/runtimeLive runtime logs (`?instance=all` or a pod name) as Server-Sent Events.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring
instancequeryobject

Antworten

  • 200

Services

GET/v1/services/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
PATCH/v1/services/{id}Updates the service's runtime config, then re-rolls it.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyUpdateServiceDto

NameTypBeschreibung
namestring
imagestringNew image ref (image-source services only).
branchstring
dockerfilePathstring
portnumber
internalboolean
publicAllowedCidrsstring[]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.
minInstancesnumber0 = scale-to-zero.
maxInstancesnumber
cpuRequeststring
memRequeststring
cpuLimitstring
memLimitstring
healthPathstringReadiness path; blank clears it, back to the plain TCP probe.
argsstring[]Container args (replaces the image's CMD). An empty array clears them.

Antworten

  • 200
DELETE/v1/services/{id}Deletes the service + all its vcluster resources (irreversible).

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
GET/v1/services/{id}/deploymentsThe service's deploy history (newest first).

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 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).

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
POST/v1/services/{id}/redeployRe-rolls the service (rebuilds repo sources). Accepted; runs async.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 202
POST/v1/services/{id}/restartRestarts the service's pods in place (no rebuild). Accepted; runs async.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 202
POST/v1/services/{id}/rollbackRolls back to a prior deployment's image (redeploy, no rebuild).

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyRollbackServiceDto

NameTypBeschreibung
deploymentIdPflichtstringThe prior deployment to roll back to (its image is redeployed).

Antworten

  • 202
POST/v1/services/{id}/startStarts a stopped service (scale back to its floor).

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
POST/v1/services/{id}/stopStops the service (scale to 0, KEDA paused).

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204

SpaceEnvVars

GET/v1/spaces/{spaceId}/env

Parameter

NameOrtTypBeschreibung
spaceIdPflichtpathstring

Antworten

  • 200
PUT/v1/spaces/{spaceId}/env

Parameter

NameOrtTypBeschreibung
spaceIdPflichtpathstring

Request-BodySetEnvVarDto

NameTypBeschreibung
keyPflichtstring
valuePflichtstring
secretbooleanEncrypt at rest + space via a k8s Secret (default false).

Antworten

  • 204
DELETE/v1/spaces/{spaceId}/env/{key}

Parameter

NameOrtTypBeschreibung
spaceIdPflichtpathstring
keyPflichtpathstring

Antworten

  • 204

Spaces

GET/v1/spaces

Antworten

  • 200
POST/v1/spaces

Request-BodyCreateSpaceDto

NameTypBeschreibung
namePflichtstring
descriptionstring
colorstring

Antworten

  • 201
GET/v1/spaces/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
PATCH/v1/spaces/{id}Renames the space (display name only; the slug stays stable).

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyUpdateSpaceDto

NameTypBeschreibung
namePflichtstring

Antworten

  • 200
DELETE/v1/spaces/{id}Deletes the space + all its services' vcluster resources (irreversible).

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyMoveSpaceDto

NameTypBeschreibung
afterSpaceIdstringPlace the space directly after this one; omit or null to put it first. Both must belong to the active workspace.

Antworten

  • 200

SpaceServices

GET/v1/spaces/{id}/services

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 200
POST/v1/spaces/{id}/services

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyCreateServiceDto

NameTypBeschreibung
namePflichtstring
sourcePflicht"image" | "repo" | "dockerfile" | "compose"
environmentIdstring (uuid)Target environment; defaults to the space's default (production).
imagestringPrebuilt image ref (source = image).
repostringRepo "owner/name" (source = repo/dockerfile/compose).
branchstring
dockerfilePathstring
portnumber
minInstancesnumber0 = scale-to-zero.
maxInstancesnumber
cpuRequeststringPer-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.
memRequeststring
cpuLimitstring
memLimitstring
healthPathstringReadiness 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.
argsstring[]Container args (replaces the image's CMD). A catalog service inherits the entry's args; passing them here overrides that for this one service.
internalbooleanInternal (no public domain) — ClusterIP only. Databases are internal.
statefulbooleanStateful workload (database/storage) → StatefulSet + PVC.
storageGinumberPersistent volume size in GiB (required when stateful).
dataPathstringContainer path the volume mounts at (required when stateful).
catalogServiceIdstring (uuid)Create from a catalog entry (one-click) — resolves image/port/stateful/etc.
versionstringCatalog image version (defaults to the catalog's newest).
fieldValuesobjectCatalog field values (key → value) → env vars + the PVC size.

Antworten

  • 201

Sprints

PUT/v1/items/{id}/sprint

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodySetItemSprintDto

NameTypBeschreibung
sprintIdstringThe target sprint; omit / null to remove the item from its sprint.

Antworten

  • 200
GET/v1/spaces/{spaceId}/sprints

Parameter

NameOrtTypBeschreibung
spaceIdPflichtpathstring

Antworten

  • 200
POST/v1/spaces/{spaceId}/sprints

Parameter

NameOrtTypBeschreibung
spaceIdPflichtpathstring

Request-BodyCreateSprintDto

NameTypBeschreibung
namePflichtstring
goalstring
startDatestring
endDatestring
capacitynumber

Antworten

  • 201
PATCH/v1/sprints/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyUpdateSprintDto

NameTypBeschreibung
namestring
goalstringnull clears the goal.
startDatestring
endDatestring
capacitynumber

Antworten

  • 200
DELETE/v1/sprints/{id}

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
POST/v1/sprints/{id}/transition

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyTransitionSprintDto

NameTypBeschreibung
actionPflicht"start" | "complete"'start' (PLANNED → ACTIVE) or 'complete' (→ COMPLETED).

Antworten

  • 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

NameTypBeschreibung
licenseKeyPflichtstring

Antworten

  • 201
GET/v1/admin/system/update

Antworten

  • 200
POST/v1/admin/system/update/applyTriggers an update to the given tag (or the latest). Idempotent while running.

Request-BodyApplyUpdateDto

NameTypBeschreibung
versionstringTarget 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.

Antworten

  • 201
GET/v1/admin/system/update/status

Antworten

  • 200
GET/v1/admin/system/update/streamLive progress of the running update (Server-Sent Events).

Antworten

  • 200
GET/v1/admin/system/version

Antworten

  • 200

Tags

PUT/v1/items/{id}/tags

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodySetItemTagsDto

NameTypBeschreibung
tagIdsPflichtstring[]The complete desired tag set (replaces the current tags).

Antworten

  • 200
GET/v1/spaces/{spaceId}/tags

Parameter

NameOrtTypBeschreibung
spaceIdPflichtpathstring

Antworten

  • 200
POST/v1/spaces/{spaceId}/tags

Parameter

NameOrtTypBeschreibung
spaceIdPflichtpathstring

Request-BodyCreateTagDto

NameTypBeschreibung
labelPflichtstring
colorPflichtstring

Antworten

  • 201

Templates

GET/v1/space-templates

Antworten

  • 200
POST/v1/spaces/{spaceId}/apply-templateMaterializes the template's whole structure into the Space.

Parameter

NameOrtTypBeschreibung
spaceIdPflichtpathstring

Request-BodyApplyTemplateDto

NameTypBeschreibung
templateKeyPflichtstringThe template key from the catalog (e.g. "scrum", "kanban", "bug-tracker").

Antworten

  • 204

Webhooks

POST/v1/webhooks/{provider}

Parameter

NameOrtTypBeschreibung
providerPflichtpathstring

Antworten

  • 202

Wiki

GET/v1/repositories/{repositoryId}/wikiWiki availability + pages (markdown), read from the `.wiki` git repo.

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring

Antworten

  • 200

Workflows

GET/v1/repositories/{repositoryId}/workflows

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring

Antworten

  • 200
PATCH/v1/repositories/{repositoryId}/workflows/{workflowFileId}/enabledEnables/disables ONE pipeline. Applies to the next event; runs already in flight finish (see SetWorkflowEnabledHandler).

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
workflowFileIdPflichtpathstring

Request-BodySetWorkflowEnabledDto

NameTypBeschreibung
enabledPflichtboolean

Antworten

  • 204
GET/v1/repositories/{repositoryId}/workflows/action-metadataAction metadata (inputs) for the step assistant — any `owner/repo@ref`.

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
usesPflichtquerystring

Antworten

  • 200
GET/v1/repositories/{repositoryId}/workflows/contentRaw YAML of a workflow file (fetched from the provider on demand).

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring
pathPflichtquerystring

Antworten

  • 200
PUT/v1/repositories/{repositoryId}/workflows/contentCommits edited YAML back to a workflow file (needs Contents: write).

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring

Request-BodySaveWorkflowContentDto

NameTypBeschreibung
pathPflichtstringWorkflow path, e.g. `.github/workflows/ci.yml`.
contentPflichtstring
messagestringCommit message (defaults to "Update <path> via eQuantic Space").
branchstringTarget branch (defaults to the repo's default branch).

Antworten

  • 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.

Parameter

NameOrtTypBeschreibung
repositoryIdPflichtpathstring

Antworten

  • 200

Workspace

GET/v1/workspacesThe user's workspaces, with the active one flagged.

Antworten

  • 200
POST/v1/workspacesCreate a workspace (under the user's tenant) and make it active.

Request-BodyCreateWorkspaceDto

NameTypBeschreibung
namePflichtstring
slugstringDesired slug; derived from the name when omitted.
typestringOnboarding hints persisted in `workspace.metadata`.
sizestring
featuresstring[]
invitesstringComma/space/newline-separated emails to invite (pending invitations).
inviteRolestring

Antworten

  • 201
PATCH/v1/workspaces/{id}Update a workspace's name and/or enabled features (owner/admin).

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Request-BodyUpdateWorkspaceDto

NameTypBeschreibung
namestring
featuresstring[]

Antworten

  • 200
POST/v1/workspaces/{id}/activateSwitch the active workspace for the current session.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring

Antworten

  • 204
GET/v1/workspaces/check-slugSlug-availability check for the wizard.

Parameter

NameOrtTypBeschreibung
slugqueryobject

Antworten

  • 200