RéférenceRéférence de l'API

Référence de l'API

Tous les endpoints de l'API eQuantic Space, générés depuis l'API elle-même.

L'API qu'utilisent l'application web, la CLI eqs et les runners. Cette page est générée à partir du document OpenAPI de l'API elle-même : elle liste exactement les endpoints que l'API sert.

URL de base

OùURL de base
Cloud eQuantic Spacehttps://api.app.equantic.space
Une installation self-hostedhttps://api.<votre-domaine>

Authentification

Envoyez un jeton dans l'en-tête Authorization :

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

Le jeton peut être un jeton d'accès personnel ou le secret d'un service principal (voir Accès (RBAC)). Chaque requête est vérifiée selon les rôles de l'identité derrière le jeton.

Endpoints

Les résumés sont rédigés en anglais, tels que l'API les documente.

400 endpoints dans 74 domaines

Access

GET/v1/access/assignments

Paramètres

NomEmplacementTypeDescription
scopeTypequerystring
scopeIdquerystring
inheritedquerystring

Réponses

  • 200
POST/v1/access/assignments

Corps de la requêteAddAssignmentDto

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 204
GET/v1/access/effective

Paramètres

NomEmplacementTypeDescription
principalTypequerystring
principalIdobligatoirequerystring
scopeTypequerystring
scopeIdquerystring

Réponses

  • 200
GET/v1/access/roles

Réponses

  • 200
POST/v1/access/roles

Corps de la requêteCreateRoleDto

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteUpdateRoleDto

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 204
GET/v1/access/scopes

Réponses

  • 200
GET/v1/access/service-principals

Réponses

  • 200
POST/v1/access/service-principals

Corps de la requêteCreateSpDto

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring
scopeTypequerystring
scopeIdquerystring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteUpdateSpDto

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteAddSpAssignmentDto

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring
assignmentIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteAddSpCertDto

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteAddSpCredentialDto

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring
credentialIdobligatoirepathstring

Réponses

  • 204
GET/v1/access/tokens

Réponses

  • 200
POST/v1/access/tokens

Corps de la requêteCreateTokenDto

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 204

App

GET/

Réponses

  • 200
GET/health

Réponses

  • 200

ArtifactBlob

GET/_apis/results/download/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
uploadIdobligatoirepathstring
blockidqueryobject
compqueryobject

Réponses

  • 201

ArtifactResults

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

Réponses

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

Réponses

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

Réponses

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

Réponses

  • 201

Artifacts

GET/v1/artifacts

Réponses

  • 200
POST/v1/artifacts

Corps de la requêteCreateArtifactRepoDto

NomTypeDescription
typeobligatoire"container" | "npm" | "maven" | "nuget" | "rubygems" | "pypi"
nameobligatoirestring
visibilityobligatoire"private" | "public" | "internal"
descriptionstring
immutableTagsboolean
scanOnPushboolean

Réponses

  • 201
GET/v1/artifacts/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 200
PATCH/v1/artifacts/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteUpdateArtifactRepoDto

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

Réponses

  • 204
DELETE/v1/artifacts/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteCreatePolicyDto

NomTypeDescription
nameobligatoirestring
kindobligatoire"keep-n" | "age" | "policy"
scopeobligatoirestring
valueobligatoirenumber
actionobligatoire"keep" | "delete" | "block"
enabledboolean

Réponses

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

Paramètres

NomEmplacementTypeDescription
policyIdobligatoirepathstring

Corps de la requêteUpdatePolicyDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
policyIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteAddSigningKeyDto

NomTypeDescription
nameobligatoirestring
publicKeyobligatoirestringPEM-encoded cosign public key (`cosign.pub`).

Réponses

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

Paramètres

NomEmplacementTypeDescription
keyIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring
tagobligatoirepathstring

Réponses

  • 200
GET/v1/artifacts/usage

Réponses

  • 200

AzureAccount

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

Réponses

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

Corps de la requêteConnectAzureAccountDto

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

Réponses

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

Réponses

  • 200

BitbucketAccount

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

Réponses

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

Corps de la requêteConnectBitbucketAccountDto

NomTypeDescription
usernameobligatoirestringHTTP 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.
secretobligatoirestringApp password or Atlassian API token (repository read at minimum).
workspaceobligatoirestringThe 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 `-`/`_`.

Réponses

  • 200
GET/v1/accounts/bitbucket/repositories

Réponses

  • 200

Boards

POST/v1/containers/{containerId}/stages

Paramètres

NomEmplacementTypeDescription
containerIdobligatoirepathstring

Corps de la requêteCreateStageDto

NomTypeDescription
nameobligatoirestring
stageType"TODO" | "IN_PROGRESS" | "REVIEW" | "TESTING" | "DONE" | "BLOCKED" | "CUSTOM"
colorstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
containerIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
containerIdobligatoirepathstring

Corps de la requêteCreateViewDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
containerIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteSetItemStageDto

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

Réponses

  • 200
PATCH/v1/stages/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteUpdateStageDto

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

Réponses

  • 200
DELETE/v1/stages/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 204
PATCH/v1/views/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteUpdateViewDto

NomTypeDescription
namestring
configobject
isDefaultboolean

Réponses

  • 200
DELETE/v1/views/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 204

BranchProtections

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring

Corps de la requêtePutBranchProtectionDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
ruleIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring
tokenqueryobject

Réponses

  • 200
GET/_apis/artifactcache/cache

Paramètres

NomEmplacementTypeDescription
keysobligatoirequerystring
versionobligatoirequerystring

Réponses

  • 200
POST/_apis/artifactcache/caches

Réponses

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

Paramètres

NomEmplacementTypeDescription
cacheIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
cacheIdobligatoirepathstring

Réponses

  • 204

CacheBlob

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

Paramètres

NomEmplacementTypeDescription
uploadIdobligatoirepathstring
blockidqueryobject
compqueryobject

Réponses

  • 201

CacheResults

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

Réponses

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

Réponses

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

Réponses

  • 200

Catalog

GET/v1/catalog/categories

Réponses

  • 200
GET/v1/catalog/services

Paramètres

NomEmplacementTypeDescription
categoryobligatoirequerystring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 200

CiStorage

GET/v1/ci-storage

Réponses

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

Corps de la requêteCiStoragePolicyDto

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

Réponses

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

Corps de la requêteCiStoragePolicyDto

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

Réponses

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

Réponses

  • 202

CodeBrowser

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
refquerystring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
pathobligatoirequerystring
refquerystring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
refquerystring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
pathobligatoirequerystring
refquerystring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
refquerystring
pathqueryobject

Réponses

  • 200

Comments

GET/v1/blocks/{id}/comments

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteCreateCommentDto

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

Réponses

  • 201
PATCH/v1/comments/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteUpdateCommentDto

NomTypeDescription
bodystring
mentionsstring[]

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteReactionDto

NomTypeDescription
emojiobligatoirestringThe emoji to add (e.g. "👍", "🎉").

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring
emojiobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteResolveCommentDto

NomTypeDescription
resolvedobligatoirebooleantrue resolves the comment, false reopens it.

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteCreateCommentDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteCreateCommentDto

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

Réponses

  • 201

Containers

GET/v1/container-types

Réponses

  • 200
POST/v1/container-types

Corps de la requêteCreateContainerTypeDto

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

Réponses

  • 201
PATCH/v1/containers/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteUpdateContainerDto

NomTypeDescription
namestring
configobject

Réponses

  • 200
DELETE/v1/containers/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteMoveContainerDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring

Corps de la requêteCreateContainerDto

NomTypeDescription
nameobligatoirestring
containerTypeIdobligatoirestring
parentContainerIdstringOmit / null for a top-level container directly under the Space.
configobject

Réponses

  • 201

Dependencies

DELETE/v1/dependencies/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteAddItemDependencyDto

NomTypeDescription
targetItemIdobligatoirestringThe other item in the relation.
typeobligatoire"blocks" | "blocked_by"`blocks` → this item blocks the target; `blocked_by` → the target blocks it.

Réponses

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

Réponses

  • 204

DeploymentLogs

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

Paramètres

NomEmplacementTypeDescription
deploymentIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
deploymentIdobligatoirepathstring

Réponses

  • 200

DocCollab

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 201

Docs

PATCH/v1/blocks/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteUpdateBlockDto

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

Réponses

  • 200
DELETE/v1/blocks/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteMoveBlockDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
docIdobligatoirepathstring

Corps de la requêteCreateBlockDto

NomTypeDescription
blockTypeobligatoire"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.

Réponses

  • 201
GET/v1/docs/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 200
PATCH/v1/docs/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteUpdateDocDto

NomTypeDescription
titlestring
iconstringnull clears the icon.
isArchivedboolean

Réponses

  • 200
DELETE/v1/docs/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteMoveDocDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring

Corps de la requêteCreateDocDto

NomTypeDescription
titleobligatoirestring
parentDocIdstringOmit / null for a top-level doc under the Space.
iconstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
docIdobligatoirepathstring

Réponses

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

Réponses

  • 200

DocVersions

GET/v1/docs/{id}/versions

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteCaptureDocVersionDto

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring
versionIdobligatoirepathstring

Réponses

  • 200

Fleet

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

Corps de la requêteRequestJoinGrantDto

NomTypeDescription
roleobligatoire"server" | "agent"The k3s role the new node will take.

Réponses

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Corps de la requêteProvisionNodeDto

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

Réponses

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

Corps de la requêteRegisterNodeDto

NomTypeDescription
tokenobligatoirestringThe single-use join grant the node was handed at provisioning time.
wgPublicKeyobligatoirestringThe 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.

Réponses

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

Paramètres

NomEmplacementTypeDescription
authorizationobligatoireheaderstring

Réponses

  • 200

FleetProviders

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

Réponses

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

Corps de la requêteCreateFleetProviderDto

NomTypeDescription
nameobligatoirestringThe operator's label, e.g. "Hetzner prod".
providerobligatoire"hetzner" | "digitalocean"Which cloud this credential talks to.
tokenobligatoirestringThe 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).

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 204

GithubAccount

GET/v1/accounts/github

Réponses

  • 200
PUT/v1/accounts/github

Corps de la requêteConnectGithubAccountDto

NomTypeDescription
tokenobligatoirestringPersonal access token (classic or fine-grained).

Réponses

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

Réponses

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

Corps de la requêteConnectGithubAppDto

NomTypeDescription
installationIdobligatoirestring
appIdobligatoirestring
clientIdobligatoirestring
clientSecretstring
privateKeyobligatoirestring
webhookSecretstring

Réponses

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerqueryobject

Réponses

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

Corps de la requêteConnectGithubManagedAppDto

NomTypeDescription
installationIdobligatoirestring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 204
GET/v1/accounts/github/repositories

Réponses

  • 200

GithubIssues

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring
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.

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring

Corps de la requêteCreateGithubIssueDto

NomTypeDescription
titleobligatoirestring
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.

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring
numberobligatoirepathnumber
commentsquerybooleanWith its comments.
relationsquerybooleanWith its parent, its sub-issues, and what blocks it and what it blocks.

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring
numberobligatoirepathnumber

Corps de la requêteEditGithubIssueDto

NomTypeDescription
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[]

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring
numberobligatoirepathnumber

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring
numberobligatoirepathnumber

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring
numberobligatoirepathnumber

Corps de la requêteCreateGithubIssueBranchDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring
numberobligatoirepathnumber

Corps de la requêteCloseGithubIssueDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring
numberobligatoirepathnumber

Corps de la requêteCommentGithubIssueDto

NomTypeDescription
bodyobligatoirestring

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring
numberobligatoirepathnumber

Corps de la requêteEditLastGithubCommentDto

NomTypeDescription
bodyobligatoirestring
createIfNonebooleanComment instead, when the member has none to edit.

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring
numberobligatoirepathnumber

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring
numberobligatoirepathnumber

Corps de la requêteLockGithubIssueDto

NomTypeDescription
reason"OFF_TOPIC" | "RESOLVED" | "SPAM" | "TOO_HEATED"

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring
numberobligatoirepathnumber

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring
numberobligatoirepathnumber

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring
numberobligatoirepathnumber

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring
numberobligatoirepathnumber

Corps de la requêteReopenGithubIssueDto

NomTypeDescription
commentstringPosted before it is reopened.

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring
numberobligatoirepathnumber

Corps de la requêteTransferGithubIssueDto

NomTypeDescription
repositoryobligatoirestringThe destination, as `owner/name`, of the same owner.

Réponses

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

Paramètres

NomEmplacementTypeDescription
ownerobligatoirepathstring
repoobligatoirepathstring

Réponses

  • 200

GitlabAccount

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

Réponses

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

Corps de la requêteConnectGitlabAccountDto

NomTypeDescription
patobligatoirestringGitLab 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.

Réponses

  • 200
GET/v1/accounts/gitlab/repositories

Réponses

  • 200

Goals

GET/v1/goals/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 200
PATCH/v1/goals/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteUpdateGoalDto

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

Réponses

  • 200
DELETE/v1/goals/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteCreateKeyResultDto

NomTypeDescription
nameobligatoirestring
targetValueobligatoirenumber
startValuenumber
currentValuenumber
unitstring
weightnumber

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteSetItemKeyResultDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteUpdateKeyResultDto

NomTypeDescription
namestring
currentValuenumber
startValuenumber
targetValuenumber
unitstringnull clears the unit.
weightnumber

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring

Corps de la requêteCreateGoalDto

NomTypeDescription
nameobligatoirestring
descriptionstring
startDatestring
endDatestring

Réponses

  • 201

ItemLifecycle

POST/v1/items/{id}/close

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteCloseItemDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteLockItemDto

NomTypeDescription
reason"OFF_TOPIC" | "RESOLVED" | "SPAM" | "TOO_HEATED"

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteReopenItemDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteTransferItemDto

NomTypeDescription
containerIdobligatoirestringThe list it moves to, in its space or in another.

Réponses

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

Paramètres

NomEmplacementTypeDescription
identifierobligatoirepathstring

Réponses

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring
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.

Réponses

  • 200

Items

GET/v1/containers/{containerId}/items

Paramètres

NomEmplacementTypeDescription
containerIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
containerIdobligatoirepathstring

Corps de la requêteCreateItemDto

NomTypeDescription
titleobligatoirestring
itemTypeIdobligatoirestring
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).

Réponses

  • 201
GET/v1/item-types

Réponses

  • 200
POST/v1/item-types

Corps de la requêteCreateItemTypeDto

NomTypeDescription
nameobligatoirestring
pluralNameobligatoirestring
identifierPrefixobligatoirestringUppercase prefix for human ids, e.g. "TASK" → TASK-1.
iconstring
colorstring
hierarchyLevelnumber1=Epic … 5=Subtask.

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteCreateFieldDefinitionDto

NomTypeDescription
nameobligatoirestring
fieldTypeobligatoire"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

Réponses

  • 201
GET/v1/items/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 200
PATCH/v1/items/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteUpdateItemDto

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

Réponses

  • 200
DELETE/v1/items/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteSetItemAssigneesDto

NomTypeDescription
userIdsobligatoirestring[]The complete desired assignee set (replaces the current assignees).

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteDuplicateItemDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteSetFieldValuesDto

NomTypeDescription
valuesobligatoireobject{ [fieldDefinitionId]: value | null } — null clears that field.

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteMoveItemDto

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

Réponses

  • 201

Maven

GET/maven/{splat}

Réponses

  • 200
POST/maven/{splat}

Réponses

  • 200
PUT/maven/{splat}

Réponses

  • 200
PATCH/maven/{splat}

Réponses

  • 200
DELETE/maven/{splat}

Réponses

  • 200

Me

GET/v1/me

Réponses

  • 200

Npm

GET/npm/{splat}

Réponses

  • 200
POST/npm/{splat}

Réponses

  • 200
PUT/npm/{splat}

Réponses

  • 200
PATCH/npm/{splat}

Réponses

  • 200
DELETE/npm/{splat}

Réponses

  • 200

NuGet

GET/nuget/{splat}

Réponses

  • 200
POST/nuget/{splat}

Réponses

  • 200
PUT/nuget/{splat}

Réponses

  • 200
PATCH/nuget/{splat}

Réponses

  • 200
DELETE/nuget/{splat}

Réponses

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

Corps de la requêtePreviewPipelineDto

NomTypeDescription
yamlobligatoirestringRaw workflow YAML to parse, validate and plan.

Réponses

  • 201

Previews

DELETE/v1/previews/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring

Corps de la requêteCreatePreviewManuallyDto

NomTypeDescription
prNumberobligatoirenumberThe open pull-request number to stand a preview up for.

Réponses

  • 201

PrReviews

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteSubmitReviewDto

NomTypeDescription
stateobligatoire"approved" | "changes"
bodystringOptional summary accompanying the verdict.

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteCreateReviewThreadDto

NomTypeDescription
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).
bodyobligatoirestringThe thread's opening comment.

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteAddThreadCommentDto

NomTypeDescription
bodyobligatoirestring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 201

PullRequests

GET/v1/pull-requests/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteEnqueuePullRequestDto

NomTypeDescription
strategy"merge" | "squash" | "rebase"

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteMergePullRequestDto

NomTypeDescription
strategy"merge" | "squash" | "rebase"

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
targetquerystring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring

Corps de la requêteSetPrModeDto

NomTypeDescription
modeobligatoire"provider" | "equantic"

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
statequerystring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring

Corps de la requêteCreatePullRequestDto

NomTypeDescription
titleobligatoirestring
bodystring
sourceBranchobligatoirestringBranch whose changes the PR proposes (its head sha is resolved from the forge).
targetBranchobligatoirestringBranch the PR merges into (its head sha becomes the diff base).

Réponses

  • 201

Pypi

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

Réponses

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

Réponses

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

Réponses

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

Réponses

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

Réponses

  • 200
GET/pypi/{splat}

Réponses

  • 200
POST/pypi/{splat}

Réponses

  • 200
PUT/pypi/{splat}

Réponses

  • 200
PATCH/pypi/{splat}

Réponses

  • 200
DELETE/pypi/{splat}

Réponses

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

Réponses

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

Réponses

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

Réponses

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

Réponses

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

Réponses

  • 200
GET/v2/{splat}

Réponses

  • 200
POST/v2/{splat}

Réponses

  • 200
PUT/v2/{splat}

Réponses

  • 200
PATCH/v2/{splat}

Réponses

  • 200
DELETE/v2/{splat}

Réponses

  • 200

RegistryToken

GET/v1/registry/tokens

Réponses

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

Corps de la requêteCreateRegistryTokenDto

NomTypeDescription
nameobligatoirestring
expiresInDaysnumberOptional expiry in days (omit = never expires).

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 204

Repositories

GET/v1/repositories

Réponses

  • 200
POST/v1/repositories

Corps de la requêteConnectRepositoryDto

NomTypeDescription
fullNameobligatoirestringGitHub/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).

Réponses

  • 201
GET/v1/repositories/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 200
DELETE/v1/repositories/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteSetRepositoryEqsCliDto

NomTypeDescription
enabledobligatoireboolean

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteSetRepositoryPipelinesDto

NomTypeDescription
enabledobligatoireboolean

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteSetRepositoryPreviewConfigDto

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

Réponses

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

Corps de la requêteSetRepositoriesPipelinesDto

NomTypeDescription
repositoryIdsobligatoirestring (uuid)[]The repositories to pause or resume, all of them or none.
enabledobligatoireboolean

Réponses

  • 204

RepositoryEnvironments

GET/v1/repositories/{repositoryId}/environments

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
nameobligatoirepathstring

Corps de la requêteSetEnvironmentDto

NomTypeDescription
requiresApprovalobligatoirebooleanWhether a job targeting this environment must be manually approved first.

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
nameobligatoirepathstring

Réponses

  • 204

RepositorySecrets

GET/v1/repositories/{repositoryId}/secrets

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
nameobligatoirepathstring

Corps de la requêteSetSecretDto

NomTypeDescription
valueobligatoirestring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
nameobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring

Réponses

  • 200

RepositoryVariables

GET/v1/repositories/{repositoryId}/variables

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
nameobligatoirepathstring

Corps de la requêteSetVariableDto

NomTypeDescription
valueobligatoirestring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
nameobligatoirepathstring

Réponses

  • 204

Rollout

POST/v1/admin/system/rollout

Corps de la requêteRolloutPlanDto

NomTypeDescription
namespaceobligatoirestring
jobRolloutJobDto
ensurePullSecretstring
stepsobligatoireRolloutStepDto[]

Réponses

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

Réponses

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

Réponses

  • 200

Rubygems

GET/rubygems/{splat}

Réponses

  • 200
POST/rubygems/{splat}

Réponses

  • 200
PUT/rubygems/{splat}

Réponses

  • 200
PATCH/rubygems/{splat}

Réponses

  • 200
DELETE/rubygems/{splat}

Réponses

  • 200

RunDeployments

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

Paramètres

NomEmplacementTypeDescription
runIdobligatoirepathstring

Réponses

  • 200

RunnerHosts

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

Réponses

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

Corps de la requêteRegisterRunnerHostDto

NomTypeDescription
nameobligatoirestringUnique, and the handle the job log names — `Running on 'mac-mini-1'`.
osobligatoire"linux" | "windows" | "macos"
addressobligatoirestringHostname or IP the platform opens ssh to.
userobligatoirestringThe 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.

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteRunnerHostIdleStopDto

NomTypeDescription
minutesobligatoirenumber

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteRunnerHostPowerDto

NomTypeDescription
actionobligatoire"on" | "off"

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteRunnerHostStatusDto

NomTypeDescription
statusobligatoire"online" | "draining" | "offline"`draining` before a reboot, `offline` to retire, `online` to take work.

Réponses

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

Réponses

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

Corps de la requêteCiPolicyDto

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

Réponses

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

Corps de la requêteCiPolicyDto

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

Réponses

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

Réponses

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

Paramètres

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

Réponses

  • 200
GET/v1/runs/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring
jobRunIdobligatoirepathstring
afterSeqquerynumber

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring
jobRunIdobligatoirepathstring
last-event-idobligatoireheaderstring
afterSeqquerynumber

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring
jobRunIdobligatoirepathstring

Corps de la requêteReviewDeploymentDto

NomTypeDescription
decisionobligatoire"approve" | "reject"

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteRerunRunDto

NomTypeDescription
modeobligatoire"all" | "failed"

Réponses

  • 200
POST/v1/runs/dispatch

Corps de la requêteDispatchWorkflowDto

NomTypeDescription
repositoryIdobligatoirestring (uuid)
workflowPathobligatoirestringPath 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).

Réponses

  • 201

ServiceConsole

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring
podquerystring

Réponses

  • 201

ServiceData

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring

Corps de la requêteRunStatementDto

NomTypeDescription
statementobligatoirestringThe 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).

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring

Corps de la requêteRunStatementDto

NomTypeDescription
statementobligatoirestringThe 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).

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring

Corps de la requêteRunStatementDto

NomTypeDescription
statementobligatoirestringThe 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).

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring
tableobligatoirepathstring

Réponses

  • 200

ServiceDomains

GET/v1/services/{serviceId}/domains

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring

Corps de la requêteAddDomainDto

NomTypeDescription
hostobligatoirestringThe custom domain to attach, e.g. `app.mycompany.com`.

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring
domainIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring
domainIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring
domainIdobligatoirepathstring

Corps de la requêteSetWwwAliasDto

NomTypeDescription
enabledobligatoireboolean
mode"serve" | "redirect"

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring

Corps de la requêteChooseAddressDto

NomTypeDescription
nameobligatoirestringThe 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.

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring

Réponses

  • 204

ServiceEnvVars

GET/v1/services/{serviceId}/env

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring

Corps de la requêteSetEnvVarDto

NomTypeDescription
keyobligatoirestring
valueobligatoirestring
secretbooleanEncrypt at rest + space via a k8s Secret (default false).

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring
keyobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring

Réponses

  • 200

ServiceExec

POST/v1/services/{id}/exec

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteExecServiceDto

NomTypeDescription
commandobligatoirestring[]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.

Réponses

  • 201

ServiceMetrics

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring
hoursquerystring

Réponses

  • 200

ServiceMq

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring
targetobligatoirepathstring

Corps de la requêteBrokerOperationDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring
targetobligatoirepathstring

Corps de la requêteBrokerOperationDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring
targetobligatoirepathstring

Corps de la requêteBrokerOperationDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
serviceIdobligatoirepathstring
targetobligatoirepathstring

Corps de la requêteBrokerOperationDto

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

Réponses

  • 200

ServiceRuntimeLogs

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring
instancequeryobject

Réponses

  • 200

Services

GET/v1/services/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteUpdateServiceDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteRollbackServiceDto

NomTypeDescription
deploymentIdobligatoirestringThe prior deployment to roll back to (its image is redeployed).

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

  • 204

SpaceEnvVars

GET/v1/spaces/{spaceId}/env

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring

Corps de la requêteSetEnvVarDto

NomTypeDescription
keyobligatoirestring
valueobligatoirestring
secretbooleanEncrypt at rest + space via a k8s Secret (default false).

Réponses

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

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring
keyobligatoirepathstring

Réponses

  • 204

Spaces

GET/v1/spaces

Réponses

  • 200
POST/v1/spaces

Corps de la requêteCreateSpaceDto

NomTypeDescription
nameobligatoirestring
descriptionstring
colorstring

Réponses

  • 201
GET/v1/spaces/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteUpdateSpaceDto

NomTypeDescription
nameobligatoirestring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteMoveSpaceDto

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

Réponses

  • 200

SpaceServices

GET/v1/spaces/{id}/services

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteCreateServiceDto

NomTypeDescription
nameobligatoirestring
sourceobligatoire"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.

Réponses

  • 201

Sprints

PUT/v1/items/{id}/sprint

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteSetItemSprintDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring

Corps de la requêteCreateSprintDto

NomTypeDescription
nameobligatoirestring
goalstring
startDatestring
endDatestring
capacitynumber

Réponses

  • 201
PATCH/v1/sprints/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteUpdateSprintDto

NomTypeDescription
namestring
goalstringnull clears the goal.
startDatestring
endDatestring
capacitynumber

Réponses

  • 200
DELETE/v1/sprints/{id}

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteTransitionSprintDto

NomTypeDescription
actionobligatoire"start" | "complete"'start' (PLANNED → ACTIVE) or 'complete' (→ COMPLETED).

Réponses

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

Corps de la requêteApplyLicenseDto

NomTypeDescription
licenseKeyobligatoirestring

Réponses

  • 201
GET/v1/admin/system/update

Réponses

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

Corps de la requêteApplyUpdateDto

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

Réponses

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

Réponses

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

Réponses

  • 200
GET/v1/admin/system/version

Réponses

  • 200

Tags

PUT/v1/items/{id}/tags

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteSetItemTagsDto

NomTypeDescription
tagIdsobligatoirestring[]The complete desired tag set (replaces the current tags).

Réponses

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

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring

Corps de la requêteCreateTagDto

NomTypeDescription
labelobligatoirestring
colorobligatoirestring

Réponses

  • 201

Templates

GET/v1/space-templates

Réponses

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

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring

Corps de la requêteApplyTemplateDto

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

Réponses

  • 204

Webhooks

POST/v1/webhooks/{provider}

Paramètres

NomEmplacementTypeDescription
providerobligatoirepathstring

Réponses

  • 202

Wiki

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring

Réponses

  • 200

Workflows

GET/v1/repositories/{repositoryId}/workflows

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
workflowFileIdobligatoirepathstring

Corps de la requêteSetWorkflowEnabledDto

NomTypeDescription
enabledobligatoireboolean

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
usesobligatoirequerystring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring
pathobligatoirequerystring

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring

Corps de la requêteSaveWorkflowContentDto

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

Réponses

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

Paramètres

NomEmplacementTypeDescription
repositoryIdobligatoirepathstring

Réponses

  • 200

Workspace

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

Réponses

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

Corps de la requêteCreateWorkspaceDto

NomTypeDescription
nameobligatoirestring
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

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Corps de la requêteUpdateWorkspaceDto

NomTypeDescription
namestring
featuresstring[]

Réponses

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

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring

Réponses

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

Paramètres

NomEmplacementTypeDescription
slugqueryobject

Réponses

  • 200