diff --git a/src/pages/docs/api/_generated/certificates.md b/src/pages/docs/api/_generated/certificates.md index 3a9f48d4cb..84199c8e92 100644 --- a/src/pages/docs/api/_generated/certificates.md +++ b/src/pages/docs/api/_generated/certificates.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-04 +modDate: 2026-10-07 title: Certificates --- @@ -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} @@ -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, @@ -1947,7 +1946,7 @@ Also reachable at `/api/certificates/{id}/usages`, `/api/spaces/{spaceIdentifier "string" ] }, - "ProjectGroupId": "string", + "ProjectGroupId": "ProjectGroups-1", "ProjectTags": [ "string" ], @@ -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" @@ -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, diff --git a/src/pages/docs/api/_generated/deployment-targets.md b/src/pages/docs/api/_generated/deployment-targets.md index 678caadcc3..f49dec46a6 100644 --- a/src/pages/docs/api/_generated/deployment-targets.md +++ b/src/pages/docs/api/_generated/deployment-targets.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-04 +modDate: 2026-10-07 title: Deployment Targets --- @@ -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"} diff --git a/src/pages/docs/api/_generated/environments.md b/src/pages/docs/api/_generated/environments.md index 6df7e7dab6..902519ec9b 100644 --- a/src/pages/docs/api/_generated/environments.md +++ b/src/pages/docs/api/_generated/environments.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-04 +modDate: 2026-10-07 title: Environments --- @@ -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} @@ -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", @@ -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)* @@ -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, @@ -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} @@ -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", @@ -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} @@ -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", @@ -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} @@ -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", @@ -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", @@ -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", @@ -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)* @@ -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, @@ -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} @@ -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", @@ -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} @@ -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", diff --git a/src/pages/docs/api/_generated/events.md b/src/pages/docs/api/_generated/events.md index 9cb9ddc4fb..dd721fe63a 100644 --- a/src/pages/docs/api/_generated/events.md +++ b/src/pages/docs/api/_generated/events.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-04 +modDate: 2026-10-06 title: Events --- @@ -81,6 +81,15 @@ A list of all audit events collected to date, ordered by the date of the event i - **`ItemType`** :span[string]{.type-label} The type of item in this list. - **`Items`** :span[array of object]{.type-label} + - **`Actor`** :span[string]{.type-label} + Gets or sets a readable description of the AI tool that created the event, such as Claude. It includes the tool's client ID and redirect URI. To read those values separately, use ActorOAuthClient. Null when the event wasn't created through an OAuth connection. + - **`ActorOAuthClient`** :span[object]{.type-label} + - **`ActorType`** :span[enum]{.type-label} + Gets or sets whether a user, an AI agent, a service account, or Octopus itself created the event. Use this field to find changes made by AI agents. Null for events created before Octopus recorded this. + Allowed values: `Unknown`, `System`, `User`, `Agent`, `ServiceAccount`. + - **`ApiKeyActorType`** :span[enum]{.type-label} + Gets or sets the actor type of the API key used to authenticate the request, if applicable. + Allowed values: `User`, `AiAgent`. - **`ApiKeyHint`** :span[string]{.type-label} Gets or sets the obfuscated hint of the API key used to authenticate the request, if applicable. - **`ApiKeyId`** :span[string]{.type-label} @@ -114,8 +123,13 @@ A list of all audit events collected to date, ordered by the date of the event i Gets or sets an array of document ID's and indexes where they are mentioned in the message text. - **`Occurred`** :span[string]{.type-label} Gets or sets the date/time that the event took place. Format `date-time`. + - **`OnBehalfOf`** :span[string]{.type-label} + Gets or sets the ID of the user an AI agent acted for. If the agent has its own service account, this is that account's ID. Null when an AI agent didn't create the event. - **`RelatedDocumentIds`** :span[array of string]{.type-label} Gets or sets a collection of document ID's that this event relates to. Note that the document ID's may no longer exist. + - **`ServiceAccountType`** :span[enum]{.type-label} + Gets or sets the type of service account that created the event. Null when the user is not a service account. + Allowed values: `Standard`, `Agent`. - **`SpaceId`** :span[string]{.type-label} Gets or sets the SpaceId of the event. This represents the space in which the event was raised. - **`UserAgent`** :span[string]{.type-label} @@ -142,6 +156,15 @@ A list of all audit events collected to date, ordered by the date of the event i "ItemType": "Event", "Items": [ { + "Actor": "Claude (client_id: https://claude.ai/oauth/mcp-oauth-client-metadata, redirect_uri: https://claude.ai/api/mcp/auth_callback)", + "ActorOAuthClient": { + "ClientId": "https://claude.ai/oauth/mcp-oauth-client-metadata", + "ClientName": "Claude", + "IsLoopbackRedirect": false, + "RedirectUri": "https://claude.ai/api/mcp/auth_callback" + }, + "ActorType": "Agent", + "ApiKeyActorType": null, "ApiKeyHint": null, "ApiKeyId": null, "Category": "Modified", @@ -175,9 +198,11 @@ A list of all audit events collected to date, ordered by the date of the event i {} ], "Occurred": "2020-01-01T00:00:00.000Z", + "OnBehalfOf": "Users-1", "RelatedDocumentIds": [ "Tenants-1" ], + "ServiceAccountType": null, "SpaceId": "Spaces-1", "UserAgent": "OctopusClient-js/2026.3.15581", "UserId": "Users-1", @@ -378,6 +403,23 @@ Also reachable at `/api/events/{id}`, `/api/spaces/{spaceIdentifier}/events/{id} `200` — The requested event +- **`Actor`** :span[string]{.type-label} + Gets or sets a readable description of the AI tool that created the event, such as Claude. It includes the tool's client ID and redirect URI. To read those values separately, use ActorOAuthClient. Null when the event wasn't created through an OAuth connection. +- **`ActorOAuthClient`** :span[object]{.type-label} + - **`ClientId`** :span[string]{.type-label} + Gets the ID of the OAuth client. + - **`ClientName`** :span[string]{.type-label} + Gets the name the OAuth client registered with. + - **`IsLoopbackRedirect`** :span[boolean]{.type-label} + Gets whether the redirect URI was a loopback address. This describes where the browser sent the authorization code, not where the token is used. + - **`RedirectUri`** :span[string]{.type-label} + Gets the redirect URI the authorization code was sent to. +- **`ActorType`** :span[enum]{.type-label} + Gets or sets whether a user, an AI agent, a service account, or Octopus itself created the event. Use this field to find changes made by AI agents. Null for events created before Octopus recorded this. + Allowed values: `Unknown`, `System`, `User`, `Agent`, `ServiceAccount`. +- **`ApiKeyActorType`** :span[enum]{.type-label} + Gets or sets the actor type of the API key used to authenticate the request, if applicable. + Allowed values: `User`, `AiAgent`. - **`ApiKeyHint`** :span[string]{.type-label} Gets or sets the obfuscated hint of the API key used to authenticate the request, if applicable. - **`ApiKeyId`** :span[string]{.type-label} @@ -416,8 +458,13 @@ Also reachable at `/api/events/{id}`, `/api/spaces/{spaceIdentifier}/events/{id} - **`StartIndex`** :span[integer]{.type-label} - **`Occurred`** :span[string]{.type-label} Gets or sets the date/time that the event took place. Format `date-time`. +- **`OnBehalfOf`** :span[string]{.type-label} + Gets or sets the ID of the user an AI agent acted for. If the agent has its own service account, this is that account's ID. Null when an AI agent didn't create the event. - **`RelatedDocumentIds`** :span[array of string]{.type-label} Gets or sets a collection of document ID's that this event relates to. Note that the document ID's may no longer exist. +- **`ServiceAccountType`** :span[enum]{.type-label} + Gets or sets the type of service account that created the event. Null when the user is not a service account. + Allowed values: `Standard`, `Agent`. - **`SpaceId`** :span[string]{.type-label} Gets or sets the SpaceId of the event. This represents the space in which the event was raised. - **`UserAgent`** :span[string]{.type-label} @@ -430,6 +477,15 @@ Also reachable at `/api/events/{id}`, `/api/spaces/{spaceIdentifier}/events/{id} :::api-example{label="Response"} ```json { + "Actor": "Claude (client_id: https://claude.ai/oauth/mcp-oauth-client-metadata, redirect_uri: https://claude.ai/api/mcp/auth_callback)", + "ActorOAuthClient": { + "ClientId": "https://claude.ai/oauth/mcp-oauth-client-metadata", + "ClientName": "Claude", + "IsLoopbackRedirect": false, + "RedirectUri": "https://claude.ai/api/mcp/auth_callback" + }, + "ActorType": "Agent", + "ApiKeyActorType": null, "ApiKeyHint": null, "ApiKeyId": null, "Category": "Modified", @@ -467,9 +523,11 @@ Also reachable at `/api/events/{id}`, `/api/spaces/{spaceIdentifier}/events/{id} } ], "Occurred": "2020-01-01T00:00:00.000Z", + "OnBehalfOf": "Users-1", "RelatedDocumentIds": [ "Tenants-1" ], + "ServiceAccountType": null, "SpaceId": "Spaces-1", "UserAgent": "OctopusClient-js/2026.3.15581", "UserId": "Users-1", diff --git a/src/pages/docs/api/_generated/features-configuration.md b/src/pages/docs/api/_generated/features-configuration.md index bd76d87580..e921816078 100644 --- a/src/pages/docs/api/_generated/features-configuration.md +++ b/src/pages/docs/api/_generated/features-configuration.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-04 +modDate: 2026-09-23 title: Features Configuration --- @@ -29,7 +29,6 @@ Gets the features configuration of the current instance - **`IsHelpSidebarEnabled`** :span[boolean]{.type-label} - **`IsKubernetesCloudTargetDiscoveryEnabled`** :span[boolean]{.type-label} - **`IsProjectsPageOnboardingEnabled`** :span[boolean]{.type-label} -- **`IsProjectsPageOptimizationEnabled`** :span[boolean]{.type-label} - **`IsWebhookTriggerEnabled`** :span[boolean]{.type-label} - **`LastModifiedBy`** :span[string]{.type-label} Gets or sets the username of the user who last modified this resource. @@ -54,7 +53,6 @@ Gets the features configuration of the current instance "IsHelpSidebarEnabled": false, "IsKubernetesCloudTargetDiscoveryEnabled": false, "IsProjectsPageOnboardingEnabled": false, - "IsProjectsPageOptimizationEnabled": false, "IsWebhookTriggerEnabled": false, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", @@ -101,8 +99,6 @@ Updates the features configuration of the current instance Enable navigation visual uplift feature. - **`IsProjectsPageOnboardingEnabled`** :span[boolean]{.type-label} Enable projects page onboarding experience. -- **`IsProjectsPageOptimizationEnabled`** :span[boolean]{.type-label} - Enable new project page bff datasource. - **`IsWebhookTriggerEnabled`** :span[boolean]{.type-label} Enable the webhook triggers feature. @@ -123,7 +119,6 @@ Updates the features configuration of the current instance "IsKubernetesCloudTargetDiscoveryEnabled": false, "IsNavigationVisualUpliftEnabled": false, "IsProjectsPageOnboardingEnabled": false, - "IsProjectsPageOptimizationEnabled": false, "IsWebhookTriggerEnabled": false } ``` @@ -147,7 +142,6 @@ Updates the features configuration of the current instance - **`IsHelpSidebarEnabled`** :span[boolean]{.type-label} - **`IsKubernetesCloudTargetDiscoveryEnabled`** :span[boolean]{.type-label} - **`IsProjectsPageOnboardingEnabled`** :span[boolean]{.type-label} -- **`IsProjectsPageOptimizationEnabled`** :span[boolean]{.type-label} - **`IsWebhookTriggerEnabled`** :span[boolean]{.type-label} - **`LastModifiedBy`** :span[string]{.type-label} Gets or sets the username of the user who last modified this resource. @@ -172,7 +166,6 @@ Updates the features configuration of the current instance "IsHelpSidebarEnabled": false, "IsKubernetesCloudTargetDiscoveryEnabled": false, "IsProjectsPageOnboardingEnabled": false, - "IsProjectsPageOptimizationEnabled": false, "IsWebhookTriggerEnabled": false, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", diff --git a/src/pages/docs/api/_generated/icons.md b/src/pages/docs/api/_generated/icons.md index 9b0a66db50..1b302f359e 100644 --- a/src/pages/docs/api/_generated/icons.md +++ b/src/pages/docs/api/_generated/icons.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-10-07 title: Icons --- @@ -115,26 +115,26 @@ Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/logo/icon` **Path Parameters** - **`projectId`** :span[string]{.type-label} *(required)* - The ID of the project to change logo for. Example: 'Projects-1'. + The ID of the project to change logo for. - **`spaceId`** :span[string]{.type-label} *(required)* The ID of the space containing the resource(s). **Request Body** - **`IconColor`** :span[string]{.type-label} *(required)* - Color of the icon in hex format. Example: '#0D80D8'. Minimum length 1. Must match `^#[0-9a-fA-F]{6}$`. + Color of the icon in hex format. Minimum length 1. Must match `^#[0-9a-fA-F]{6}$`. - **`IconId`** :span[string]{.type-label} *(required)* - ID of the icon. Example: 'octopus-deploy'. Minimum length 1. + ID of the icon. Minimum length 1. - **`ProjectId`** :span[string]{.type-label} *(required)* - The ID of the project to change logo for. Example: 'Projects-1'. + The ID of the project to change logo for. - **`SpaceId`** :span[string]{.type-label} *(required)* The ID of the space containing the resource(s). :::api-example{label="Request"} ```json { - "IconColor": "string", - "IconId": "string", + "IconColor": "#0D80D8", + "IconId": "octopus-deploy", "ProjectId": "Projects-1", "SpaceId": "Spaces-1" } diff --git a/src/pages/docs/api/_generated/interruptions.md b/src/pages/docs/api/_generated/interruptions.md index 4cc88c03f4..b72e5c540a 100644 --- a/src/pages/docs/api/_generated/interruptions.md +++ b/src/pages/docs/api/_generated/interruptions.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-04 +modDate: 2026-10-02 title: Interruptions --- @@ -64,6 +64,11 @@ Also reachable at `/api/interruptions`, `/api/spaces/{spaceIdentifier}/interrupt Gets the ids of documents related to this interruption. - **`ResponsibleTeamIds`** :span[array of string]{.type-label} Gets the ids of groups that can take responsibility for this interruption. + - **`ResponsibleUserActor`** :span[string]{.type-label} + Gets or sets the agent client (such as an MCP client) the responsible user acted through, typically in the same form as OAuth client. Null for other kinds of credential. + - **`ResponsibleUserActorType`** :span[enum]{.type-label} + Gets or sets the kind of actor (user, service account, AI agent) that took responsibility for this interruption. Unknown when nobody has taken responsibility, or for interruptions claimed before this was recorded. + Allowed values: `Unknown`, `System`, `User`, `Agent`, `ServiceAccount`. - **`ResponsibleUserId`** :span[string]{.type-label} Gets or sets the. - **`SpaceId`** :span[string]{.type-label} @@ -119,6 +124,8 @@ Also reachable at `/api/interruptions`, `/api/spaces/{spaceIdentifier}/interrupt "ResponsibleTeamIds": [ "string" ], + "ResponsibleUserActor": "string", + "ResponsibleUserActorType": "Unknown", "ResponsibleUserId": "string", "SpaceId": "Spaces-1", "TaskId": "string", @@ -195,6 +202,11 @@ Also reachable at `/api/interruptions/{id}`, `/api/spaces/{spaceIdentifier}/inte Gets the ids of documents related to this interruption. - **`ResponsibleTeamIds`** :span[array of string]{.type-label} Gets the ids of groups that can take responsibility for this interruption. +- **`ResponsibleUserActor`** :span[string]{.type-label} + Gets or sets the agent client (such as an MCP client) the responsible user acted through, typically in the same form as OAuth client. Null for other kinds of credential. +- **`ResponsibleUserActorType`** :span[enum]{.type-label} + Gets or sets the kind of actor (user, service account, AI agent) that took responsibility for this interruption. Unknown when nobody has taken responsibility, or for interruptions claimed before this was recorded. + Allowed values: `Unknown`, `System`, `User`, `Agent`, `ServiceAccount`. - **`ResponsibleUserId`** :span[string]{.type-label} Gets or sets the. - **`SpaceId`** :span[string]{.type-label} @@ -252,6 +264,8 @@ Also reachable at `/api/interruptions/{id}`, `/api/spaces/{spaceIdentifier}/inte "ResponsibleTeamIds": [ "string" ], + "ResponsibleUserActor": "string", + "ResponsibleUserActorType": "Unknown", "ResponsibleUserId": "string", "SpaceId": "Spaces-1", "TaskId": "string", @@ -444,6 +458,11 @@ Only the user with responsibility for this interruption can submit this form. Gets the ids of documents related to this interruption. - **`ResponsibleTeamIds`** :span[array of string]{.type-label} Gets the ids of groups that can take responsibility for this interruption. +- **`ResponsibleUserActor`** :span[string]{.type-label} + Gets or sets the agent client (such as an MCP client) the responsible user acted through, typically in the same form as OAuth client. Null for other kinds of credential. +- **`ResponsibleUserActorType`** :span[enum]{.type-label} + Gets or sets the kind of actor (user, service account, AI agent) that took responsibility for this interruption. Unknown when nobody has taken responsibility, or for interruptions claimed before this was recorded. + Allowed values: `Unknown`, `System`, `User`, `Agent`, `ServiceAccount`. - **`ResponsibleUserId`** :span[string]{.type-label} Gets or sets the. - **`SpaceId`** :span[string]{.type-label} @@ -501,6 +520,8 @@ Only the user with responsibility for this interruption can submit this form. "ResponsibleTeamIds": [ "string" ], + "ResponsibleUserActor": "string", + "ResponsibleUserActorType": "Unknown", "ResponsibleUserId": "string", "SpaceId": "Spaces-1", "TaskId": "string", diff --git a/src/pages/docs/api/_generated/lifecycles.md b/src/pages/docs/api/_generated/lifecycles.md index a727de3852..7534873bdf 100644 --- a/src/pages/docs/api/_generated/lifecycles.md +++ b/src/pages/docs/api/_generated/lifecycles.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-04 +modDate: 2026-10-07 title: Lifecycles --- @@ -986,7 +986,8 @@ Also reachable at `/api/lifecycles/{id}/projects`, `/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. - **`ExtensionId`** :span[string]{.type-label} - **`Values`** :span[string]{.type-label} - **`ForcePackageDownload`** :span[boolean]{.type-label} @@ -1056,36 +1057,31 @@ Also reachable at `/api/lifecycles/{id}/projects`, `/api/spaces/{spaceIdentifier "AutoCreateRelease": false, "AutoDeployReleaseOverrides": [ { - "EnvironmentId": "string", - "ReleaseId": "string", + "EnvironmentId": "Environments-1", + "ReleaseId": "Releases-1", "TenantId": "Tenants-1" } ], "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": [ - { - "ExtensionId": "string", - "Values": "string" - } - ], + "ExtensionSettings": [], "ForcePackageDownload": false, "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IncludedLibraryVariableSetIds": [ - "string" + "LibraryVariableSets-1" ], "IsBadgesEnabled": false, "IsDisabled": false, @@ -1108,7 +1104,7 @@ Also reachable at `/api/lifecycles/{id}/projects`, `/api/spaces/{spaceIdentifier "string" ] }, - "ProjectGroupId": "string", + "ProjectGroupId": "ProjectGroups-1", "ProjectTags": [ "string" ], @@ -1139,7 +1135,7 @@ Also reachable at `/api/lifecycles/{id}/projects`, `/api/spaces/{spaceIdentifier } ], "TenantedDeploymentMode": "Untenanted", - "VariableSetId": "string", + "VariableSetId": "variableset-Projects-1", "VersioningStrategy": { "DonorPackage": { "DeploymentAction": "string", diff --git a/src/pages/docs/api/_generated/octopus-server-nodes.md b/src/pages/docs/api/_generated/octopus-server-nodes.md index 5dcee87d39..9789c7eff1 100644 --- a/src/pages/docs/api/_generated/octopus-server-nodes.md +++ b/src/pages/docs/api/_generated/octopus-server-nodes.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-04 +modDate: 2026-10-06 title: Octopus Server Nodes --- @@ -181,6 +181,7 @@ Returns HTTP ImATeapot (418) when the Octopus Server node is draining or offline `200` — The Octopus Server Nodes Summary +- **`IsMultiNodePollingTentaclesEnabled`** :span[boolean]{.type-label} - **`Links`** :span[object]{.type-label} - **`Nodes`** :span[array of object]{.type-label} - **`Id`** :span[string]{.type-label} @@ -205,6 +206,7 @@ Returns HTTP ImATeapot (418) when the Octopus Server node is draining or offline :::api-example{label="Response"} ```json { + "IsMultiNodePollingTentaclesEnabled": false, "Links": { "additionalProp1": "string", "additionalProp2": "string", diff --git a/src/pages/docs/api/_generated/platform-hub.md b/src/pages/docs/api/_generated/platform-hub.md index c561f2685a..5bcd95f9ed 100644 --- a/src/pages/docs/api/_generated/platform-hub.md +++ b/src/pages/docs/api/_generated/platform-hub.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-04 +modDate: 2026-10-07 title: Platform Hub --- @@ -2850,8 +2850,8 @@ Request will fail if the user does not have a valid GitHub OAuth token. "Description": "string", "GitRef": "string", "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "Name": "string", diff --git a/src/pages/docs/api/_generated/process-templates.md b/src/pages/docs/api/_generated/process-templates.md index 3ae1ed1020..ec31432b57 100644 --- a/src/pages/docs/api/_generated/process-templates.md +++ b/src/pages/docs/api/_generated/process-templates.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-20 +modDate: 2026-10-07 title: Process Templates --- @@ -106,8 +106,8 @@ title: Process Templates "GitCommit": "string", "GitRef": "string", "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "ProcessTemplateVersion-1", "IsPreRelease": false, @@ -179,8 +179,8 @@ title: Process Templates "Description": "string", "GitRef": "string", "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "Name": "string", @@ -288,8 +288,8 @@ title: Process Templates "Description": "string", "GitRef": "string", "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "Name": "string", @@ -385,8 +385,8 @@ title: Process Templates "Description": "string", "GitRef": "string", "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "Name": "string", @@ -588,8 +588,8 @@ title: Process Templates "GitCommit": "string", "GitRef": "string", "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "ProcessTemplateVersion-1", "IsPreRelease": false, @@ -689,8 +689,8 @@ title: Process Templates "Description": "string", "GitRef": "string", "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Name": "string", "Parameters": [ @@ -776,8 +776,8 @@ title: Process Templates "Description": "string", "GitRef": "string", "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "Name": "string", @@ -886,8 +886,8 @@ Also reachable at `/api/spaces/{spaceIdentifier}/processtemplates/{slug}/{versio "Description": "string", "GitRef": "string", "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "Name": "string", diff --git a/src/pages/docs/api/_generated/project-groups.md b/src/pages/docs/api/_generated/project-groups.md index 2d616b8b8e..0f928d8bce 100644 --- a/src/pages/docs/api/_generated/project-groups.md +++ b/src/pages/docs/api/_generated/project-groups.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-04 +modDate: 2026-10-07 title: Project Groups --- @@ -434,7 +434,8 @@ Also reachable at `/api/projectgroups/{id}/projects`, `/api/spaces/{spaceIdentif - **`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} @@ -494,25 +495,23 @@ Also reachable at `/api/projectgroups/{id}/projects`, `/api/spaces/{spaceIdentif "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, @@ -535,7 +534,7 @@ Also reachable at `/api/projectgroups/{id}/projects`, `/api/spaces/{spaceIdentif "string" ] }, - "ProjectGroupId": "string", + "ProjectGroupId": "ProjectGroups-1", "ProjectTags": [ "string" ], @@ -556,7 +555,7 @@ Also reachable at `/api/projectgroups/{id}/projects`, `/api/spaces/{spaceIdentif {} ], "TenantedDeploymentMode": "Untenanted", - "VariableSetId": "string", + "VariableSetId": "variableset-Projects-1", "VersioningStrategy": { "DonorPackage": {}, "Template": "string" diff --git a/src/pages/docs/api/_generated/projects.md b/src/pages/docs/api/_generated/projects.md index 089140915b..3c0af24206 100644 --- a/src/pages/docs/api/_generated/projects.md +++ b/src/pages/docs/api/_generated/projects.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-04 +modDate: 2026-10-07 title: Projects --- @@ -55,7 +55,8 @@ List all the projects in the supplied Octopus Deploy Space, from all project gro - **`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} @@ -115,25 +116,23 @@ List all the projects in the supplied Octopus Deploy Space, from all project gro "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, @@ -156,7 +155,7 @@ List all the projects in the supplied Octopus Deploy Space, from all project gro "string" ] }, - "ProjectGroupId": "string", + "ProjectGroupId": "ProjectGroups-1", "ProjectTags": [ "string" ], @@ -177,7 +176,7 @@ List all the projects in the supplied Octopus Deploy Space, from all project gro {} ], "TenantedDeploymentMode": "Untenanted", - "VariableSetId": "string", + "VariableSetId": "variableset-Projects-1", "VersioningStrategy": { "DonorPackage": {}, "Template": "string" @@ -226,7 +225,8 @@ Also reachable at `/api/projects`, `/api/spaces/{spaceIdentifier}/projects`. - **`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. - **`ExtensionId`** :span[string]{.type-label} - **`Values`** :span[string]{.type-label} - **`ForcePackageDownload`** :span[boolean]{.type-label} @@ -278,8 +278,8 @@ Also reachable at `/api/projects`, `/api/spaces/{spaceIdentifier}/projects`. "AutoCreateRelease": false, "AutoDeployReleaseOverrides": [ { - "EnvironmentId": "string", - "ReleaseId": "string", + "EnvironmentId": "Environments-1", + "ReleaseId": "Releases-1", "TenantId": "Tenants-1" } ], @@ -291,12 +291,7 @@ Also reachable at `/api/projects`, `/api/spaces/{spaceIdentifier}/projects`. "Description": "string", "DiscreteChannelRelease": false, "ExecuteDeploymentsOnEventBasedPipeline": false, - "ExtensionSettings": [ - { - "ExtensionId": "string", - "Values": "string" - } - ], + "ExtensionSettings": [], "ForcePackageDownload": false, "IncludedLibraryVariableSetIds": [ "string" @@ -383,7 +378,8 @@ Also reachable at `/api/projects`, `/api/spaces/{spaceIdentifier}/projects`. - **`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. - **`ExtensionId`** :span[string]{.type-label} - **`Values`** :span[string]{.type-label} - **`ForcePackageDownload`** :span[boolean]{.type-label} @@ -452,36 +448,31 @@ Also reachable at `/api/projects`, `/api/spaces/{spaceIdentifier}/projects`. "AutoCreateRelease": false, "AutoDeployReleaseOverrides": [ { - "EnvironmentId": "string", - "ReleaseId": "string", + "EnvironmentId": "Environments-1", + "ReleaseId": "Releases-1", "TenantId": "Tenants-1" } ], "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": [ - { - "ExtensionId": "string", - "Values": "string" - } - ], + "ExtensionSettings": [], "ForcePackageDownload": false, "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IncludedLibraryVariableSetIds": [ - "string" + "LibraryVariableSets-1" ], "IsBadgesEnabled": false, "IsDisabled": false, @@ -504,7 +495,7 @@ Also reachable at `/api/projects`, `/api/spaces/{spaceIdentifier}/projects`. "string" ] }, - "ProjectGroupId": "string", + "ProjectGroupId": "ProjectGroups-1", "ProjectTags": [ "string" ], @@ -543,7 +534,7 @@ Also reachable at `/api/projects`, `/api/spaces/{spaceIdentifier}/projects`. } ], "TenantedDeploymentMode": "Untenanted", - "VariableSetId": "string", + "VariableSetId": "variableset-Projects-1", "VersioningStrategy": { "DonorPackage": { "DeploymentAction": "string", @@ -596,7 +587,8 @@ List all of the projects in the supplied Octopus Deploy Space. - **`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. - **`ExtensionId`** :span[string]{.type-label} - **`Values`** :span[string]{.type-label} - **`ForcePackageDownload`** :span[boolean]{.type-label} @@ -666,36 +658,31 @@ List all of the projects in the supplied Octopus Deploy Space. "AutoCreateRelease": false, "AutoDeployReleaseOverrides": [ { - "EnvironmentId": "string", - "ReleaseId": "string", + "EnvironmentId": "Environments-1", + "ReleaseId": "Releases-1", "TenantId": "Tenants-1" } ], "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": [ - { - "ExtensionId": "string", - "Values": "string" - } - ], + "ExtensionSettings": [], "ForcePackageDownload": false, "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IncludedLibraryVariableSetIds": [ - "string" + "LibraryVariableSets-1" ], "IsBadgesEnabled": false, "IsDisabled": false, @@ -718,7 +705,7 @@ List all of the projects in the supplied Octopus Deploy Space. "string" ] }, - "ProjectGroupId": "string", + "ProjectGroupId": "ProjectGroups-1", "ProjectTags": [ "string" ], @@ -749,7 +736,7 @@ List all of the projects in the supplied Octopus Deploy Space. } ], "TenantedDeploymentMode": "Untenanted", - "VariableSetId": "string", + "VariableSetId": "variableset-Projects-1", "VersioningStrategy": { "DonorPackage": { "DeploymentAction": "string", @@ -820,7 +807,8 @@ Also reachable at `/api/projects/{projectId}`, `/api/projects/{projectId}/{unuse - **`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. - **`ExtensionId`** :span[string]{.type-label} - **`Values`** :span[string]{.type-label} - **`ForcePackageDownload`** :span[boolean]{.type-label} @@ -889,36 +877,31 @@ Also reachable at `/api/projects/{projectId}`, `/api/projects/{projectId}/{unuse "AutoCreateRelease": false, "AutoDeployReleaseOverrides": [ { - "EnvironmentId": "string", - "ReleaseId": "string", + "EnvironmentId": "Environments-1", + "ReleaseId": "Releases-1", "TenantId": "Tenants-1" } ], "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": [ - { - "ExtensionId": "string", - "Values": "string" - } - ], + "ExtensionSettings": [], "ForcePackageDownload": false, "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IncludedLibraryVariableSetIds": [ - "string" + "LibraryVariableSets-1" ], "IsBadgesEnabled": false, "IsDisabled": false, @@ -941,7 +924,7 @@ Also reachable at `/api/projects/{projectId}`, `/api/projects/{projectId}/{unuse "string" ] }, - "ProjectGroupId": "string", + "ProjectGroupId": "ProjectGroups-1", "ProjectTags": [ "string" ], @@ -980,7 +963,7 @@ Also reachable at `/api/projects/{projectId}`, `/api/projects/{projectId}/{unuse } ], "TenantedDeploymentMode": "Untenanted", - "VariableSetId": "string", + "VariableSetId": "variableset-Projects-1", "VersioningStrategy": { "DonorPackage": { "DeploymentAction": "string", @@ -1028,7 +1011,8 @@ Also reachable at `/api/projects/{projectId}`, `/api/spaces/{spaceIdentifier}/pr - **`DiscreteChannelRelease`** :span[boolean]{.type-label} Treats releases of different channels to the same environment as a separate 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. - **`ExtensionId`** :span[string]{.type-label} - **`Values`** :span[string]{.type-label} - **`ForcePackageDownload`** :span[boolean]{.type-label} @@ -1083,8 +1067,8 @@ Also reachable at `/api/projects/{projectId}`, `/api/spaces/{spaceIdentifier}/pr "AutoCreateRelease": false, "AutoDeployReleaseOverrides": [ { - "EnvironmentId": "string", - "ReleaseId": "string", + "EnvironmentId": "Environments-1", + "ReleaseId": "Releases-1", "TenantId": "Tenants-1" } ], @@ -1099,12 +1083,7 @@ Also reachable at `/api/projects/{projectId}`, `/api/spaces/{spaceIdentifier}/pr "Description": "string", "DiscreteChannelRelease": false, "ExecuteDeploymentsOnEventBasedPipeline": false, - "ExtensionSettings": [ - { - "ExtensionId": "string", - "Values": "string" - } - ], + "ExtensionSettings": [], "ForcePackageDownload": false, "IncludedLibraryVariableSetIds": [ "string" @@ -1193,7 +1172,8 @@ Also reachable at `/api/projects/{projectId}`, `/api/spaces/{spaceIdentifier}/pr - **`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. - **`ExtensionId`** :span[string]{.type-label} - **`Values`** :span[string]{.type-label} - **`ForcePackageDownload`** :span[boolean]{.type-label} @@ -1262,36 +1242,31 @@ Also reachable at `/api/projects/{projectId}`, `/api/spaces/{spaceIdentifier}/pr "AutoCreateRelease": false, "AutoDeployReleaseOverrides": [ { - "EnvironmentId": "string", - "ReleaseId": "string", + "EnvironmentId": "Environments-1", + "ReleaseId": "Releases-1", "TenantId": "Tenants-1" } ], "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": [ - { - "ExtensionId": "string", - "Values": "string" - } - ], + "ExtensionSettings": [], "ForcePackageDownload": false, "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IncludedLibraryVariableSetIds": [ - "string" + "LibraryVariableSets-1" ], "IsBadgesEnabled": false, "IsDisabled": false, @@ -1314,7 +1289,7 @@ Also reachable at `/api/projects/{projectId}`, `/api/spaces/{spaceIdentifier}/pr "string" ] }, - "ProjectGroupId": "string", + "ProjectGroupId": "ProjectGroups-1", "ProjectTags": [ "string" ], @@ -1353,7 +1328,7 @@ Also reachable at `/api/projects/{projectId}`, `/api/spaces/{spaceIdentifier}/pr } ], "TenantedDeploymentMode": "Untenanted", - "VariableSetId": "string", + "VariableSetId": "variableset-Projects-1", "VersioningStrategy": { "DonorPackage": { "DeploymentAction": "string", diff --git a/src/pages/docs/api/_generated/runbooks.md b/src/pages/docs/api/_generated/runbooks.md index 315c322a6c..f3a128a025 100644 --- a/src/pages/docs/api/_generated/runbooks.md +++ b/src/pages/docs/api/_generated/runbooks.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-04 +modDate: 2026-10-07 title: Runbooks --- @@ -933,7 +933,8 @@ Also reachable at `/api/projects/{projectId}/runbooks/{id}/environments`, `/api/ 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} @@ -962,12 +963,7 @@ Also reachable at `/api/projects/{projectId}/runbooks/{id}/environments`, `/api/ "EnvironmentTags": [ "string" ], - "ExtensionSettings": [ - { - "ExtensionId": "string", - "Values": "string" - } - ], + "ExtensionSettings": [], "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", @@ -2365,7 +2361,8 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbooks/{id}/environments 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} @@ -2394,12 +2391,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbooks/{id}/environments "EnvironmentTags": [ "string" ], - "ExtensionSettings": [ - { - "ExtensionId": "string", - "Values": "string" - } - ], + "ExtensionSettings": [], "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", @@ -3832,7 +3824,8 @@ Also reachable at `/api/runbooks/{id}/environments`, `/api/spaces/{spaceIdentifi 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} @@ -3861,12 +3854,7 @@ Also reachable at `/api/runbooks/{id}/environments`, `/api/spaces/{spaceIdentifi "EnvironmentTags": [ "string" ], - "ExtensionSettings": [ - { - "ExtensionId": "string", - "Values": "string" - } - ], + "ExtensionSettings": [], "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", diff --git a/src/pages/docs/api/_generated/server-status.md b/src/pages/docs/api/_generated/server-status.md index 4659d909b1..9c03115a70 100644 --- a/src/pages/docs/api/_generated/server-status.md +++ b/src/pages/docs/api/_generated/server-status.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-18 +modDate: 2026-09-29 title: Server Status --- @@ -229,6 +229,47 @@ Provides a super simple interface perfect for checking the general health of you ``` ::: +## Get the status of Redis for multi-node support for polling tentacles + +:endpoint{method="GET" path="/api/serverstatus/redis"} + +Provides a simple interface for checking if Redis is enabled, configured, and reachable. + +**Response** + +`200` — Provides information about Redis status for monitoring and diagnostics. + +- **`Id`** :span[string]{.type-label} + Gets or sets a unique identifier for this resource. +- **`IsConfigured`** :span[boolean]{.type-label} + Indicates whether a valid Redis connection string is configured on this Octopus Server node. +- **`IsEnabled`** :span[boolean]{.type-label} + Indicates whether multi-node support for polling tentacles is enabled on this Octopus Server node. +- **`IsReachable`** :span[boolean]{.type-label} + Indicates whether this Octopus Server node can reach Redis and Redis responds to commands. +- **`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. + +:::api-example{label="Response"} +```json +{ + "Id": "string", + "IsConfigured": false, + "IsEnabled": false, + "IsReachable": false, + "LastModifiedBy": "string", + "LastModifiedOn": "2020-01-01T00:00:00.000Z", + "Links": { + "Self": "/api/..." + } +} +``` +::: + ## Provide information about the Octopus Server process and the machine on which it is running :endpoint{method="GET" path="/api/serverstatus/system-info"} diff --git a/src/pages/docs/api/_generated/spaces.md b/src/pages/docs/api/_generated/spaces.md index b16ed52a8c..e07b79ba18 100644 --- a/src/pages/docs/api/_generated/spaces.md +++ b/src/pages/docs/api/_generated/spaces.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-04 +modDate: 2026-10-07 title: Spaces --- @@ -1017,7 +1017,8 @@ Lists all of the Spaces in the supplied Octopus Deploy Space. The results will b The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[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. - **`Icon`** :span[object]{.type-label} - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. @@ -1053,12 +1054,10 @@ Lists all of the Spaces in the supplied Octopus Deploy Space. The results will b "Items": [ { "Description": "string", - "ExtensionSettings": [ - {} - ], + "ExtensionSettings": [], "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IsDefault": false, @@ -1133,7 +1132,8 @@ Lists all of the Spaces in the supplied Octopus Deploy Space. The results will b `201` — Created - **`Description`** :span[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} - **`Icon`** :span[object]{.type-label} @@ -1161,15 +1161,10 @@ Lists all of the Spaces in the supplied Octopus Deploy Space. The results will b ```json { "Description": "string", - "ExtensionSettings": [ - { - "ExtensionId": "string", - "Values": "string" - } - ], + "ExtensionSettings": [], "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IsDefault": false, @@ -1209,7 +1204,8 @@ Lists all Spaces. The results will be sorted alphabetically by name. `200` — The requested list of Spaces - **`Description`** :span[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} - **`Icon`** :span[object]{.type-label} @@ -1238,15 +1234,10 @@ Lists all Spaces. The results will be sorted alphabetically by name. [ { "Description": "string", - "ExtensionSettings": [ - { - "ExtensionId": "string", - "Values": "string" - } - ], + "ExtensionSettings": [], "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IsDefault": false, @@ -1312,7 +1303,8 @@ Lists all Spaces. The results will be sorted alphabetically by name. - **`Space`** :span[object]{.type-label} - **`Description`** :span[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. - **`Icon`** :span[object]{.type-label} - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. @@ -1335,15 +1327,10 @@ Lists all Spaces. The results will be sorted alphabetically by name. { "Space": { "Description": "string", - "ExtensionSettings": [ - { - "ExtensionId": "string", - "Values": "string" - } - ], + "ExtensionSettings": [], "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IsDefault": false, @@ -1382,7 +1369,8 @@ Lists all Spaces. The results will be sorted alphabetically by name. `200` — Returns a space - **`Description`** :span[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} - **`Icon`** :span[object]{.type-label} @@ -1410,15 +1398,10 @@ Lists all Spaces. The results will be sorted alphabetically by name. ```json { "Description": "string", - "ExtensionSettings": [ - { - "ExtensionId": "string", - "Values": "string" - } - ], + "ExtensionSettings": [], "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IsDefault": false, @@ -1488,7 +1471,8 @@ Lists all Spaces. The results will be sorted alphabetically by name. `200` — Confirmation that the Space was modified, contains the updated Space - **`Description`** :span[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} - **`Icon`** :span[object]{.type-label} @@ -1516,15 +1500,10 @@ Lists all Spaces. The results will be sorted alphabetically by name. ```json { "Description": "string", - "ExtensionSettings": [ - { - "ExtensionId": "string", - "Values": "string" - } - ], + "ExtensionSettings": [], "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IsDefault": false, @@ -1694,7 +1673,8 @@ Also reachable at `/api/spaces/{id}/search`, `/api/spaces/{spaceIdentifier}/spac `200` — The requested list of Spaces available to the user - **`Description`** :span[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} - **`Icon`** :span[object]{.type-label} @@ -1723,15 +1703,10 @@ Also reachable at `/api/spaces/{id}/search`, `/api/spaces/{spaceIdentifier}/spac [ { "Description": "string", - "ExtensionSettings": [ - { - "ExtensionId": "string", - "Values": "string" - } - ], + "ExtensionSettings": [], "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IsDefault": false, diff --git a/src/pages/docs/api/_generated/tenants.md b/src/pages/docs/api/_generated/tenants.md index a7b3521905..8b4bb9a46f 100644 --- a/src/pages/docs/api/_generated/tenants.md +++ b/src/pages/docs/api/_generated/tenants.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-04 +modDate: 2026-10-07 title: Tenants --- @@ -91,8 +91,8 @@ Lists all of the tenants in the supplied Octopus Deploy Space. The results will ], "Description": "string", "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IsDisabled": false, @@ -225,8 +225,8 @@ Creates a new Tenant, optionally cloning an existing tenant if the clone query s ], "Description": "string", "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IsDisabled": false, @@ -322,8 +322,8 @@ Lists all of the tenants in the supplied Octopus Deploy Space. The results will ], "Description": "string", "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IsDisabled": false, @@ -556,8 +556,8 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tenants/{id}`, `/api/tenants/{i ], "Description": "string", "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IsDisabled": false, @@ -679,8 +679,8 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tenants/{id}`, `/api/tenants/{i ], "Description": "string", "Icon": { - "Color": "string", - "Id": "string" + "Color": "#3CA4F3", + "Id": "rocket" }, "Id": "string", "IsDisabled": false, diff --git a/src/pages/docs/api/_generated/users.md b/src/pages/docs/api/_generated/users.md index 4aa52ff750..572f3c13ae 100644 --- a/src/pages/docs/api/_generated/users.md +++ b/src/pages/docs/api/_generated/users.md @@ -615,9 +615,6 @@ Unless the first administrator user is being registered, an invitation code must - **`DisplayName`** :span[string]{.type-label} *(required)* Minimum length 1. - **`EmailAddress`** :span[string]{.type-label} -- **`Identities`** :span[array of object]{.type-label} - - **`Claims`** :span[object]{.type-label} - - **`IdentityProviderName`** :span[string]{.type-label} - **`InvitationCode`** :span[string]{.type-label} *(required)* Minimum length 1. - **`Password`** :span[string]{.type-label} *(required)* @@ -630,16 +627,6 @@ Unless the first administrator user is being registered, an invitation code must { "DisplayName": "string", "EmailAddress": "string", - "Identities": [ - { - "Claims": { - "additionalProp1": {}, - "additionalProp2": {}, - "additionalProp3": {} - }, - "IdentityProviderName": "string" - } - ], "InvitationCode": "string", "Password": "string", "Username": "string" diff --git a/src/pages/docs/api/_generated/worker-pools.md b/src/pages/docs/api/_generated/worker-pools.md index 8f0703f0a9..9b96ce1e5c 100644 --- a/src/pages/docs/api/_generated/worker-pools.md +++ b/src/pages/docs/api/_generated/worker-pools.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-04 +modDate: 2026-10-08 title: Worker Pools --- @@ -361,14 +361,21 @@ Lists all worker pools, including a summary of machine information. **Query Parameters** -- **`commStyles`** :span[array of string]{.type-label} -- **`healthStatuses`** :span[array of string]{.type-label} -- **`hideEmptyWorkerPools`** :span[boolean]{.type-label} +- **`commStyles`** :span[array of string]{.type-label} + Only count workers with one of these communication styles, such as TentaclePassive, TentacleActive or Ssh. Matching is exact and case-sensitive. +- **`healthStatuses`** :span[array of string]{.type-label} + Only count workers with one of these health statuses: Healthy, HasWarnings, Unhealthy, Unavailable or Unknown. +- **`hideEmptyWorkerPools`** :span[boolean]{.type-label} + When true, leave out worker pools with no workers matching the filters. - **`ids`** :span[array of string]{.type-label} -- **`isDisabled`** :span[boolean]{.type-label} -- **`machinePartialName`** :span[string]{.type-label} -- **`partialName`** :span[string]{.type-label} -- **`shellNames`** :span[array of string]{.type-label} +- **`isDisabled`** :span[boolean]{.type-label} + When true, only count disabled workers. When false or not set, both enabled and disabled workers are counted. +- **`machinePartialName`** :span[string]{.type-label} + A partial or complete worker name. Only workers whose name contains it are counted. +- **`partialName`** :span[string]{.type-label} + A partial or complete worker pool name to search on, using a case-insensitive "contains" match. +- **`shellNames`** :span[array of string]{.type-label} + Only count workers using one of these shells, such as PowerShell or Bash. Matching is exact and case-sensitive. **Response**