Skip to content
Open
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
137 changes: 29 additions & 108 deletions src/pages/docs/api/_generated/certificates.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-09-04
modDate: 2026-10-26
title: Certificates
---

Expand Down Expand Up @@ -581,130 +581,54 @@ Also reachable at `/api/certificates/generate`, `/api/spaces/{spaceIdentifier}/c

**Path Parameters**

- **`spaceId`** :span[string]{.type-label} *(required)*
- **`spaceId`** :span[string]{.type-label} *(required)*
The ID of the space to create the certificate in.

**Request Body**

- **`Archived`** :span[string]{.type-label}
Format `date-time`.
- **`CertificateChain`** :span[array of object]{.type-label}
- **`IssuerDistinguishedName`** :span[string]{.type-label}
- **`NotAfter`** :span[string]{.type-label}
Format `date-time`.
- **`NotBefore`** :span[string]{.type-label}
Format `date-time`.
- **`SerialNumber`** :span[string]{.type-label}
- **`SignatureAlgorithmName`** :span[string]{.type-label}
- **`SubjectDistinguishedName`** :span[string]{.type-label}
- **`Thumbprint`** :span[string]{.type-label}
- **`Version`** :span[integer]{.type-label}
- **`CertificateData`** :span[sensitive value]{.type-label}
- **`HasValue`** :span[boolean]{.type-label}
- **`Hint`** :span[string]{.type-label}
- **`NewValue`** :span[string]{.type-label}
- **`CertificateDataFormat`** :span[enum]{.type-label}
Allowed values: `Pkcs12`, `Der`, `Pem`, `Unknown`.
- **`EnvironmentIds`** :span[array of string]{.type-label}
- **`HasPrivateKey`** :span[boolean]{.type-label}
- **`Id`** :span[string]{.type-label}
Gets or sets a unique identifier for this resource.
- **`IsExpired`** :span[boolean]{.type-label}
- **`IssuerCommonName`** :span[string]{.type-label}
- **`IssuerDistinguishedName`** :span[string]{.type-label}
- **`IssuerOrganization`** :span[string]{.type-label}
- **`LastModifiedBy`** :span[string]{.type-label}
Gets or sets the username of the user who last modified this resource.
- **`LastModifiedOn`** :span[string]{.type-label}
Gets or sets the date/time that this resource was last modified. Format `date-time`.
- **`Links`** :span[object]{.type-label}
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- **`Name`** :span[string]{.type-label}
- **`NotAfter`** :span[string]{.type-label}
Format `date-time`.
- **`NotBefore`** :span[string]{.type-label}
Format `date-time`.
- **`Notes`** :span[string]{.type-label}
- **`EnvironmentIds`** :span[array of string]{.type-label}
Environments the certificate should be scoped to. Leave empty to allow use in all environments.
- **`Name`** :span[string]{.type-label} *(required)*
The name of the certificate. Minimum length 1.
- **`Notes`** :span[string]{.type-label}
Additional information on the certificate. Maximum length 10240.
- **`Password`** :span[sensitive value]{.type-label}
- **`HasValue`** :span[boolean]{.type-label}
- **`Hint`** :span[string]{.type-label}
- **`NewValue`** :span[string]{.type-label}
- **`ReplacedBy`** :span[string]{.type-label}
- **`SelfSigned`** :span[boolean]{.type-label}
- **`SelfSignedCertificateCurve`** :span[string]{.type-label}
Elliptic curve for the generated key pair: nistP256, nistP384 or nistP521. Defaults to nistP384 when omitted.
- **`SerialNumber`** :span[string]{.type-label}
- **`SignatureAlgorithmName`** :span[string]{.type-label}
- **`SpaceId`** :span[string]{.type-label}
- **`SubjectAlternativeNames`** :span[array of string]{.type-label}
- **`SpaceId`** :span[string]{.type-label} *(required)*
The ID of the space to create the certificate in.
- **`SubjectCommonName`** :span[string]{.type-label}
The certificate subject's common name (CN). When creating a self-signed certificate this becomes the generated certificate's CN, and at least one of SubjectCommonName or SubjectOrganization must be supplied.
- **`SubjectDistinguishedName`** :span[string]{.type-label}
- **`SubjectOrganization`** :span[string]{.type-label}
The certificate subject's organization (O). When creating a self-signed certificate, at least one of SubjectCommonName or SubjectOrganization must be supplied.
- **`TenantIds`** :span[array of string]{.type-label}
- **`TenantTags`** :span[array of string]{.type-label}
- **`TenantIds`** :span[array of string]{.type-label}
The tenants the certificate is associated with.
- **`TenantTags`** :span[array of string]{.type-label}
The canonical tenant tag names the certificate is associated with.
- **`TenantedDeploymentParticipation`** :span[enum]{.type-label}
Whether the certificate is available to tenanted deployments. Defaults to Tenanted when TenantIds or TenantTags are supplied, otherwise Untenanted.
Allowed values: `Untenanted`, `TenantedOrUntenanted`, `Tenanted`.
- **`Thumbprint`** :span[string]{.type-label}
- **`Version`** :span[integer]{.type-label}

:::api-example{label="Request"}
```json
{
"Archived": "2020-01-01T00:00:00.000Z",
"CertificateChain": [
{
"IssuerDistinguishedName": "string",
"NotAfter": "2020-01-01T00:00:00.000Z",
"NotBefore": "2020-01-01T00:00:00.000Z",
"SerialNumber": "string",
"SignatureAlgorithmName": "string",
"SubjectDistinguishedName": "string",
"Thumbprint": "string",
"Version": 0
}
],
"CertificateData": {
"HasValue": false,
"Hint": "string",
"NewValue": "string"
},
"CertificateDataFormat": "Pkcs12",
"EnvironmentIds": [
"Environments-1",
"..."
],
"HasPrivateKey": false,
"Id": "string",
"IsExpired": false,
"IssuerCommonName": "string",
"IssuerDistinguishedName": "string",
"IssuerOrganization": "string",
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"Links": {
"Self": "/api/..."
},
"Name": "string",
"NotAfter": "2020-01-01T00:00:00.000Z",
"NotBefore": "2020-01-01T00:00:00.000Z",
"Notes": "string",
"Password": {
"HasValue": false,
"Hint": "string",
"NewValue": "string"
},
"ReplacedBy": "string",
"SelfSigned": false,
"SelfSignedCertificateCurve": "string",
"SerialNumber": "string",
"SignatureAlgorithmName": "string",
"SpaceId": "Spaces-1",
"SubjectAlternativeNames": [
"string"
],
"SubjectCommonName": "string",
"SubjectDistinguishedName": "string",
"SubjectOrganization": "string",
"TenantIds": [
"Tenants-1",
Expand All @@ -713,9 +637,7 @@ Also reachable at `/api/certificates/generate`, `/api/spaces/{spaceIdentifier}/c
"TenantTags": [
"string"
],
"TenantedDeploymentParticipation": "Untenanted",
"Thumbprint": "string",
"Version": 0
"TenantedDeploymentParticipation": "Untenanted"
}
```
:::
Expand Down Expand Up @@ -1762,7 +1684,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 +1829,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 +1868,7 @@ Also reachable at `/api/certificates/{id}/usages`, `/api/spaces/{spaceIdentifier
"string"
]
},
"ProjectGroupId": "string",
"ProjectGroupId": "ProjectGroups-1",
"ProjectTags": [
"string"
],
Expand All @@ -1968,7 +1889,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 +1904,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
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
Loading
Loading