Skip to content

Update generated API docs #3485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
team-backend-foundations-bot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update generated API docs #3485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 13 additions & 14 deletions src/pages/docs/api/_generated/certificates.md
View file
Open in desktop
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-09-04
modDate: 2026-10-07
title: Certificates
---

Expand Down Expand Up @@ -1762,7 +1762,8 @@ Also reachable at `/api/certificates/{id}/usages`, `/api/spaces/{spaceIdentifier
- **`DiscreteChannelRelease`** :span[boolean]{.type-label}
Treats releases of different channels to the same environment as a seperate deployment dimension. 'False' indicates a "hotfix"-style usage of channels (single release active per environment ignoring channels), whereas `True` indicates "microservice"-style usage (single release per environment per channel).
- **`ExecuteDeploymentsOnEventBasedPipeline`** :span[boolean]{.type-label}
- **`ExtensionSettings`** :span[array of object]{.type-label}
- **`ExtensionSettings`** :span[array of object]{.type-label}
Not intended for general use; You should not alter or add/remove any values it may have.
- **`ForcePackageDownload`** :span[boolean]{.type-label}
- **`Icon`** :span[object]{.type-label}
- **`Id`** :span[string]{.type-label}
Expand Down Expand Up @@ -1906,25 +1907,23 @@ Also reachable at `/api/certificates/{id}/usages`, `/api/spaces/{spaceIdentifier
"ClonedFromProjectId": "Projects-1",
"CombineHealthAndSyncStatusInDashboardLiveStatus": false,
"DefaultGuidedFailureMode": "EnvironmentDefault",
"DefaultPowerShellEdition": "string",
"DefaultPowerShellEdition": null,
"DefaultToSkipIfAlreadyInstalled": false,
"DeploymentChangesTemplate": "string",
"DeploymentProcessId": "string",
"DeploymentProcessId": "deploymentprocess-Projects-1",
"DeprovisioningRunbookId": "Runbooks-1",
"Description": "string",
"DiscreteChannelRelease": false,
"ExecuteDeploymentsOnEventBasedPipeline": false,
"ExtensionSettings": [
{}
],
"ExtensionSettings": [],
"ForcePackageDownload": false,
"Icon": {
"Color": "string",
"Id": "string"
"Color": "#3CA4F3",
"Id": "rocket"
},
"Id": "string",
"IncludedLibraryVariableSetIds": [
"string"
"LibraryVariableSets-1"
],
"IsBadgesEnabled": false,
"IsDisabled": false,
Expand All @@ -1947,7 +1946,7 @@ Also reachable at `/api/certificates/{id}/usages`, `/api/spaces/{spaceIdentifier
"string"
]
},
"ProjectGroupId": "string",
"ProjectGroupId": "ProjectGroups-1",
"ProjectTags": [
"string"
],
Expand All @@ -1968,7 +1967,7 @@ Also reachable at `/api/certificates/{id}/usages`, `/api/spaces/{spaceIdentifier
{}
],
"TenantedDeploymentMode": "Untenanted",
"VariableSetId": "string",
"VariableSetId": "variableset-Projects-1",
"VersioningStrategy": {
"DonorPackage": {},
"Template": "string"
Expand All @@ -1983,8 +1982,8 @@ Also reachable at `/api/certificates/{id}/usages`, `/api/spaces/{spaceIdentifier
],
"Description": "string",
"Icon": {
"Color": "string",
"Id": "string"
"Color": "#3CA4F3",
"Id": "rocket"
},
"Id": "string",
"IsDisabled": false,
Expand Down
86 changes: 85 additions & 1 deletion src/pages/docs/api/_generated/deployment-targets.md
View file
Open in desktop
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-09-04
modDate: 2026-10-07
title: Deployment Targets
---

Expand Down Expand Up @@ -743,6 +743,90 @@ Also reachable at `/api/machines/operatingsystem/shells/all`, `/api/spaces/{spac
```
:::

## Summarise deployment targets and their health by deployment target type

:endpoint{method="GET" path="/api/\{spaceId\}/machines/summary"}

Also reachable at `/api/spaces/{spaceIdentifier}/machines/summary`.

Counts the deployment targets in the supplied Octopus Deploy Space, grouped by deployment target type, with a breakdown by health status. Accepts the same filters as listing machines.

**Path Parameters**

- **`spaceId`** :span[string]{.type-label} *(required)*
The ID of the space containing the resource(s).

**Query Parameters**

- **`commStyles`** :span[array of string]{.type-label}
List of communication styles which if specified, filters the result to only include Deployment Targets with matching communication styles.
- **`deploymentTargetTypes`** :span[array of string]{.type-label}
List of deployment target types which if specified, filters the result to only include Deployment Targets with matching types.
- **`environmentIds`** :span[array of string]{.type-label}
List of Environment IDs which if specified, filters the result to only include Deployment Targets with matching Environment IDs.
- **`healthStatuses`** :span[array of string]{.type-label}
List of health statuses which if specified, filters the result to only include Deployment Targets with matching health statuses.
- **`ids`** :span[array of string]{.type-label}
List of Deployment Target IDs which if specified, filters the result to only include Deployment Targets with matching IDs.
- **`isDisabled`** :span[boolean]{.type-label}
A filter to return only disabled/enabled Deployment Targets.
- **`operatingSystemNames`** :span[array of string]{.type-label}
List of operating system names which if specified, filters the result to only include Deployment Targets with matching operating systems.
- **`partialName`** :span[string]{.type-label}
A partial or complete name to search on. This will perform a "contains" style match against the supplied name or name-fragment.
- **`roles`** :span[array of string]{.type-label}
List of roles which if specified, filters the result to only include Deployment Targets with matching roles.
- **`shellNames`** :span[array of string]{.type-label}
List of shell names which if specified, filters the result to only include Deployment Targets with matching shells.
- **`targetTags`** :span[array of string]{.type-label}
List of Target Tags which if specified, filters the result to only include Deployment Targets with matching Target Tags.
- **`tenantIds`** :span[array of string]{.type-label}
List of Tenant IDs which if specified, filters the result to only include Deployment Targets with matching Tenant IDs.
- **`tenantTags`** :span[array of string]{.type-label}
List of Tenant Tags which if specified, filters the result to only include Deployment Targets with matching Tenant Tags.

**Response**

`200` — Deployment target counts and health, overall and per deployment target type.

- **`DeploymentTargetTypeSummaries`** :span[array of object]{.type-label}
Summaries per deployment target type, ordered by the number of deployment targets, largest first.
- **`DeploymentTargetType`** :span[string]{.type-label}
Minimum length 1.
- **`MachineHealthStatusSummaries`** :span[object]{.type-label}
- **`TotalDisabledMachines`** :span[integer]{.type-label}
- **`TotalMachines`** :span[integer]{.type-label}
- **`MachineHealthStatusSummaries`** :span[object]{.type-label}
Count of deployment targets per health status. Disabled targets are only counted in TotalDisabledMachines.
- **`TotalDisabledMachines`** :span[integer]{.type-label}
- **`TotalMachines`** :span[integer]{.type-label}

:::api-example{label="Response"}
```json
{
"DeploymentTargetTypeSummaries": [
{
"DeploymentTargetType": "string",
"MachineHealthStatusSummaries": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"TotalDisabledMachines": 0,
"TotalMachines": 0
}
],
"MachineHealthStatusSummaries": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"TotalDisabledMachines": 0,
"TotalMachines": 0
}
```
:::

## List machines sorted by health status

:endpoint{method="GET" path="/api/\{spaceId\}/machines/v2"}
Expand Down
84 changes: 27 additions & 57 deletions src/pages/docs/api/_generated/environments.md
View file
Open in desktop
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-09-04
modDate: 2026-10-07
title: Environments
---

Expand Down Expand Up @@ -46,7 +46,8 @@ Lists all of the environments in the supplied Octopus Deploy Space. The results
Gets or sets a short description of this environment that can be used to explain the purpose of the environment to other users. This field may contain markdown.
- **`EnvironmentTags`** :span[array of string]{.type-label}
List of tags assigned to this environment.
- **`ExtensionSettings`** :span[array of object]{.type-label}
- **`ExtensionSettings`** :span[array of object]{.type-label}
Not intended for general use; You should not alter or add/remove any values it may have.
- **`Id`** :span[string]{.type-label}
Gets or sets a unique identifier for this resource.
- **`LastModifiedBy`** :span[string]{.type-label}
Expand Down Expand Up @@ -86,9 +87,7 @@ Lists all of the environments in the supplied Octopus Deploy Space. The results
"EnvironmentTags": [
"string"
],
"ExtensionSettings": [
{}
],
"ExtensionSettings": [],
"Id": "string",
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
Expand Down Expand Up @@ -130,7 +129,8 @@ Also reachable at `/api/environments`, `/api/spaces/{spaceIdentifier}/environmen
- **`AllowDynamicInfrastructure`** :span[boolean]{.type-label}
- **`Description`** :span[string]{.type-label}
- **`EnvironmentTags`** :span[array of string]{.type-label}
- **`ExtensionSettings`** :span[array of object]{.type-label}
- **`ExtensionSettings`** :span[array of object]{.type-label}
Not intended for general use; You should not alter or add/remove any values it may have.
- **`ExtensionId`** :span[string]{.type-label}
- **`Values`** :span[string]{.type-label}
- **`Name`** :span[string]{.type-label} *(required)*
Expand All @@ -148,12 +148,7 @@ Also reachable at `/api/environments`, `/api/spaces/{spaceIdentifier}/environmen
"EnvironmentTags": [
"string"
],
"ExtensionSettings": [
{
"ExtensionId": "string",
"Values": "string"
}
],
"ExtensionSettings": [],
"Name": "string",
"Slug": "string",
"SortOrder": 0,
Expand All @@ -173,7 +168,8 @@ Also reachable at `/api/environments`, `/api/spaces/{spaceIdentifier}/environmen
Gets or sets a short description of this environment that can be used to explain the purpose of the environment to other users. This field may contain markdown.
- **`EnvironmentTags`** :span[array of string]{.type-label}
List of tags assigned to this environment.
- **`ExtensionSettings`** :span[array of object]{.type-label}
- **`ExtensionSettings`** :span[array of object]{.type-label}
Not intended for general use; You should not alter or add/remove any values it may have.
- **`ExtensionId`** :span[string]{.type-label}
- **`Values`** :span[string]{.type-label}
- **`Id`** :span[string]{.type-label}
Expand Down Expand Up @@ -201,12 +197,7 @@ Also reachable at `/api/environments`, `/api/spaces/{spaceIdentifier}/environmen
"EnvironmentTags": [
"string"
],
"ExtensionSettings": [
{
"ExtensionId": "string",
"Values": "string"
}
],
"ExtensionSettings": [],
"Id": "string",
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
Expand Down Expand Up @@ -254,7 +245,8 @@ Lists the name and ID of all of the environments in the supplied Space. The resu
Gets or sets a short description of this environment that can be used to explain the purpose of the environment to other users. This field may contain markdown.
- **`EnvironmentTags`** :span[array of string]{.type-label}
List of tags assigned to this environment.
- **`ExtensionSettings`** :span[array of object]{.type-label}
- **`ExtensionSettings`** :span[array of object]{.type-label}
Not intended for general use; You should not alter or add/remove any values it may have.
- **`ExtensionId`** :span[string]{.type-label}
- **`Values`** :span[string]{.type-label}
- **`Id`** :span[string]{.type-label}
Expand Down Expand Up @@ -283,12 +275,7 @@ Lists the name and ID of all of the environments in the supplied Space. The resu
"EnvironmentTags": [
"string"
],
"ExtensionSettings": [
{
"ExtensionId": "string",
"Values": "string"
}
],
"ExtensionSettings": [],
"Id": "string",
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
Expand Down Expand Up @@ -338,7 +325,8 @@ Lists the name and ID of all of the environments in the supplied Space. The resu
Gets or sets a short description of this environment that can be used to explain the purpose of the environment to other users. This field may contain markdown.
- **`EnvironmentTags`** :span[array of string]{.type-label}
List of tags assigned to this environment.
- **`ExtensionSettings`** :span[array of object]{.type-label}
- **`ExtensionSettings`** :span[array of object]{.type-label}
Not intended for general use; You should not alter or add/remove any values it may have.
- **`Id`** :span[string]{.type-label}
Gets or sets a unique identifier for this resource.
- **`LastModifiedBy`** :span[string]{.type-label}
Expand Down Expand Up @@ -366,9 +354,7 @@ Lists the name and ID of all of the environments in the supplied Space. The resu
"EnvironmentTags": [
"string"
],
"ExtensionSettings": [
{}
],
"ExtensionSettings": [],
"Id": "string",
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
Expand Down Expand Up @@ -489,9 +475,7 @@ Also reachable at `/api/environments/summary`, `/api/spaces/{spaceIdentifier}/en
"EnvironmentTags": [
"string"
],
"ExtensionSettings": [
{}
],
"ExtensionSettings": [],
"Id": "string",
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
Expand Down Expand Up @@ -784,9 +768,7 @@ Lists all of the environments in the supplied Octopus Deploy Space. The results
"EnvironmentTags": [
"string"
],
"ExtensionSettings": [
{}
],
"ExtensionSettings": [],
"Id": "string",
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
Expand Down Expand Up @@ -907,7 +889,8 @@ Also reachable at `/api/environments/{environmentId}`, `/api/spaces/{spaceIdenti
- **`Description`** :span[string]{.type-label}
- **`EnvironmentId`** :span[string]{.type-label} *(required)*
- **`EnvironmentTags`** :span[array of string]{.type-label}
- **`ExtensionSettings`** :span[array of object]{.type-label}
- **`ExtensionSettings`** :span[array of object]{.type-label}
Not intended for general use; You should not alter or add/remove any values it may have.
- **`ExtensionId`** :span[string]{.type-label}
- **`Values`** :span[string]{.type-label}
- **`Name`** :span[string]{.type-label} *(required)*
Expand All @@ -926,12 +909,7 @@ Also reachable at `/api/environments/{environmentId}`, `/api/spaces/{spaceIdenti
"EnvironmentTags": [
"string"
],
"ExtensionSettings": [
{
"ExtensionId": "string",
"Values": "string"
}
],
"ExtensionSettings": [],
"Name": "string",
"Slug": "string",
"SortOrder": 0,
Expand All @@ -951,7 +929,8 @@ Also reachable at `/api/environments/{environmentId}`, `/api/spaces/{spaceIdenti
Gets or sets a short description of this environment that can be used to explain the purpose of the environment to other users. This field may contain markdown.
- **`EnvironmentTags`** :span[array of string]{.type-label}
List of tags assigned to this environment.
- **`ExtensionSettings`** :span[array of object]{.type-label}
- **`ExtensionSettings`** :span[array of object]{.type-label}
Not intended for general use; You should not alter or add/remove any values it may have.
- **`ExtensionId`** :span[string]{.type-label}
- **`Values`** :span[string]{.type-label}
- **`Id`** :span[string]{.type-label}
Expand Down Expand Up @@ -979,12 +958,7 @@ Also reachable at `/api/environments/{environmentId}`, `/api/spaces/{spaceIdenti
"EnvironmentTags": [
"string"
],
"ExtensionSettings": [
{
"ExtensionId": "string",
"Values": "string"
}
],
"ExtensionSettings": [],
"Id": "string",
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
Expand Down Expand Up @@ -1105,7 +1079,8 @@ Also reachable at `/api/environments/{id}`, `/api/spaces/{spaceIdentifier}/envir
Gets or sets a short description of this environment that can be used to explain the purpose of the environment to other users. This field may contain markdown.
- **`EnvironmentTags`** :span[array of string]{.type-label}
List of tags assigned to this environment.
- **`ExtensionSettings`** :span[array of object]{.type-label}
- **`ExtensionSettings`** :span[array of object]{.type-label}
Not intended for general use; You should not alter or add/remove any values it may have.
- **`ExtensionId`** :span[string]{.type-label}
- **`Values`** :span[string]{.type-label}
- **`Id`** :span[string]{.type-label}
Expand Down Expand Up @@ -1133,12 +1108,7 @@ Also reachable at `/api/environments/{id}`, `/api/spaces/{spaceIdentifier}/envir
"EnvironmentTags": [
"string"
],
"ExtensionSettings": [
{
"ExtensionId": "string",
"Values": "string"
}
],
"ExtensionSettings": [],
"Id": "string",
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
Expand Down
Loading
Loading