Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions src/pages/docs/api/_generated/capabilities.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-08-11
modDate: 2026-08-25
title: Capabilities
---

## Ask the server to return a list of all the Capabilities (Commands and Requests) it supports
A Capability is a Request or Command that the server supports.

You can list all capabilities, or query for an individual one.

The intent of these endpoints is to allow HTTP clients to detect features in a more robust way than
guessing based on the Server Version.

Capabilities are expressed in terms of the internal Command or Request data type names.
For example, the URL `/api/{SpaceId}/certificates/v2` maps to the `GetCertificatesRequestV2` request type,
which will appear as a capability for servers which support it.

The capabilities endpoints can be accessed anonymously; If a client needs to detect a feature before
authenticating, it may do so.

## List capabilities (Commands and Requests) this server supports

:endpoint{method="GET" path="/api/capabilities"}

Expand All @@ -26,14 +40,16 @@ title: Capabilities
```
:::

## Ask the server if a single capability exists or not. If the Capability exists, an HTTP 200 (OK) will be returned. If not, a 404 (Not Found) will be returned
## Query for a single capability (Command or Request)

:endpoint{method="GET" path="/api/capabilities/\{capability\}"}

If the Capability exists, an HTTP 200 (OK) will be returned. If not, a 404 (Not Found) will be returned.

**Path Parameters**

- **`capability`** :span[string]{.type-label} *(required)*
The capability you want to query for. Name matching is case insensitive but otherwise must be a full string match.
The capability you want to query for. Name matching is case insensitive. Partial matching is not supported.

**Response**

Expand Down
24 changes: 12 additions & 12 deletions src/pages/docs/api/_generated/deployment-processes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-08-11
modDate: 2026-08-20
title: Deployment Processes
---

Expand Down Expand Up @@ -258,7 +258,7 @@ Also reachable at `/api/deploymentprocesses/{id}`, `/api/spaces/{spaceIdentifier
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label}
Expand Down Expand Up @@ -339,7 +339,7 @@ Also reachable at `/api/projects/{projectId}/deploymentprocesses`, `/api/spaces/
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label}
Expand Down Expand Up @@ -413,7 +413,7 @@ Modifies a deployment process. Only allowed for deployment processes owned by a
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label} *(required)*
Expand Down Expand Up @@ -476,7 +476,7 @@ Modifies a deployment process. Only allowed for deployment processes owned by a
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label}
Expand Down Expand Up @@ -559,7 +559,7 @@ This request returns the deployment process with all process template usages res
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label}
Expand Down Expand Up @@ -805,7 +805,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/deploymentprocesses`, `/ap
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label}
Expand Down Expand Up @@ -881,7 +881,7 @@ Modifies a deployment process. Only allowed for deployment processes owned by a
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label} *(required)*
Expand Down Expand Up @@ -945,7 +945,7 @@ Modifies a deployment process. Only allowed for deployment processes owned by a
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label}
Expand Down Expand Up @@ -1029,7 +1029,7 @@ This request returns the deployment process with all process template usages res
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label}
Expand Down Expand Up @@ -1282,7 +1282,7 @@ Modifies a deployment process. Only allowed for deployment processes owned by a
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label} *(required)*
Expand Down Expand Up @@ -1352,7 +1352,7 @@ Modifies a deployment process. Only allowed for deployment processes owned by a
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label}
Expand Down
14 changes: 7 additions & 7 deletions src/pages/docs/api/_generated/process-templates.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-08-11
modDate: 2026-08-20
title: Process Templates
---

Expand Down Expand Up @@ -92,7 +92,7 @@ title: Process Templates
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[string]{.type-label}
Expand Down Expand Up @@ -278,7 +278,7 @@ title: Process Templates
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.

Expand Down Expand Up @@ -375,7 +375,7 @@ title: Process Templates
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.

Expand Down Expand Up @@ -575,7 +575,7 @@ title: Process Templates
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[string]{.type-label}
Expand Down Expand Up @@ -678,7 +678,7 @@ title: Process Templates
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.

Expand Down Expand Up @@ -766,7 +766,7 @@ title: Process Templates
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.

Expand Down
20 changes: 10 additions & 10 deletions src/pages/docs/api/_generated/runbook-processes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-08-11
modDate: 2026-08-20
title: Runbook Processes
---

Expand Down Expand Up @@ -138,7 +138,7 @@ Also reachable at `/api/projects/{projectId}/runbookProcesses/{id}`, `/api/space
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label}
Expand Down Expand Up @@ -223,7 +223,7 @@ Only allowed for Runbook Processes owned by a project.
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label} *(required)*
Expand Down Expand Up @@ -295,7 +295,7 @@ Only allowed for Runbook Processes owned by a project.
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label}
Expand Down Expand Up @@ -495,7 +495,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbookProcesses/{id}`, `/
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label}
Expand Down Expand Up @@ -586,7 +586,7 @@ Only allowed for Runbook Processes owned by a project.
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label} *(required)*
Expand Down Expand Up @@ -660,7 +660,7 @@ Only allowed for Runbook Processes owned by a project.
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label}
Expand Down Expand Up @@ -834,7 +834,7 @@ Also reachable at `/api/runbookProcesses/{id}`, `/api/spaces/{spaceIdentifier}/r
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label}
Expand Down Expand Up @@ -918,7 +918,7 @@ Only allowed for Runbook Processes owned by a project.
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label} *(required)*
Expand Down Expand Up @@ -990,7 +990,7 @@ Only allowed for Runbook Processes owned by a project.
- **`Properties`** :span[object]{.type-label}
- **`Slug`** :span[string]{.type-label}
- **`StartTrigger`** :span[enum]{.type-label}
Allowed values: `StartAfterPrevious`, `StartWithPrevious`.
Allowed values: `StartAfterPrevious`, `StartWithPrevious`, `Variable`.
- **`Type`** :span[string]{.type-label}
Either "Step" or "ProcessTemplateUsage". Defaults to "Step" if no type is provided.
- **`Version`** :span[integer]{.type-label}
Expand Down
Loading